{"items":[{"type":"link","label":"Ripple Collections","link":"/pt-br/products/collections/api/collections","routeSlug":"/pt-br/products/collections/api/collections","content":{"contentType":"overview","meta":{"name":"Ripple Collections"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"collections.json","url":"/_bundle/@l10n/pt-BR/products/collections/@v1/api/collections.json?download"},{"kind":"download","label":"collections.yaml","url":"/_bundle/@l10n/pt-BR/products/collections/@v1/api/collections.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"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/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Ripple Collections (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Ripple Collection APIs are used to manage accounts, payment channels, partners, transactions, transfers and settlements."},"children":[]}]}]}]}],"sectionId":"/"}],"sectionId":"/"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/api-environments"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Environments"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Ripple Collection APIs offers the following environments:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"div","attrs":{"style":{"width":"90px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base URL"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://docs.ripple.com/products/collections/_mock/api/collections"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox environment with mock data which does not require auth."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UAT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.test.ripple.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UAT environment with simulated transactions."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.ripple.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production environment"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For guides on API authentication, idempotency, and webhook verification, see the sidebar."},"children":[]}]}]}]}],"sectionId":"/section/api-environments"}]}]}},{"type":"link","label":"API Environments","link":"/pt-br/products/collections/api/collections/section/api-environments","routeSlug":"/pt-br/products/collections/api/collections/section/api-environments","content":null},{"type":"group","label":"Authentication","link":"/pt-br/products/collections/api/collections/authentication","routeSlug":"/pt-br/products/collections/api/collections/authentication","items":[{"label":"Request an access token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/authentication/authenticate","routeSlug":"/pt-br/products/collections/api/collections/authentication/authenticate","metadata":{"seo":{"title":"Request an access token","description":"Request an access token for authentication with Ripple APIs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authenticate","name":"Request an access token","isWebhook":false,"pointer":"/paths/~1v2~1oauth~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request an access token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request an access token for authentication with Ripple APIs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to request a token for the environment you want to authenticate with."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The length of the access token isn't fixed, hence it can vary. Avoid validating tokens based on character length."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tutorials"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn how to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../tutorials/request-an-access-token/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request an access token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"authentication/authenticate/request/environments","deepLinkHash":"/authentication/authenticate#authentication/authenticate/request/environments"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environments"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environment"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UAT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api.test.ripple.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UAT environment with simulated transactions."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api.ripple.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production environment"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuthenticationRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/AuthenticationRequest"}},"schemaId":"components/schemas/AuthenticationRequest","pointer":"/paths/~1v2~1oauth~1token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/oauth/token","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/AuthenticationRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/AuthenticationRequest"}},"responseCodes":["200","400","401","403"],"pointer":"/v2/oauth/token","href":"authentication/authenticate","openApiOperationId":"authenticate","summary":"Request an access token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"schemaId":"components/schemas/AuthenticationRequest","mediaTypes":["application/json","application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuthenticationRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/AuthenticationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns the authentication response object that includes the token, type, scopes, and expiry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthenticationResponse"}},"schemaId":"components/schemas/AuthenticationResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthErrorResponse","exampleIds":["paths/~1v2~1oauth~1token/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/AuthErrorResponse","exampleIds":["paths/~1v2~1oauth~1token/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthErrorResponse","exampleIds":["paths/~1v2~1oauth~1token/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/AuthErrorResponse","exampleIds":["paths/~1v2~1oauth~1token/post/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthErrorResponse","exampleIds":["paths/~1v2~1oauth~1token/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/AuthErrorResponse","exampleIds":["paths/~1v2~1oauth~1token/post/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1v2~1oauth~1token/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuthenticationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthenticationResponse"}}},{"code":"400","schemaId":"components/schemas/AuthErrorResponse","exampleIds":["paths/~1v2~1oauth~1token/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthErrorResponse","exampleIds":["paths/~1v2~1oauth~1token/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/AuthErrorResponse","exampleIds":["paths/~1v2~1oauth~1token/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthErrorResponse","exampleIds":["paths/~1v2~1oauth~1token/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/AuthErrorResponse","exampleIds":["paths/~1v2~1oauth~1token/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthErrorResponse","exampleIds":["paths/~1v2~1oauth~1token/post/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/authenticate"}],"panels":[]}]},"httpPath":"/v2/oauth/token"},{"label":"Test access token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/authentication/testauthtoken","routeSlug":"/pt-br/products/collections/api/collections/authentication/testauthtoken","metadata":{"seo":{"title":"Test access token","description":"Test if an access token can be used for authentication with Ripple APIs and how much time remains on it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"testAuthToken","name":"Test access token","isWebhook":false,"pointer":"/paths/~1v2~1oauth~1token~1test/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test access token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Test if an access token can be used for authentication with Ripple APIs and how much time remains on it."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/oauth/token/test","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/v2/oauth/token/test","href":"authentication/testauthtoken","openApiOperationId":"testAuthToken","summary":"Test access token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"If a valid bearer token is supplied, the time remaining before the token expires is returned.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_0"}},"schemaId":"schema_0"},{"code":"400","description":"Bad Request","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_1","exampleIds":["paths/~1v2~1oauth~1token~1test/get/responses/400/content/text~1plain/example"]}},"schemaId":"schema_1","exampleIds":["paths/~1v2~1oauth~1token~1test/get/responses/400/content/text~1plain/example"]},{"code":"401","description":"Unauthorized"}],"pointer":"/paths/~1v2~1oauth~1token~1test/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_0","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_0"}}},{"code":"400","schemaId":"schema_1","exampleIds":["paths/~1v2~1oauth~1token~1test/get/responses/400/content/text~1plain/example"],"mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_1","exampleIds":["paths/~1v2~1oauth~1token~1test/get/responses/400/content/text~1plain/example"]}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/testauthtoken"}],"panels":[]}]},"httpPath":"/v2/oauth/token/test"}],"content":{"contentType":"group","meta":{"name":"Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for authentication"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/oauth/token","summary":"Request an access token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/authenticate","deprecated":false},{"title":"/v2/oauth/token/test","summary":"Test access token","prefix":{"name":"get","color":"get"},"badges":[],"link":"/authentication/testauthtoken","deprecated":false}]}]}]}]}},{"type":"group","label":"Accounts","link":"/pt-br/products/collections/api/collections/accounts","routeSlug":"/pt-br/products/collections/api/collections/accounts","items":[{"label":"List accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/accounts/listaccountsv1","routeSlug":"/pt-br/products/collections/api/collections/accounts/listaccountsv1","metadata":{"seo":{"title":"List accounts","description":"Retrieves a list of accounts, filterable by query parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAccountsV1","name":"List accounts","isWebhook":false,"pointer":"/paths/~1v1~1collections~1accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of accounts, filterable by query parameters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_2","description":"Filter accounts by specific account identifier"},{"name":"account_owner_id","in":"query","schemaId":"schema_2","description":"Filter accounts by account owner identifier"},{"name":"beneficiary_id","in":"query","schemaId":"schema_2","description":"Filter accounts by beneficiary partner identifier"},{"name":"ownership_level","in":"query","schemaId":"schema_3","description":"Filter accounts by ownership level"},{"name":"currency","in":"query","schemaId":"schema_1","description":"Filter accounts by currency"},{"name":"since","in":"query","schemaId":"schema_4","description":"ISO 8601 timestamp after account was created"},{"name":"until","in":"query","schemaId":"schema_4","description":"ISO 8601 timestamp before account was created"},{"name":"page","in":"query","schemaId":"schema_5","description":"Page number (zero-indexed, starts at 0)","example":0},{"name":"size","in":"query","schemaId":"schema_6","description":"Page size (items per page)","example":10},{"name":"sort_by","in":"query","schemaId":"schema_7","description":"Field to sort results by","example":"CREATED_AT"},{"name":"direction","in":"query","schemaId":"schema_8","description":"Sort direction","example":"desc"}],"pointer":"/paths/~1v1~1collections~1accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/collections/accounts","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[],"query":[{"name":"id","in":"query","schemaId":"schema_2"},{"name":"account_owner_id","in":"query","schemaId":"schema_2"},{"name":"beneficiary_id","in":"query","schemaId":"schema_2"},{"name":"ownership_level","in":"query","schemaId":"schema_3"},{"name":"currency","in":"query","schemaId":"schema_1"},{"name":"since","in":"query","schemaId":"schema_4"},{"name":"until","in":"query","schemaId":"schema_4"},{"name":"page","in":"query","example":0,"schemaId":"schema_5"},{"name":"size","in":"query","example":10,"schemaId":"schema_6"},{"name":"sort_by","in":"query","example":"CREATED_AT","schemaId":"schema_7"},{"name":"direction","in":"query","example":"desc","schemaId":"schema_8"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v1/collections/accounts","href":"accounts/listaccountsv1","openApiOperationId":"listAccountsV1","summary":"List accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of accounts.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_9","exampleIds":["paths/~1v1~1collections~1accounts/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"schema_9","exampleIds":["paths/~1v1~1collections~1accounts/get/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Bad Request - Invalid input parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized - Invalid or missing authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1collections~1accounts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_9","exampleIds":["paths/~1v1~1collections~1accounts/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_9","exampleIds":["paths/~1v1~1collections~1accounts/get/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/listaccountsv1"}],"panels":[]}]},"httpPath":"/v1/collections/accounts"},{"label":"Create an account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/accounts/createaccountv1","routeSlug":"/pt-br/products/collections/api/collections/accounts/createaccountv1","metadata":{"seo":{"title":"Create an account","description":"Creates a new payment account for a beneficiary partner. The account type (CRYPTO or FIAT) is determined by the currency specified. Account creation is subject to the beneficiary's partner eligibility."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAccountV1","name":"Create an account","isWebhook":false,"pointer":"/paths/~1v1~1collections~1accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new payment account for a beneficiary partner. The account type (CRYPTO or FIAT)\nis determined by the currency specified. Account creation is subject to the beneficiary's\npartner eligibility.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAccountRequest","exampleIds":["paths/~1v1~1collections~1accounts/post/requestBody/content/application~1json/examples/crypto_account","paths/~1v1~1collections~1accounts/post/requestBody/content/application~1json/examples/usd_fiat_account","paths/~1v1~1collections~1accounts/post/requestBody/content/application~1json/examples/brl_fiat_account"]}},"schemaId":"components/schemas/CreateAccountRequest","exampleIds":["paths/~1v1~1collections~1accounts/post/requestBody/content/application~1json/examples/crypto_account","paths/~1v1~1collections~1accounts/post/requestBody/content/application~1json/examples/usd_fiat_account","paths/~1v1~1collections~1accounts/post/requestBody/content/application~1json/examples/brl_fiat_account"],"pointer":"/paths/~1v1~1collections~1accounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/collections/accounts","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateAccountRequest","exampleIds":["paths/~1v1~1collections~1accounts/post/requestBody/content/application~1json/examples/crypto_account","paths/~1v1~1collections~1accounts/post/requestBody/content/application~1json/examples/usd_fiat_account","paths/~1v1~1collections~1accounts/post/requestBody/content/application~1json/examples/brl_fiat_account"]}},"responseCodes":["201","400","401","403","500"],"pointer":"/v1/collections/accounts","href":"accounts/createaccountv1","openApiOperationId":"createAccountV1","summary":"Create an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"schemaId":"components/schemas/CreateAccountRequest","exampleIds":["paths/~1v1~1collections~1accounts/post/requestBody/content/application~1json/examples/crypto_account","paths/~1v1~1collections~1accounts/post/requestBody/content/application~1json/examples/usd_fiat_account","paths/~1v1~1collections~1accounts/post/requestBody/content/application~1json/examples/brl_fiat_account"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAccountRequest","exampleIds":["paths/~1v1~1collections~1accounts/post/requestBody/content/application~1json/examples/crypto_account","paths/~1v1~1collections~1accounts/post/requestBody/content/application~1json/examples/usd_fiat_account","paths/~1v1~1collections~1accounts/post/requestBody/content/application~1json/examples/brl_fiat_account"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Account created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Account","exampleIds":["paths/~1v1~1collections~1accounts/post/responses/201/content/application~1json/examples/crypto_account","paths/~1v1~1collections~1accounts/post/responses/201/content/application~1json/examples/usd_fiat_account","paths/~1v1~1collections~1accounts/post/responses/201/content/application~1json/examples/brl_fiat_account"]}},"schemaId":"components/schemas/Account","exampleIds":["paths/~1v1~1collections~1accounts/post/responses/201/content/application~1json/examples/crypto_account","paths/~1v1~1collections~1accounts/post/responses/201/content/application~1json/examples/usd_fiat_account","paths/~1v1~1collections~1accounts/post/responses/201/content/application~1json/examples/brl_fiat_account"]},{"code":"400","description":"Bad Request - Invalid input parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized - Invalid or missing authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Forbidden - Partner access does not allow this account type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1collections~1accounts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Account","exampleIds":["paths/~1v1~1collections~1accounts/post/responses/201/content/application~1json/examples/crypto_account","paths/~1v1~1collections~1accounts/post/responses/201/content/application~1json/examples/usd_fiat_account","paths/~1v1~1collections~1accounts/post/responses/201/content/application~1json/examples/brl_fiat_account"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Account","exampleIds":["paths/~1v1~1collections~1accounts/post/responses/201/content/application~1json/examples/crypto_account","paths/~1v1~1collections~1accounts/post/responses/201/content/application~1json/examples/usd_fiat_account","paths/~1v1~1collections~1accounts/post/responses/201/content/application~1json/examples/brl_fiat_account"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/createaccountv1"}],"panels":[]}]},"httpPath":"/v1/collections/accounts"},{"label":"Get account by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/accounts/getaccountbyidv1","routeSlug":"/pt-br/products/collections/api/collections/accounts/getaccountbyidv1","metadata":{"seo":{"title":"Get account by ID","description":"Retrieves the details of a specific account by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountByIdV1","name":"Get account by ID","isWebhook":false,"pointer":"/paths/~1v1~1collections~1accounts~1{account_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get account by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the details of a specific account by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_10","description":"Unique identifier of the account to retrieve","required":true}],"pointer":"/paths/~1v1~1collections~1accounts~1{account_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/collections/accounts/{account_id}","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","schemaId":"schema_10"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/collections/accounts/{account_id}","href":"accounts/getaccountbyidv1","openApiOperationId":"getAccountByIdV1","summary":"Get account by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Account"}},"schemaId":"components/schemas/Account"},{"code":"400","description":"Bad Request - Invalid input parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized - Invalid or missing authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Account not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1collections~1accounts~1{account_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Account","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Account"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/getaccountbyidv1"}],"panels":[]}]},"httpPath":"/v1/collections/accounts/{account_id}"}],"content":{"contentType":"group","meta":{"name":"Accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accounts","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for managing payment accounts"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/collections/accounts","summary":"List accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/listaccountsv1","deprecated":false},{"title":"/v1/collections/accounts","summary":"Create an account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/accounts/createaccountv1","deprecated":false},{"title":"/v1/collections/accounts/{account_id}","summary":"Get account by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/getaccountbyidv1","deprecated":false}]}]}]}]}},{"type":"group","label":"Collection Channels","link":"/pt-br/products/collections/api/collections/collection-channels","routeSlug":"/pt-br/products/collections/api/collections/collection-channels","items":[{"label":"List channels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/collection-channels/listchannelsv1","routeSlug":"/pt-br/products/collections/api/collections/collection-channels/listchannelsv1","metadata":{"seo":{"title":"List channels","description":"Retrieves a list of channels using account-based routing, filterable by query parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listChannelsV1","name":"List channels","isWebhook":false,"pointer":"/paths/~1v1~1collections~1channels/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List channels","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of channels using account-based routing, filterable by query parameters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_2","description":"Filter channels by specific channel identifier"},{"name":"payer_id","in":"query","schemaId":"schema_2","description":"Filter channels by payer identifier"},{"name":"account_id","in":"query","schemaId":"schema_2","description":"Filter channels by account identifier"},{"name":"beneficiary_id","in":"query","schemaId":"schema_2","description":"Filter channels by beneficiary identifier"},{"name":"status","in":"query","schemaId":"schema_11","description":"Filter channels by status"},{"name":"since","in":"query","schemaId":"schema_4","description":"ISO 8601 timestamp after channel was created"},{"name":"until","in":"query","schemaId":"schema_4","description":"ISO 8601 timestamp before channel was created"},{"name":"page","in":"query","schemaId":"schema_5","description":"Page number (zero-indexed, starts at 0)","example":0},{"name":"size","in":"query","schemaId":"schema_6","description":"Page size (items per page)","example":10},{"name":"sort_by","in":"query","schemaId":"schema_12","description":"Field to sort results by","example":"CREATED_AT"},{"name":"direction","in":"query","schemaId":"schema_8","description":"Sort direction","example":"desc"}],"pointer":"/paths/~1v1~1collections~1channels/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/collections/channels","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[],"query":[{"name":"id","in":"query","schemaId":"schema_2"},{"name":"payer_id","in":"query","schemaId":"schema_2"},{"name":"account_id","in":"query","schemaId":"schema_2"},{"name":"beneficiary_id","in":"query","schemaId":"schema_2"},{"name":"status","in":"query","example":"ACTIVE","schemaId":"components/schemas/ChannelStatus"},{"name":"since","in":"query","schemaId":"schema_4"},{"name":"until","in":"query","schemaId":"schema_4"},{"name":"page","in":"query","example":0,"schemaId":"schema_5"},{"name":"size","in":"query","example":10,"schemaId":"schema_6"},{"name":"sort_by","in":"query","example":"CREATED_AT","schemaId":"schema_12"},{"name":"direction","in":"query","example":"desc","schemaId":"schema_8"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v1/collections/channels","href":"collection-channels/listchannelsv1","openApiOperationId":"listChannelsV1","summary":"List channels"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of channels.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13","exampleIds":["paths/~1v1~1collections~1channels/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"schema_13","exampleIds":["paths/~1v1~1collections~1channels/get/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Bad Request - Invalid input parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized - Invalid or missing authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1collections~1channels/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_13","exampleIds":["paths/~1v1~1collections~1channels/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13","exampleIds":["paths/~1v1~1collections~1channels/get/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collection-channels/listchannelsv1"}],"panels":[]}]},"httpPath":"/v1/collections/channels"},{"label":"Create a channel","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/collection-channels/createchannelv1","routeSlug":"/pt-br/products/collections/api/collections/collection-channels/createchannelv1","metadata":{"seo":{"title":"Create a channel","description":"Creates a new payment channel using account-based routing. The channel is associated with an account which determines the available payment rails (crypto networks or fiat rails) based on the account's currency."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createChannelV1","name":"Create a channel","isWebhook":false,"pointer":"/paths/~1v1~1collections~1channels/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a channel","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new payment channel using account-based routing. The channel is associated\nwith an account which determines the available payment rails (crypto networks or fiat\nrails) based on the account's currency.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateChannelRequestV1","exampleIds":["paths/~1v1~1collections~1channels/post/requestBody/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CreateChannelRequestV1","exampleIds":["paths/~1v1~1collections~1channels/post/requestBody/content/application~1json/examples/default"],"pointer":"/paths/~1v1~1collections~1channels/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/collections/channels","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateChannelRequestV1","exampleIds":["paths/~1v1~1collections~1channels/post/requestBody/content/application~1json/examples/default"]}},"responseCodes":["201","400","401","403","404","500"],"pointer":"/v1/collections/channels","href":"collection-channels/createchannelv1","openApiOperationId":"createChannelV1","summary":"Create a channel"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"schemaId":"components/schemas/CreateChannelRequestV1","exampleIds":["paths/~1v1~1collections~1channels/post/requestBody/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateChannelRequestV1","exampleIds":["paths/~1v1~1collections~1channels/post/requestBody/content/application~1json/examples/default"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Channel created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChannelV1","exampleIds":["paths/~1v1~1collections~1channels/post/responses/201/content/application~1json/examples/crypto_channel","paths/~1v1~1collections~1channels/post/responses/201/content/application~1json/examples/fiat_channel","paths/~1v1~1collections~1channels/post/responses/201/content/application~1json/examples/brl_fiat_channel"]}},"schemaId":"components/schemas/ChannelV1","exampleIds":["paths/~1v1~1collections~1channels/post/responses/201/content/application~1json/examples/crypto_channel","paths/~1v1~1collections~1channels/post/responses/201/content/application~1json/examples/fiat_channel","paths/~1v1~1collections~1channels/post/responses/201/content/application~1json/examples/brl_fiat_channel"]},{"code":"400","description":"Bad Request - Invalid input parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized - Invalid or missing authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Forbidden - Account type not allowed for this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not Found - Account or payer not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1collections~1channels/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/ChannelV1","exampleIds":["paths/~1v1~1collections~1channels/post/responses/201/content/application~1json/examples/crypto_channel","paths/~1v1~1collections~1channels/post/responses/201/content/application~1json/examples/fiat_channel","paths/~1v1~1collections~1channels/post/responses/201/content/application~1json/examples/brl_fiat_channel"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChannelV1","exampleIds":["paths/~1v1~1collections~1channels/post/responses/201/content/application~1json/examples/crypto_channel","paths/~1v1~1collections~1channels/post/responses/201/content/application~1json/examples/fiat_channel","paths/~1v1~1collections~1channels/post/responses/201/content/application~1json/examples/brl_fiat_channel"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collection-channels/createchannelv1"}],"panels":[]}]},"httpPath":"/v1/collections/channels"},{"label":"Get channel details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/collection-channels/getchannelbyidv1","routeSlug":"/pt-br/products/collections/api/collections/collection-channels/getchannelbyidv1","metadata":{"seo":{"title":"Get channel details","description":"Retrieves the details of a specific channel by its ID using account-based routing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getChannelByIdV1","name":"Get channel details","isWebhook":false,"pointer":"/paths/~1v1~1collections~1channels~1{channel_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get channel details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the details of a specific channel by its ID using account-based routing."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"channel_id","in":"path","schemaId":"schema_14","description":"Unique identifier of the channel to retrieve","required":true}],"pointer":"/paths/~1v1~1collections~1channels~1{channel_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/collections/channels/{channel_id}","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[{"name":"channel_id","in":"path","required":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","schemaId":"schema_14"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/collections/channels/{channel_id}","href":"collection-channels/getchannelbyidv1","openApiOperationId":"getChannelByIdV1","summary":"Get channel details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChannelV1","exampleIds":["paths/~1v1~1collections~1channels~1{channel_id}/get/responses/200/content/application~1json/examples/crypto_channel","paths/~1v1~1collections~1channels~1{channel_id}/get/responses/200/content/application~1json/examples/fiat_channel","paths/~1v1~1collections~1channels~1{channel_id}/get/responses/200/content/application~1json/examples/brl_fiat_channel"]}},"schemaId":"components/schemas/ChannelV1","exampleIds":["paths/~1v1~1collections~1channels~1{channel_id}/get/responses/200/content/application~1json/examples/crypto_channel","paths/~1v1~1collections~1channels~1{channel_id}/get/responses/200/content/application~1json/examples/fiat_channel","paths/~1v1~1collections~1channels~1{channel_id}/get/responses/200/content/application~1json/examples/brl_fiat_channel"]},{"code":"400","description":"Bad Request - Invalid input parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized - Invalid or missing authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not Found - Channel does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1collections~1channels~1{channel_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ChannelV1","exampleIds":["paths/~1v1~1collections~1channels~1{channel_id}/get/responses/200/content/application~1json/examples/crypto_channel","paths/~1v1~1collections~1channels~1{channel_id}/get/responses/200/content/application~1json/examples/fiat_channel","paths/~1v1~1collections~1channels~1{channel_id}/get/responses/200/content/application~1json/examples/brl_fiat_channel"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChannelV1","exampleIds":["paths/~1v1~1collections~1channels~1{channel_id}/get/responses/200/content/application~1json/examples/crypto_channel","paths/~1v1~1collections~1channels~1{channel_id}/get/responses/200/content/application~1json/examples/fiat_channel","paths/~1v1~1collections~1channels~1{channel_id}/get/responses/200/content/application~1json/examples/brl_fiat_channel"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collection-channels/getchannelbyidv1"}],"panels":[]}]},"httpPath":"/v1/collections/channels/{channel_id}"}],"content":{"contentType":"group","meta":{"name":"Collection Channels"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Collection Channels","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for managing persistent collection channels with account-based routing"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/collections/channels","summary":"List channels","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collection-channels/listchannelsv1","deprecated":false},{"title":"/v1/collections/channels","summary":"Create a channel","prefix":{"name":"post","color":"post"},"badges":[],"link":"/collection-channels/createchannelv1","deprecated":false},{"title":"/v1/collections/channels/{channel_id}","summary":"Get channel details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collection-channels/getchannelbyidv1","deprecated":false}]}]}]}]}},{"type":"group","label":"Partners","link":"/pt-br/products/collections/api/collections/partners","routeSlug":"/pt-br/products/collections/api/collections/partners","items":[{"label":"List partners","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/partners/listpartnersv1","routeSlug":"/pt-br/products/collections/api/collections/partners/listpartnersv1","metadata":{"seo":{"title":"List partners","description":"Retrieves a list of partners, filterable by ID or type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPartnersV1","name":"List partners","isWebhook":false,"pointer":"/paths/~1v1~1collections~1partners/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List partners","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of partners, filterable by ID or type."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_2","description":"Filter partners by specific partner ID"},{"name":"since","in":"query","schemaId":"schema_4","description":"ISO 8601 timestamp after partner was created"},{"name":"until","in":"query","schemaId":"schema_4","description":"ISO 8601 timestamp before partner was created"},{"name":"type","in":"query","schemaId":"schema_15","description":"Filter partners by type"},{"name":"status","in":"query","schemaId":"schema_16","description":"Filter partners by status"},{"name":"external_reference_id","in":"query","schemaId":"schema_17"},{"name":"page","in":"query","schemaId":"schema_5","description":"Page number (zero-indexed, starts at 0)","example":0},{"name":"size","in":"query","schemaId":"schema_6","description":"Page size (items per page)","example":10},{"name":"sort_by","in":"query","schemaId":"schema_18","description":"Field to sort results by","example":"CREATED_AT"},{"name":"direction","in":"query","schemaId":"schema_8","description":"Sort direction","example":"desc"}],"pointer":"/paths/~1v1~1collections~1partners/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/collections/partners","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[],"query":[{"name":"id","in":"query","schemaId":"schema_2"},{"name":"since","in":"query","schemaId":"schema_4"},{"name":"until","in":"query","schemaId":"schema_4"},{"name":"type","in":"query","example":"BUSINESS","schemaId":"components/schemas/PartnerType"},{"name":"status","in":"query","example":"PENDING","schemaId":"components/schemas/PartnerStatus"},{"name":"external_reference_id","in":"query","schemaId":"schema_17"},{"name":"page","in":"query","example":0,"schemaId":"schema_5"},{"name":"size","in":"query","example":10,"schemaId":"schema_6"},{"name":"sort_by","in":"query","example":"CREATED_AT","schemaId":"schema_18"},{"name":"direction","in":"query","example":"desc","schemaId":"schema_8"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v1/collections/partners","href":"partners/listpartnersv1","openApiOperationId":"listPartnersV1","summary":"List partners"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of partners.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19","exampleIds":["paths/~1v1~1collections~1partners/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"schema_19","exampleIds":["paths/~1v1~1collections~1partners/get/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Bad Request - Invalid input parameters or invalid field partner for business or individual partner","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized - Invalid or missing authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1collections~1partners/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_19","exampleIds":["paths/~1v1~1collections~1partners/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19","exampleIds":["paths/~1v1~1collections~1partners/get/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/partners/listpartnersv1"}],"panels":[]}]},"httpPath":"/v1/collections/partners"},{"label":"Create a partner","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/partners/createpartnerv1","routeSlug":"/pt-br/products/collections/api/collections/partners/createpartnerv1","metadata":{"seo":{"title":"Create a partner","description":"This API allows users to add new parties who can transact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPartnerV1","name":"Create a partner","isWebhook":false,"pointer":"/paths/~1v1~1collections~1partners/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a partner","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This API allows users to add new parties who can transact."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePartnerRequest","exampleIds":["paths/~1v1~1collections~1partners/post/requestBody/content/application~1json/examples/payer","paths/~1v1~1collections~1partners/post/requestBody/content/application~1json/examples/beneficiary"]}},"schemaId":"components/schemas/CreatePartnerRequest","exampleIds":["paths/~1v1~1collections~1partners/post/requestBody/content/application~1json/examples/payer","paths/~1v1~1collections~1partners/post/requestBody/content/application~1json/examples/beneficiary"],"pointer":"/paths/~1v1~1collections~1partners/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/collections/partners","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePartnerRequest","exampleIds":["paths/~1v1~1collections~1partners/post/requestBody/content/application~1json/examples/payer","paths/~1v1~1collections~1partners/post/requestBody/content/application~1json/examples/beneficiary"]}},"responseCodes":["201","400","401","500"],"pointer":"/v1/collections/partners","href":"partners/createpartnerv1","openApiOperationId":"createPartnerV1","summary":"Create a partner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"schemaId":"components/schemas/CreatePartnerRequest","exampleIds":["paths/~1v1~1collections~1partners/post/requestBody/content/application~1json/examples/payer","paths/~1v1~1collections~1partners/post/requestBody/content/application~1json/examples/beneficiary"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePartnerRequest","exampleIds":["paths/~1v1~1collections~1partners/post/requestBody/content/application~1json/examples/payer","paths/~1v1~1collections~1partners/post/requestBody/content/application~1json/examples/beneficiary"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Partner created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PartnerV1","exampleIds":["paths/~1v1~1collections~1partners/post/responses/201/content/application~1json/examples/payer","paths/~1v1~1collections~1partners/post/responses/201/content/application~1json/examples/beneficiary"]}},"schemaId":"components/schemas/PartnerV1","exampleIds":["paths/~1v1~1collections~1partners/post/responses/201/content/application~1json/examples/payer","paths/~1v1~1collections~1partners/post/responses/201/content/application~1json/examples/beneficiary"]},{"code":"400","description":"Bad Request - Invalid input parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized - Invalid or missing authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1collections~1partners/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/PartnerV1","exampleIds":["paths/~1v1~1collections~1partners/post/responses/201/content/application~1json/examples/payer","paths/~1v1~1collections~1partners/post/responses/201/content/application~1json/examples/beneficiary"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PartnerV1","exampleIds":["paths/~1v1~1collections~1partners/post/responses/201/content/application~1json/examples/payer","paths/~1v1~1collections~1partners/post/responses/201/content/application~1json/examples/beneficiary"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/partners/createpartnerv1"}],"panels":[]}]},"httpPath":"/v1/collections/partners"},{"label":"Get partner by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/partners/getpartnerbyidv1","routeSlug":"/pt-br/products/collections/api/collections/partners/getpartnerbyidv1","metadata":{"seo":{"title":"Get partner by ID","description":"This API allows users to retrieve a specific partner by their ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPartnerByIdV1","name":"Get partner by ID","isWebhook":false,"pointer":"/paths/~1v1~1collections~1partners~1{partner_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get partner by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This API allows users to retrieve a specific partner by their ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"partner_id","in":"path","schemaId":"schema_20","description":"Unique identifier of the partner to retrieve","required":true}],"pointer":"/paths/~1v1~1collections~1partners~1{partner_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"external_reference_id","in":"query","schemaId":"schema_17","example":"Ref-123"}],"pointer":"/paths/~1v1~1collections~1partners~1{partner_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/collections/partners/{partner_id}","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[{"name":"partner_id","in":"path","required":true,"example":"0c5479ff-3772-4123-b2b7-e679e71eb570","schemaId":"schema_20"}],"query":[{"name":"external_reference_id","in":"query","example":"Ref-123","schemaId":"schema_17"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/collections/partners/{partner_id}","href":"partners/getpartnerbyidv1","openApiOperationId":"getPartnerByIdV1","summary":"Get partner by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PartnerV1","exampleIds":["paths/~1v1~1collections~1partners~1{partner_id}/get/responses/200/content/application~1json/examples/payer","paths/~1v1~1collections~1partners~1{partner_id}/get/responses/200/content/application~1json/examples/beneficiary"]}},"schemaId":"components/schemas/PartnerV1","exampleIds":["paths/~1v1~1collections~1partners~1{partner_id}/get/responses/200/content/application~1json/examples/payer","paths/~1v1~1collections~1partners~1{partner_id}/get/responses/200/content/application~1json/examples/beneficiary"]},{"code":"400","description":"Bad Request - Invalid input parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized - Invalid or missing authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not Found - Partner does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1collections~1partners~1{partner_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PartnerV1","exampleIds":["paths/~1v1~1collections~1partners~1{partner_id}/get/responses/200/content/application~1json/examples/payer","paths/~1v1~1collections~1partners~1{partner_id}/get/responses/200/content/application~1json/examples/beneficiary"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PartnerV1","exampleIds":["paths/~1v1~1collections~1partners~1{partner_id}/get/responses/200/content/application~1json/examples/payer","paths/~1v1~1collections~1partners~1{partner_id}/get/responses/200/content/application~1json/examples/beneficiary"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/partners/getpartnerbyidv1"}],"panels":[]}]},"httpPath":"/v1/collections/partners/{partner_id}"},{"label":"Update a partner","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/partners/updatepartnerv1","routeSlug":"/pt-br/products/collections/api/collections/partners/updatepartnerv1","metadata":{"seo":{"title":"Update a partner","description":"API to update a partner to use in collections API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePartnerV1","name":"Update a partner","isWebhook":false,"pointer":"/paths/~1v1~1collections~1partners~1{partner_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a partner","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to update a partner to use in collections API."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"partner_id","in":"path","schemaId":"schema_20","description":"Unique identifier of the partner to update","required":true}],"pointer":"/paths/~1v1~1collections~1partners~1{partner_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePartnerRequest"}},"schemaId":"components/schemas/UpdatePartnerRequest","pointer":"/paths/~1v1~1collections~1partners~1{partner_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/collections/partners/{partner_id}","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[{"name":"partner_id","in":"path","required":true,"example":"0c5479ff-3772-4123-b2b7-e679e71eb570","schemaId":"schema_20"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdatePartnerRequest"}},"responseCodes":["200","400","401","404","500"],"pointer":"/v1/collections/partners/{partner_id}","href":"partners/updatepartnerv1","openApiOperationId":"updatePartnerV1","summary":"Update a partner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"schemaId":"components/schemas/UpdatePartnerRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePartnerRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Partner updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PartnerV1"}},"schemaId":"components/schemas/PartnerV1"},{"code":"400","description":"Bad Request - Invalid input parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized - Invalid or missing authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not Found - Partner does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1collections~1partners~1{partner_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PartnerV1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PartnerV1"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/partners/updatepartnerv1"}],"panels":[]}]},"httpPath":"/v1/collections/partners/{partner_id}"}],"content":{"contentType":"group","meta":{"name":"Partners"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partners","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for managing partners who can transact"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/collections/partners","summary":"List partners","prefix":{"name":"get","color":"get"},"badges":[],"link":"/partners/listpartnersv1","deprecated":false},{"title":"/v1/collections/partners","summary":"Create a partner","prefix":{"name":"post","color":"post"},"badges":[],"link":"/partners/createpartnerv1","deprecated":false},{"title":"/v1/collections/partners/{partner_id}","summary":"Get partner by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/partners/getpartnerbyidv1","deprecated":false},{"title":"/v1/collections/partners/{partner_id}","summary":"Update a partner","prefix":{"name":"put","color":"put"},"badges":[],"link":"/partners/updatepartnerv1","deprecated":false}]}]}]}]}},{"type":"group","label":"Settlements","link":"/pt-br/products/collections/api/collections/settlements","routeSlug":"/pt-br/products/collections/api/collections/settlements","items":[{"label":"List settlements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/settlements/listsettlementsv1","routeSlug":"/pt-br/products/collections/api/collections/settlements/listsettlementsv1","metadata":{"seo":{"title":"List settlements","description":"API to fetch first party payouts (settlements) with enhanced v1 response format."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSettlementsV1","name":"List settlements","isWebhook":false,"pointer":"/paths/~1v1~1collections~1settlements/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List settlements","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to fetch first party payouts (settlements) with enhanced v1 response format."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_2","description":"Filter settlements by specific settlement ID"},{"name":"type","in":"query","schemaId":"schema_21","description":"Settlement type"},{"name":"status","in":"query","schemaId":"schema_22","description":"Settlement status"},{"name":"since","in":"query","schemaId":"schema_4","description":"ISO 8601 timestamp after settlement was created"},{"name":"until","in":"query","schemaId":"schema_4","description":"ISO 8601 timestamp before settlement was created"},{"name":"page","in":"query","schemaId":"schema_5","description":"Page number (zero-indexed, starts at 0)","example":0},{"name":"size","in":"query","schemaId":"schema_23","description":"Number of settlements per page","example":10}],"pointer":"/paths/~1v1~1collections~1settlements/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/collections/settlements","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[],"query":[{"name":"id","in":"query","schemaId":"schema_2"},{"name":"type","in":"query","example":"FIAT","schemaId":"components/schemas/SettlementType"},{"name":"status","in":"query","example":"PENDING","schemaId":"components/schemas/SettlementStatus"},{"name":"since","in":"query","schemaId":"schema_4"},{"name":"until","in":"query","schemaId":"schema_4"},{"name":"page","in":"query","example":0,"schemaId":"schema_5"},{"name":"size","in":"query","example":10,"schemaId":"schema_23"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v1/collections/settlements","href":"settlements/listsettlementsv1","openApiOperationId":"listSettlementsV1","summary":"List settlements"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of settlements.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_24","exampleIds":["paths/~1v1~1collections~1settlements/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"schema_24","exampleIds":["paths/~1v1~1collections~1settlements/get/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Bad Request - Invalid input parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized - Invalid or missing authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1collections~1settlements/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_24","exampleIds":["paths/~1v1~1collections~1settlements/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_24","exampleIds":["paths/~1v1~1collections~1settlements/get/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlements/listsettlementsv1"}],"panels":[]}]},"httpPath":"/v1/collections/settlements"},{"label":"Create a settlement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/settlements/createsettlementv1","routeSlug":"/pt-br/products/collections/api/collections/settlements/createsettlementv1","metadata":{"seo":{"title":"Create a settlement","description":"API to initiate a first party payout (settlement to our customer)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSettlementV1","name":"Create a settlement","isWebhook":false,"pointer":"/paths/~1v1~1collections~1settlements/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a settlement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to initiate a first party payout (settlement to our customer)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSettlementRequestV1"}},"schemaId":"components/schemas/CreateSettlementRequestV1","pointer":"/paths/~1v1~1collections~1settlements/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/collections/settlements","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateSettlementRequestV1"}},"responseCodes":["201","400","401","500"],"pointer":"/v1/collections/settlements","href":"settlements/createsettlementv1","openApiOperationId":"createSettlementV1","summary":"Create a settlement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"schemaId":"components/schemas/CreateSettlementRequestV1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSettlementRequestV1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Settlement created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SettlementV1","exampleIds":["paths/~1v1~1collections~1settlements/post/responses/201/content/application~1json/examples/usd_fedwire_settlement","paths/~1v1~1collections~1settlements/post/responses/201/content/application~1json/examples/rlusd_settlement","paths/~1v1~1collections~1settlements/post/responses/201/content/application~1json/examples/brl_settlement"]}},"schemaId":"components/schemas/SettlementV1","exampleIds":["paths/~1v1~1collections~1settlements/post/responses/201/content/application~1json/examples/usd_fedwire_settlement","paths/~1v1~1collections~1settlements/post/responses/201/content/application~1json/examples/rlusd_settlement","paths/~1v1~1collections~1settlements/post/responses/201/content/application~1json/examples/brl_settlement"]},{"code":"400","description":"Bad Request - Invalid input parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized - Invalid or missing authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1collections~1settlements/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/SettlementV1","exampleIds":["paths/~1v1~1collections~1settlements/post/responses/201/content/application~1json/examples/usd_fedwire_settlement","paths/~1v1~1collections~1settlements/post/responses/201/content/application~1json/examples/rlusd_settlement","paths/~1v1~1collections~1settlements/post/responses/201/content/application~1json/examples/brl_settlement"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SettlementV1","exampleIds":["paths/~1v1~1collections~1settlements/post/responses/201/content/application~1json/examples/usd_fedwire_settlement","paths/~1v1~1collections~1settlements/post/responses/201/content/application~1json/examples/rlusd_settlement","paths/~1v1~1collections~1settlements/post/responses/201/content/application~1json/examples/brl_settlement"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlements/createsettlementv1"}],"panels":[]}]},"httpPath":"/v1/collections/settlements"},{"label":"Get settlement by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/settlements/getsettlementbyidv1","routeSlug":"/pt-br/products/collections/api/collections/settlements/getsettlementbyidv1","metadata":{"seo":{"title":"Get settlement by ID","description":"API to fetch a first party payout (settlement to our customer) with enhanced v1 response format."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSettlementByIdV1","name":"Get settlement by ID","isWebhook":false,"pointer":"/paths/~1v1~1collections~1settlements~1{settlement_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get settlement by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to fetch a first party payout (settlement to our customer) with enhanced v1 response format."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"settlement_id","in":"path","schemaId":"schema_25","description":"Unique identifier of the settlement to retrieve","required":true}],"pointer":"/paths/~1v1~1collections~1settlements~1{settlement_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/collections/settlements/{settlement_id}","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[{"name":"settlement_id","in":"path","required":true,"example":"63dd59dd-88be-41a2-a246-2f6724209422","schemaId":"schema_25"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/collections/settlements/{settlement_id}","href":"settlements/getsettlementbyidv1","openApiOperationId":"getSettlementByIdV1","summary":"Get settlement by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SettlementV1"}},"schemaId":"components/schemas/SettlementV1"},{"code":"400","description":"Bad Request - Invalid input parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized - Invalid or missing authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not Found - Settlement does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1collections~1settlements~1{settlement_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SettlementV1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SettlementV1"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlements/getsettlementbyidv1"}],"panels":[]}]},"httpPath":"/v1/collections/settlements/{settlement_id}"}],"content":{"contentType":"group","meta":{"name":"Settlements"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Settlements","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for managing settlements"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/collections/settlements","summary":"List settlements","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settlements/listsettlementsv1","deprecated":false},{"title":"/v1/collections/settlements","summary":"Create a settlement","prefix":{"name":"post","color":"post"},"badges":[],"link":"/settlements/createsettlementv1","deprecated":false},{"title":"/v1/collections/settlements/{settlement_id}","summary":"Get settlement by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settlements/getsettlementbyidv1","deprecated":false}]}]}]}]}},{"type":"group","label":"Transactions","link":"/pt-br/products/collections/api/collections/transactions","routeSlug":"/pt-br/products/collections/api/collections/transactions","items":[{"label":"List Transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/transactions/listtransactionsv1","routeSlug":"/pt-br/products/collections/api/collections/transactions/listtransactionsv1","metadata":{"seo":{"title":"List Transactions","description":"API to fetch transactions received through channels using account-based routing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTransactionsV1","name":"List Transactions","isWebhook":false,"pointer":"/paths/~1v1~1collections~1transactions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to fetch transactions received through channels using account-based routing."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_2","description":"Filter transactions by specific transaction ID"},{"name":"status","in":"query","schemaId":"schema_26","description":"Transaction status"},{"name":"payer_id","in":"query","schemaId":"schema_2","description":"Filter transactions by payer identifier"},{"name":"beneficiary_id","in":"query","schemaId":"schema_2","description":"Filter transactions by beneficiary identifier"},{"name":"account_id","in":"query","schemaId":"schema_2","description":"Filter transactions by account identifier"},{"name":"currency","in":"query","schemaId":"schema_1","description":"Filter transactions by transaction currency"},{"name":"network","in":"query","schemaId":"schema_27","description":"Filter transactions by transaction network"},{"name":"wallet_address","in":"query","schemaId":"schema_1","description":"Filter transactions by wallet address"},{"name":"since","in":"query","schemaId":"schema_4","description":"ISO 8601 timestamp after transaction was created"},{"name":"until","in":"query","schemaId":"schema_4","description":"ISO 8601 timestamp before transaction was created"},{"name":"page","in":"query","schemaId":"schema_5","description":"Page number (zero-indexed, starts at 0)","example":0},{"name":"size","in":"query","schemaId":"schema_6","description":"Page size (items per page)","example":10},{"name":"sort_by","in":"query","schemaId":"schema_28","description":"Field to sort results by","example":"CREATED_AT"},{"name":"direction","in":"query","schemaId":"schema_8","description":"Sort direction","example":"desc"}],"pointer":"/paths/~1v1~1collections~1transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/collections/transactions","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[],"query":[{"name":"id","in":"query","schemaId":"schema_2"},{"name":"status","in":"query","example":"COMPLETED","schemaId":"components/schemas/TransactionStatus"},{"name":"payer_id","in":"query","schemaId":"schema_2"},{"name":"beneficiary_id","in":"query","schemaId":"schema_2"},{"name":"account_id","in":"query","schemaId":"schema_2"},{"name":"currency","in":"query","schemaId":"schema_1"},{"name":"network","in":"query","example":"XRPL","schemaId":"components/schemas/Network"},{"name":"wallet_address","in":"query","schemaId":"schema_1"},{"name":"since","in":"query","schemaId":"schema_4"},{"name":"until","in":"query","schemaId":"schema_4"},{"name":"page","in":"query","example":0,"schemaId":"schema_5"},{"name":"size","in":"query","example":10,"schemaId":"schema_6"},{"name":"sort_by","in":"query","example":"CREATED_AT","schemaId":"schema_28"},{"name":"direction","in":"query","example":"desc","schemaId":"schema_8"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v1/collections/transactions","href":"transactions/listtransactionsv1","openApiOperationId":"listTransactionsV1","summary":"List Transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of transactions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_29","exampleIds":["paths/~1v1~1collections~1transactions/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"schema_29","exampleIds":["paths/~1v1~1collections~1transactions/get/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Bad Request - Invalid input parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized - Invalid or missing authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1collections~1transactions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_29","exampleIds":["paths/~1v1~1collections~1transactions/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_29","exampleIds":["paths/~1v1~1collections~1transactions/get/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/listtransactionsv1"}],"panels":[]}]},"httpPath":"/v1/collections/transactions"},{"label":"Get transaction by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/transactions/gettransactionbyidv1","routeSlug":"/pt-br/products/collections/api/collections/transactions/gettransactionbyidv1","metadata":{"seo":{"title":"Get transaction by ID","description":"API to fetch a transaction (payment from a payer to beneficiary) using account-based routing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTransactionByIdV1","name":"Get transaction by ID","isWebhook":false,"pointer":"/paths/~1v1~1collections~1transactions~1{transaction_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get transaction by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to fetch a transaction (payment from a payer to beneficiary) using account-based routing."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transaction_id","in":"path","schemaId":"schema_30","description":"Unique identifier of the transaction to retrieve","required":true}],"pointer":"/paths/~1v1~1collections~1transactions~1{transaction_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/collections/transactions/{transaction_id}","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[{"name":"transaction_id","in":"path","required":true,"example":"487ba009-56cf-4ad9-8b5c-045e27893e00","schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/collections/transactions/{transaction_id}","href":"transactions/gettransactionbyidv1","openApiOperationId":"getTransactionByIdV1","summary":"Get transaction by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionV1","exampleIds":["paths/~1v1~1collections~1transactions~1{transaction_id}/get/responses/200/content/application~1json/examples/blockchain_transaction","paths/~1v1~1collections~1transactions~1{transaction_id}/get/responses/200/content/application~1json/examples/fiat_transaction"]}},"schemaId":"components/schemas/TransactionV1","exampleIds":["paths/~1v1~1collections~1transactions~1{transaction_id}/get/responses/200/content/application~1json/examples/blockchain_transaction","paths/~1v1~1collections~1transactions~1{transaction_id}/get/responses/200/content/application~1json/examples/fiat_transaction"]},{"code":"400","description":"Bad Request - Invalid input parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized - Invalid or missing authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not Found - Transaction does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1collections~1transactions~1{transaction_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransactionV1","exampleIds":["paths/~1v1~1collections~1transactions~1{transaction_id}/get/responses/200/content/application~1json/examples/blockchain_transaction","paths/~1v1~1collections~1transactions~1{transaction_id}/get/responses/200/content/application~1json/examples/fiat_transaction"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionV1","exampleIds":["paths/~1v1~1collections~1transactions~1{transaction_id}/get/responses/200/content/application~1json/examples/blockchain_transaction","paths/~1v1~1collections~1transactions~1{transaction_id}/get/responses/200/content/application~1json/examples/fiat_transaction"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/gettransactionbyidv1"}],"panels":[]}]},"httpPath":"/v1/collections/transactions/{transaction_id}"}],"content":{"contentType":"group","meta":{"name":"Transactions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transactions","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for viewing transactions received through channels with account-based routing"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/collections/transactions","summary":"List Transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/listtransactionsv1","deprecated":false},{"title":"/v1/collections/transactions/{transaction_id}","summary":"Get transaction by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/gettransactionbyidv1","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhooks","link":"/pt-br/products/collections/api/collections/webhooks","routeSlug":"/pt-br/products/collections/api/collections/webhooks","items":[{"label":"List webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/webhooks/listwebhooks","routeSlug":"/pt-br/products/collections/api/collections/webhooks/listwebhooks","metadata":{"seo":{"title":"List webhooks","description":"List webhooks"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listWebhooks","name":"List webhooks","isWebhook":false,"pointer":"/paths/~1v1~1collections~1webhooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List webhooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"event_type","in":"query","schemaId":"schema_31","description":"Unique identifier event type to filter webhooks","required":true},{"name":"since","in":"query","schemaId":"schema_4","description":"ISO 8601 timestamp after webhook was created"},{"name":"until","in":"query","schemaId":"schema_4","description":"ISO 8601 timestamp before webhook was created"},{"name":"page","in":"query","schemaId":"schema_5","description":"Page number (zero-indexed, starts at 0)","example":0},{"name":"size","in":"query","schemaId":"schema_6","description":"Page size (items per page)","example":10}],"pointer":"/paths/~1v1~1collections~1webhooks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/collections/webhooks","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[],"query":[{"name":"event_type","in":"query","required":true,"example":"TRANSACTION_STATUS_CHANGED","schemaId":"components/schemas/EventType"},{"name":"since","in":"query","schemaId":"schema_4"},{"name":"until","in":"query","schemaId":"schema_4"},{"name":"page","in":"query","example":0,"schemaId":"schema_5"},{"name":"size","in":"query","example":10,"schemaId":"schema_6"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v1/collections/webhooks","href":"webhooks/listwebhooks","openApiOperationId":"listWebhooks","summary":"List webhooks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of webhooks for the customer and page requested","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32"}},"schemaId":"schema_32"},{"code":"400","description":"Bad Request - Invalid input parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized - Invalid or missing authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1collections~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_32","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/listwebhooks"}],"panels":[]}]},"httpPath":"/v1/collections/webhooks"},{"label":"Create webhooks","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/webhooks/createwebhooks","routeSlug":"/pt-br/products/collections/api/collections/webhooks/createwebhooks","metadata":{"seo":{"title":"Create webhooks","description":"Creates one webhook per event type supplied."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWebhooks","name":"Create webhooks","isWebhook":false,"pointer":"/paths/~1v1~1collections~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create webhooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates one webhook per event type supplied."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWebhookRequest","exampleIds":["paths/~1v1~1collections~1webhooks/post/requestBody/content/application~1json/examples/create"]}},"schemaId":"components/schemas/CreateWebhookRequest","exampleIds":["paths/~1v1~1collections~1webhooks/post/requestBody/content/application~1json/examples/create"],"pointer":"/paths/~1v1~1collections~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/collections/webhooks","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateWebhookRequest","exampleIds":["paths/~1v1~1collections~1webhooks/post/requestBody/content/application~1json/examples/create"]}},"responseCodes":["201","400","401","500"],"pointer":"/v1/collections/webhooks","href":"webhooks/createwebhooks","openApiOperationId":"createWebhooks","summary":"Create webhooks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"schemaId":"components/schemas/CreateWebhookRequest","exampleIds":["paths/~1v1~1collections~1webhooks/post/requestBody/content/application~1json/examples/create"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWebhookRequest","exampleIds":["paths/~1v1~1collections~1webhooks/post/requestBody/content/application~1json/examples/create"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Webhooks created (one per event type)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33","exampleIds":["paths/~1v1~1collections~1webhooks/post/responses/201/content/application~1json/examples/created"]}},"schemaId":"schema_33","exampleIds":["paths/~1v1~1collections~1webhooks/post/responses/201/content/application~1json/examples/created"]},{"code":"400","description":"Bad Request - Invalid input parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized - Invalid or missing authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1collections~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_33","exampleIds":["paths/~1v1~1collections~1webhooks/post/responses/201/content/application~1json/examples/created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33","exampleIds":["paths/~1v1~1collections~1webhooks/post/responses/201/content/application~1json/examples/created"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/createwebhooks"}],"panels":[]}]},"httpPath":"/v1/collections/webhooks"},{"label":"Get a webhook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/webhooks/getwebhook","routeSlug":"/pt-br/products/collections/api/collections/webhooks/getwebhook","metadata":{"seo":{"title":"Get a webhook","description":"Get a webhook"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebhook","name":"Get a webhook","isWebhook":false,"pointer":"/paths/~1v1~1collections~1webhooks~1{webhook_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhook_id","in":"path","schemaId":"schema_34","description":"Unique identifier of the webhook to retrieve","required":true}],"pointer":"/paths/~1v1~1collections~1webhooks~1{webhook_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/collections/webhooks/{webhook_id}","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[{"name":"webhook_id","in":"path","required":true,"example":"5c0d9ec9-5ad8-4a43-a1b4-6f8f1f6c4c10","schemaId":"schema_34"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/collections/webhooks/{webhook_id}","href":"webhooks/getwebhook","openApiOperationId":"getWebhook","summary":"Get a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponse","exampleIds":["paths/~1v1~1collections~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/examples/webhook"]}},"schemaId":"components/schemas/WebhookResponse","exampleIds":["paths/~1v1~1collections~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/examples/webhook"]},{"code":"400","description":"Bad Request - Invalid input parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized - Invalid or missing authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not Found - Webhook does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1collections~1webhooks~1{webhook_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookResponse","exampleIds":["paths/~1v1~1collections~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/examples/webhook"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponse","exampleIds":["paths/~1v1~1collections~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/examples/webhook"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/getwebhook"}],"panels":[]}]},"httpPath":"/v1/collections/webhooks/{webhook_id}"},{"label":"Delete a webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/webhooks/deletewebhook","routeSlug":"/pt-br/products/collections/api/collections/webhooks/deletewebhook","metadata":{"seo":{"title":"Delete a webhook","description":"Delete a webhook"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWebhook","name":"Delete a webhook","isWebhook":false,"pointer":"/paths/~1v1~1collections~1webhooks~1{webhook_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhook_id","in":"path","schemaId":"schema_34","description":"Unique identifier of the webhook to retrieve","required":true}],"pointer":"/paths/~1v1~1collections~1webhooks~1{webhook_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/collections/webhooks/{webhook_id}","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[{"name":"webhook_id","in":"path","required":true,"example":"5c0d9ec9-5ad8-4a43-a1b4-6f8f1f6c4c10","schemaId":"schema_34"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/collections/webhooks/{webhook_id}","href":"webhooks/deletewebhook","openApiOperationId":"deleteWebhook","summary":"Delete a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Deleted webhook id","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2","exampleIds":["paths/~1v1~1collections~1webhooks~1{webhook_id}/delete/responses/200/content/application~1json/examples/deleted"]}},"schemaId":"schema_2","exampleIds":["paths/~1v1~1collections~1webhooks~1{webhook_id}/delete/responses/200/content/application~1json/examples/deleted"]},{"code":"400","description":"Bad Request - Invalid input parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized - Invalid or missing authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not Found - Webhook does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1collections~1webhooks~1{webhook_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","exampleIds":["paths/~1v1~1collections~1webhooks~1{webhook_id}/delete/responses/200/content/application~1json/examples/deleted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2","exampleIds":["paths/~1v1~1collections~1webhooks~1{webhook_id}/delete/responses/200/content/application~1json/examples/deleted"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/deletewebhook"}],"panels":[]}]},"httpPath":"/v1/collections/webhooks/{webhook_id}"}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for managing webhook registrations"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/collections/webhooks","summary":"List webhooks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/listwebhooks","deprecated":false},{"title":"/v1/collections/webhooks","summary":"Create webhooks","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/createwebhooks","deprecated":false},{"title":"/v1/collections/webhooks/{webhook_id}","summary":"Get a webhook","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/getwebhook","deprecated":false},{"title":"/v1/collections/webhooks/{webhook_id}","summary":"Delete a webhook","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhooks/deletewebhook","deprecated":false}]}]}]}]}},{"type":"group","label":"Transfers","link":"/pt-br/products/collections/api/collections/transfers","routeSlug":"/pt-br/products/collections/api/collections/transfers","items":[{"label":"List transfers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/transfers/listtransfersv1","routeSlug":"/pt-br/products/collections/api/collections/transfers/listtransfersv1","metadata":{"seo":{"title":"List transfers","description":"Retrieves a list of transfers, filterable by query parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTransfersV1","name":"List transfers","isWebhook":false,"pointer":"/paths/~1v1~1collections~1transfers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List transfers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of transfers, filterable by query parameters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"source_account_id","in":"query","schemaId":"schema_2","description":"Filter transfers by source account identifier"},{"name":"destination_account_id","in":"query","schemaId":"schema_2","description":"Filter transfers by destination account identifier"},{"name":"status","in":"query","schemaId":"schema_35","description":"Filter transfers by status"},{"name":"type","in":"query","schemaId":"schema_36","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter transfers by type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRADE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for cross-currency transfers, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSACTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for same-currency transfers. Used only as a filter; not returned on the transfer itself."},"children":[]}]}]}]},{"name":"since","in":"query","schemaId":"schema_4","description":"ISO 8601 timestamp after transfer was created"},{"name":"until","in":"query","schemaId":"schema_4","description":"ISO 8601 timestamp before transfer was created"},{"name":"page","in":"query","schemaId":"schema_5","description":"Page number (zero-indexed, starts at 0)","example":0},{"name":"size","in":"query","schemaId":"schema_6","description":"Page size (items per page)","example":10},{"name":"sort_by","in":"query","schemaId":"schema_37","description":"Field to sort results by","example":"CREATED_AT"},{"name":"direction","in":"query","schemaId":"schema_8","description":"Sort direction","example":"desc"}],"pointer":"/paths/~1v1~1collections~1transfers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/collections/transfers","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[],"query":[{"name":"source_account_id","in":"query","schemaId":"schema_2"},{"name":"destination_account_id","in":"query","schemaId":"schema_2"},{"name":"status","in":"query","example":"PENDING","schemaId":"components/schemas/TransferStatus"},{"name":"type","in":"query","example":"TRADE","schemaId":"components/schemas/TransferType"},{"name":"since","in":"query","schemaId":"schema_4"},{"name":"until","in":"query","schemaId":"schema_4"},{"name":"page","in":"query","example":0,"schemaId":"schema_5"},{"name":"size","in":"query","example":10,"schemaId":"schema_6"},{"name":"sort_by","in":"query","example":"CREATED_AT","schemaId":"schema_37"},{"name":"direction","in":"query","example":"desc","schemaId":"schema_8"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v1/collections/transfers","href":"transfers/listtransfersv1","openApiOperationId":"listTransfersV1","summary":"List transfers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of transfers.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1v1~1collections~1transfers/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"schema_38","exampleIds":["paths/~1v1~1collections~1transfers/get/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Bad Request - Invalid input parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized - Invalid or missing authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1collections~1transfers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_38","exampleIds":["paths/~1v1~1collections~1transfers/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1v1~1collections~1transfers/get/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfers/listtransfersv1"}],"panels":[]}]},"httpPath":"/v1/collections/transfers"},{"label":"Create a transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/transfers/createtransferv1","routeSlug":"/pt-br/products/collections/api/collections/transfers/createtransferv1","metadata":{"seo":{"title":"Create a transfer","description":"Moves funds between two of your accounts. When the accounts hold different currencies,the transfer is quoted at creation and the quote is applied when you confirm; transfersbetween same-currency accounts move at par. A new transfer starts as PENDING and mustbe confirmed before it expires (expires_at)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTransferV1","name":"Create a transfer","isWebhook":false,"pointer":"/paths/~1v1~1collections~1transfers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Moves funds between two of your accounts. When the accounts hold different currencies,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the transfer is quoted at creation and the quote is applied when you confirm; transfers"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"between same-currency accounts move at par. A new transfer starts as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and must"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be confirmed before it expires ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTransferRequestV1","exampleIds":["paths/~1v1~1collections~1transfers/post/requestBody/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CreateTransferRequestV1","exampleIds":["paths/~1v1~1collections~1transfers/post/requestBody/content/application~1json/examples/default"],"pointer":"/paths/~1v1~1collections~1transfers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/collections/transfers","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateTransferRequestV1","exampleIds":["paths/~1v1~1collections~1transfers/post/requestBody/content/application~1json/examples/default"]}},"responseCodes":["201","400","401","404","409","422","500"],"pointer":"/v1/collections/transfers","href":"transfers/createtransferv1","openApiOperationId":"createTransferV1","summary":"Create a transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"schemaId":"components/schemas/CreateTransferRequestV1","exampleIds":["paths/~1v1~1collections~1transfers/post/requestBody/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTransferRequestV1","exampleIds":["paths/~1v1~1collections~1transfers/post/requestBody/content/application~1json/examples/default"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Transfer created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferV1","exampleIds":["paths/~1v1~1collections~1transfers/post/responses/201/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TransferV1","exampleIds":["paths/~1v1~1collections~1transfers/post/responses/201/content/application~1json/examples/default"]},{"code":"400","description":"Bad Request - Invalid input parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized - Invalid or missing authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not Found - Source or destination account does not exist or is not accessible","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"409","description":"Conflict - An in-flight transfer already exists for this source and destination account pair","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable Entity - Transfer request failed business validation (e.g. same source/destination account, accounts belong to different customers, an account is inactive or ineligible, or insufficient balance)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1collections~1transfers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/TransferV1","exampleIds":["paths/~1v1~1collections~1transfers/post/responses/201/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferV1","exampleIds":["paths/~1v1~1collections~1transfers/post/responses/201/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfers/createtransferv1"}],"panels":[]}]},"httpPath":"/v1/collections/transfers"},{"label":"Get transfer by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/transfers/gettransferbyidv1","routeSlug":"/pt-br/products/collections/api/collections/transfers/gettransferbyidv1","metadata":{"seo":{"title":"Get transfer by ID","description":"Retrieves the details of a specific transfer by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTransferByIdV1","name":"Get transfer by ID","isWebhook":false,"pointer":"/paths/~1v1~1collections~1transfers~1{transfer_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get transfer by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the details of a specific transfer by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transfer_id","in":"path","schemaId":"schema_39","description":"Unique identifier of the transfer to retrieve","required":true}],"pointer":"/paths/~1v1~1collections~1transfers~1{transfer_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/collections/transfers/{transfer_id}","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[{"name":"transfer_id","in":"path","required":true,"example":"6f3e9c2a-1b4d-47f0-9e3a-2c6b8d1f5a7e","schemaId":"schema_39"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/collections/transfers/{transfer_id}","href":"transfers/gettransferbyidv1","openApiOperationId":"getTransferByIdV1","summary":"Get transfer by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferV1"}},"schemaId":"components/schemas/TransferV1"},{"code":"401","description":"Unauthorized - Invalid or missing authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not Found - Transfer does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1collections~1transfers~1{transfer_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransferV1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferV1"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfers/gettransferbyidv1"}],"panels":[]}]},"httpPath":"/v1/collections/transfers/{transfer_id}"},{"label":"Confirm a transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/transfers/confirmtransferv1","routeSlug":"/pt-br/products/collections/api/collections/transfers/confirmtransferv1","metadata":{"seo":{"title":"Confirm a transfer","description":"Confirms a PENDING transfer so the funds move. For a cross-currency transfer this locksin the quoted rate; same-currency transfers move at par. Pass an Idempotency-Key headerto safely retry the same confirmation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"confirmTransferV1","name":"Confirm a transfer","isWebhook":false,"pointer":"/paths/~1v1~1collections~1transfers~1{transfer_id}~1confirm/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Confirm a transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirms a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transfer so the funds move. For a cross-currency transfer this locks"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the quoted rate; same-currency transfers move at par. Pass an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to safely retry the same confirmation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transfer_id","in":"path","schemaId":"schema_39","description":"Unique identifier of the transfer to confirm","required":true}],"pointer":"/paths/~1v1~1collections~1transfers~1{transfer_id}~1confirm/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/collections/transfers/{transfer_id}/confirm","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[{"name":"transfer_id","in":"path","required":true,"example":"6f3e9c2a-1b4d-47f0-9e3a-2c6b8d1f5a7e","schemaId":"schema_39"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","404","409","410","422","500","503"],"pointer":"/v1/collections/transfers/{transfer_id}/confirm","href":"transfers/confirmtransferv1","openApiOperationId":"confirmTransferV1","summary":"Confirm a transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transfer confirmed and execution started or completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfirmTransferResponseV1"}},"schemaId":"components/schemas/ConfirmTransferResponseV1"},{"code":"401","description":"Unauthorized - Invalid or missing authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not Found - Transfer does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"409","description":"Conflict - Transfer cannot be confirmed in its current state (another confirm is in flight or the transfer already reached a terminal state)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"410","description":"Gone - Transfer has expired","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable Entity - The source and destination currency pair is no longer supported for execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error - Transfer execution failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Service Unavailable - Cross-currency transfer execution is temporarily disabled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1collections~1transfers~1{transfer_id}~1confirm/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConfirmTransferResponseV1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConfirmTransferResponseV1"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"410","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"503","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfers/confirmtransferv1"}],"panels":[]}]},"httpPath":"/v1/collections/transfers/{transfer_id}/confirm"},{"label":"Cancel a transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/transfers/canceltransferv1","routeSlug":"/pt-br/products/collections/api/collections/transfers/canceltransferv1","metadata":{"seo":{"title":"Cancel a transfer","description":"Cancels a previously-created PENDING transfer. A transfer that is not PENDINGreturns 422. Supports request deduplication via the Idempotency-Key header."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelTransferV1","name":"Cancel a transfer","isWebhook":false,"pointer":"/paths/~1v1~1collections~1transfers~1{transfer_id}~1cancel/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancels a previously-created "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transfer. A transfer that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returns 422. Supports request deduplication via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transfer_id","in":"path","schemaId":"schema_39","description":"Unique identifier of the transfer to cancel","required":true}],"pointer":"/paths/~1v1~1collections~1transfers~1{transfer_id}~1cancel/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/collections/transfers/{transfer_id}/cancel","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[{"name":"transfer_id","in":"path","required":true,"example":"6f3e9c2a-1b4d-47f0-9e3a-2c6b8d1f5a7e","schemaId":"schema_39"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","404","422","500"],"pointer":"/v1/collections/transfers/{transfer_id}/cancel","href":"transfers/canceltransferv1","openApiOperationId":"cancelTransferV1","summary":"Cancel a transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Transfer cancelled successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferV1"}},"schemaId":"components/schemas/TransferV1"},{"code":"401","description":"Unauthorized - Invalid or missing authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not Found - Transfer does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable Entity - Transfer is not in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, so it cannot be cancelled"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1collections~1transfers~1{transfer_id}~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransferV1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferV1"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfers/canceltransferv1"}],"panels":[]}]},"httpPath":"/v1/collections/transfers/{transfer_id}/cancel"}],"content":{"contentType":"group","meta":{"name":"Transfers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfers","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for transferring funds between accounts"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/collections/transfers","summary":"List transfers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transfers/listtransfersv1","deprecated":false},{"title":"/v1/collections/transfers","summary":"Create a transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transfers/createtransferv1","deprecated":false},{"title":"/v1/collections/transfers/{transfer_id}","summary":"Get transfer by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transfers/gettransferbyidv1","deprecated":false},{"title":"/v1/collections/transfers/{transfer_id}/confirm","summary":"Confirm a transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transfers/confirmtransferv1","deprecated":false},{"title":"/v1/collections/transfers/{transfer_id}/cancel","summary":"Cancel a transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transfers/canceltransferv1","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AuthenticationRequest":{"id":"components/schemas/AuthenticationRequest","kind":"json-schema","title":"AuthenticationRequest","data":{"description":"The authentication request.","properties":{"client_id":{"type":"string","description":"The client ID associated with a specific set of API credentials.","example":"{YOUR_CLIENT_ID}"},"client_secret":{"type":"string","description":"The client secret associated with a specific set of API credentials.","example":"{YOUR_CLIENT_SECRET}"},"audience":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audience"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is based on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Uniform_Resource_Name"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" syntax."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urn:ripplexcurrent-{ENVIRONMENT_STRING}:{YOUR_TENANT_ID}"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first component is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urn:ripplenetxcurrent-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The second component refers to the environment you want to access."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The third component is your tenant ID. Ripple integration engineers provide this component during training."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environment"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environment string"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UAT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uat"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UAT environment with simulated transactions."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production environment for Ripple's internal services."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urn:ripplexcurrent-uat:{YOUR_TENANT_ID}"},"children":[]}]}]}],"example":"urn:ripplexcurrent-uat:{YOUR_TENANT_ID}"},"grant_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set the grant-type for this client credentials request. This must be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["client_credentials"],"example":"client_credentials"}},"required":["client_id","client_secret","audience","grant_type"],"type":"object"}},"components/schemas/AuthenticationResponse":{"id":"components/schemas/AuthenticationResponse","kind":"json-schema","title":"AuthenticationResponse","data":{"description":"The authentication response object that includes the token, type, scopes, and expiry.","properties":{"access_token":{"type":"string","description":"The bearer token you use when authenticating with a Ripple API.","example":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJ"},"scope":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of scopes applied to your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"expires_in":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How long your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is valid. You need to request a new token when it expires."},"children":[]}]}]}],"example":3600},"token_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of token. Ripple APIs use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" auth tokens."},"children":[]}]}]}],"example":"Bearer"}},"type":"object"}},"components/schemas/ValidateTokenResponse":{"id":"components/schemas/ValidateTokenResponse","kind":"json-schema","title":"ValidateTokenResponse","data":{"description":"The response object indicating a token's validity and the time remaining on it","properties":{"message":{"type":"string","example":"token_ok"},"seconds_to_expiry":{"type":"integer","format":"int64","description":"Remaining time in seconds before the tested token expires.","example":3600}}}},"components/schemas/CreatePartnerRequest":{"id":"components/schemas/CreatePartnerRequest","kind":"json-schema","title":"CreatePartnerRequest","data":{"type":"object","description":"Request payload for creating a new partner","required":["name","email"],"properties":{"name":{"type":"string","description":"Full name of the partner organization or individual","example":"Nigerian Imports Ltd."},"email":{"type":"string","description":"Email address for partner communications","format":"email","example":"nigerian@imports.com"},"external_reference_id":{"type":"string","description":"External reference id for partner","example":"Ref-123"},"data":{"$ref":"#/components/schemas/PartnerMetadata","example":{"type":"BUSINESS","legal_entity":"Nigerian Imports Ltd.","registration_number":"RC-123456-NGR","registration_type":"AIIN","country":"NG","city":"Lagos Island","postal_code":"10010","address":"15 Marina Street","address_line_2":"Suite 200"}}}}},"components/schemas/UpdatePartnerRequest":{"id":"components/schemas/UpdatePartnerRequest","kind":"json-schema","title":"UpdatePartnerRequest","data":{"type":"object","description":"Request payload for updating an existing partner","properties":{"name":{"type":"string","description":"Full name of the partner organization or individual","example":"Nigerian Imports Ltd."},"email":{"type":"string","description":"Email address for partner communications","format":"email","example":"nigerian@imports.com"},"external_reference_id":{"type":"string","description":"External reference id for partner","example":"Ref-123"},"data":{"$ref":"#/components/schemas/PartnerMetadata","example":{"type":"BUSINESS","legal_entity":"Nigerian Imports Ltd.","registration_number":"RC-123456-NGR","registration_type":"AIIN","country":"NG","city":"Lagos Island","postal_code":"10010","address":"15 Marina Street","address_line_2":"Suite 200"}}}}},"components/schemas/PartnerV1":{"id":"components/schemas/PartnerV1","kind":"json-schema","title":"PartnerV1","data":{"type":"object","description":"Partner response","required":["id","name","email","status","created_at","updated_at"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the partner","readOnly":true,"example":"0c5479ff-3772-4123-b2b7-e679e71eb570"},"name":{"type":"string","description":"Full name of the partner organization or individual","example":"Nigerian Imports Ltd."},"email":{"type":"string","description":"Email address for partner communications","format":"email","example":"nigerian@imports.com"},"external_reference_id":{"type":"string","description":"External reference id for partner","example":"Ref-123"},"data":{"$ref":"#/components/schemas/PartnerMetadata","example":{"type":"BUSINESS","legal_entity":"Nigerian Imports Ltd.","registration_number":"RC-123456-NGR","registration_type":"AIIN","country":"NG","city":"Lagos Island","postal_code":"10010","address":"15 Marina Street","address_line_2":"Suite 200"}},"status":{"type":"string","description":"Current status of the partner","$ref":"#/components/schemas/PartnerStatus","example":"PENDING"},"reason":{"type":"string","nullable":true,"description":"Reason for current status (if applicable)","example":null},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the partner was created","readOnly":true,"example":"2025-09-18T22:54:00.542Z"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the partner was last updated","readOnly":true,"example":"2025-09-18T23:54:00.542Z"}}}},"components/schemas/PartnerType":{"id":"components/schemas/PartnerType","kind":"json-schema","title":"PartnerType","data":{"type":"string","description":"Partner type","enum":["BUSINESS","INDIVIDUAL"],"x-enum-descriptions":{"BUSINESS":"Partner is a business entity","INDIVIDUAL":"Partner is an individual"},"example":"BUSINESS"}},"components/schemas/PartnerMetadata":{"id":"components/schemas/PartnerMetadata","kind":"json-schema","title":"PartnerMetadata","data":{"type":"object","discriminator":{"propertyName":"type","mapping":{"BUSINESS":"#/components/schemas/BusinessMetadata","INDIVIDUAL":"#/components/schemas/IndividualMetadata"}},"oneOf":[{"$ref":"#/components/schemas/BusinessMetadata"},{"$ref":"#/components/schemas/IndividualMetadata"}]}},"components/schemas/BusinessMetadata":{"id":"components/schemas/BusinessMetadata","kind":"json-schema","title":"BusinessMetadata","data":{"type":"object","description":"Metadata specific to business partners","required":["type","legal_entity","registration_number","registration_type","country","address"],"properties":{"type":{"type":"string","enum":["BUSINESS"],"description":"Discriminator: indicates this is business metadata"},"legal_entity":{"type":"string","description":"Legal name of the business entity","example":"Nigerian Imports Ltd."},"registration_number":{"type":"string","description":"Business registration number","example":"RC-123456-NGR"},"registration_type":{"$ref":"#/components/schemas/RegistrationType"},"country":{"type":"string","description":"Country where the business is registered","example":"NG"},"city":{"type":"string","description":"City where the business is located","example":"Lagos Island"},"postal_code":{"type":"string","description":"Postal code of the business address","example":"10010"},"address":{"type":"string","description":"Primary address of the business","example":"15 Marina Street"},"address_line_2":{"type":"string","description":"Secondary address line","example":"Suite 200"}}}},"components/schemas/RegistrationType":{"id":"components/schemas/RegistrationType","kind":"json-schema","title":"RegistrationType","data":{"type":"string","description":"Business registration/identification type","enum":["AIIN","BANK","BOID","CBID","CHID","CINC","COID","CUST","DUNS","EMPL","GS1G","SREN","SRET","TXID","USCC"],"x-enum-descriptions":{"AIIN":"Issuer Identification Number","BANK":"Bank Party Identification","BOID":"BusinessOtherIdentification","CBID":"Central Bank Identification Number","CHID":"Clearing Identification Number","CINC":"Certificate Of Incorporation Number","COID":"Country Identification Code","CUST":"Customer Number","DUNS":"Data Universal Numbering System","EMPL":"Employer Identification Number","GS1G":"GS1GLN Identifier","SREN":"SIREN","SRET":"SIRET","TXID":"Tax Identification Number","USCC":"Unified Social Credit Code"},"example":"AIIN"}},"components/schemas/IndividualMetadata":{"id":"components/schemas/IndividualMetadata","kind":"json-schema","title":"IndividualMetadata","data":{"type":"object","description":"Metadata specific to individual partners","required":["type","first_name","last_name","date_of_birth","country","address","identification_number","identification_type"],"properties":{"type":{"type":"string","enum":["INDIVIDUAL"],"description":"Discriminator: indicates this is individual metadata"},"first_name":{"type":"string","description":"First name of the individual","example":"John"},"last_name":{"type":"string","description":"Last name of the individual","example":"Doe"},"date_of_birth":{"type":"string","format":"date","description":"Date of birth of the individual","example":"1990-05-15"},"identification_number":{"type":"string","description":"Identification number of the individual"},"identification_type":{"$ref":"#/components/schemas/IdentificationType"},"country":{"type":"string","description":"Country of residence","example":"United States"},"city":{"type":"string","description":"City of residence","example":"New York"},"postal_code":{"type":"string","description":"Postal code of residence","example":"10001"},"address":{"type":"string","description":"Primary address of residence","example":"123 Main Street"},"address_line_2":{"type":"string","description":"Secondary address line","example":"Suite 200"}}}},"components/schemas/IdentificationType":{"id":"components/schemas/IdentificationType","kind":"json-schema","title":"IdentificationType","data":{"type":"string","description":"Identification type for the individual identifier","enum":["AIIN","ARNU","CCPT","CUST","DRLC","NIDN","POID","SOS","TXID"],"x-enum-descriptions":{"AIIN":"Issuer Identification Number","ARNU":"Alien Registration Number","CCPT":"Passport Number","CUST":"Customer Number","DRLC":"Driver's License Number","NIDN":"National Identity Number","POID":"PersonCommercialIdentification","SOS":"Social Security Number","TXID":"Tax Identification Number"},"example":"CCPT"}},"components/schemas/PartnerStatus":{"id":"components/schemas/PartnerStatus","kind":"json-schema","title":"PartnerStatus","data":{"type":"string","description":"Partner status","enum":["PENDING","ON_HOLD","FAILED","ACTIVATED","DEACTIVATED"],"x-enum-descriptions":{"PENDING":"Partner is pending review","ON_HOLD":"Partner is on hold due to review","FAILED":"Partner has failed review","ACTIVATED":"Partner hs been activated","DEACTIVATED":"Partner has been deactivated"},"example":"PENDING"}},"components/schemas/AccountType":{"id":"components/schemas/AccountType","kind":"json-schema","title":"AccountType","data":{"type":"string","description":"Type of account","enum":["CRYPTO","FIAT"],"x-enum-descriptions":{"CRYPTO":"Cryptocurrency account with blockchain wallet addresses","FIAT":"Fiat currency account with bank deposit instructions"},"example":"CRYPTO"}},"components/schemas/AccountStatus":{"id":"components/schemas/AccountStatus","kind":"json-schema","title":"AccountStatus","data":{"type":"string","description":"Status of the account","enum":["PENDING","ACTIVE","INACTIVE","SUSPENDED","CLOSED"],"x-enum-descriptions":{"PENDING":"Account is pending activation","ACTIVE":"Account is active and ready to receive funds","INACTIVE":"Account is temporarily inactive","SUSPENDED":"Account is temporarily suspended (e.g. compliance hold)","CLOSED":"Account has been closed"},"example":"ACTIVE"}},"components/schemas/RailType":{"id":"components/schemas/RailType","kind":"json-schema","title":"RailType","data":{"type":"string","description":"Type of payment rail","enum":["BLOCKCHAIN","FEDWIRE","ACH","RTP","PIX"],"x-enum-descriptions":{"BLOCKCHAIN":"Blockchain network for cryptocurrency payments","FEDWIRE":"Federal Reserve Wire Network (USD)","ACH":"Automated Clearing House (USD)","RTP":"Real-Time Payments (USD)","PIX":"Brazilian instant payment system (BRL)"},"example":"BLOCKCHAIN"}},"components/schemas/Rail":{"id":"components/schemas/Rail","kind":"json-schema","title":"Rail","data":{"type":"object","description":"Payment rail with deposit instructions","discriminator":{"propertyName":"type","mapping":{"BLOCKCHAIN":"#/components/schemas/BlockchainRail","FEDWIRE":"#/components/schemas/FedwireRail","ACH":"#/components/schemas/AchRail","RTP":"#/components/schemas/RtpRail","PIX":"#/components/schemas/PixRail"}},"oneOf":[{"$ref":"#/components/schemas/BlockchainRail"},{"$ref":"#/components/schemas/FedwireRail"},{"$ref":"#/components/schemas/AchRail"},{"$ref":"#/components/schemas/RtpRail"},{"$ref":"#/components/schemas/PixRail"}]}},"components/schemas/BlockchainRail":{"id":"components/schemas/BlockchainRail","kind":"json-schema","title":"BlockchainRail","data":{"type":"object","description":"Blockchain payment rail with network details","required":["type","network","address","currency"],"properties":{"type":{"type":"string","enum":["BLOCKCHAIN"],"description":"Discriminator: indicates blockchain rail"},"network":{"$ref":"#/components/schemas/Network"},"address":{"type":"string","description":"Blockchain wallet address for receiving funds","example":"0xBb592aaaF9AcE2fbE3F735645819FA94c95a9cb5"},"currency":{"type":"string","description":"Cryptocurrency asset symbol","example":"RLUSD"},"destination_tag":{"type":"string","description":"Optional destination tag/memo for networks that require one (e.g. XRPL)","example":"12345"}}}},"components/schemas/FedwireRail":{"id":"components/schemas/FedwireRail","kind":"json-schema","title":"FedwireRail","data":{"type":"object","description":"Fedwire payment rail for USD wire transfers","required":["type","account_number","routing_number"],"properties":{"type":{"type":"string","enum":["FEDWIRE"],"description":"Discriminator: indicates Fedwire rail"},"account_number":{"type":"string","description":"Bank account number","example":"XXXX7890"},"routing_number":{"type":"string","description":"ABA routing number","example":"021000021"},"swift_code":{"type":"string","description":"SWIFT/BIC code for international transfers","example":"CHASUS33"},"memo":{"type":"string","description":"Reference memo to include with the transfer","example":"ACC-123456"}}}},"components/schemas/AchRail":{"id":"components/schemas/AchRail","kind":"json-schema","title":"AchRail","data":{"type":"object","description":"ACH payment rail for USD domestic transfers","required":["type","account_number","routing_number"],"properties":{"type":{"type":"string","enum":["ACH"],"description":"Discriminator: indicates ACH rail"},"account_number":{"type":"string","description":"Bank account number","example":"XXXX7890"},"routing_number":{"type":"string","description":"ABA routing number","example":"021000021"},"swift_code":{"type":"string","description":"SWIFT/BIC code (optional for ACH)","example":"CHASUS33"},"memo":{"type":"string","description":"Reference memo to include with the transfer","example":"ACC-123456"}}}},"components/schemas/RtpRail":{"id":"components/schemas/RtpRail","kind":"json-schema","title":"RtpRail","data":{"type":"object","description":"RTP (Real-Time Payments) rail for instant USD transfers","required":["type","account_number","routing_number"],"properties":{"type":{"type":"string","enum":["RTP"],"description":"Discriminator: indicates RTP rail"},"account_number":{"type":"string","description":"Bank account number","example":"XXXX7890"},"routing_number":{"type":"string","description":"ABA routing number","example":"021000021"},"swift_code":{"type":"string","description":"SWIFT/BIC code (optional for RTP)","example":"CHASUS33"},"memo":{"type":"string","description":"Reference memo to include with the transfer","example":"ACC-123456"}}}},"components/schemas/PixRail":{"id":"components/schemas/PixRail","kind":"json-schema","title":"PixRail","data":{"type":"object","description":"PIX payment rail for instant BRL transfers in Brazil","required":["type","pix_key","pix_key_type"],"properties":{"type":{"type":"string","enum":["PIX"],"description":"Discriminator: indicates PIX rail"},"pix_key":{"type":"string","description":"PIX key for receiving payments","example":"12345678901"},"pix_key_type":{"type":"string","description":"Type of PIX key","enum":["CPF","CNPJ","EMAIL","PHONE","RANDOM"],"example":"CPF"},"beneficiary_name":{"type":"string","description":"Name of the beneficiary as registered with PIX","example":"Empresa ABC Ltda"}}}},"components/schemas/SourcePaymentMethod":{"id":"components/schemas/SourcePaymentMethod","kind":"json-schema","title":"SourcePaymentMethod","data":{"type":"object","description":"Source payment method details for a transaction","discriminator":{"propertyName":"type","mapping":{"BLOCKCHAIN":"#/components/schemas/BlockchainSourcePaymentMethod","FEDWIRE":"#/components/schemas/FedwireSourcePaymentMethod","ACH":"#/components/schemas/AchSourcePaymentMethod","RTP":"#/components/schemas/RtpSourcePaymentMethod","PIX":"#/components/schemas/PixSourcePaymentMethod"}},"oneOf":[{"$ref":"#/components/schemas/BlockchainSourcePaymentMethod"},{"$ref":"#/components/schemas/FedwireSourcePaymentMethod"},{"$ref":"#/components/schemas/AchSourcePaymentMethod"},{"$ref":"#/components/schemas/RtpSourcePaymentMethod"},{"$ref":"#/components/schemas/PixSourcePaymentMethod"}]}},"components/schemas/BlockchainSourcePaymentMethod":{"id":"components/schemas/BlockchainSourcePaymentMethod","kind":"json-schema","title":"BlockchainSourcePaymentMethod","data":{"type":"object","description":"Blockchain/crypto source payment method with on-chain transaction details","required":["type","network","transaction_hash","block_id","source_address","destination_address","gas_fee"],"properties":{"type":{"type":"string","enum":["BLOCKCHAIN"],"description":"Discriminator: indicates blockchain payment method"},"network":{"$ref":"#/components/schemas/Network"},"transaction_hash":{"type":"string","description":"Blockchain transaction hash","example":"0x94365ftfr76iy45t6ghu876567ytr54ertyui987uyt698uyh87u"},"block_id":{"type":"string","description":"Blockchain block identifier containing this transaction","example":"0xh7865gugi87yea94e8267987a9e91eddcd0da916b22f3cfa0c8bd91dbad85"},"source_address":{"type":"string","description":"Blockchain address from which funds were sent","example":"0x880f622a1933ACf82bFC5e630c9ab7f18eF47809"},"destination_address":{"type":"string","description":"Blockchain address to which funds were sent","example":"0x02937b288b588058533C48b18EdFDdd76A324D6"},"gas_fee":{"type":"object","description":"Blockchain gas fee details","properties":{"value":{"type":"string","description":"Gas fee value","example":"0.0045"},"asset":{"type":"string","description":"Asset used to pay gas fee","example":"ETH"}}}}}},"components/schemas/FedwireSourcePaymentMethod":{"id":"components/schemas/FedwireSourcePaymentMethod","kind":"json-schema","title":"FedwireSourcePaymentMethod","data":{"type":"object","description":"Fedwire source payment method for USD wire transfers","required":["type","account_number","routing_number"],"properties":{"type":{"type":"string","enum":["FEDWIRE"],"description":"Discriminator: indicates Fedwire payment method"},"account_number":{"type":"string","description":"Source bank account number","example":"XXXX7890"},"routing_number":{"type":"string","description":"ABA routing number","example":"021000021"},"swift_code":{"type":"string","description":"SWIFT/BIC code for international transfers","example":"CHASUS33"},"memo":{"type":"string","description":"Reference memo included with the transfer","example":"Payment for invoice INV-2024-001"}}}},"components/schemas/AchSourcePaymentMethod":{"id":"components/schemas/AchSourcePaymentMethod","kind":"json-schema","title":"AchSourcePaymentMethod","data":{"type":"object","description":"ACH source payment method for USD domestic transfers","required":["type","account_number","routing_number"],"properties":{"type":{"type":"string","enum":["ACH"],"description":"Discriminator: indicates ACH payment method"},"account_number":{"type":"string","description":"Source bank account number","example":"XXXX7890"},"routing_number":{"type":"string","description":"ABA routing number","example":"021000021"},"swift_code":{"type":"string","description":"SWIFT/BIC code (optional for ACH)","example":"CHASUS33"},"memo":{"type":"string","description":"Reference memo included with the transfer","example":"Payment for invoice INV-2024-001"}}}},"components/schemas/RtpSourcePaymentMethod":{"id":"components/schemas/RtpSourcePaymentMethod","kind":"json-schema","title":"RtpSourcePaymentMethod","data":{"type":"object","description":"RTP (Real-Time Payments) source payment method for instant USD transfers","required":["type","account_number","routing_number"],"properties":{"type":{"type":"string","enum":["RTP"],"description":"Discriminator: indicates RTP payment method"},"account_number":{"type":"string","description":"Source bank account number","example":"XXXX7890"},"routing_number":{"type":"string","description":"ABA routing number","example":"021000021"},"swift_code":{"type":"string","description":"SWIFT/BIC code (optional for RTP)","example":"CHASUS33"},"memo":{"type":"string","description":"Reference memo included with the transfer","example":"Payment for invoice INV-2024-001"}}}},"components/schemas/PixSourcePaymentMethod":{"id":"components/schemas/PixSourcePaymentMethod","kind":"json-schema","title":"PixSourcePaymentMethod","data":{"type":"object","description":"PIX source payment method for instant BRL transfers in Brazil","required":["type","pix_key","pix_key_type"],"properties":{"type":{"type":"string","enum":["PIX"],"description":"Discriminator: indicates PIX payment method"},"pix_key":{"type":"string","description":"PIX key used for the payment","example":"12345678901"},"pix_key_type":{"type":"string","description":"Type of PIX key","enum":["CPF","CNPJ","EMAIL","PHONE","RANDOM"],"example":"CPF"},"sender_name":{"type":"string","description":"Name of the sender as registered with PIX","example":"João Silva"}}}},"components/schemas/CreateAccountRequest":{"id":"components/schemas/CreateAccountRequest","kind":"json-schema","title":"CreateAccountRequest","data":{"type":"object","description":"Request payload for creating a new account","required":["beneficiary_id","currency"],"properties":{"beneficiary_id":{"type":"string","format":"uuid","description":"Unique identifier of the beneficiary partner who will own this account","example":"291ecf34-a01d-466a-b0fd-662a88b7a1bb"},"currency":{"type":"string","description":"Currency for the account. The currency determines the account type and the payment rails provisioned: crypto currencies (RLUSD, USDC, USDT) create a CRYPTO account on the BLOCKCHAIN rail, USD creates a FIAT account on FEDWIRE/ACH/RTP, and BRL creates a FIAT account on PIX.\n","example":"USD"}}}},"components/schemas/Account":{"id":"components/schemas/Account","kind":"json-schema","title":"Account","data":{"type":"object","description":"Account for receiving payments with associated rails","required":["id","account_owner_id","currency","type","rails","balances","ownership_level","status","created_at","updated_at"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the account","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"account_owner_id":{"type":"string","format":"uuid","description":"Unique identifier of the account owner can be customer or partner","example":"291ecf34-a01d-466a-b0fd-662a88b7a1bb"},"beneficiary":{"type":"object","description":"The beneficiary this account belongs to, including their name so you don't need a separate lookup to display it","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the beneficiary","example":"291ecf34-a01d-466a-b0fd-662a88b7a1bb"},"name":{"type":"string","description":"Name of the beneficiary","example":"Hong Kong Exports Ltd."},"email":{"type":"string","description":"Email address of the beneficiary, if available","example":"hongkong@exports.com"}}},"customer_id":{"type":"string","format":"uuid","description":"The customer this account belongs to","example":"87a6b830-1bbe-409c-9bff-9cf12bed774f"},"currency":{"type":"string","description":"Currency for the account","example":"USD"},"type":{"$ref":"#/components/schemas/AccountType"},"rails":{"type":"array","description":"Available payment rail types for this account","items":{"$ref":"#/components/schemas/RailType"}},"balances":{"type":"object","description":"Account balance information","required":["available","pending"],"properties":{"account_id":{"type":"string","format":"uuid","description":"Identifier of the account these balances belong to","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"available":{"type":"object","description":"Available balance that can be withdrawn or used","required":["amount"],"properties":{"amount":{"type":"string","description":"Available balance amount as a string to preserve precision","example":"1250.50"}}},"pending":{"type":"object","description":"Pending balance information","required":["inbound","outbound"],"properties":{"inbound":{"type":"object","description":"Pending inbound balance","required":["amount"],"properties":{"amount":{"type":"string","description":"Pending inbound amount as a string to preserve precision","example":"50.00"}}},"outbound":{"type":"object","description":"Pending outbound balance","required":["amount"],"properties":{"amount":{"type":"string","description":"Pending outbound amount as a string to preserve precision","example":"25.00"}}}}},"updated_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when these balances were last updated","example":"2025-09-18T22:54:00.542Z"}}},"ownership_level":{"type":"string","description":"Indicates whether this account is owned at the partner or customer level","enum":["PARTNER","CUSTOMER"],"x-enum-descriptions":{"PARTNER":"Account owned by a specific partner (beneficiary). Funds in this account are moved to a customer-level accounts for the same currency.","CUSTOMER":"Account owned at the customer level. Eligible for settlement and receiving funds from partner accounts."},"example":"PARTNER"},"status":{"$ref":"#/components/schemas/AccountStatus"},"created_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the account was created","example":"2025-09-18T22:54:00.542Z"},"updated_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the account was last updated","example":"2025-09-18T22:54:00.542Z"}}}},"components/schemas/TransactionV1":{"id":"components/schemas/TransactionV1","kind":"json-schema","title":"TransactionV1","data":{"type":"object","description":"Transaction details","required":["id","parent_id","account_id","payer","beneficiary","payment_amount","account_equivalent","market_rate","exchange_rate","source_payment_method","status","transaction_processed_date","date_created","date_confirmed"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the transaction","example":"487ba009-56cf-4ad9-8b5c-045e27893e00"},"parent_id":{"type":"string","format":"uuid","description":"Identifier of the channel this transaction was received through","example":"e8d43598-107d-4694-9fb2-934e7484c3d4"},"account_id":{"type":"string","format":"uuid","description":"Identifier of the account associated with this transaction","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"settlement_id":{"type":"string","format":"uuid","nullable":true,"description":"Identifier of the settlement this transaction was included in, if any","example":"63dd59dd-88be-41a2-a246-2f6724209422"},"payer":{"type":"object","description":"Payer partner details","required":["id","name","email"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the payer partner","example":"0c5479ff-3772-4123-b2b7-e679e71eb570"},"name":{"type":"string","description":"Full name of the payer partner","example":"Nigerian Imports Ltd."},"email":{"type":"string","description":"Email address of the payer partner","format":"email","example":"nigerian@imports.com"}}},"beneficiary":{"type":"object","description":"Beneficiary partner details","required":["id","name","email"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the beneficiary partner","example":"01467076-8bb0-41c1-ad54-5751dd4a9e80"},"name":{"type":"string","description":"Full name of the beneficiary partner","example":"Hong Kong Exports Ltd."},"email":{"type":"string","description":"Email address of the beneficiary partner","format":"email","example":"hongkong@exports.com"}}},"payment_amount":{"type":"object","description":"Payment amount and asset","required":["value","asset"],"properties":{"value":{"type":"string","description":"Payment amount as a string to preserve precision","example":"50.00000000"},"asset":{"type":"string","description":"Asset symbol of the payment","example":"USDT"}}},"account_equivalent":{"type":"object","description":"Account equivalent amounts for payment, fee, and net (converted to account's native currency)","required":["gross_amount","fee_amount","net_amount"],"properties":{"gross_amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","description":"Gross amount in account currency","example":"50.00"},"currency":{"type":"string","description":"Account currency code","example":"USD"}}},"fee_amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","description":"Fee amount in account currency","example":"0.50"},"currency":{"type":"string","description":"Account currency code","example":"USD"}}},"net_amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","description":"Net amount in account currency","example":"49.50"},"currency":{"type":"string","description":"Account currency code","example":"USD"}}}}},"market_rate":{"type":"object","description":"Market rate reference for the transaction","properties":{"base":{"type":"string","description":"Base currency for the exchange rate","example":"USDT"},"counter":{"type":"string","description":"Counter currency for the exchange rate","example":"USD"},"rate":{"type":"string","description":"Exchange rate from base to counter currency","example":"1.00"}}},"exchange_rate":{"type":"object","description":"Exchange rate applied on the transaction","properties":{"base":{"type":"string","description":"Base currency for the exchange rate","example":"USDT"},"counter":{"type":"string","description":"Counter currency for the exchange rate","example":"USD"},"rate":{"type":"string","description":"Exchange rate from base to counter currency","example":"0.99"}}},"source_payment_method":{"$ref":"#/components/schemas/SourcePaymentMethod"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"reason":{"type":"string","nullable":true,"description":"Reason for current status (if applicable)","example":null},"transaction_processed_date":{"type":"string","format":"date-time","description":"ISO 8601 timestamp of the transaction","example":"2025-06-17T12:20:00Z"},"date_created":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when transaction was created","example":"2025-09-18T22:54:00.542Z"},"date_confirmed":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when transaction was confirmed","example":"2025-09-18T22:54:00.542Z"}}}},"components/schemas/TransactionStatus":{"id":"components/schemas/TransactionStatus","kind":"json-schema","title":"TransactionStatus","data":{"type":"string","description":"Transaction status","enum":["COMPLETED","FAILED_KYT","FAILED","HOLD_KYT","REFUNDED_KYT","PROCESSING","IGNORED"],"x-enum-descriptions":{"COMPLETED":"Funds have been successfully converted into the desired currency","HOLD_KYT":"Funds have been held for our KYT checks","FAILED_KYT":"Funds have failed our KYT checks","REFUNDED_KYT":"Funds have been refunded based on our kyt checks","PROCESSING":"Funds are settled and being processed in our system","FAILED":"Funds have failed transaction processing and will not be settled","IGNORED":"Funds were below the dust threshold and were not processed"},"example":"COMPLETED"}},"components/schemas/SettlementType":{"id":"components/schemas/SettlementType","kind":"json-schema","title":"SettlementType","data":{"type":"string","description":"Settlement type","enum":["FIAT","CRYPTO"],"x-enum-descriptions":{"FIAT":"Settlement of fiat currency","CRYPTO":"Settlement of crypto currency"},"example":"FIAT"}},"components/schemas/SettlementStatus":{"id":"components/schemas/SettlementStatus","kind":"json-schema","title":"SettlementStatus","data":{"type":"string","description":"Settlement status","enum":["PENDING","PROCESSING","COMPLETED","FAILED","CANCELLED"],"x-enum-descriptions":{"PENDING":"Settlement is pending","PROCESSING":"Settlement is being processed","COMPLETED":"Settlement has been completed","FAILED":"Settlement has failed","CANCELLED":"Settlement has been cancelled"},"example":"PENDING"}},"components/schemas/CreateSettlementRequestV1":{"id":"components/schemas/CreateSettlementRequestV1","kind":"json-schema","title":"CreateSettlementRequestV1","data":{"type":"object","description":"Request to create a new settlement. The caller supplies only the source account; the\nserver settles all unsettled trades for that account, grouped by counter currency, and\nderives the amount/currency/payout destination server-side.\n","required":["source_account_id"],"properties":{"source_account_id":{"type":"string","format":"uuid","description":"Source account to draw funds from. Must be CUSTOMER-owned and ACTIVE.","example":"b2c3d4e5-f6a7-8901-bcde-f12345678901"}}}},"components/schemas/SettlementV1":{"id":"components/schemas/SettlementV1","kind":"json-schema","title":"SettlementV1","data":{"type":"object","description":"Complete settlement information","required":["id","source_account_id","currency","gross_amount","settlement_amount","fees","status","data","created_at","updated_at"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the settlement","example":"63dd59dd-88be-41a2-a246-2f6724209422"},"source_account_id":{"type":"string","format":"uuid","description":"Source account the settlement was drawn from","example":"b2c3d4e5-f6a7-8901-bcde-f12345678901"},"currency":{"type":"string","description":"Currency code for the settlement","example":"USD"},"gross_amount":{"type":"string","description":"Total settlement amount before fees","example":"50.00"},"settlement_amount":{"type":"string","description":"Net settlement amount after fees","example":"49.50"},"fees":{"type":"object","description":"Fees applied to the settlement","required":["transaction_fees"],"properties":{"transaction_fees":{"type":"string","description":"Total transaction fees applied to the settlement, as a string to preserve precision","example":"0.50"}}},"status":{"$ref":"#/components/schemas/SettlementStatus"},"data":{"$ref":"#/components/schemas/SettlementDataV1"},"created_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the settlement was created","example":"2025-09-18T22:54:00.542Z"},"updated_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the settlement was last updated","example":"2025-09-18T22:54:00.542Z"}},"example":{"id":"63dd59dd-88be-41a2-a246-2f6724209422","source_account_id":"c3d4e5f6-a7b8-9012-cdef-234567890123","currency":"USD","gross_amount":"50.00","settlement_amount":"49.50","fees":{"transaction_fees":"0.50"},"status":"COMPLETED","data":{"transaction_reference_numbers":["ABC12345"],"payout_destination":{"type":"FEDWIRE","account_name":"Finance Corp","account_number":"XXXX7890","routing_number":"021000021","swift_code":"CHASUS33","institution_name":"Bank of America","reference":"INV-2024-001"}},"created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"}}},"components/schemas/SettlementDataV1":{"id":"components/schemas/SettlementDataV1","kind":"json-schema","title":"SettlementDataV1","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement execution data — carries the bank transaction reference numbers (fiat) or the on-chain transaction hash (crypto), plus the configured payout destination."},"children":[]}]}]}],"required":["payout_destination"],"properties":{"transaction_reference_numbers":{"type":"array","items":{"type":"string"},"description":"Bank transaction reference numbers; populated for fiat settlements after completion","example":["ABC12345"]},"transaction_hash":{"type":"string","description":"On-chain transaction hash; populated for crypto settlements after completion","example":"0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF"},"payout_destination":{"$ref":"#/components/schemas/PayoutDestination"}}}},"components/schemas/PayoutDestination":{"id":"components/schemas/PayoutDestination","kind":"json-schema","title":"PayoutDestination","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configured payout destination for a settlement, discriminated by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the payment rail)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fiat settlements use FEDWIRE / ACH / RTP / PIX; crypto settlements use BLOCKCHAIN."},"children":[]}]}]}],"discriminator":{"propertyName":"type","mapping":{"BLOCKCHAIN":"#/components/schemas/BlockchainPayoutDestination","FEDWIRE":"#/components/schemas/FedwirePayoutDestination","ACH":"#/components/schemas/AchPayoutDestination","RTP":"#/components/schemas/RtpPayoutDestination","PIX":"#/components/schemas/PixPayoutDestination"}},"oneOf":[{"$ref":"#/components/schemas/FedwirePayoutDestination"},{"$ref":"#/components/schemas/AchPayoutDestination"},{"$ref":"#/components/schemas/RtpPayoutDestination"},{"$ref":"#/components/schemas/PixPayoutDestination"},{"$ref":"#/components/schemas/BlockchainPayoutDestination"}]}},"components/schemas/FedwirePayoutDestination":{"id":"components/schemas/FedwirePayoutDestination","kind":"json-schema","title":"FedwirePayoutDestination","data":{"type":"object","description":"Fedwire payout destination for USD wire payouts","required":["type","account_number","routing_number"],"properties":{"type":{"type":"string","enum":["FEDWIRE"],"description":"Discriminator: indicates Fedwire payout"},"account_name":{"type":"string","description":"Name on the destination bank account (the Ripple customer receiving the settlement)","example":"Finance Corp"},"account_number":{"type":"string","description":"Destination bank account number (obfuscated; only the last four digits are shown)","example":"XXXX7890"},"routing_number":{"type":"string","description":"ABA routing number","example":"021000021"},"swift_code":{"type":"string","description":"SWIFT/BIC code for international payouts","example":"CHASUS33"},"institution_name":{"type":"string","description":"Name of the receiving financial institution","example":"Bank of America"},"reference":{"type":"string","description":"Reference to include with the payout","example":"INV-2024-001"}}}},"components/schemas/AchPayoutDestination":{"id":"components/schemas/AchPayoutDestination","kind":"json-schema","title":"AchPayoutDestination","data":{"type":"object","description":"ACH payout destination for USD domestic payouts","required":["type","account_number","routing_number"],"properties":{"type":{"type":"string","enum":["ACH"],"description":"Discriminator: indicates ACH payout"},"account_name":{"type":"string","description":"Name on the destination bank account (the Ripple customer receiving the settlement)","example":"Finance Corp"},"account_number":{"type":"string","description":"Destination bank account number (obfuscated; only the last four digits are shown)","example":"XXXX7890"},"routing_number":{"type":"string","description":"ABA routing number","example":"021000021"},"institution_name":{"type":"string","description":"Name of the receiving financial institution","example":"Bank of America"},"reference":{"type":"string","description":"Reference to include with the payout","example":"INV-2024-001"}}}},"components/schemas/RtpPayoutDestination":{"id":"components/schemas/RtpPayoutDestination","kind":"json-schema","title":"RtpPayoutDestination","data":{"type":"object","description":"RTP (Real-Time Payments) payout destination for instant USD payouts","required":["type","account_number","routing_number"],"properties":{"type":{"type":"string","enum":["RTP"],"description":"Discriminator: indicates RTP payout"},"account_name":{"type":"string","description":"Name on the destination bank account (the Ripple customer receiving the settlement)","example":"Finance Corp"},"account_number":{"type":"string","description":"Destination bank account number (obfuscated; only the last four digits are shown)","example":"XXXX7890"},"routing_number":{"type":"string","description":"ABA routing number","example":"021000021"},"institution_name":{"type":"string","description":"Name of the receiving financial institution","example":"Bank of America"},"reference":{"type":"string","description":"Reference to include with the payout","example":"INV-2024-001"}}}},"components/schemas/PixPayoutDestination":{"id":"components/schemas/PixPayoutDestination","kind":"json-schema","title":"PixPayoutDestination","data":{"type":"object","description":"PIX payout destination for instant BRL payouts in Brazil","required":["type","pix_key","pix_key_type"],"properties":{"type":{"type":"string","enum":["PIX"],"description":"Discriminator: indicates PIX payout"},"pix_key":{"type":"string","description":"PIX key for the payout (obfuscated; only the last four characters are shown)","example":"XXXX8901"},"pix_key_type":{"type":"string","description":"Type of PIX key","enum":["CPF","CNPJ","EMAIL","PHONE","RANDOM"],"example":"CPF"},"beneficiary_name":{"type":"string","description":"Name of the account holder as registered with PIX (the Ripple customer receiving the settlement)","example":"Finance Corp"}}}},"components/schemas/BlockchainPayoutDestination":{"id":"components/schemas/BlockchainPayoutDestination","kind":"json-schema","title":"BlockchainPayoutDestination","data":{"type":"object","description":"Blockchain payout destination for crypto payouts","required":["type","network","address"],"properties":{"type":{"type":"string","enum":["BLOCKCHAIN"],"description":"Discriminator: indicates blockchain payout"},"network":{"$ref":"#/components/schemas/Network"},"address":{"type":"string","description":"Destination blockchain wallet address","example":"rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh"},"currency":{"type":"string","description":"Cryptocurrency asset symbol","example":"RLUSD"},"destination_tag":{"type":"string","description":"Optional destination tag/memo for networks that require one (e.g. XRPL)","example":"12345"}}}},"components/schemas/ChannelStatus":{"id":"components/schemas/ChannelStatus","kind":"json-schema","title":"ChannelStatus","data":{"type":"string","description":"Status of the channel","enum":["ACTIVE","INACTIVE","CLOSED"],"x-enum-descriptions":{"ACTIVE":"Channel is active","INACTIVE":"Channel is inactive","CLOSED":"Channel is closed"},"example":"ACTIVE"}},"components/schemas/CreateChannelRequestV1":{"id":"components/schemas/CreateChannelRequestV1","kind":"json-schema","title":"CreateChannelRequestV1","data":{"type":"object","description":"Request payload for creating a new channel using account-based routing","required":["payer_id","account_id","payment_currencies"],"properties":{"payer_id":{"type":"string","format":"uuid","description":"Unique identifier of the payer partner","example":"e471b938-98ad-45e4-b144-53a556ea047d"},"account_id":{"type":"string","format":"uuid","description":"Unique identifier of the account to receive funds","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"payment_currencies":{"type":"array","description":"List of currencies accepted for payment on this channel.","minItems":1,"items":{"type":"object","required":["currency"],"properties":{"currency":{"type":"string","description":"Currency code (uppercase letters, 3-10 characters)","pattern":"^[A-Z]{3,10}$","example":"RLUSD"}}},"example":[{"currency":"RLUSD"}]}}}},"components/schemas/ChannelV1":{"id":"components/schemas/ChannelV1","kind":"json-schema","title":"ChannelV1","data":{"type":"object","description":"Channel information with account-based routing","required":["id","payer","beneficiary","account","payment_methods","payment_link","status","created_at","updated_at"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the channel","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"payer":{"type":"object","description":"Payer partner details","required":["id","name","email"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the payer partner","example":"e471b938-98ad-45e4-b144-53a556ea047d"},"name":{"type":"string","description":"Full name of the payer partner","example":"Nigerian Imports Ltd."},"email":{"type":"string","format":"email","description":"Email address of the payer partner","example":"nigerian@imports.com"}}},"beneficiary":{"type":"object","description":"Beneficiary partner details","required":["id","name","email"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the beneficiary partner","example":"01467076-8bb0-41c1-ad54-5751dd4a9e80"},"name":{"type":"string","description":"Full name of the beneficiary partner","example":"Hong Kong Exports Ltd."},"email":{"type":"string","description":"Email address of the beneficiary partner","format":"email","example":"hongkong@exports.com"}}},"account":{"type":"object","description":"Account associated to this channel, which funds will be routed to","required":["id","beneficiary_id","currency","type"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the account","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"beneficiary_id":{"type":"string","format":"uuid","description":"Unique identifier of the beneficiary partner","example":"291ecf34-a01d-466a-b0fd-662a88b7a1bb"},"currency":{"type":"string","description":"Currency for the account","example":"USD"},"type":{"type":"string","description":"Type of account","enum":["FIAT","CRYPTO"],"example":"FIAT"}}},"payment_methods":{"type":"array","description":"Available payment methods with full deposit instructions","items":{"$ref":"#/components/schemas/Rail"}},"payment_link":{"type":"string","format":"uri","description":"URL for payer UI to access this channel","example":"https://collections.ripplenet.com/pay/channel/3fa85f64-5717-4562-b3fc-2c963f66afa6"},"status":{"$ref":"#/components/schemas/ChannelStatus"},"reason":{"type":"string","nullable":true,"description":"Reason for current status (if applicable)","example":null},"created_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the channel was created","example":"2025-09-18T22:54:00.542Z"},"updated_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the channel was last updated","example":"2025-09-18T22:54:00.542Z"}}}},"components/schemas/Network":{"id":"components/schemas/Network","kind":"json-schema","title":"Network","data":{"type":"string","description":"Supported blockchain networks","enum":["ETHEREUM","ETHEREUM_SEPOLIA_TESTNET","SOLANA","SOLANA_TESTNET","XRPL","XRPL_TESTNET"],"example":"XRPL"}},"components/schemas/EventType":{"id":"components/schemas/EventType","kind":"json-schema","title":"EventType","data":{"type":"string","description":"Event type for which a webhook can be created.","enum":["WEBHOOK_CREATED","WEBHOOK_UPDATED","WEBHOOK_DELETED","TRANSACTION_STATUS_CHANGED","PARTNER_STATUS_CHANGED","WALLET_ADDRESS_CREATED","WALLET_ADDRESS_ROTATED","SETTLEMENT_INITIATED","SETTLEMENT_COMPLETED","SETTLEMENT_FAILED","CHANNEL_CREATED","CHANNEL_ARCHIVED","TRANSFER_STATUS_CHANGED","ACCOUNT_CREATED","ACCOUNT_STATUS_CHANGED","ACCOUNT_BALANCE_UPDATED"],"x-enum-descriptions":{"WEBHOOK_CREATED":"Fired when a new webhook subscription is created","WEBHOOK_UPDATED":"Fired when a webhook subscription is updated","WEBHOOK_DELETED":"Fired when a webhook subscription is deleted","TRANSACTION_STATUS_CHANGED":"Fired when a transaction status changes","PARTNER_STATUS_CHANGED":"Fired when a partner status changes","WALLET_ADDRESS_CREATED":"Fired when a new wallet address is created","WALLET_ADDRESS_ROTATED":"Fired when a wallet address is rotated","SETTLEMENT_INITIATED":"Fired when a settlement is initiated","SETTLEMENT_COMPLETED":"Fired when a settlement is completed","SETTLEMENT_FAILED":"Fired when a settlement fails","CHANNEL_CREATED":"Fired when a new channel is created","CHANNEL_ARCHIVED":"Fired when a channel is archived","TRANSFER_STATUS_CHANGED":"Fired when a transfer status changes","ACCOUNT_CREATED":"Fired when a new account is created for a beneficiary","ACCOUNT_STATUS_CHANGED":"Fired when an account status changes (e.g., ACTIVE, SUSPENDED, CLOSED)","ACCOUNT_BALANCE_UPDATED":"Fired when an account balance is updated after transactions settle"},"example":"TRANSACTION_STATUS_CHANGED"}},"components/schemas/CreateWebhookRequest":{"id":"components/schemas/CreateWebhookRequest","kind":"json-schema","title":"CreateWebhookRequest","data":{"type":"object","required":["callback_url","event_types"],"properties":{"callback_url":{"type":"string","format":"uri","description":"HTTPS URL to POST events to.","example":"https://webhook.partner.example/webhooks"},"event_types":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/EventType"}}}}},"components/schemas/WebhookResponse":{"id":"components/schemas/WebhookResponse","kind":"json-schema","title":"WebhookResponse","data":{"type":"object","required":["id","event_type","callback_url","signature_verification_key"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the webhook.","example":"5c0d9ec9-5ad8-4a43-a1b4-6f8f1f6c4c10"},"event_type":{"allOf":[{"$ref":"#/components/schemas/EventType"}],"example":"TRANSACTION_STATUS_CHANGED"},"callback_url":{"type":"string","format":"uri","description":"HTTPS URL to which events will be sent.","example":"https://webhook.partner.example/webhooks"},"signature_verification_key":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64-encoded shared secret for verifying the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Webhook-Signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header on deliveries to this webhook. Each webhook has its own key. Treat it as a credential: keep it server-side, and do not log it or expose it in client-side code. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/pt-br/products/collections/guides/verifying-webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify webhook signatures"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"SKgxrHfGiY6fpwo+yIixFzgnE+N2ZNzLcUCr9DO+YWY="}}}},"components/schemas/AuthErrorResponse":{"id":"components/schemas/AuthErrorResponse","kind":"json-schema","title":"AuthErrorResponse","data":{"description":"The response object containing the error and its description if the authentication call fails.","properties":{"error_description":{"type":"string","description":"Summary of the returned problem.","example":"Unauthorized"},"error":{"type":"string","description":"Error status.","example":"access_denied"}}}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","description":"Standard error response format","required":["code","reason"],"properties":{"code":{"type":"string","description":"Error code identifying the type of error"},"reason":{"type":"string","description":"Human-readable error message"}}}},"components/schemas/PageMetadata":{"id":"components/schemas/PageMetadata","kind":"json-schema","title":"PageMetadata","data":{"type":"object","description":"Pagination metadata.","properties":{"page":{"type":"integer","example":0},"size":{"type":"integer","example":10},"total_elements":{"type":"integer","example":100},"total_pages":{"type":"integer","example":10}},"required":["page","size","total_elements","total_pages"]}},"components/schemas/TransferStatus":{"id":"components/schemas/TransferStatus","kind":"json-schema","title":"TransferStatus","data":{"type":"string","description":"Status of the transfer","enum":["PENDING","PROCESSING","COMPLETED","EXPIRED","FAILED","CANCELLED"],"x-enum-descriptions":{"PENDING":"Transfer created, awaiting confirmation before expires_at","PROCESSING":"Confirm received; execution in progress","COMPLETED":"Terminal - funds moved successfully","EXPIRED":"Terminal - quote validity window elapsed before confirm","FAILED":"Terminal - execution or validation failure","CANCELLED":"Terminal - cancelled by the customer"},"example":"PENDING"}},"components/schemas/TransferType":{"id":"components/schemas/TransferType","kind":"json-schema","title":"TransferType","data":{"type":"string","description":"Indicates whether a transfer requires a currency trade. Used only as a list filter; not returned on the transfer object itself.","enum":["TRADE","TRANSACTION"],"x-enum-descriptions":{"TRADE":"Cross-currency transfer requiring an external trade execution","TRANSACTION":"Same-currency transfer between accounts (no trade)"},"example":"TRADE"}},"components/schemas/CreateTransferRequestV1":{"id":"components/schemas/CreateTransferRequestV1","kind":"json-schema","title":"CreateTransferRequestV1","data":{"type":"object","description":"Request payload for creating a new transfer between two accounts","required":["source_account_id","destination_account_id","amount"],"properties":{"source_account_id":{"type":"string","format":"uuid","description":"Unique identifier of the account to move funds from","example":"b2c3d4e5-f6a7-8901-bcde-f12345678901"},"destination_account_id":{"type":"string","format":"uuid","description":"Unique identifier of the account to move funds to","example":"250d6dc5-382f-4750-8657-0780be594d68"},"amount":{"type":"string","description":"Transfer amount, denominated in the source account's currency, as a string to preserve precision. Must be positive.","example":"1000.00"}}}},"components/schemas/TransferAccountAmountV1":{"id":"components/schemas/TransferAccountAmountV1","kind":"json-schema","title":"TransferAccountAmountV1","data":{"type":"object","description":"Account and amount moved on one side of a transfer","properties":{"account_id":{"type":"string","format":"uuid","description":"Unique identifier of the account","example":"b2c3d4e5-f6a7-8901-bcde-f12345678901"},"currency":{"type":"string","description":"Currency of the account","example":"USD"},"amount":{"type":"string","description":"Amount moved, as a string to preserve precision","example":"1000.00"}}}},"components/schemas/TransferV1":{"id":"components/schemas/TransferV1","kind":"json-schema","title":"TransferV1","data":{"type":"object","description":"Transfer information","required":["id","status","source","destination","market_rate","exchange_rate","fees","expires_at","created_at","updated_at"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the transfer","example":"6f3e9c2a-1b4d-47f0-9e3a-2c6b8d1f5a7e"},"status":{"$ref":"#/components/schemas/TransferStatus"},"source":{"$ref":"#/components/schemas/TransferAccountAmountV1"},"destination":{"$ref":"#/components/schemas/TransferAccountAmountV1"},"market_rate":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Market exchange rate at the time the transfer's quote was created. Base=counter=1 for same-currency transfers."},"children":[]}]}]}],"properties":{"base":{"type":"string","example":"USD"},"counter":{"type":"string","example":"BRL"},"rate":{"type":"string","description":"Market rate as a string to preserve precision","example":"5.25"}}},"exchange_rate":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quoted exchange rate applied to this transfer, including spread. Base=counter=1 for same-currency transfers."},"children":[]}]}]}],"properties":{"base":{"type":"string","example":"USD"},"counter":{"type":"string","example":"BRL"},"rate":{"type":"string","description":"Quoted rate as a string to preserve precision","example":"5.20"}}},"fees":{"type":"object","description":"Fees charged on this transfer","properties":{"transaction_fee":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Spread between market_rate and exchange_rate, applied to the source amount. Zero for same-currency transfers."},"children":[]}]}]}],"properties":{"amount":{"type":"string","example":"50.00"},"currency":{"type":"string","description":"Currency the fee is denominated in (always the destination currency)","example":"BRL"}}}}},"reason":{"type":"string","nullable":true,"description":"Reason for the current status, populated on terminal FAILED status (if applicable)","example":null},"expires_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp after which a PENDING transfer can no longer be confirmed","example":"2025-09-18T23:09:00.542Z"},"created_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the transfer was created","example":"2025-09-18T22:54:00.542Z"},"updated_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the transfer was last updated","example":"2025-09-18T22:54:00.542Z"}}}},"components/schemas/ConfirmTransferResponseV1":{"id":"components/schemas/ConfirmTransferResponseV1","kind":"json-schema","title":"ConfirmTransferResponseV1","data":{"type":"object","description":"Transfer information returned after a confirm request","required":["id","status","source","destination","market_rate","exchange_rate","fees","expires_at","created_at","updated_at"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the transfer","example":"6f3e9c2a-1b4d-47f0-9e3a-2c6b8d1f5a7e"},"status":{"$ref":"#/components/schemas/TransferStatus"},"source":{"$ref":"#/components/schemas/TransferAccountAmountV1"},"destination":{"$ref":"#/components/schemas/TransferAccountAmountV1"},"market_rate":{"type":"object","properties":{"base":{"type":"string","example":"USD"},"counter":{"type":"string","example":"BRL"},"rate":{"type":"string","example":"5.25"}}},"exchange_rate":{"type":"object","properties":{"base":{"type":"string","example":"USD"},"counter":{"type":"string","example":"BRL"},"rate":{"type":"string","example":"5.20"}}},"fees":{"type":"object","properties":{"transaction_fee":{"type":"object","properties":{"amount":{"type":"string","example":"50.00"},"currency":{"type":"string","example":"BRL"}}}}},"reason":{"type":"string","nullable":true,"example":null},"expires_at":{"type":"string","format":"date-time","example":"2025-09-18T23:09:00.542Z"},"created_at":{"type":"string","format":"date-time","example":"2025-09-18T22:54:00.542Z"},"updated_at":{"type":"string","format":"date-time","example":"2025-09-18T22:55:00.542Z"}}}},"schema_0":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ValidateTokenResponse"},"type":"array"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"string","enum":["PARTNER","CUSTOMER"]},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"integer","minimum":0,"default":0},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"integer","minimum":1,"default":10},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"string","default":"CREATED_AT","enum":["CREATED_AT","UPDATED_AT","STATUS","CURRENCY"]},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"string","default":"desc","enum":["asc","desc"]},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Account"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ChannelStatus"},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"string","default":"CREATED_AT","enum":["CREATED_AT","UPDATED_AT","STATUS","PAYER_NAME","PAYER_EMAIL","BENEFICIARY_NAME","BENEFICIARY_EMAIL"]},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/ChannelV1"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"string","$ref":"#/components/schemas/PartnerType"},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"string","$ref":"#/components/schemas/PartnerStatus"},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"string","description":"External reference id for partner"},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"string","default":"CREATED_AT","enum":["CREATED_AT","UPDATED_AT"]},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/PartnerV1"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"0c5479ff-3772-4123-b2b7-e679e71eb570"},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"$ref":"#/components/schemas/SettlementType"},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"$ref":"#/components/schemas/SettlementStatus"},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100,"default":10},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/SettlementV1"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"63dd59dd-88be-41a2-a246-2f6724209422"},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"$ref":"#/components/schemas/TransactionStatus"},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":"string","$ref":"#/components/schemas/Network"},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"type":"string","default":"CREATED_AT","enum":["TRANSACTION_DATE","CREATED_AT","STATUS"]},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/TransactionV1"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"487ba009-56cf-4ad9-8b5c-045e27893e00"},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"type":"string","$ref":"#/components/schemas/EventType"},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/WebhookResponse"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/WebhookResponse"}},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"5c0d9ec9-5ad8-4a43-a1b4-6f8f1f6c4c10"},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"$ref":"#/components/schemas/TransferStatus"},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"$ref":"#/components/schemas/TransferType"},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":"string","default":"CREATED_AT","enum":["CREATED_AT","UPDATED_AT","STATUS","TYPE","EXPIRES_AT"]},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/TransferV1"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"6f3e9c2a-1b4d-47f0-9e3a-2c6b8d1f5a7e"},"id":"schema_39"}},"exampleStore":{"paths/~1v2~1oauth~1token/post/responses/400/content/application~1json/example":{"value":{"error_description":"Missing required parameter: grant_type","error":"invalid_request"},"id":"paths/~1v2~1oauth~1token/post/responses/400/content/application~1json/example"},"paths/~1v2~1oauth~1token/post/responses/401/content/application~1json/example":{"value":{"error_description":"Unauthorized","error":"access_denied"},"id":"paths/~1v2~1oauth~1token/post/responses/401/content/application~1json/example"},"paths/~1v2~1oauth~1token/post/responses/403/content/application~1json/example":{"value":{"error_description":"Service not enabled within domain: <wrong:domain>"},"id":"paths/~1v2~1oauth~1token/post/responses/403/content/application~1json/example"},"paths/~1v2~1oauth~1token~1test/get/responses/400/content/text~1plain/example":{"value":"Invalid Request parameters [Invalid bearer authentication token]","id":"paths/~1v2~1oauth~1token~1test/get/responses/400/content/text~1plain/example"},"paths/~1v1~1collections~1accounts/get/responses/200/content/application~1json/examples/default":{"value":{"content":[{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","account_owner_id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","beneficiary":{"id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","name":"Hong Kong Exports Ltd.","email":"hongkong@exports.com"},"customer_id":"87a6b830-1bbe-409c-9bff-9cf12bed774f","currency":"USD","type":"FIAT","rails":["FEDWIRE","ACH","RTP"],"balances":{"available":{"amount":"1250.50"},"pending":{"inbound":{"amount":"50.00"},"outbound":{"amount":"25.00"}}},"ownership_level":"PARTNER","status":"ACTIVE","created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"},{"id":"250d6dc5-382f-4750-8657-0780be594d68","account_owner_id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","beneficiary":{"id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","name":"Hong Kong Exports Ltd.","email":"hongkong@exports.com"},"customer_id":"87a6b830-1bbe-409c-9bff-9cf12bed774f","currency":"BRL","type":"FIAT","rails":["PIX"],"balances":{"available":{"amount":"0.00"},"pending":{"inbound":{"amount":"0.00"},"outbound":{"amount":"0.00"}}},"ownership_level":"PARTNER","status":"ACTIVE","created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"},{"id":"f6a7b8c9-d0e1-2345-f012-567890123456","account_owner_id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","beneficiary":{"id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","name":"Hong Kong Exports Ltd.","email":"hongkong@exports.com"},"customer_id":"87a6b830-1bbe-409c-9bff-9cf12bed774f","currency":"RLUSD","type":"CRYPTO","rails":["BLOCKCHAIN"],"balances":{"available":{"amount":"0.00"},"pending":{"inbound":{"amount":"0.00"},"outbound":{"amount":"0.00"}}},"ownership_level":"PARTNER","status":"ACTIVE","created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"},{"id":"c3d4e5f6-a7b8-9012-cdef-234567890123","account_owner_id":"87a6b830-1bbe-409c-9bff-9cf12bed774f","currency":"USD","type":"FIAT","rails":["FEDWIRE","ACH","RTP"],"balances":{"available":{"amount":"0.00"},"pending":{"inbound":{"amount":"0.00"},"outbound":{"amount":"0.00"}}},"ownership_level":"CUSTOMER","status":"ACTIVE","created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"},{"id":"d4e5f6a7-b8c9-0123-def0-345678901234","account_owner_id":"87a6b830-1bbe-409c-9bff-9cf12bed774f","currency":"BRL","type":"FIAT","rails":["PIX"],"balances":{"available":{"amount":"0.00"},"pending":{"inbound":{"amount":"0.00"},"outbound":{"amount":"0.00"}}},"ownership_level":"CUSTOMER","status":"ACTIVE","created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"},{"id":"e5f6a7b8-c9d0-1234-ef01-456789012345","account_owner_id":"87a6b830-1bbe-409c-9bff-9cf12bed774f","currency":"RLUSD","type":"CRYPTO","rails":["BLOCKCHAIN"],"balances":{"available":{"amount":"0.00"},"pending":{"inbound":{"amount":"0.00"},"outbound":{"amount":"0.00"}}},"ownership_level":"CUSTOMER","status":"ACTIVE","created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"}],"page":{"page":0,"size":10,"total_elements":6,"total_pages":1}},"key":"default","summary":"Example account list response","id":"paths/~1v1~1collections~1accounts/get/responses/200/content/application~1json/examples/default"},"paths/~1v1~1collections~1accounts/post/requestBody/content/application~1json/examples/crypto_account":{"value":{"beneficiary_id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","currency":"RLUSD"},"key":"crypto_account","summary":"Example crypto account creation","id":"paths/~1v1~1collections~1accounts/post/requestBody/content/application~1json/examples/crypto_account"},"paths/~1v1~1collections~1accounts/post/requestBody/content/application~1json/examples/usd_fiat_account":{"value":{"beneficiary_id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","currency":"USD"},"key":"usd_fiat_account","summary":"Example USD fiat account creation","id":"paths/~1v1~1collections~1accounts/post/requestBody/content/application~1json/examples/usd_fiat_account"},"paths/~1v1~1collections~1accounts/post/requestBody/content/application~1json/examples/brl_fiat_account":{"value":{"beneficiary_id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","currency":"BRL"},"key":"brl_fiat_account","summary":"Example BRL fiat account creation","id":"paths/~1v1~1collections~1accounts/post/requestBody/content/application~1json/examples/brl_fiat_account"},"paths/~1v1~1collections~1accounts/post/responses/201/content/application~1json/examples/crypto_account":{"value":{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","account_owner_id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","beneficiary":{"id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","name":"Hong Kong Exports Ltd.","email":"hongkong@exports.com"},"customer_id":"87a6b830-1bbe-409c-9bff-9cf12bed774f","currency":"RLUSD","type":"CRYPTO","rails":["BLOCKCHAIN"],"balances":{"available":{"amount":"0.00"},"pending":{"inbound":{"amount":"0.00"},"outbound":{"amount":"0.00"}}},"ownership_level":"PARTNER","status":"ACTIVE","created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"},"key":"crypto_account","summary":"Example crypto account response","id":"paths/~1v1~1collections~1accounts/post/responses/201/content/application~1json/examples/crypto_account"},"paths/~1v1~1collections~1accounts/post/responses/201/content/application~1json/examples/usd_fiat_account":{"value":{"id":"b2c3d4e5-f6a7-8901-bcde-f12345678901","account_owner_id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","beneficiary":{"id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","name":"Hong Kong Exports Ltd.","email":"hongkong@exports.com"},"customer_id":"87a6b830-1bbe-409c-9bff-9cf12bed774f","currency":"USD","type":"FIAT","rails":["FEDWIRE","ACH","RTP"],"balances":{"available":{"amount":"0.00"},"pending":{"inbound":{"amount":"0.00"},"outbound":{"amount":"0.00"}}},"ownership_level":"PARTNER","status":"ACTIVE","created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"},"key":"usd_fiat_account","summary":"Example USD fiat account response","id":"paths/~1v1~1collections~1accounts/post/responses/201/content/application~1json/examples/usd_fiat_account"},"paths/~1v1~1collections~1accounts/post/responses/201/content/application~1json/examples/brl_fiat_account":{"value":{"id":"250d6dc5-382f-4750-8657-0780be594d68","account_owner_id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","beneficiary":{"id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","name":"Hong Kong Exports Ltd.","email":"hongkong@exports.com"},"customer_id":"87a6b830-1bbe-409c-9bff-9cf12bed774f","currency":"BRL","type":"FIAT","rails":["PIX"],"balances":{"available":{"amount":"0.00"},"pending":{"inbound":{"amount":"0.00"},"outbound":{"amount":"0.00"}}},"ownership_level":"PARTNER","status":"ACTIVE","created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"},"key":"brl_fiat_account","summary":"Example BRL fiat account response","id":"paths/~1v1~1collections~1accounts/post/responses/201/content/application~1json/examples/brl_fiat_account"},"paths/~1v1~1collections~1channels/get/responses/200/content/application~1json/examples/default":{"value":{"content":[{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","payer":{"id":"e471b938-98ad-45e4-b144-53a556ea047d","name":"Nigerian Imports Ltd.","email":"nigerian@imports.com"},"beneficiary":{"id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","name":"Hong Kong Exports Ltd.","email":"hongkong@exports.com"},"account":{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","beneficiary_id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","currency":"RLUSD","type":"CRYPTO"},"payment_methods":[{"type":"BLOCKCHAIN","network":"ETHEREUM","address":"0xBb592aaaF9AcE2fbE3F735645819FA94c95a9cb5","currency":"RLUSD"}],"payment_link":"https://collections.ripplenet.com/pay/channel/3fa85f64-5717-4562-b3fc-2c963f66afa6","status":"ACTIVE","reason":null,"created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"},{"id":"cb34b0e3-d20d-4a7c-9ad7-b461d7991555","payer":{"id":"e471b938-98ad-45e4-b144-53a556ea047d","name":"Nigerian Imports Ltd.","email":"nigerian@imports.com"},"beneficiary":{"id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","name":"Hong Kong Exports Ltd.","email":"hongkong@exports.com"},"account":{"id":"b2c3d4e5-f6a7-8901-bcde-f12345678901","beneficiary_id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","currency":"USD","type":"FIAT"},"payment_methods":[{"type":"FEDWIRE","account_number":"XXXX7890","routing_number":"021000021","swift_code":"CHASUS33","memo":"CH-cb34b0e3"},{"type":"ACH","account_number":"XXXX7890","routing_number":"021000021","memo":"CH-cb34b0e3"}],"payment_link":"https://collections.ripplenet.com/pay/channel/cb34b0e3-d20d-4a7c-9ad7-b461d7991555","status":"ACTIVE","reason":null,"created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"}],"page":{"page":0,"size":10,"total_elements":2,"total_pages":1}},"key":"default","summary":"Example channel list response","id":"paths/~1v1~1collections~1channels/get/responses/200/content/application~1json/examples/default"},"paths/~1v1~1collections~1channels/post/requestBody/content/application~1json/examples/default":{"value":{"payer_id":"e471b938-98ad-45e4-b144-53a556ea047d","account_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","payment_currencies":[{"currency":"RLUSD"}]},"key":"default","summary":"Example channel creation request","id":"paths/~1v1~1collections~1channels/post/requestBody/content/application~1json/examples/default"},"paths/~1v1~1collections~1channels/post/responses/201/content/application~1json/examples/crypto_channel":{"value":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","payer":{"id":"e471b938-98ad-45e4-b144-53a556ea047d","name":"Nigerian Imports Ltd.","email":"nigerian@imports.com"},"beneficiary":{"id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","name":"Hong Kong Exports Ltd.","email":"hongkong@exports.com"},"account":{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","beneficiary_id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","currency":"RLUSD","type":"CRYPTO"},"payment_methods":[{"type":"BLOCKCHAIN","network":"ETHEREUM","address":"0xBb592aaaF9AcE2fbE3F735645819FA94c95a9cb5","currency":"RLUSD"},{"type":"BLOCKCHAIN","network":"XRPL","address":"rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh","currency":"RLUSD"}],"payment_link":"https://collections.ripplenet.com/pay/channel/3fa85f64-5717-4562-b3fc-2c963f66afa6","status":"ACTIVE","reason":null,"created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"},"key":"crypto_channel","summary":"Example crypto channel response","id":"paths/~1v1~1collections~1channels/post/responses/201/content/application~1json/examples/crypto_channel"},"paths/~1v1~1collections~1channels/post/responses/201/content/application~1json/examples/fiat_channel":{"value":{"id":"cb34b0e3-d20d-4a7c-9ad7-b461d7991555","payer":{"id":"e471b938-98ad-45e4-b144-53a556ea047d","name":"Nigerian Imports Ltd.","email":"nigerian@imports.com"},"beneficiary":{"id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","name":"Hong Kong Exports Ltd.","email":"hongkong@exports.com"},"account":{"id":"b2c3d4e5-f6a7-8901-bcde-f12345678901","beneficiary_id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","currency":"USD","type":"FIAT"},"payment_methods":[{"type":"FEDWIRE","account_number":"XXXX7890","routing_number":"021000021","swift_code":"CHASUS33","memo":"CH-cb34b0e3"},{"type":"ACH","account_number":"XXXX7890","routing_number":"021000021","memo":"CH-cb34b0e3"},{"type":"RTP","account_number":"XXXX7890","routing_number":"021000021","memo":"CH-cb34b0e3"}],"payment_link":"https://collections.ripplenet.com/pay/channel/4gb96g75-6828-5673-c4gd-3d074g77bgb7","status":"ACTIVE","reason":null,"created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"},"key":"fiat_channel","summary":"Example fiat channel response","id":"paths/~1v1~1collections~1channels/post/responses/201/content/application~1json/examples/fiat_channel"},"paths/~1v1~1collections~1channels/post/responses/201/content/application~1json/examples/brl_fiat_channel":{"value":{"id":"d45e6f7a-8b9c-0d1e-2f3a-4b5c6d7e8f9a","payer":{"id":"e471b938-98ad-45e4-b144-53a556ea047d","name":"Brazilian Imports Ltd.","email":"brazil@imports.com"},"beneficiary":{"id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","name":"Hong Kong Exports Ltd.","email":"hongkong@exports.com"},"account":{"id":"250d6dc5-382f-4750-8657-0780be594d68","beneficiary_id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","currency":"BRL","type":"FIAT"},"payment_methods":[{"type":"PIX","pix_key":"payments@hongkongexports.com","pix_key_type":"EMAIL","beneficiary_name":"Hong Kong Exports Ltd."}],"payment_link":"https://collections.ripplenet.com/pay/channel/d45e6f7a-8b9c-0d1e-2f3a-4b5c6d7e8f9a","status":"ACTIVE","reason":null,"created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"},"key":"brl_fiat_channel","summary":"Example BRL fiat channel response with PIX","id":"paths/~1v1~1collections~1channels/post/responses/201/content/application~1json/examples/brl_fiat_channel"},"paths/~1v1~1collections~1channels~1{channel_id}/get/responses/200/content/application~1json/examples/crypto_channel":{"value":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","payer":{"id":"e471b938-98ad-45e4-b144-53a556ea047d","name":"Nigerian Imports Ltd.","email":"nigerian@imports.com"},"beneficiary":{"id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","name":"Hong Kong Exports Ltd.","email":"hongkong@exports.com"},"account":{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","beneficiary_id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","currency":"RLUSD","type":"CRYPTO"},"payment_methods":[{"type":"BLOCKCHAIN","network":"ETHEREUM","address":"0xBb592aaaF9AcE2fbE3F735645819FA94c95a9cb5","currency":"RLUSD"},{"type":"BLOCKCHAIN","network":"XRPL","address":"rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh","currency":"RLUSD"}],"payment_link":"https://collections.ripplenet.com/pay/channel/3fa85f64-5717-4562-b3fc-2c963f66afa6","status":"ACTIVE","reason":null,"created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"},"key":"crypto_channel","summary":"Example crypto channel response","id":"paths/~1v1~1collections~1channels~1{channel_id}/get/responses/200/content/application~1json/examples/crypto_channel"},"paths/~1v1~1collections~1channels~1{channel_id}/get/responses/200/content/application~1json/examples/fiat_channel":{"value":{"id":"cb34b0e3-d20d-4a7c-9ad7-b461d7991555","payer":{"id":"e471b938-98ad-45e4-b144-53a556ea047d","name":"Nigerian Imports Ltd.","email":"nigerian@imports.com"},"beneficiary":{"id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","name":"Hong Kong Exports Ltd.","email":"hongkong@exports.com"},"account":{"id":"b2c3d4e5-f6a7-8901-bcde-f12345678901","beneficiary_id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","currency":"USD","type":"FIAT"},"payment_methods":[{"type":"FEDWIRE","account_number":"XXXX7890","routing_number":"021000021","swift_code":"CHASUS33","memo":"CH-cb34b0e3"},{"type":"ACH","account_number":"XXXX7890","routing_number":"021000021","memo":"CH-cb34b0e3"},{"type":"RTP","account_number":"XXXX7890","routing_number":"021000021","memo":"CH-cb34b0e3"}],"payment_link":"https://collections.ripplenet.com/pay/channel/cb34b0e3-d20d-4a7c-9ad7-b461d7991555","status":"ACTIVE","reason":null,"created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"},"key":"fiat_channel","summary":"Example fiat channel response","id":"paths/~1v1~1collections~1channels~1{channel_id}/get/responses/200/content/application~1json/examples/fiat_channel"},"paths/~1v1~1collections~1channels~1{channel_id}/get/responses/200/content/application~1json/examples/brl_fiat_channel":{"value":{"id":"d45e6f7a-8b9c-0d1e-2f3a-4b5c6d7e8f9a","payer":{"id":"e471b938-98ad-45e4-b144-53a556ea047d","name":"Brazilian Imports Ltd.","email":"brazil@imports.com"},"beneficiary":{"id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","name":"Hong Kong Exports Ltd.","email":"hongkong@exports.com"},"account":{"id":"250d6dc5-382f-4750-8657-0780be594d68","beneficiary_id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","currency":"BRL","type":"FIAT"},"payment_methods":[{"type":"PIX","pix_key":"payments@hongkongexports.com","pix_key_type":"EMAIL","beneficiary_name":"Hong Kong Exports Ltd."}],"payment_link":"https://collections.ripplenet.com/pay/channel/d45e6f7a-8b9c-0d1e-2f3a-4b5c6d7e8f9a","status":"ACTIVE","reason":null,"created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"},"key":"brl_fiat_channel","summary":"Example BRL fiat channel response with PIX","id":"paths/~1v1~1collections~1channels~1{channel_id}/get/responses/200/content/application~1json/examples/brl_fiat_channel"},"paths/~1v1~1collections~1partners/get/responses/200/content/application~1json/examples/default":{"value":{"content":[{"id":"0c5479ff-3772-4123-b2b7-e679e71eb570","name":"Nigerian Imports Ltd.","email":"nigerian@imports.com","external_reference_id":"Ref-NG-001","data":{"type":"BUSINESS","legal_entity":"Nigerian Imports Ltd.","registration_number":"RC-123456-NGR","registration_type":"AIIN","country":"NG","city":"Lagos Island","postal_code":"10010","address":"15 Marina Street","address_line_2":"Suite 200"},"status":"ACTIVATED","reason":null,"created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T23:54:00.542Z"},{"id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","name":"Hong Kong Exports Ltd.","email":"hongkong@exports.com","external_reference_id":"Ref-HK-001","data":{"type":"BUSINESS","legal_entity":"Hong Kong Exports Ltd.","registration_number":"CR-987654-HK","registration_type":"CINC","country":"HK","city":"Central","postal_code":"999077","address":"8 Connaught Road Central","address_line_2":"Level 30"},"status":"ACTIVATED","reason":null,"created_at":"2025-09-18T22:55:00.542Z","updated_at":"2025-09-18T23:55:00.542Z"}],"page":{"page":0,"size":10,"total_elements":2,"total_pages":1}},"key":"default","summary":"A payer and a beneficiary","id":"paths/~1v1~1collections~1partners/get/responses/200/content/application~1json/examples/default"},"paths/~1v1~1collections~1partners/post/requestBody/content/application~1json/examples/payer":{"value":{"name":"Nigerian Imports Ltd.","email":"nigerian@imports.com","external_reference_id":"Ref-NG-001","data":{"type":"BUSINESS","legal_entity":"Nigerian Imports Ltd.","registration_number":"RC-123456-NGR","registration_type":"AIIN","country":"NG","city":"Lagos Island","postal_code":"10010","address":"15 Marina Street","address_line_2":"Suite 200"}},"key":"payer","summary":"Payer (Nigerian Imports)","id":"paths/~1v1~1collections~1partners/post/requestBody/content/application~1json/examples/payer"},"paths/~1v1~1collections~1partners/post/requestBody/content/application~1json/examples/beneficiary":{"value":{"name":"Hong Kong Exports Ltd.","email":"hongkong@exports.com","external_reference_id":"Ref-HK-001","data":{"type":"BUSINESS","legal_entity":"Hong Kong Exports Ltd.","registration_number":"CR-987654-HK","registration_type":"CINC","country":"HK","city":"Central","postal_code":"999077","address":"8 Connaught Road Central","address_line_2":"Level 30"}},"key":"beneficiary","summary":"Beneficiary (Hong Kong Exports)","id":"paths/~1v1~1collections~1partners/post/requestBody/content/application~1json/examples/beneficiary"},"paths/~1v1~1collections~1partners/post/responses/201/content/application~1json/examples/payer":{"value":{"id":"0c5479ff-3772-4123-b2b7-e679e71eb570","name":"Nigerian Imports Ltd.","email":"nigerian@imports.com","external_reference_id":"Ref-NG-001","data":{"type":"BUSINESS","legal_entity":"Nigerian Imports Ltd.","registration_number":"RC-123456-NGR","registration_type":"AIIN","country":"NG","city":"Lagos Island","postal_code":"10010","address":"15 Marina Street","address_line_2":"Suite 200"},"status":"PENDING","reason":null,"created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"},"key":"payer","summary":"Payer (Nigerian Imports)","id":"paths/~1v1~1collections~1partners/post/responses/201/content/application~1json/examples/payer"},"paths/~1v1~1collections~1partners/post/responses/201/content/application~1json/examples/beneficiary":{"value":{"id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","name":"Hong Kong Exports Ltd.","email":"hongkong@exports.com","external_reference_id":"Ref-HK-001","data":{"type":"BUSINESS","legal_entity":"Hong Kong Exports Ltd.","registration_number":"CR-987654-HK","registration_type":"CINC","country":"HK","city":"Central","postal_code":"999077","address":"8 Connaught Road Central","address_line_2":"Level 30"},"status":"PENDING","reason":null,"created_at":"2025-09-18T22:55:00.542Z","updated_at":"2025-09-18T22:55:00.542Z"},"key":"beneficiary","summary":"Beneficiary (Hong Kong Exports)","id":"paths/~1v1~1collections~1partners/post/responses/201/content/application~1json/examples/beneficiary"},"paths/~1v1~1collections~1partners~1{partner_id}/get/responses/200/content/application~1json/examples/payer":{"value":{"id":"0c5479ff-3772-4123-b2b7-e679e71eb570","name":"Nigerian Imports Ltd.","email":"nigerian@imports.com","external_reference_id":"Ref-NG-001","data":{"type":"BUSINESS","legal_entity":"Nigerian Imports Ltd.","registration_number":"RC-123456-NGR","registration_type":"AIIN","country":"NG","city":"Lagos Island","postal_code":"10010","address":"15 Marina Street","address_line_2":"Suite 200"},"status":"ACTIVATED","reason":null,"created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T23:54:00.542Z"},"key":"payer","summary":"Payer (Nigerian Imports)","id":"paths/~1v1~1collections~1partners~1{partner_id}/get/responses/200/content/application~1json/examples/payer"},"paths/~1v1~1collections~1partners~1{partner_id}/get/responses/200/content/application~1json/examples/beneficiary":{"value":{"id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","name":"Hong Kong Exports Ltd.","email":"hongkong@exports.com","external_reference_id":"Ref-HK-001","data":{"type":"BUSINESS","legal_entity":"Hong Kong Exports Ltd.","registration_number":"CR-987654-HK","registration_type":"CINC","country":"HK","city":"Central","postal_code":"999077","address":"8 Connaught Road Central","address_line_2":"Level 30"},"status":"ACTIVATED","reason":null,"created_at":"2025-09-18T22:55:00.542Z","updated_at":"2025-09-18T23:55:00.542Z"},"key":"beneficiary","summary":"Beneficiary (Hong Kong Exports)","id":"paths/~1v1~1collections~1partners~1{partner_id}/get/responses/200/content/application~1json/examples/beneficiary"},"paths/~1v1~1collections~1settlements/get/responses/200/content/application~1json/examples/default":{"value":{"content":[{"id":"63dd59dd-88be-41a2-a246-2f6724209422","source_account_id":"c3d4e5f6-a7b8-9012-cdef-234567890123","currency":"USD","gross_amount":"50.00","settlement_amount":"49.50","fees":{"transaction_fees":"0.50"},"status":"COMPLETED","data":{"transaction_reference_numbers":["ABC12345"],"payout_destination":{"type":"FEDWIRE","account_name":"Finance Corp","account_number":"XXXX7890","routing_number":"021000021","swift_code":"CHASUS33","institution_name":"Bank of America","reference":"INV-2024-001"}},"created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"},{"id":"7a1e4b2c-9d3f-4e5a-8b6c-1d2e3f4a5b6c","source_account_id":"e5f6a7b8-c9d0-1234-ef01-456789012345","currency":"RLUSD","gross_amount":"100.00","settlement_amount":"99.00","fees":{"transaction_fees":"1.00"},"status":"COMPLETED","data":{"transaction_hash":"0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF","payout_destination":{"type":"BLOCKCHAIN","network":"XRPL","address":"rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh","currency":"RLUSD","destination_tag":"12345"}},"created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"},{"id":"9f8e7d6c-5b4a-3c2d-1e0f-a1b2c3d4e5f6","source_account_id":"d4e5f6a7-b8c9-0123-def0-345678901234","currency":"BRL","gross_amount":"75.00","settlement_amount":"74.25","fees":{"transaction_fees":"0.75"},"status":"COMPLETED","data":{"transaction_reference_numbers":["PIX54321"],"payout_destination":{"type":"PIX","pix_key":"XXXX8901","pix_key_type":"CNPJ","beneficiary_name":"Finance Corp"}},"created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"}],"page":{"page":0,"size":10,"total_elements":3,"total_pages":1}},"key":"default","summary":"Settlements list (same data as the create examples)","id":"paths/~1v1~1collections~1settlements/get/responses/200/content/application~1json/examples/default"},"paths/~1v1~1collections~1settlements/post/responses/201/content/application~1json/examples/usd_fedwire_settlement":{"value":{"id":"63dd59dd-88be-41a2-a246-2f6724209422","source_account_id":"c3d4e5f6-a7b8-9012-cdef-234567890123","currency":"USD","gross_amount":"50.00","settlement_amount":"49.50","fees":{"transaction_fees":"0.50"},"status":"COMPLETED","data":{"transaction_reference_numbers":["ABC12345"],"payout_destination":{"type":"FEDWIRE","account_name":"Finance Corp","account_number":"XXXX7890","routing_number":"021000021","swift_code":"CHASUS33","institution_name":"Bank of America","reference":"INV-2024-001"}},"created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"},"key":"usd_fedwire_settlement","summary":"USD settlement paid out via FEDWIRE","id":"paths/~1v1~1collections~1settlements/post/responses/201/content/application~1json/examples/usd_fedwire_settlement"},"paths/~1v1~1collections~1settlements/post/responses/201/content/application~1json/examples/rlusd_settlement":{"value":{"id":"7a1e4b2c-9d3f-4e5a-8b6c-1d2e3f4a5b6c","source_account_id":"e5f6a7b8-c9d0-1234-ef01-456789012345","currency":"RLUSD","gross_amount":"100.00","settlement_amount":"99.00","fees":{"transaction_fees":"1.00"},"status":"COMPLETED","data":{"transaction_hash":"0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF","payout_destination":{"type":"BLOCKCHAIN","network":"XRPL","address":"rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh","currency":"RLUSD","destination_tag":"12345"}},"created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"},"key":"rlusd_settlement","summary":"RLUSD settlement paid out on XRPL","id":"paths/~1v1~1collections~1settlements/post/responses/201/content/application~1json/examples/rlusd_settlement"},"paths/~1v1~1collections~1settlements/post/responses/201/content/application~1json/examples/brl_settlement":{"value":{"id":"9f8e7d6c-5b4a-3c2d-1e0f-a1b2c3d4e5f6","source_account_id":"d4e5f6a7-b8c9-0123-def0-345678901234","currency":"BRL","gross_amount":"75.00","settlement_amount":"74.25","fees":{"transaction_fees":"0.75"},"status":"COMPLETED","data":{"transaction_reference_numbers":["PIX54321"],"payout_destination":{"type":"PIX","pix_key":"XXXX8901","pix_key_type":"CNPJ","beneficiary_name":"Finance Corp"}},"created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"},"key":"brl_settlement","summary":"BRL settlement paid out via PIX","id":"paths/~1v1~1collections~1settlements/post/responses/201/content/application~1json/examples/brl_settlement"},"paths/~1v1~1collections~1transactions/get/responses/200/content/application~1json/examples/default":{"value":{"content":[{"id":"487ba009-56cf-4ad9-8b5c-045e27893e00","parent_id":"22a0337b-8e62-449c-91ca-a0f830c55733","account_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","payer":{"id":"0c5479ff-3772-4123-b2b7-e679e71eb570","name":"Nigerian Imports Ltd.","email":"nigerian@imports.com"},"beneficiary":{"id":"01467076-8bb0-41c1-ad54-5751dd4a9e80","name":"Hong Kong Exports Ltd.","email":"hongkong@exports.com"},"payment_amount":{"value":"50.00000000","asset":"USDT"},"account_equivalent":{"gross_amount":{"value":"50.00","currency":"USD"},"fee_amount":{"value":"0.50","currency":"USD"},"net_amount":{"value":"49.50","currency":"USD"}},"market_rate":{"base":"USDT","counter":"USD","rate":"1.00"},"exchange_rate":{"base":"USDT","counter":"USD","rate":"0.99"},"source_payment_method":{"type":"BLOCKCHAIN","network":"ETHEREUM","transaction_hash":"0x94365ftfr76iy45t6ghu876567ytr54ertyui987uyt698uyh87u","block_id":"0xh7865gugi87yea94e8267987a9e91eddcd0da916b22f3cfa0c8bd91dbad85","source_address":"0x880f622a1933ACf82bFC5e630c9ab7f18eF47809","destination_address":"0x02937b288b588058533C48b18EdFDdd76A324D6","gas_fee":{"value":"0.0045","asset":"ETH"}},"status":"COMPLETED","transaction_processed_date":"2025-06-17T12:20:00Z","date_created":"2025-09-18T22:54:00.542Z","date_confirmed":"2025-09-18T22:56:00.542Z"}],"page":{"page":0,"size":10,"total_elements":1,"total_pages":1}},"key":"default","summary":"Example transaction list response","id":"paths/~1v1~1collections~1transactions/get/responses/200/content/application~1json/examples/default"},"paths/~1v1~1collections~1transactions~1{transaction_id}/get/responses/200/content/application~1json/examples/blockchain_transaction":{"value":{"id":"487ba009-56cf-4ad9-8b5c-045e27893e00","parent_id":"22a0337b-8e62-449c-91ca-a0f830c55733","account_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","payer":{"id":"0c5479ff-3772-4123-b2b7-e679e71eb570","name":"Nigerian Imports Ltd.","email":"nigerian@imports.com"},"beneficiary":{"id":"01467076-8bb0-41c1-ad54-5751dd4a9e80","name":"Hong Kong Exports Ltd.","email":"hongkong@exports.com"},"payment_amount":{"value":"50.00000000","asset":"USDT"},"account_equivalent":{"gross_amount":{"value":"50.00","currency":"USD"},"fee_amount":{"value":"0.50","currency":"USD"},"net_amount":{"value":"49.50","currency":"USD"}},"market_rate":{"base":"USDT","counter":"USD","rate":"1.00"},"exchange_rate":{"base":"USDT","counter":"USD","rate":"0.99"},"source_payment_method":{"type":"BLOCKCHAIN","network":"ETHEREUM","transaction_hash":"0x94365ftfr76iy45t6ghu876567ytr54ertyui987uyt698uyh87u","block_id":"0xh7865gugi87yea94e8267987a9e91eddcd0da916b22f3cfa0c8bd91dbad85","source_address":"0x880f622a1933ACf82bFC5e630c9ab7f18eF47809","destination_address":"0x02937b288b588058533C48b18EdFDdd76A324D6","gas_fee":{"value":"0.0045","asset":"ETH"}},"status":"COMPLETED","transaction_processed_date":"2025-06-17T12:20:00Z","date_created":"2025-09-18T22:54:00.542Z","date_confirmed":"2025-09-18T22:56:00.542Z"},"key":"blockchain_transaction","summary":"Example blockchain transaction response","id":"paths/~1v1~1collections~1transactions~1{transaction_id}/get/responses/200/content/application~1json/examples/blockchain_transaction"},"paths/~1v1~1collections~1transactions~1{transaction_id}/get/responses/200/content/application~1json/examples/fiat_transaction":{"value":{"id":"63dd59dd-88be-41a2-a246-2f6724209422","parent_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","account_id":"250d6dc5-382f-4750-8657-0780be594d68","payer":{"id":"e471b938-98ad-45e4-b144-53a556ea047d","name":"Brazilian Imports Ltd.","email":"brazil@imports.com"},"beneficiary":{"id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","name":"Hong Kong Exports Ltd.","email":"hongkong@exports.com"},"payment_amount":{"value":"1000.00","asset":"BRL"},"account_equivalent":{"gross_amount":{"value":"1000.00","currency":"BRL"},"fee_amount":{"value":"10.00","currency":"BRL"},"net_amount":{"value":"990.00","currency":"BRL"}},"market_rate":{"base":"BRL","counter":"BRL","rate":"1.00"},"exchange_rate":{"base":"BRL","counter":"BRL","rate":"1.00"},"source_payment_method":{"type":"PIX","pix_key":"12345678901","pix_key_type":"CPF","sender_name":"João Silva"},"status":"COMPLETED","transaction_processed_date":"2025-06-17T14:30:00Z","date_created":"2025-09-18T22:54:00.542Z","date_confirmed":"2025-09-18T22:56:00.542Z"},"key":"fiat_transaction","summary":"Example fiat (PIX) transaction response","id":"paths/~1v1~1collections~1transactions~1{transaction_id}/get/responses/200/content/application~1json/examples/fiat_transaction"},"paths/~1v1~1collections~1webhooks/post/requestBody/content/application~1json/examples/create":{"value":{"callback_url":"https://webhook.partner.example/webhooks","event_types":["WALLET_ADDRESS_CREATED","SETTLEMENT_COMPLETED"]},"key":"create","summary":"create","id":"paths/~1v1~1collections~1webhooks/post/requestBody/content/application~1json/examples/create"},"paths/~1v1~1collections~1webhooks/post/responses/201/content/application~1json/examples/created":{"value":[{"id":"5c0d9ec9-5ad8-4a43-a1b4-6f8f1f6c4c10","event_type":"WALLET_ADDRESS_CREATED","callback_url":"https://webhook.partner.example/webhooks","signature_verification_key":"SKgxrHfGiY6fpwo+yIixFzgnE+N2ZNzLcUCr9DO+YWY="},{"id":"1c9fe6fd-1dd8-4e9a-8de2-7f4c89b4d210","event_type":"SETTLEMENT_COMPLETED","callback_url":"https://webhook.partner.example/webhooks","signature_verification_key":"bN4EcC9pK6ZmAZwicmOCw5lt2a076zV2S0CjJe+keJs="}],"key":"created","summary":"created","id":"paths/~1v1~1collections~1webhooks/post/responses/201/content/application~1json/examples/created"},"paths/~1v1~1collections~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/examples/webhook":{"value":{"id":"5c0d9ec9-5ad8-4a43-a1b4-6f8f1f6c4c10","event_type":"WALLET_ADDRESS_CREATED","callback_url":"https://webhook.partner.example/webhooks","signature_verification_key":"SKgxrHfGiY6fpwo+yIixFzgnE+N2ZNzLcUCr9DO+YWY="},"key":"webhook","summary":"webhook","id":"paths/~1v1~1collections~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/examples/webhook"},"paths/~1v1~1collections~1webhooks~1{webhook_id}/delete/responses/200/content/application~1json/examples/deleted":{"value":"5c0d9ec9-5ad8-4a43-a1b4-6f8f1f6c4c10","key":"deleted","summary":"deleted","id":"paths/~1v1~1collections~1webhooks~1{webhook_id}/delete/responses/200/content/application~1json/examples/deleted"},"paths/~1v1~1collections~1transfers/get/responses/200/content/application~1json/examples/default":{"value":{"content":[{"id":"6f3e9c2a-1b4d-47f0-9e3a-2c6b8d1f5a7e","status":"PENDING","source":{"account_id":"b2c3d4e5-f6a7-8901-bcde-f12345678901","currency":"USD","amount":"1000.00"},"destination":{"account_id":"250d6dc5-382f-4750-8657-0780be594d68","currency":"BRL","amount":"5200.00"},"market_rate":{"base":"USD","counter":"BRL","rate":"5.25"},"exchange_rate":{"base":"USD","counter":"BRL","rate":"5.20"},"fees":{"transaction_fee":{"amount":"50.00","currency":"BRL"}},"reason":null,"expires_at":"2025-09-18T23:09:00.542Z","created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"}],"page":{"page":0,"size":10,"total_elements":1,"total_pages":1}},"key":"default","summary":"Example transfer list response","id":"paths/~1v1~1collections~1transfers/get/responses/200/content/application~1json/examples/default"},"paths/~1v1~1collections~1transfers/post/requestBody/content/application~1json/examples/default":{"value":{"source_account_id":"b2c3d4e5-f6a7-8901-bcde-f12345678901","destination_account_id":"250d6dc5-382f-4750-8657-0780be594d68","amount":"1000.00"},"key":"default","summary":"Example transfer request","id":"paths/~1v1~1collections~1transfers/post/requestBody/content/application~1json/examples/default"},"paths/~1v1~1collections~1transfers/post/responses/201/content/application~1json/examples/default":{"value":{"id":"6f3e9c2a-1b4d-47f0-9e3a-2c6b8d1f5a7e","status":"PENDING","source":{"account_id":"b2c3d4e5-f6a7-8901-bcde-f12345678901","currency":"USD","amount":"1000.00"},"destination":{"account_id":"250d6dc5-382f-4750-8657-0780be594d68","currency":"BRL","amount":"5200.00"},"market_rate":{"base":"USD","counter":"BRL","rate":"5.25"},"exchange_rate":{"base":"USD","counter":"BRL","rate":"5.20"},"fees":{"transaction_fee":{"amount":"50.00","currency":"BRL"}},"reason":null,"expires_at":"2025-09-18T23:09:00.542Z","created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"},"key":"default","summary":"Example transfer response","id":"paths/~1v1~1collections~1transfers/post/responses/201/content/application~1json/examples/default"}},"securitySchemeStore":{"Bearer":{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"specVersion":"3.0.1","servers":[{"url":"/_mock/pt-br/products/collections/api/collections","isMockServer":true,"description":"Mock server"},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/pt-br/products/collections/api/collections","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/@l10n/pt-BR/products/collections/@v1/api/collections.json?download"},{"url":"/_bundle/@l10n/pt-BR/products/collections/@v1/api/collections.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Ripple Collections","description":"The Ripple Collection APIs are used to manage accounts, payment channels, partners, transactions, transfers and settlements.\n## API Environments\nThe Ripple Collection APIs offers the following environments:\n| <div style=\"width:90px\">Environment</div>  | Base URL                      | Description                               |\n| ------------------------------------------ | ----------------------------- | ----------------------------------------- |\n| Sandbox                                    | `https://docs.ripple.com/products/collections/_mock/api/collections` | Sandbox environment with mock data which does not require auth.|\n| UAT                                       | `https://api.test.ripple.com` | UAT environment with simulated transactions. |\n| Production                                 | `https://api.ripple.com`      | Production environment                    |\n\nFor guides on API authentication, idempotency, and webhook verification, see the sidebar. "}},"baseSlug":"/pt-br/products/collections/api/collections","routesMapping":{}}