{"items":[{"type":"link","label":"Client Management API","link":"/apis/client-management-api-v1","routeSlug":"/apis/client-management-api-v1","content":{"contentType":"overview","meta":{"name":"Client Management API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"client-management-api-v1.json","url":"/_bundle/apis/client-management-api-v1.json?download"},{"kind":"download","label":"client-management-api-v1.yaml","url":"/_bundle/apis/client-management-api-v1.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Proprietary — © RAI Partners Inc. All rights reserved.","url":"https://www.raipartners.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/apis/client-management-api-v1","description":"Mock server","isMockServer":true},{"url":"https://api.raipartners.com/client-management","description":"Production"},{"url":"https://api.dev.raipartners.com/client-management","description":"Sandbox"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Client Management API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"RAI Partners Client Management API"}],"sectionId":"/apis/client-management-api-v1"}],"sectionId":"/apis/client-management-api-v1"}]}]}},{"type":"group","label":"Account","link":"/apis/client-management-api-v1/account","routeSlug":"/apis/client-management-api-v1/account","items":[{"label":"Retrieve the accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/client-management-api-v1/account/streamaccounts","routeSlug":"/apis/client-management-api-v1/account/streamaccounts","metadata":{"seo":{"title":"Retrieve the accounts","description":"Retrieve the accounts associated with the client."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"streamAccounts","name":"Retrieve the accounts","isWebhook":false,"pointer":"/paths/~1accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the accounts associated with the client."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-jwt","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"API-Version","in":"header","schemaId":"schema_1"}],"pointer":"/paths/~1accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts","servers":[{"url":"/_mock/apis/client-management-api-v1","description":"Mock server","isMockServer":true},{"url":"https://api.raipartners.com/client-management","description":"Production"},{"url":"https://api.dev.raipartners.com/client-management","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"API-Version","in":"header","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-jwt","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500","503"],"pointer":"/accounts","href":"account/streamaccounts","openApiOperationId":"streamAccounts","summary":"Retrieve the accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/client-management-api-v1","description":"Mock server","isMockServer":true},{"url":"https://api.raipartners.com/client-management","description":"Production"},{"url":"https://api.dev.raipartners.com/client-management","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful stream of accounts. IMPORTANT: The accounts are returned in NDJSON format (one account json object per line), not as an array.","mediaType":"application/x-ndjson","mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/AccountInformation"}},"schemaId":"components/schemas/AccountInformation"},{"code":"400","description":"Bad request.","mediaType":"application/x-ndjson","mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1accounts/get/responses/400/content/application~1x-ndjson/examples/Generic invalid data","paths/~1accounts/get/responses/400/content/application~1x-ndjson/examples/Generic missing data"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1accounts/get/responses/400/content/application~1x-ndjson/examples/Generic invalid data","paths/~1accounts/get/responses/400/content/application~1x-ndjson/examples/Generic missing data"]},{"code":"401","description":"Unauthorized.","mediaType":"application/x-ndjson","mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1accounts/get/responses/401/content/application~1x-ndjson/examples/Unauthorized"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1accounts/get/responses/401/content/application~1x-ndjson/examples/Unauthorized"]},{"code":"403","description":"Forbidden.","mediaType":"application/x-ndjson","mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1accounts/get/responses/403/content/application~1x-ndjson/examples/Forbidden"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1accounts/get/responses/403/content/application~1x-ndjson/examples/Forbidden"]},{"code":"404","description":"not found.","mediaType":"application/x-ndjson","mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1accounts/get/responses/404/content/application~1x-ndjson/examples/Not found"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1accounts/get/responses/404/content/application~1x-ndjson/examples/Not found"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/x-ndjson","mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1accounts/get/responses/500/content/application~1x-ndjson/examples/Internal server error"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1accounts/get/responses/500/content/application~1x-ndjson/examples/Internal server error"]},{"code":"503","description":"Service unavailable.","mediaType":"application/x-ndjson","mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1accounts/get/responses/503/content/application~1x-ndjson/examples/Service unavailable"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1accounts/get/responses/503/content/application~1x-ndjson/examples/Service unavailable"]}],"pointer":"/paths/~1accounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountInformation","mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/AccountInformation"}}},{"code":"400","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1accounts/get/responses/400/content/application~1x-ndjson/examples/Generic invalid data","paths/~1accounts/get/responses/400/content/application~1x-ndjson/examples/Generic missing data"],"mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1accounts/get/responses/400/content/application~1x-ndjson/examples/Generic invalid data","paths/~1accounts/get/responses/400/content/application~1x-ndjson/examples/Generic missing data"]}}},{"code":"401","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1accounts/get/responses/401/content/application~1x-ndjson/examples/Unauthorized"],"mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1accounts/get/responses/401/content/application~1x-ndjson/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1accounts/get/responses/403/content/application~1x-ndjson/examples/Forbidden"],"mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1accounts/get/responses/403/content/application~1x-ndjson/examples/Forbidden"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1accounts/get/responses/404/content/application~1x-ndjson/examples/Not found"],"mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1accounts/get/responses/404/content/application~1x-ndjson/examples/Not found"]}}},{"code":"500","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1accounts/get/responses/500/content/application~1x-ndjson/examples/Internal server error"],"mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1accounts/get/responses/500/content/application~1x-ndjson/examples/Internal server error"]}}},{"code":"503","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1accounts/get/responses/503/content/application~1x-ndjson/examples/Service unavailable"],"mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1accounts/get/responses/503/content/application~1x-ndjson/examples/Service unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/streamaccounts"}],"panels":[]}]},"httpPath":"/accounts"},{"label":"Retrieve the transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/client-management-api-v1/account/streamtransactions","routeSlug":"/apis/client-management-api-v1/account/streamtransactions","metadata":{"seo":{"title":"Retrieve the transactions","description":"Retrieve the transactions across all accounts for the given cycle date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"streamTransactions","name":"Retrieve the transactions","isWebhook":false,"pointer":"/paths/~1transactions~1{date}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the transactions across all accounts for the given cycle date."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-jwt","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"date","in":"path","schemaId":"schema_2","description":"The cycle date for which the transactions are requested","required":true,"example":"2026-07-31"}],"pointer":"/paths/~1transactions~1{date}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"API-Version","in":"header","schemaId":"schema_1"}],"pointer":"/paths/~1transactions~1{date}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transactions/{date}","servers":[{"url":"/_mock/apis/client-management-api-v1","description":"Mock server","isMockServer":true},{"url":"https://api.raipartners.com/client-management","description":"Production"},{"url":"https://api.dev.raipartners.com/client-management","description":"Sandbox"}],"parameters":{"path":[{"name":"date","in":"path","required":true,"example":"2026-07-31","schemaId":"schema_2"}],"query":[],"querystring":[],"header":[{"name":"API-Version","in":"header","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-jwt","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500","503"],"pointer":"/transactions/{date}","href":"account/streamtransactions","openApiOperationId":"streamTransactions","summary":"Retrieve the transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/client-management-api-v1","description":"Mock server","isMockServer":true},{"url":"https://api.raipartners.com/client-management","description":"Production"},{"url":"https://api.dev.raipartners.com/client-management","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful stream of transactions. IMPORTANT: The transactions are returned in NDJSON format (one transaction json object per line), not as an array.","mediaType":"application/x-ndjson","mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/Transaction"}},"schemaId":"components/schemas/Transaction"},{"code":"400","description":"Bad request.","mediaType":"application/x-ndjson","mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1transactions~1{date}/get/responses/400/content/application~1x-ndjson/examples/Generic invalid data","paths/~1transactions~1{date}/get/responses/400/content/application~1x-ndjson/examples/Generic missing data"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1transactions~1{date}/get/responses/400/content/application~1x-ndjson/examples/Generic invalid data","paths/~1transactions~1{date}/get/responses/400/content/application~1x-ndjson/examples/Generic missing data"]},{"code":"401","description":"Unauthorized.","mediaType":"application/x-ndjson","mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1transactions~1{date}/get/responses/401/content/application~1x-ndjson/examples/Unauthorized"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1transactions~1{date}/get/responses/401/content/application~1x-ndjson/examples/Unauthorized"]},{"code":"403","description":"Forbidden.","mediaType":"application/x-ndjson","mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1transactions~1{date}/get/responses/403/content/application~1x-ndjson/examples/Forbidden"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1transactions~1{date}/get/responses/403/content/application~1x-ndjson/examples/Forbidden"]},{"code":"404","description":"not found.","mediaType":"application/x-ndjson","mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1transactions~1{date}/get/responses/404/content/application~1x-ndjson/examples/Not found"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1transactions~1{date}/get/responses/404/content/application~1x-ndjson/examples/Not found"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/x-ndjson","mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1transactions~1{date}/get/responses/500/content/application~1x-ndjson/examples/Internal server error"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1transactions~1{date}/get/responses/500/content/application~1x-ndjson/examples/Internal server error"]},{"code":"503","description":"Service unavailable.","mediaType":"application/x-ndjson","mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1transactions~1{date}/get/responses/503/content/application~1x-ndjson/examples/Service unavailable"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1transactions~1{date}/get/responses/503/content/application~1x-ndjson/examples/Service unavailable"]}],"pointer":"/paths/~1transactions~1{date}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Transaction","mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/Transaction"}}},{"code":"400","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1transactions~1{date}/get/responses/400/content/application~1x-ndjson/examples/Generic invalid data","paths/~1transactions~1{date}/get/responses/400/content/application~1x-ndjson/examples/Generic missing data"],"mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1transactions~1{date}/get/responses/400/content/application~1x-ndjson/examples/Generic invalid data","paths/~1transactions~1{date}/get/responses/400/content/application~1x-ndjson/examples/Generic missing data"]}}},{"code":"401","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1transactions~1{date}/get/responses/401/content/application~1x-ndjson/examples/Unauthorized"],"mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1transactions~1{date}/get/responses/401/content/application~1x-ndjson/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1transactions~1{date}/get/responses/403/content/application~1x-ndjson/examples/Forbidden"],"mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1transactions~1{date}/get/responses/403/content/application~1x-ndjson/examples/Forbidden"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1transactions~1{date}/get/responses/404/content/application~1x-ndjson/examples/Not found"],"mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1transactions~1{date}/get/responses/404/content/application~1x-ndjson/examples/Not found"]}}},{"code":"500","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1transactions~1{date}/get/responses/500/content/application~1x-ndjson/examples/Internal server error"],"mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1transactions~1{date}/get/responses/500/content/application~1x-ndjson/examples/Internal server error"]}}},{"code":"503","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1transactions~1{date}/get/responses/503/content/application~1x-ndjson/examples/Service unavailable"],"mediaTypes":["application/x-ndjson"],"mediaTypeContent":{"application/x-ndjson":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1transactions~1{date}/get/responses/503/content/application~1x-ndjson/examples/Service unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account/streamtransactions"}],"panels":[]}]},"httpPath":"/transactions/{date}"}],"content":{"contentType":"group","meta":{"name":"Account"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account","showPageActions":true},{"nodeType":"markdoc","content":"Account functions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/accounts","summary":"Retrieve the accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account/streamaccounts","deprecated":false},{"title":"/transactions/{date}","summary":"Retrieve the transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account/streamtransactions","deprecated":false}]}]}]}]}},{"type":"group","label":"Authentication","link":"/apis/client-management-api-v1/authentication","routeSlug":"/apis/client-management-api-v1/authentication","items":[{"label":"Rotate the client secret","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/client-management-api-v1/authentication/rotateclientsecret","routeSlug":"/apis/client-management-api-v1/authentication/rotateclientsecret","metadata":{"seo":{"title":"Rotate the client secret","description":"Rotate and return the client secret"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"rotateClientSecret","name":"Rotate the client secret","isWebhook":false,"pointer":"/paths/~1auth~1client-secret~1rotation/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rotate the client secret","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Rotate and return the client secret"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-jwt","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"API-Version","in":"header","schemaId":"schema_1"}],"pointer":"/paths/~1auth~1client-secret~1rotation/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/auth/client-secret/rotation","servers":[{"url":"/_mock/apis/client-management-api-v1","description":"Mock server","isMockServer":true},{"url":"https://api.raipartners.com/client-management","description":"Production"},{"url":"https://api.dev.raipartners.com/client-management","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"API-Version","in":"header","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-jwt","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500","503"],"pointer":"/auth/client-secret/rotation","href":"authentication/rotateclientsecret","openApiOperationId":"rotateClientSecret","summary":"Rotate the client secret"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/client-management-api-v1","description":"Mock server","isMockServer":true},{"url":"https://api.raipartners.com/client-management","description":"Production"},{"url":"https://api.dev.raipartners.com/client-management","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The rotated secret.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RotatedSecret"}},"schemaId":"components/schemas/RotatedSecret"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/400/content/application~1json/examples/Generic invalid data","paths/~1auth~1client-secret~1rotation/post/responses/400/content/application~1json/examples/Generic missing data"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/400/content/application~1json/examples/Generic invalid data","paths/~1auth~1client-secret~1rotation/post/responses/400/content/application~1json/examples/Generic missing data"]},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/403/content/application~1json/examples/Forbidden"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/403/content/application~1json/examples/Forbidden"]},{"code":"404","description":"not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/404/content/application~1json/examples/Not found"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/500/content/application~1json/examples/Internal server error"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/500/content/application~1json/examples/Internal server error"]},{"code":"503","description":"Service unavailable.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/503/content/application~1json/examples/Service unavailable"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/503/content/application~1json/examples/Service unavailable"]}],"pointer":"/paths/~1auth~1client-secret~1rotation/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RotatedSecret","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RotatedSecret"}}},{"code":"400","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/400/content/application~1json/examples/Generic invalid data","paths/~1auth~1client-secret~1rotation/post/responses/400/content/application~1json/examples/Generic missing data"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/400/content/application~1json/examples/Generic invalid data","paths/~1auth~1client-secret~1rotation/post/responses/400/content/application~1json/examples/Generic missing data"]}}},{"code":"401","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/403/content/application~1json/examples/Forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/403/content/application~1json/examples/Forbidden"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/404/content/application~1json/examples/Not found"]}}},{"code":"500","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/500/content/application~1json/examples/Internal server error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/500/content/application~1json/examples/Internal server error"]}}},{"code":"503","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/503/content/application~1json/examples/Service unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/503/content/application~1json/examples/Service unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/rotateclientsecret"}],"panels":[]}]},"httpPath":"/auth/client-secret/rotation"},{"label":"Authenticate client","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/client-management-api-v1/authentication/authenticateclient","routeSlug":"/apis/client-management-api-v1/authentication/authenticateclient","metadata":{"seo":{"title":"Authenticate client","description":"Authenticate a client and retrieve the JWT token"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authenticateClient","name":"Authenticate client","isWebhook":false,"pointer":"/paths/~1auth~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authenticate client","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Authenticate a client and retrieve the JWT token"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"API-Version","in":"header","schemaId":"schema_1"}],"pointer":"/paths/~1auth~1token/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClientTokenRequest"}},"schemaId":"components/schemas/ClientTokenRequest","pointer":"/paths/~1auth~1token/post/requestBody","description":"The client credentials."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/auth/token","servers":[{"url":"/_mock/apis/client-management-api-v1","description":"Mock server","isMockServer":true},{"url":"https://api.raipartners.com/client-management","description":"Production"},{"url":"https://api.dev.raipartners.com/client-management","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"API-Version","in":"header","schemaId":"schema_1"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ClientTokenRequest"}},"responseCodes":["200","400","404","500","503"],"pointer":"/auth/token","href":"authentication/authenticateclient","openApiOperationId":"authenticateClient","summary":"Authenticate client"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/client-management-api-v1","description":"Mock server","isMockServer":true},{"url":"https://api.raipartners.com/client-management","description":"Production"},{"url":"https://api.dev.raipartners.com/client-management","description":"Sandbox"}],"schemaId":"components/schemas/ClientTokenRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClientTokenRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The JWT token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JWTClientTokenResponse"}},"schemaId":"components/schemas/JWTClientTokenResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/400/content/application~1json/examples/Generic invalid data","paths/~1auth~1token/post/responses/400/content/application~1json/examples/Generic missing data"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/400/content/application~1json/examples/Generic invalid data","paths/~1auth~1token/post/responses/400/content/application~1json/examples/Generic missing data"]},{"code":"404","description":"not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/404/content/application~1json/examples/Not found"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/500/content/application~1json/examples/Internal server error"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/500/content/application~1json/examples/Internal server error"]},{"code":"503","description":"Service unavailable.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/503/content/application~1json/examples/Service unavailable"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/503/content/application~1json/examples/Service unavailable"]}],"pointer":"/paths/~1auth~1token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/JWTClientTokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JWTClientTokenResponse"}}},{"code":"400","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/400/content/application~1json/examples/Generic invalid data","paths/~1auth~1token/post/responses/400/content/application~1json/examples/Generic missing data"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/400/content/application~1json/examples/Generic invalid data","paths/~1auth~1token/post/responses/400/content/application~1json/examples/Generic missing data"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/404/content/application~1json/examples/Not found"]}}},{"code":"500","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/500/content/application~1json/examples/Internal server error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/500/content/application~1json/examples/Internal server error"]}}},{"code":"503","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/503/content/application~1json/examples/Service unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/503/content/application~1json/examples/Service unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/authenticateclient"}],"panels":[]}]},"httpPath":"/auth/token"}],"content":{"contentType":"group","meta":{"name":"Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication","showPageActions":true},{"nodeType":"markdoc","content":"Authentication functions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/auth/client-secret/rotation","summary":"Rotate the client secret","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/rotateclientsecret","deprecated":false},{"title":"/auth/token","summary":"Authenticate client","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/authenticateclient","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AccountIdentification":{"id":"components/schemas/AccountIdentification","kind":"json-schema","title":"AccountIdentification","data":{"type":"object","properties":{"id":{"type":"string","description":"The 64 characters account identifier.","example":"f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2","pattern":"[0-9a-f]{64}"},"number":{"type":"string","description":"The 16 digit account number.","example":"1234567890123456","pattern":"\\d{16}"}},"required":["id","number"]}},"components/schemas/AccountInformation":{"id":"components/schemas/AccountInformation","kind":"json-schema","title":"AccountInformation","data":{"type":"object","properties":{"accountIdentification":{"$ref":"#/components/schemas/AccountIdentification","description":"The account identification."},"status":{"type":"string","description":"The account status.","enum":["AuthorizationProhibited","Bankrupt","ChargeOff","Closed","Frozen","InterestAccrualProhibited","Lost","Normal","Revoked","Stolen"],"example":"Normal"},"internalStatus":{"type":"string","description":"The account internal status.","enum":["CreditBalance","Delinquent","DelinquentAndOverLimit","Normal","OverLimit"],"example":"Delinquent"},"currentBalance":{"type":"number","description":"The account current balance.","example":1000},"creditLimit":{"type":"number","description":"The account credit limit.","example":10000},"annualRates":{"$ref":"#/components/schemas/Rates","description":"The account annual rates."},"openingDate":{"type":"string","format":"date","description":"The account opening date.","example":"2022-01-31"},"paymentDueDate":{"type":["string","null"],"format":"date","description":"The account payment due date.","example":"2022-02-01"},"nextCycleDate":{"type":"string","format":"date","description":"The account next cycle date.","example":"2022-03-01"},"cycleToDatePaymentPosted":{"type":"number","description":"The account cycle to date payment amount posted.","example":1000},"lastStatementPaymentAmount":{"type":"number","description":"The account last statement payment amount.","example":1000},"primaryCardholder":{"$ref":"#/components/schemas/Individual","description":"The account primary cardholder."},"secondaryCardholder":{"oneOf":[{"$ref":"#/components/schemas/Individual"},{"type":"null"}]}},"required":["accountIdentification","annualRates","creditLimit","currentBalance","cycleToDatePaymentPosted","internalStatus","lastStatementPaymentAmount","nextCycleDate","openingDate","primaryCardholder","status"]}},"components/schemas/Individual":{"id":"components/schemas/Individual","kind":"json-schema","title":"Individual","data":{"type":"object","properties":{"ssnId":{"type":"string","description":"The individual social security number identifier.","example":"b2ce1ee6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2","pattern":"[0-9a-f]{64}"},"ssn":{"type":"string","description":"The 9 digit social security number.","example":"123456789","pattern":"\\d{9}"},"name":{"type":"string","description":"The individual name.","example":"Doe, John","maxLength":50,"minLength":5},"dob":{"type":"string","format":"date","description":"The individual date of birth.","example":"1970-01-01"}},"required":["dob","name","ssn","ssnId"]}},"components/schemas/Rates":{"id":"components/schemas/Rates","kind":"json-schema","title":"Rates","data":{"type":"object","properties":{"cash":{"type":"number","description":"The cash rate in percent.","example":19.99},"merchandise":{"type":"number","description":"The merchandise rate in percent.","example":12.99}},"required":["cash","merchandise"]}},"components/schemas/ProblemDetail":{"id":"components/schemas/ProblemDetail","kind":"json-schema","title":"ProblemDetail","data":{"type":"object","properties":{"type":{"type":["string","null"],"format":"uri","description":"The URI of the problem type","example":"urn:raipartners:api"},"title":{"type":["string","null"],"description":"The title of the problem","example":"Bad Request"},"status":{"type":"integer","format":"int32","description":"The status code of the problem","example":400},"detail":{"type":["string","null"],"description":"The details of the problem","example":"One or more required fields are missing."},"instance":{"type":["string","null"],"format":"uri-reference","description":"The instance of the problem","example":"/account/12345/errors/abc-987"},"properties":{"type":["object","null"],"additionalProperties":{},"description":"extra properties to enhance information about the problem"}},"required":["status"]}},"components/schemas/RotatedSecret":{"id":"components/schemas/RotatedSecret","kind":"json-schema","title":"RotatedSecret","data":{"type":"object","description":"Client rotated secret","properties":{"secret":{"type":"string","description":"The new client secret.","example":"PX4eWb9rcRT1RBqvLw4GtuqyoUFWoGLr"}},"required":["secret"]}},"components/schemas/ClientTokenRequest":{"id":"components/schemas/ClientTokenRequest","kind":"json-schema","title":"ClientTokenRequest","data":{"type":"object","description":"A client token request payload","properties":{"client_id":{"type":"string","description":"The client ID to use for authentication","example":"my-client-id"},"client_secret":{"type":"string","description":"The client secret to use for authentication","example":"my-super-auth-secret"}},"required":["client_id","client_secret"]}},"components/schemas/JWTClientTokenResponse":{"id":"components/schemas/JWTClientTokenResponse","kind":"json-schema","title":"JWTClientTokenResponse","data":{"type":"object","properties":{"scope":{"type":"string","description":"The token scope as a space delimited set of values.","example":"read:user write:user"},"access_token":{"type":"string","description":"The JWT token.","example":"eyo....."},"expires_in":{"type":"integer","format":"int32","description":"The token expiry in seconds.","example":300},"token_type":{"type":"string","description":"The token type.","example":"Bearer"},"not-before-policy":{"type":"integer","format":"int32","description":"The not before policy in seconds.","example":0},"refresh_expires_in":{"type":"integer","format":"int32","description":"The refresh token expiry in seconds.","example":300}},"required":["access_token","expires_in","scope","token_type"]}},"components/schemas/CurrencyInfo":{"id":"components/schemas/CurrencyInfo","kind":"json-schema","title":"CurrencyInfo","data":{"type":"object","properties":{"code":{"type":"string","description":"ISO-3 Currency code","example":"EUR","pattern":"[A-Z]{3}"},"name":{"type":"string","description":"Currency name","example":"Euro","maxLength":50}},"required":["code","name"]}},"components/schemas/ExchangeInfo":{"id":"components/schemas/ExchangeInfo","kind":"json-schema","title":"ExchangeInfo","data":{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/CurrencyInfo","description":"Currency of the exchange"},"amount":{"type":"number","description":"Amount in foreign currency","example":24.2},"exchangeRate":{"type":["number","null"],"description":"Exchange rate from USD to foreign currency","example":1.171487603}},"required":["amount","currency"]}},"components/schemas/Merchant":{"id":"components/schemas/Merchant","kind":"json-schema","title":"Merchant","data":{"type":"object","properties":{"name":{"type":["string","null"],"description":"The optional merchant name.","example":"MUSEO OPERA SANTA CROCE","maxLength":50},"category":{"type":["string","null"],"description":"The optional merchant category code (4 digit SIC).","example":"7997","pattern":"\\d{4}"},"description":{"type":["string","null"],"description":"The optional merchant description.","example":"MUSEO OPERA SANTA CROCE  FIRENZE      IT","maxLength":50},"location":{"oneOf":[{"$ref":"#/components/schemas/MerchantLocation"},{"type":"null"}]}}}},"components/schemas/MerchantLocation":{"id":"components/schemas/MerchantLocation","kind":"json-schema","title":"MerchantLocation","data":{"type":"object","properties":{"city":{"type":["string","null"],"description":"The optional merchant city.","example":"FIRENZE","maxLength":50},"state":{"type":["string","null"],"description":"The optional merchant state.","example":"IT","maxLength":2},"country":{"type":["string","null"],"description":"The optional merchant country in ISO 3166-1 alpha-3 format.","example":"ITA","maxLength":3}}}},"components/schemas/Transaction":{"id":"components/schemas/Transaction","kind":"json-schema","title":"Transaction","data":{"type":"object","properties":{"referenceNumber":{"type":"string","description":"The transaction reference number.","example":"7434495GE9WRQ9QVE"},"type":{"type":"string","description":"The transaction type.","enum":["Authorization","AuthorizationAdjustment","Sale","CashAdvance","Return","MerchandiseSaleReversal","CashAdvanceReversal","ReturnReversal","MerchandiseSaleAmountAdjustment","CashAdvanceAmountAdjustment","ReturnAmountAdjustment","Payment","PaymentReversal","PaymentAmountAdjustment","Adjustment","CashAdvanceItemChargeRefund","LatefeeRefund","MerchandiseFinanceChargeRefund","CashAdvanceFinanceChargeRefund","BackdatedPaymentAdjustment","MerchandiseItemChargeRefund","OverLimitChargeRefund","CreditInsuranceFeeRefund","BackdateCashAdvanceandSalesAdjustment","SmallBalanceChargeOff","ChargeOffTotalAccount","ChargeOffCashAdvanceInterest","ChargeOffBilledLateCharges","ChargeOffMerchandiseInterestandServiceCharge","ChargeOffCreditInsurance","ChargeOffAllFinanceCharges","ChargeOffAllCurrentCashAdvanceInterest","ChargeOffAllCurrentMerchandiseInterest","ChargeOffCycleToDateLateCharges","ChargeOffBilledCashAdvanceItemCharges","ChargeOffBilledMerchandiseItemCharges","ChargeOffBilledOverLimitFee","ChargeOffCycleToDateCashAdvanceItemCharges","ChargeOffCycleToDateMerchandiseItemCharges","ChargeOffCycleToDateOverLimitFees","AccountTransfer","NotSpecified"],"example":"Sale"},"sys":{"type":"string","description":"The 4 digit sys of the account.","example":"6161","pattern":"\\d{4}"},"prin":{"type":"string","description":"The 4 digit prin of the account.","example":"0000","pattern":"\\d{4}"},"agent":{"type":"string","description":"The 4 digit agent of the account.","example":"1000","pattern":"\\d{4}"},"account":{"$ref":"#/components/schemas/AccountIdentification","description":"The parent account associated with this transaction."},"cardAccount":{"oneOf":[{"$ref":"#/components/schemas/AccountIdentification"},{"type":"null"}]},"amount":{"type":"number","description":"The transaction amount in US Dollars.","example":28.35},"date":{"type":"string","format":"date","description":"The transaction date.","example":"2023-01-01"},"postedDate":{"type":"string","format":"date","description":"The date the transaction was posted.","example":"2023-01-02"},"cycleDate":{"type":"string","format":"date","description":"The cycle date assoicated with the transaction.","example":"2023-01-02"},"merchant":{"oneOf":[{"$ref":"#/components/schemas/Merchant"},{"type":"null"}]},"exchangeInfo":{"oneOf":[{"$ref":"#/components/schemas/ExchangeInfo"},{"type":"null"}]}},"required":["account","agent","amount","cycleDate","date","postedDate","prin","referenceNumber","sys","type"]}},"schema_1":{"kind":"json-schema","data":{"type":"string","enum":["1.0.0"]},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"string","format":"date"},"id":"schema_2"}},"exampleStore":{"paths/~1accounts/get/responses/400/content/application~1x-ndjson/examples/Generic invalid data":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:validation:invalid-data","title":"Bad Request","status":400,"detail":"One or more fields are invalid."},"key":"Generic invalid data","summary":"Generic invalid data","description":"Generic invalid data","id":"paths/~1accounts/get/responses/400/content/application~1x-ndjson/examples/Generic invalid data"},"paths/~1accounts/get/responses/400/content/application~1x-ndjson/examples/Generic missing data":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:validation:missing-data","title":"Bad Request","status":400,"detail":"One or more required fields are missing."},"key":"Generic missing data","summary":"Generic missing data","description":"Generic missing data","id":"paths/~1accounts/get/responses/400/content/application~1x-ndjson/examples/Generic missing data"},"paths/~1accounts/get/responses/401/content/application~1x-ndjson/examples/Unauthorized":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:authorization:unauthorized","title":"Unauthorized","status":401,"detail":"You are not authorized to perform this action."},"key":"Unauthorized","summary":"Unauthorized","description":"Unauthorized","id":"paths/~1accounts/get/responses/401/content/application~1x-ndjson/examples/Unauthorized"},"paths/~1accounts/get/responses/403/content/application~1x-ndjson/examples/Forbidden":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:authorization:forbidden","title":"Forbidden","status":403,"detail":"You are forbidden to perform this action."},"key":"Forbidden","summary":"Forbidden","description":"Forbidden","id":"paths/~1accounts/get/responses/403/content/application~1x-ndjson/examples/Forbidden"},"paths/~1accounts/get/responses/404/content/application~1x-ndjson/examples/Not found":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:not-found","title":"Not Found","status":404,"detail":"Resource not found."},"key":"Not found","summary":"Not found","description":"Not found","id":"paths/~1accounts/get/responses/404/content/application~1x-ndjson/examples/Not found"},"paths/~1accounts/get/responses/500/content/application~1x-ndjson/examples/Internal server error":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:internal","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred."},"key":"Internal server error","summary":"Internal server error","description":"Internal server error","id":"paths/~1accounts/get/responses/500/content/application~1x-ndjson/examples/Internal server error"},"paths/~1accounts/get/responses/503/content/application~1x-ndjson/examples/Service unavailable":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:internal","title":"Service unavailable Error","status":503,"detail":"Service is unavailable."},"key":"Service unavailable","summary":"Service unavailable","description":"Service unavailable","id":"paths/~1accounts/get/responses/503/content/application~1x-ndjson/examples/Service unavailable"},"paths/~1transactions~1{date}/get/responses/400/content/application~1x-ndjson/examples/Generic invalid data":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:validation:invalid-data","title":"Bad Request","status":400,"detail":"One or more fields are invalid."},"key":"Generic invalid data","summary":"Generic invalid data","description":"Generic invalid data","id":"paths/~1transactions~1{date}/get/responses/400/content/application~1x-ndjson/examples/Generic invalid data"},"paths/~1transactions~1{date}/get/responses/400/content/application~1x-ndjson/examples/Generic missing data":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:validation:missing-data","title":"Bad Request","status":400,"detail":"One or more required fields are missing."},"key":"Generic missing data","summary":"Generic missing data","description":"Generic missing data","id":"paths/~1transactions~1{date}/get/responses/400/content/application~1x-ndjson/examples/Generic missing data"},"paths/~1transactions~1{date}/get/responses/401/content/application~1x-ndjson/examples/Unauthorized":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:authorization:unauthorized","title":"Unauthorized","status":401,"detail":"You are not authorized to perform this action."},"key":"Unauthorized","summary":"Unauthorized","description":"Unauthorized","id":"paths/~1transactions~1{date}/get/responses/401/content/application~1x-ndjson/examples/Unauthorized"},"paths/~1transactions~1{date}/get/responses/403/content/application~1x-ndjson/examples/Forbidden":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:authorization:forbidden","title":"Forbidden","status":403,"detail":"You are forbidden to perform this action."},"key":"Forbidden","summary":"Forbidden","description":"Forbidden","id":"paths/~1transactions~1{date}/get/responses/403/content/application~1x-ndjson/examples/Forbidden"},"paths/~1transactions~1{date}/get/responses/404/content/application~1x-ndjson/examples/Not found":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:not-found","title":"Not Found","status":404,"detail":"Resource not found."},"key":"Not found","summary":"Not found","description":"Not found","id":"paths/~1transactions~1{date}/get/responses/404/content/application~1x-ndjson/examples/Not found"},"paths/~1transactions~1{date}/get/responses/500/content/application~1x-ndjson/examples/Internal server error":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:internal","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred."},"key":"Internal server error","summary":"Internal server error","description":"Internal server error","id":"paths/~1transactions~1{date}/get/responses/500/content/application~1x-ndjson/examples/Internal server error"},"paths/~1transactions~1{date}/get/responses/503/content/application~1x-ndjson/examples/Service unavailable":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:internal","title":"Service unavailable Error","status":503,"detail":"Service is unavailable."},"key":"Service unavailable","summary":"Service unavailable","description":"Service unavailable","id":"paths/~1transactions~1{date}/get/responses/503/content/application~1x-ndjson/examples/Service unavailable"},"paths/~1auth~1client-secret~1rotation/post/responses/400/content/application~1json/examples/Generic invalid data":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:validation:invalid-data","title":"Bad Request","status":400,"detail":"One or more fields are invalid."},"key":"Generic invalid data","summary":"Generic invalid data","description":"Generic invalid data","id":"paths/~1auth~1client-secret~1rotation/post/responses/400/content/application~1json/examples/Generic invalid data"},"paths/~1auth~1client-secret~1rotation/post/responses/400/content/application~1json/examples/Generic missing data":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:validation:missing-data","title":"Bad Request","status":400,"detail":"One or more required fields are missing."},"key":"Generic missing data","summary":"Generic missing data","description":"Generic missing data","id":"paths/~1auth~1client-secret~1rotation/post/responses/400/content/application~1json/examples/Generic missing data"},"paths/~1auth~1client-secret~1rotation/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:authorization:unauthorized","title":"Unauthorized","status":401,"detail":"You are not authorized to perform this action."},"key":"Unauthorized","summary":"Unauthorized","description":"Unauthorized","id":"paths/~1auth~1client-secret~1rotation/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1auth~1client-secret~1rotation/post/responses/403/content/application~1json/examples/Forbidden":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:authorization:forbidden","title":"Forbidden","status":403,"detail":"You are forbidden to perform this action."},"key":"Forbidden","summary":"Forbidden","description":"Forbidden","id":"paths/~1auth~1client-secret~1rotation/post/responses/403/content/application~1json/examples/Forbidden"},"paths/~1auth~1client-secret~1rotation/post/responses/404/content/application~1json/examples/Not found":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:not-found","title":"Not Found","status":404,"detail":"Resource not found."},"key":"Not found","summary":"Not found","description":"Not found","id":"paths/~1auth~1client-secret~1rotation/post/responses/404/content/application~1json/examples/Not found"},"paths/~1auth~1client-secret~1rotation/post/responses/500/content/application~1json/examples/Internal server error":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:internal","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred."},"key":"Internal server error","summary":"Internal server error","description":"Internal server error","id":"paths/~1auth~1client-secret~1rotation/post/responses/500/content/application~1json/examples/Internal server error"},"paths/~1auth~1client-secret~1rotation/post/responses/503/content/application~1json/examples/Service unavailable":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:internal","title":"Service unavailable Error","status":503,"detail":"Service is unavailable."},"key":"Service unavailable","summary":"Service unavailable","description":"Service unavailable","id":"paths/~1auth~1client-secret~1rotation/post/responses/503/content/application~1json/examples/Service unavailable"},"paths/~1auth~1token/post/responses/400/content/application~1json/examples/Generic invalid data":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:validation:invalid-data","title":"Bad Request","status":400,"detail":"One or more fields are invalid."},"key":"Generic invalid data","summary":"Generic invalid data","description":"Generic invalid data","id":"paths/~1auth~1token/post/responses/400/content/application~1json/examples/Generic invalid data"},"paths/~1auth~1token/post/responses/400/content/application~1json/examples/Generic missing data":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:validation:missing-data","title":"Bad Request","status":400,"detail":"One or more required fields are missing."},"key":"Generic missing data","summary":"Generic missing data","description":"Generic missing data","id":"paths/~1auth~1token/post/responses/400/content/application~1json/examples/Generic missing data"},"paths/~1auth~1token/post/responses/404/content/application~1json/examples/Not found":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:not-found","title":"Not Found","status":404,"detail":"Resource not found."},"key":"Not found","summary":"Not found","description":"Not found","id":"paths/~1auth~1token/post/responses/404/content/application~1json/examples/Not found"},"paths/~1auth~1token/post/responses/500/content/application~1json/examples/Internal server error":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:internal","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred."},"key":"Internal server error","summary":"Internal server error","description":"Internal server error","id":"paths/~1auth~1token/post/responses/500/content/application~1json/examples/Internal server error"},"paths/~1auth~1token/post/responses/503/content/application~1json/examples/Service unavailable":{"value":{"type":"urn:raipartners:api:clientmanagement:errors:internal","title":"Service unavailable Error","status":503,"detail":"Service is unavailable."},"key":"Service unavailable","summary":"Service unavailable","description":"Service unavailable","id":"paths/~1auth~1token/post/responses/503/content/application~1json/examples/Service unavailable"}},"securitySchemeStore":{"bearer-jwt":{"id":"bearer-jwt","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"servers":[{"url":"/_mock/apis/client-management-api-v1","isMockServer":true,"description":"Mock server"},{"url":"https://api.raipartners.com/client-management","description":"Production"},{"url":"https://api.dev.raipartners.com/client-management","description":"Sandbox"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/apis/client-management-api-v1","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/client-management-api-v1.json?download"},{"url":"/_bundle/apis/client-management-api-v1.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Client Management API","description":"RAI Partners Client Management API"}},"baseSlug":"/apis/client-management-api-v1","routesMapping":{}}