{"items":[{"type":"link","label":"Ripple Collections (alpha)","link":"/pt-br/products/collections/v0/api/collections","routeSlug":"/pt-br/products/collections/v0/api/collections","content":{"contentType":"overview","meta":{"name":"Ripple Collections (alpha)"},"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/@v0/api/collections.json?download"},{"kind":"download","label":"collections.yaml","url":"/_bundle/@l10n/pt-BR/products/collections/@v0/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/v0/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 (alpha) (0.0.1)","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 collections, manage payment channels, manage partners and settlements."},"children":[]}]}]}]}],"sectionId":"/pt-br/products/collections/v0/api/collections"}],"sectionId":"/pt-br/products/collections/v0/api/collections"},{"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":"/pt-br/products/collections/v0/api/collections/section/api-environments"}]}]}},{"type":"link","label":"API Environments","link":"/pt-br/products/collections/v0/api/collections/section/api-environments","routeSlug":"/pt-br/products/collections/v0/api/collections/section/api-environments","content":null},{"type":"group","label":"Authentication","link":"/pt-br/products/collections/v0/api/collections/authentication","routeSlug":"/pt-br/products/collections/v0/api/collections/authentication","items":[{"label":"Request an access token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/v0/api/collections/authentication/authenticate","routeSlug":"/pt-br/products/collections/v0/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/v0/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/v0/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/v0/api/collections/authentication/testauthtoken","routeSlug":"/pt-br/products/collections/v0/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/v0/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/v0/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":"Collection Links","link":"/pt-br/products/collections/v0/api/collections/collection-links","routeSlug":"/pt-br/products/collections/v0/api/collections/collection-links","items":[{"label":"List collections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/v0/api/collections/collection-links/listcollections","routeSlug":"/pt-br/products/collections/v0/api/collections/collection-links/listcollections","metadata":{"seo":{"title":"List collections","description":"Retrieves a list of collections, filterable by query parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCollections","name":"List collections","isWebhook":false,"pointer":"/paths/~1v0~1collections~1links/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List collections","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 collections, 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 collections by specific collection identifier"},{"name":"payer_id","in":"query","schemaId":"schema_3","description":"Filter collections by payer identifier"},{"name":"beneficiary_id","in":"query","schemaId":"schema_4","description":"Filter collections by beneficiary identifier"},{"name":"since","in":"query","schemaId":"schema_5","example":"2025-06-17T12:00:00Z"},{"name":"until","in":"query","schemaId":"schema_6","example":"2025-06-17T12:00:00Z"},{"name":"page","in":"query","schemaId":"schema_7","description":"Page number (starts at 1)","example":1},{"name":"size","in":"query","schemaId":"schema_8","description":"Page size (items per page)","example":10}],"pointer":"/paths/~1v0~1collections~1links/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/collections/links","servers":[{"url":"/_mock/pt-br/products/collections/v0/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","example":"e8d43598-107d-4694-9fb2-934e7484c3d4","schemaId":"schema_2"},{"name":"payer_id","in":"query","example":"0c5479ff-3772-4123-b2b7-e679e71eb570","schemaId":"schema_3"},{"name":"beneficiary_id","in":"query","example":"01467076-8bb0-41c1-ad54-5751dd4a9e80","schemaId":"schema_4"},{"name":"since","in":"query","example":"2025-06-17T12:00:00Z","schemaId":"schema_5"},{"name":"until","in":"query","example":"2025-06-17T12:00:00Z","schemaId":"schema_6"},{"name":"page","in":"query","example":1,"schemaId":"schema_7"},{"name":"size","in":"query","example":10,"schemaId":"schema_8"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v0/collections/links","href":"collection-links/listcollections","openApiOperationId":"listCollections","summary":"List collections"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/v0/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 collections.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_9"}},"schemaId":"schema_9"},{"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/~1v0~1collections~1links/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_9","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_9"}}},{"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-links/listcollections"}],"panels":[]}]},"httpPath":"/v0/collections/links"},{"label":"Create a collection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/v0/api/collections/collection-links/createcollection","routeSlug":"/pt-br/products/collections/v0/api/collections/collection-links/createcollection","metadata":{"seo":{"title":"Create a collection","description":"Creates a new payment link for a collection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCollection","name":"Create a collection","isWebhook":false,"pointer":"/paths/~1v0~1collections~1links/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a collection","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 link for a collection."},{"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/CreateCollectionRequest","exampleIds":["paths/~1v0~1collections~1links/post/requestBody/content/application~1json/examples/example_with_excluded_fee","paths/~1v0~1collections~1links/post/requestBody/content/application~1json/examples/example_with_included_fee"]}},"schemaId":"components/schemas/CreateCollectionRequest","exampleIds":["paths/~1v0~1collections~1links/post/requestBody/content/application~1json/examples/example_with_excluded_fee","paths/~1v0~1collections~1links/post/requestBody/content/application~1json/examples/example_with_included_fee"],"pointer":"/paths/~1v0~1collections~1links/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v0/collections/links","servers":[{"url":"/_mock/pt-br/products/collections/v0/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/CreateCollectionRequest","exampleIds":["paths/~1v0~1collections~1links/post/requestBody/content/application~1json/examples/example_with_excluded_fee","paths/~1v0~1collections~1links/post/requestBody/content/application~1json/examples/example_with_included_fee"]}},"responseCodes":["201","400","401","500"],"pointer":"/v0/collections/links","href":"collection-links/createcollection","openApiOperationId":"createCollection","summary":"Create a collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/v0/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"schemaId":"components/schemas/CreateCollectionRequest","exampleIds":["paths/~1v0~1collections~1links/post/requestBody/content/application~1json/examples/example_with_excluded_fee","paths/~1v0~1collections~1links/post/requestBody/content/application~1json/examples/example_with_included_fee"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCollectionRequest","exampleIds":["paths/~1v0~1collections~1links/post/requestBody/content/application~1json/examples/example_with_excluded_fee","paths/~1v0~1collections~1links/post/requestBody/content/application~1json/examples/example_with_included_fee"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Collection Created Successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Collection","exampleIds":["paths/~1v0~1collections~1links/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/Collection","exampleIds":["paths/~1v0~1collections~1links/post/responses/201/content/application~1json/example"]},{"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/~1v0~1collections~1links/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Collection","exampleIds":["paths/~1v0~1collections~1links/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Collection","exampleIds":["paths/~1v0~1collections~1links/post/responses/201/content/application~1json/example"]}}},{"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-links/createcollection"}],"panels":[]}]},"httpPath":"/v0/collections/links"},{"label":"Get collection details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/v0/api/collections/collection-links/getcollectionbyid","routeSlug":"/pt-br/products/collections/v0/api/collections/collection-links/getcollectionbyid","metadata":{"seo":{"title":"Get collection details","description":"Retrieves the details of a specific collection by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCollectionById","name":"Get collection details","isWebhook":false,"pointer":"/paths/~1v0~1collections~1links~1{collection_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get collection 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 collection 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":"collection_id","in":"path","schemaId":"schema_10","description":"Unique identifier of the collection to retrieve","required":true}],"pointer":"/paths/~1v0~1collections~1links~1{collection_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/collections/links/{collection_id}","servers":[{"url":"/_mock/pt-br/products/collections/v0/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"parameters":{"path":[{"name":"collection_id","in":"path","required":true,"example":"22a0337b-8e62-449c-91ca-a0f830c55733","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":"/v0/collections/links/{collection_id}","href":"collection-links/getcollectionbyid","openApiOperationId":"getCollectionById","summary":"Get collection details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/v0/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/Collection","exampleIds":["paths/~1v0~1collections~1links~1{collection_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Collection","exampleIds":["paths/~1v0~1collections~1links~1{collection_id}/get/responses/200/content/application~1json/example"]},{"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 - Collection 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/~1v0~1collections~1links~1{collection_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Collection","exampleIds":["paths/~1v0~1collections~1links~1{collection_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Collection","exampleIds":["paths/~1v0~1collections~1links~1{collection_id}/get/responses/200/content/application~1json/example"]}}},{"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-links/getcollectionbyid"}],"panels":[]}]},"httpPath":"/v0/collections/links/{collection_id}"},{"label":"Cancel a collection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/v0/api/collections/collection-links/cancelcollection","routeSlug":"/pt-br/products/collections/v0/api/collections/collection-links/cancelcollection","metadata":{"seo":{"title":"Cancel a collection","description":"API to cancel a payment collection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelCollection","name":"Cancel a collection","isWebhook":false,"pointer":"/paths/~1v0~1collections~1links~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a collection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to cancel a payment collection."},{"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":"schema_11"}},"schemaId":"schema_11","pointer":"/paths/~1v0~1collections~1links~1cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v0/collections/links/cancel","servers":[{"url":"/_mock/pt-br/products/collections/v0/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":"schema_11"}},"responseCodes":["200","400","401","404","500"],"pointer":"/v0/collections/links/cancel","href":"collection-links/cancelcollection","openApiOperationId":"cancelCollection","summary":"Cancel a collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/v0/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"schemaId":"schema_11","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_11"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Collection cancelled successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Collection","exampleIds":["paths/~1v0~1collections~1links~1cancel/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Collection","exampleIds":["paths/~1v0~1collections~1links~1cancel/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request - Invalid input parameters or collection cannot be cancelled","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 - Collection 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/~1v0~1collections~1links~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Collection","exampleIds":["paths/~1v0~1collections~1links~1cancel/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Collection","exampleIds":["paths/~1v0~1collections~1links~1cancel/post/responses/200/content/application~1json/example"]}}},{"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-links/cancelcollection"}],"panels":[]}]},"httpPath":"/v0/collections/links/cancel"}],"content":{"contentType":"group","meta":{"name":"Collection Links"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Collection Links","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for managing one-time collection links"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v0/collections/links","summary":"List collections","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collection-links/listcollections","deprecated":false},{"title":"/v0/collections/links","summary":"Create a collection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/collection-links/createcollection","deprecated":false},{"title":"/v0/collections/links/{collection_id}","summary":"Get collection details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collection-links/getcollectionbyid","deprecated":false},{"title":"/v0/collections/links/cancel","summary":"Cancel a collection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/collection-links/cancelcollection","deprecated":false}]}]}]}]}},{"type":"group","label":"Collection Channels","link":"/pt-br/products/collections/v0/api/collections/collection-channels","routeSlug":"/pt-br/products/collections/v0/api/collections/collection-channels","items":[{"label":"List channels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/v0/api/collections/collection-channels/listchannels","routeSlug":"/pt-br/products/collections/v0/api/collections/collection-channels/listchannels","metadata":{"seo":{"title":"List channels","description":"Retrieves a list of channels, filterable by query parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listChannels","name":"List channels","isWebhook":false,"pointer":"/paths/~1v0~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, 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_12","description":"Filter channels by specific channel identifier"},{"name":"payer_id","in":"query","schemaId":"schema_13","description":"Filter channels by payer identifier"},{"name":"beneficiary_id","in":"query","schemaId":"schema_14","description":"Filter channels by beneficiary identifier"},{"name":"status","in":"query","schemaId":"schema_15","description":"Filter channels by status","example":"ACTIVE"},{"name":"payment_currency","in":"query","schemaId":"schema_1","description":"Filter channels by payment currency asset","example":"USDC"},{"name":"network","in":"query","schemaId":"schema_16","description":"Filter channels by payment currency network","example":"ETHEREUM"},{"name":"wallet_address","in":"query","schemaId":"schema_1","description":"Filter channels by wallet address","example":"0xBb592aaaF9AcE2fbE3F735645819FA94c95a9cb5"},{"name":"since","in":"query","schemaId":"schema_17","example":"2025-06-17T12:00:00Z"},{"name":"until","in":"query","schemaId":"schema_18","example":"2025-06-17T12:00:00Z"},{"name":"page","in":"query","schemaId":"schema_7","description":"Page number (starts at 1)","example":1},{"name":"size","in":"query","schemaId":"schema_8","description":"Page size (items per page)","example":10}],"pointer":"/paths/~1v0~1collections~1channels/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/collections/channels","servers":[{"url":"/_mock/pt-br/products/collections/v0/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","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","schemaId":"schema_12"},{"name":"payer_id","in":"query","example":"e471b938-98ad-45e4-b144-53a556ea047d","schemaId":"schema_13"},{"name":"beneficiary_id","in":"query","example":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","schemaId":"schema_14"},{"name":"status","in":"query","example":"ACTIVE","schemaId":"components/schemas/ChannelStatus"},{"name":"payment_currency","in":"query","example":"USDC","schemaId":"schema_1"},{"name":"network","in":"query","example":"ETHEREUM","schemaId":"components/schemas/Network"},{"name":"wallet_address","in":"query","example":"0xBb592aaaF9AcE2fbE3F735645819FA94c95a9cb5","schemaId":"schema_1"},{"name":"since","in":"query","example":"2025-06-17T12:00:00Z","schemaId":"schema_17"},{"name":"until","in":"query","example":"2025-06-17T12:00:00Z","schemaId":"schema_18"},{"name":"page","in":"query","example":1,"schemaId":"schema_7"},{"name":"size","in":"query","example":10,"schemaId":"schema_8"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v0/collections/channels","href":"collection-channels/listchannels","openApiOperationId":"listChannels","summary":"List channels"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/v0/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_19","exampleIds":["paths/~1v0~1collections~1channels/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"schema_19","exampleIds":["paths/~1v0~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/~1v0~1collections~1channels/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_19","exampleIds":["paths/~1v0~1collections~1channels/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19","exampleIds":["paths/~1v0~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/listchannels"}],"panels":[]}]},"httpPath":"/v0/collections/channels"},{"label":"Create a channel","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/v0/api/collections/collection-channels/createchannel","routeSlug":"/pt-br/products/collections/v0/api/collections/collection-channels/createchannel","metadata":{"seo":{"title":"Create a channel","description":"Creates a new payment channel between payer and beneficiary."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createChannel","name":"Create a channel","isWebhook":false,"pointer":"/paths/~1v0~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 between payer and beneficiary."},{"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/CreateChannelRequest","exampleIds":["paths/~1v0~1collections~1channels/post/requestBody/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CreateChannelRequest","exampleIds":["paths/~1v0~1collections~1channels/post/requestBody/content/application~1json/examples/default"],"pointer":"/paths/~1v0~1collections~1channels/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v0/collections/channels","servers":[{"url":"/_mock/pt-br/products/collections/v0/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/CreateChannelRequest","exampleIds":["paths/~1v0~1collections~1channels/post/requestBody/content/application~1json/examples/default"]}},"responseCodes":["201","400","401","500"],"pointer":"/v0/collections/channels","href":"collection-channels/createchannel","openApiOperationId":"createChannel","summary":"Create a channel"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/v0/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"schemaId":"components/schemas/CreateChannelRequest","exampleIds":["paths/~1v0~1collections~1channels/post/requestBody/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateChannelRequest","exampleIds":["paths/~1v0~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/Channel","exampleIds":["paths/~1v0~1collections~1channels/post/responses/201/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Channel","exampleIds":["paths/~1v0~1collections~1channels/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":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v0~1collections~1channels/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Channel","exampleIds":["paths/~1v0~1collections~1channels/post/responses/201/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Channel","exampleIds":["paths/~1v0~1collections~1channels/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":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/collection-channels/createchannel"}],"panels":[]}]},"httpPath":"/v0/collections/channels"},{"label":"Get channel details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/v0/api/collections/collection-channels/getchannelbyid","routeSlug":"/pt-br/products/collections/v0/api/collections/collection-channels/getchannelbyid","metadata":{"seo":{"title":"Get channel details","description":"Retrieves the details of a specific channel by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getChannelById","name":"Get channel details","isWebhook":false,"pointer":"/paths/~1v0~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."},{"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_12","description":"Unique identifier of the channel to retrieve","required":true}],"pointer":"/paths/~1v0~1collections~1channels~1{channel_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/collections/channels/{channel_id}","servers":[{"url":"/_mock/pt-br/products/collections/v0/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_12"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v0/collections/channels/{channel_id}","href":"collection-channels/getchannelbyid","openApiOperationId":"getChannelById","summary":"Get channel details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/v0/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/Channel","exampleIds":["paths/~1v0~1collections~1channels~1{channel_id}/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/Channel","exampleIds":["paths/~1v0~1collections~1channels~1{channel_id}/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":"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/~1v0~1collections~1channels~1{channel_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Channel","exampleIds":["paths/~1v0~1collections~1channels~1{channel_id}/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Channel","exampleIds":["paths/~1v0~1collections~1channels~1{channel_id}/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":"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/getchannelbyid"}],"panels":[]}]},"httpPath":"/v0/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"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v0/collections/channels","summary":"List channels","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collection-channels/listchannels","deprecated":false},{"title":"/v0/collections/channels","summary":"Create a channel","prefix":{"name":"post","color":"post"},"badges":[],"link":"/collection-channels/createchannel","deprecated":false},{"title":"/v0/collections/channels/{channel_id}","summary":"Get channel details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collection-channels/getchannelbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Partners","link":"/pt-br/products/collections/v0/api/collections/partners","routeSlug":"/pt-br/products/collections/v0/api/collections/partners","items":[{"label":"List partners","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/v0/api/collections/partners/listpartners","routeSlug":"/pt-br/products/collections/v0/api/collections/partners/listpartners","metadata":{"seo":{"title":"List partners","description":"Retrieves a list of partners, filterable by ID or type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPartners","name":"List partners","isWebhook":false,"pointer":"/paths/~1v0~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_3","description":"Filter partners by specific partner ID"},{"name":"since","in":"query","schemaId":"schema_20","example":"2025-06-17T12:00:00Z"},{"name":"until","in":"query","schemaId":"schema_21","example":"2025-06-17T12:00:00Z"},{"name":"type","in":"query","schemaId":"schema_22","description":"Filter partners by type"},{"name":"status","in":"query","schemaId":"schema_23","description":"Filter partners by status"},{"name":"external_reference_id","in":"query","schemaId":"schema_24","example":"Ref-123"},{"name":"page","in":"query","schemaId":"schema_7","description":"Page number (starts at 1)","example":1},{"name":"size","in":"query","schemaId":"schema_8","description":"Page size (items per page)","example":10}],"pointer":"/paths/~1v0~1collections~1partners/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/collections/partners","servers":[{"url":"/_mock/pt-br/products/collections/v0/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","example":"0c5479ff-3772-4123-b2b7-e679e71eb570","schemaId":"schema_3"},{"name":"since","in":"query","example":"2025-06-17T12:00:00Z","schemaId":"schema_20"},{"name":"until","in":"query","example":"2025-06-17T12:00:00Z","schemaId":"schema_21"},{"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","example":"Ref-123","schemaId":"schema_24"},{"name":"page","in":"query","example":1,"schemaId":"schema_7"},{"name":"size","in":"query","example":10,"schemaId":"schema_8"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v0/collections/partners","href":"partners/listpartners","openApiOperationId":"listPartners","summary":"List partners"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/v0/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_25"}},"schemaId":"schema_25"},{"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/~1v0~1collections~1partners/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_25","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}}},{"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/listpartners"}],"panels":[]}]},"httpPath":"/v0/collections/partners"},{"label":"Create a partner","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/v0/api/collections/partners/createpartner","routeSlug":"/pt-br/products/collections/v0/api/collections/partners/createpartner","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":"createPartner","name":"Create a partner","isWebhook":false,"pointer":"/paths/~1v0~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"}},"schemaId":"components/schemas/CreatePartnerRequest","pointer":"/paths/~1v0~1collections~1partners/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v0/collections/partners","servers":[{"url":"/_mock/pt-br/products/collections/v0/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"}},"responseCodes":["201","400","401","500"],"pointer":"/v0/collections/partners","href":"partners/createpartner","openApiOperationId":"createPartner","summary":"Create a partner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/v0/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"schemaId":"components/schemas/CreatePartnerRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePartnerRequest"}},"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/Partner"}},"schemaId":"components/schemas/Partner"},{"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/~1v0~1collections~1partners/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Partner","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Partner"}}},{"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/createpartner"}],"panels":[]}]},"httpPath":"/v0/collections/partners"},{"label":"Get partner by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/v0/api/collections/partners/getpartnerbyid","routeSlug":"/pt-br/products/collections/v0/api/collections/partners/getpartnerbyid","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":"getPartnerById","name":"Get partner by ID","isWebhook":false,"pointer":"/paths/~1v0~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_3","description":"Unique identifier of the partner to retrieve","required":true}],"pointer":"/paths/~1v0~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_24","example":"Ref-123"}],"pointer":"/paths/~1v0~1collections~1partners~1{partner_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/collections/partners/{partner_id}","servers":[{"url":"/_mock/pt-br/products/collections/v0/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_3"}],"query":[{"name":"external_reference_id","in":"query","example":"Ref-123","schemaId":"schema_24"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v0/collections/partners/{partner_id}","href":"partners/getpartnerbyid","openApiOperationId":"getPartnerById","summary":"Get partner by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/v0/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/Partner"}},"schemaId":"components/schemas/Partner"},{"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/~1v0~1collections~1partners~1{partner_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Partner","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Partner"}}},{"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/getpartnerbyid"}],"panels":[]}]},"httpPath":"/v0/collections/partners/{partner_id}"},{"label":"Update a partner","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/v0/api/collections/partners/updatepartner","routeSlug":"/pt-br/products/collections/v0/api/collections/partners/updatepartner","metadata":{"seo":{"title":"Update a partner","description":"API to update a partner to use in collections API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePartner","name":"Update a partner","isWebhook":false,"pointer":"/paths/~1v0~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_3","description":"Unique identifier of the partner to update","required":true}],"pointer":"/paths/~1v0~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/~1v0~1collections~1partners~1{partner_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v0/collections/partners/{partner_id}","servers":[{"url":"/_mock/pt-br/products/collections/v0/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_3"}],"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":"/v0/collections/partners/{partner_id}","href":"partners/updatepartner","openApiOperationId":"updatePartner","summary":"Update a partner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/v0/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/Partner"}},"schemaId":"components/schemas/Partner"},{"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/~1v0~1collections~1partners~1{partner_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Partner","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Partner"}}},{"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/updatepartner"}],"panels":[]}]},"httpPath":"/v0/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":"/v0/collections/partners","summary":"List partners","prefix":{"name":"get","color":"get"},"badges":[],"link":"/partners/listpartners","deprecated":false},{"title":"/v0/collections/partners","summary":"Create a partner","prefix":{"name":"post","color":"post"},"badges":[],"link":"/partners/createpartner","deprecated":false},{"title":"/v0/collections/partners/{partner_id}","summary":"Get partner by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/partners/getpartnerbyid","deprecated":false},{"title":"/v0/collections/partners/{partner_id}","summary":"Update a partner","prefix":{"name":"put","color":"put"},"badges":[],"link":"/partners/updatepartner","deprecated":false}]}]}]}]}},{"type":"group","label":"Settlements","link":"/pt-br/products/collections/v0/api/collections/settlements","routeSlug":"/pt-br/products/collections/v0/api/collections/settlements","items":[{"label":"List settlements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/v0/api/collections/settlements/listsettlements","routeSlug":"/pt-br/products/collections/v0/api/collections/settlements/listsettlements","metadata":{"seo":{"title":"List settlements","description":"API to fetch first party payouts (settlements)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSettlements","name":"List settlements","isWebhook":false,"pointer":"/paths/~1v0~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)."},{"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_26","description":"Filter settlements by specific settlement ID"},{"name":"type","in":"query","schemaId":"schema_27","description":"Settlement type"},{"name":"status","in":"query","schemaId":"schema_28","description":"Settlement status"},{"name":"since","in":"query","schemaId":"schema_29","example":"2025-06-17T12:00:00Z"},{"name":"until","in":"query","schemaId":"schema_30","example":"2025-06-17T12:00:00Z"},{"name":"page","in":"query","schemaId":"schema_7","description":"Page number (starts at 1)","example":1},{"name":"size","in":"query","schemaId":"schema_8","description":"Page size (items per page)","example":10}],"pointer":"/paths/~1v0~1collections~1settlements/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/collections/settlements","servers":[{"url":"/_mock/pt-br/products/collections/v0/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","example":"63dd59dd-88be-41a2-a246-2f6724209422","schemaId":"schema_26"},{"name":"type","in":"query","example":"FIAT","schemaId":"components/schemas/SettlementType"},{"name":"status","in":"query","example":"PENDING","schemaId":"components/schemas/SettlementStatus"},{"name":"since","in":"query","example":"2025-06-17T12:00:00Z","schemaId":"schema_29"},{"name":"until","in":"query","example":"2025-06-17T12:00:00Z","schemaId":"schema_30"},{"name":"page","in":"query","example":1,"schemaId":"schema_7"},{"name":"size","in":"query","example":10,"schemaId":"schema_8"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v0/collections/settlements","href":"settlements/listsettlements","openApiOperationId":"listSettlements","summary":"List settlements"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/v0/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_31"}},"schemaId":"schema_31"},{"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/~1v0~1collections~1settlements/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_31","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31"}}},{"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/listsettlements"}],"panels":[]}]},"httpPath":"/v0/collections/settlements"},{"label":"Get settlement by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/v0/api/collections/settlements/getsettlementbyid","routeSlug":"/pt-br/products/collections/v0/api/collections/settlements/getsettlementbyid","metadata":{"seo":{"title":"Get settlement by ID","description":"API to fetch a first party payout (settlement to our customer)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSettlementById","name":"Get settlement by ID","isWebhook":false,"pointer":"/paths/~1v0~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)."},{"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_26","description":"Unique identifier of the settlement to retrieve","required":true}],"pointer":"/paths/~1v0~1collections~1settlements~1{settlement_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/collections/settlements/{settlement_id}","servers":[{"url":"/_mock/pt-br/products/collections/v0/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_26"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v0/collections/settlements/{settlement_id}","href":"settlements/getsettlementbyid","openApiOperationId":"getSettlementById","summary":"Get settlement by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/v0/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/Settlement"}},"schemaId":"components/schemas/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":"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/~1v0~1collections~1settlements~1{settlement_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Settlement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/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":"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/getsettlementbyid"}],"panels":[]}]},"httpPath":"/v0/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":"/v0/collections/settlements","summary":"List settlements","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settlements/listsettlements","deprecated":false},{"title":"/v0/collections/settlements/{settlement_id}","summary":"Get settlement by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settlements/getsettlementbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Transactions","link":"/pt-br/products/collections/v0/api/collections/transactions","routeSlug":"/pt-br/products/collections/v0/api/collections/transactions","items":[{"label":"List Transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/v0/api/collections/transactions/listtransactions","routeSlug":"/pt-br/products/collections/v0/api/collections/transactions/listtransactions","metadata":{"seo":{"title":"List Transactions","description":"API to fetch transactions across collections links or channels (transactions)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTransactions","name":"List Transactions","isWebhook":false,"pointer":"/paths/~1v0~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 across collections links or channels (transactions)."},{"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_26","description":"Filter transactions by specific transaction ID"},{"name":"status","in":"query","schemaId":"schema_32","description":"Transaction status"},{"name":"payer_id","in":"query","schemaId":"schema_13","description":"Filter transactions by payer identifier"},{"name":"beneficiary_id","in":"query","schemaId":"schema_14","description":"Filter transactions by beneficiary identifier"},{"name":"currency","in":"query","schemaId":"schema_1","description":"Filter transactions by transaction currency","example":"USDT"},{"name":"network","in":"query","schemaId":"schema_16","description":"Filter transactions by transaction network","example":"ETHEREUM"},{"name":"wallet_address","in":"query","schemaId":"schema_1","description":"Filter transactions by wallet addresss","example":"0xBb592aaaF9AcE2fbE3F735645819FA94c95a9cb5"},{"name":"since","in":"query","schemaId":"schema_33","example":"2025-06-17T12:00:00Z"},{"name":"until","in":"query","schemaId":"schema_34","example":"2025-06-17T12:00:00Z"},{"name":"page","in":"query","schemaId":"schema_7","description":"Page number (starts at 1)","example":1},{"name":"size","in":"query","schemaId":"schema_8","description":"Page size (items per page)","example":10}],"pointer":"/paths/~1v0~1collections~1transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/collections/transactions","servers":[{"url":"/_mock/pt-br/products/collections/v0/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","example":"63dd59dd-88be-41a2-a246-2f6724209422","schemaId":"schema_26"},{"name":"status","in":"query","example":"COMPLETED","schemaId":"components/schemas/TransactionStatus"},{"name":"payer_id","in":"query","example":"e471b938-98ad-45e4-b144-53a556ea047d","schemaId":"schema_13"},{"name":"beneficiary_id","in":"query","example":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","schemaId":"schema_14"},{"name":"currency","in":"query","example":"USDT","schemaId":"schema_1"},{"name":"network","in":"query","example":"ETHEREUM","schemaId":"components/schemas/Network"},{"name":"wallet_address","in":"query","example":"0xBb592aaaF9AcE2fbE3F735645819FA94c95a9cb5","schemaId":"schema_1"},{"name":"since","in":"query","example":"2025-06-17T12:00:00Z","schemaId":"schema_33"},{"name":"until","in":"query","example":"2025-06-17T12:00:00Z","schemaId":"schema_34"},{"name":"page","in":"query","example":1,"schemaId":"schema_7"},{"name":"size","in":"query","example":10,"schemaId":"schema_8"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v0/collections/transactions","href":"transactions/listtransactions","openApiOperationId":"listTransactions","summary":"List Transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/v0/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_35"}},"schemaId":"schema_35"},{"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/~1v0~1collections~1transactions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}},{"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/listtransactions"}],"panels":[]}]},"httpPath":"/v0/collections/transactions"},{"label":"Get transaction by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/v0/api/collections/transactions/gettransactionbyid","routeSlug":"/pt-br/products/collections/v0/api/collections/transactions/gettransactionbyid","metadata":{"seo":{"title":"Get transaction by ID","description":"API to fetch a transaction (payment from a payer to beneficiary)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTransactionById","name":"Get transaction by ID","isWebhook":false,"pointer":"/paths/~1v0~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)"},{"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_36","description":"Unique identifier of the transaction to retrieve","required":true}],"pointer":"/paths/~1v0~1collections~1transactions~1{transaction_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/collections/transactions/{transaction_id}","servers":[{"url":"/_mock/pt-br/products/collections/v0/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_36"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v0/collections/transactions/{transaction_id}","href":"transactions/gettransactionbyid","openApiOperationId":"getTransactionById","summary":"Get transaction by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/v0/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/Transaction"}},"schemaId":"components/schemas/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/~1v0~1collections~1transactions~1{transaction_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Transaction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/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/gettransactionbyid"}],"panels":[]}]},"httpPath":"/v0/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 across collection links and channels"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v0/collections/transactions","summary":"List Transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/listtransactions","deprecated":false},{"title":"/v0/collections/transactions/{transaction_id}","summary":"Get transaction by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/gettransactionbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhooks","link":"/pt-br/products/collections/v0/api/collections/webhooks","routeSlug":"/pt-br/products/collections/v0/api/collections/webhooks","items":[{"label":"List webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/v0/api/collections/webhooks/listwebhooks","routeSlug":"/pt-br/products/collections/v0/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/~1v0~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_37","description":"Unique identifier event type to filter webhooks","required":true},{"name":"since","in":"query","schemaId":"schema_38","example":"2025-06-17T12:00:00Z"},{"name":"until","in":"query","schemaId":"schema_39","example":"2025-06-17T12:00:00Z"},{"name":"page","in":"query","schemaId":"schema_7","description":"Page number (starts at 1)","example":1},{"name":"size","in":"query","schemaId":"schema_8","description":"Page size (items per page)","example":10}],"pointer":"/paths/~1v0~1collections~1webhooks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/collections/webhooks","servers":[{"url":"/_mock/pt-br/products/collections/v0/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","example":"2025-06-17T12:00:00Z","schemaId":"schema_38"},{"name":"until","in":"query","example":"2025-06-17T12:00:00Z","schemaId":"schema_39"},{"name":"page","in":"query","example":1,"schemaId":"schema_7"},{"name":"size","in":"query","example":10,"schemaId":"schema_8"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v0/collections/webhooks","href":"webhooks/listwebhooks","openApiOperationId":"listWebhooks","summary":"List webhooks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/v0/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_40"}},"schemaId":"schema_40"},{"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/~1v0~1collections~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"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":"/v0/collections/webhooks"},{"label":"Create webhooks","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/v0/api/collections/webhooks/createwebhooks","routeSlug":"/pt-br/products/collections/v0/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/~1v0~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/~1v0~1collections~1webhooks/post/requestBody/content/application~1json/examples/create"]}},"schemaId":"components/schemas/CreateWebhookRequest","exampleIds":["paths/~1v0~1collections~1webhooks/post/requestBody/content/application~1json/examples/create"],"pointer":"/paths/~1v0~1collections~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v0/collections/webhooks","servers":[{"url":"/_mock/pt-br/products/collections/v0/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/~1v0~1collections~1webhooks/post/requestBody/content/application~1json/examples/create"]}},"responseCodes":["201","400","401","500"],"pointer":"/v0/collections/webhooks","href":"webhooks/createwebhooks","openApiOperationId":"createWebhooks","summary":"Create webhooks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/v0/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"schemaId":"components/schemas/CreateWebhookRequest","exampleIds":["paths/~1v0~1collections~1webhooks/post/requestBody/content/application~1json/examples/create"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWebhookRequest","exampleIds":["paths/~1v0~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_41","exampleIds":["paths/~1v0~1collections~1webhooks/post/responses/201/content/application~1json/examples/created"]}},"schemaId":"schema_41","exampleIds":["paths/~1v0~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/~1v0~1collections~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_41","exampleIds":["paths/~1v0~1collections~1webhooks/post/responses/201/content/application~1json/examples/created"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41","exampleIds":["paths/~1v0~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":"/v0/collections/webhooks"},{"label":"Get a webhook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/v0/api/collections/webhooks/getwebhook","routeSlug":"/pt-br/products/collections/v0/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/~1v0~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_42","description":"Unique identifier of the webhook to retrieve","required":true}],"pointer":"/paths/~1v0~1collections~1webhooks~1{webhook_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/collections/webhooks/{webhook_id}","servers":[{"url":"/_mock/pt-br/products/collections/v0/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_42"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v0/collections/webhooks/{webhook_id}","href":"webhooks/getwebhook","openApiOperationId":"getWebhook","summary":"Get a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/v0/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/~1v0~1collections~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/examples/webhook"]}},"schemaId":"components/schemas/WebhookResponse","exampleIds":["paths/~1v0~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/~1v0~1collections~1webhooks~1{webhook_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookResponse","exampleIds":["paths/~1v0~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/~1v0~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":"/v0/collections/webhooks/{webhook_id}"},{"label":"Update a webhook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/v0/api/collections/webhooks/updatewebhook","routeSlug":"/pt-br/products/collections/v0/api/collections/webhooks/updatewebhook","metadata":{"seo":{"title":"Update a webhook","description":"Update a webhook"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebhook","name":"Update a webhook","isWebhook":false,"pointer":"/paths/~1v0~1collections~1webhooks~1{webhook_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update 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_42","description":"Unique identifier of the webhook to update","required":true}],"pointer":"/paths/~1v0~1collections~1webhooks~1{webhook_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateWebhookRequest"}},"schemaId":"components/schemas/UpdateWebhookRequest","pointer":"/paths/~1v0~1collections~1webhooks~1{webhook_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v0/collections/webhooks/{webhook_id}","servers":[{"url":"/_mock/pt-br/products/collections/v0/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_42"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateWebhookRequest"}},"responseCodes":["200","400","401","404","500"],"pointer":"/v0/collections/webhooks/{webhook_id}","href":"webhooks/updatewebhook","openApiOperationId":"updateWebhook","summary":"Update a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/v0/api/collections","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com"},{"url":"https://api.ripple.com"}],"schemaId":"components/schemas/UpdateWebhookRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateWebhookRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated webhook id","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponse","exampleIds":["paths/~1v0~1collections~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/updated"]}},"schemaId":"components/schemas/WebhookResponse","exampleIds":["paths/~1v0~1collections~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/updated"]},{"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/~1v0~1collections~1webhooks~1{webhook_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookResponse","exampleIds":["paths/~1v0~1collections~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/updated"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponse","exampleIds":["paths/~1v0~1collections~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/updated"]}}},{"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/updatewebhook"}],"panels":[]}]},"httpPath":"/v0/collections/webhooks/{webhook_id}"},{"label":"Delete a webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/v0/api/collections/webhooks/deletewebhook","routeSlug":"/pt-br/products/collections/v0/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/~1v0~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_42","description":"Unique identifier of the webhook to retrieve","required":true}],"pointer":"/paths/~1v0~1collections~1webhooks~1{webhook_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v0/collections/webhooks/{webhook_id}","servers":[{"url":"/_mock/pt-br/products/collections/v0/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_42"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v0/collections/webhooks/{webhook_id}","href":"webhooks/deletewebhook","openApiOperationId":"deleteWebhook","summary":"Delete a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/collections/v0/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_43","exampleIds":["paths/~1v0~1collections~1webhooks~1{webhook_id}/delete/responses/200/content/application~1json/examples/deleted"]}},"schemaId":"schema_43","exampleIds":["paths/~1v0~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/~1v0~1collections~1webhooks~1{webhook_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_43","exampleIds":["paths/~1v0~1collections~1webhooks~1{webhook_id}/delete/responses/200/content/application~1json/examples/deleted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_43","exampleIds":["paths/~1v0~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":"/v0/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":"/v0/collections/webhooks","summary":"List webhooks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/listwebhooks","deprecated":false},{"title":"/v0/collections/webhooks","summary":"Create webhooks","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/createwebhooks","deprecated":false},{"title":"/v0/collections/webhooks/{webhook_id}","summary":"Get a webhook","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/getwebhook","deprecated":false},{"title":"/v0/collections/webhooks/{webhook_id}","summary":"Update a webhook","prefix":{"name":"put","color":"put"},"badges":[],"link":"/webhooks/updatewebhook","deprecated":false},{"title":"/v0/collections/webhooks/{webhook_id}","summary":"Delete a webhook","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhooks/deletewebhook","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/Partner":{"id":"components/schemas/Partner","kind":"json-schema","title":"Partner","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","DRLC","NIDN","POID","SOS","TXID"],"x-enum-descriptions":{"AIIN":"Issuer Identification Number","ARNU":"Alien Registration Number","CCPT":"Passport 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 for collection links or channels","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/CreateCollectionRequest":{"id":"components/schemas/CreateCollectionRequest","kind":"json-schema","title":"CreateCollectionRequest","data":{"type":"object","description":"Request payload for creating a new collection","required":["payer_id","beneficiary_id","amount","currency","link_expiry","return_url"],"properties":{"payer_id":{"type":"string","format":"uuid","description":"Unique identifier of the payer partner","example":"0c5479ff-3772-4123-b2b7-e679e71eb570"},"beneficiary_id":{"type":"string","format":"uuid","description":"Unique identifier of the beneficiary partner","example":"01467076-8bb0-41c1-ad54-5751dd4a9e80"},"amount":{"type":"string","description":"Collection amount as a string to preserve precision","pattern":"^[0-9]+(\\.[0-9]{1,8})?$","example":"800.00"},"currency":{"type":"string","description":"Currency or asset symbol","example":"USD"},"fee_mode":{"allOf":[{"$ref":"#/components/schemas/FeeMode"}],"default":"EXCLUDED"},"reference_id":{"type":"string","description":"External reference identifier for the collection","example":"INV-2025-009"},"description":{"type":"string","description":"Human-readable description of the collection purpose","example":"Payment for Order #2668"},"link_expiry":{"type":"integer","description":"Payment link expiry time in seconds from creation","minimum":300,"maximum":2592000,"example":172800},"return_url":{"type":"string","format":"uri","description":"URL to redirect user after payment completion","example":"https://example.com/payment/completion"}}}},"components/schemas/UpdateCollectionRequest":{"id":"components/schemas/UpdateCollectionRequest","kind":"json-schema","title":"UpdateCollectionRequest","data":{"type":"object","description":"Request payload for updating a collection status","required":["status"],"properties":{"status":{"$ref":"#/components/schemas/CollectionStatus"}}}},"components/schemas/Collection":{"id":"components/schemas/Collection","kind":"json-schema","title":"Collection","data":{"type":"object","description":"Complete collection information","required":["id","payer","beneficiary","gross_amount","net_amount","currency","fee_mode","fee","amount_remaining","description","link_expiry","return_url","expires_at","status","created_at","updated_at"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the collection","example":"e8d43598-107d-4694-9fb2-934e7484c3d4"},"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"}}},"reference_id":{"type":"string","description":"External reference identifier for the collection","example":"INV-2025-009"},"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"}}},"gross_amount":{"type":"string","description":"Total amount including fees","example":"808.00"},"net_amount":{"type":"string","description":"Amount excluding buyer fees","example":"800.00"},"currency":{"type":"string","description":"Currency or asset symbol","example":"USD"},"fee_mode":{"$ref":"#/components/schemas/FeeMode"},"fee":{"type":"string","description":"Fee amount charged for the collection","example":"8.00"},"amount_remaining":{"type":"string","description":"Amount remaining for an incomplete payment","example":"758.50"},"description":{"type":"string","description":"Human-readable description of the collection purpose","example":"Payment for Order #2668"},"link_expiry":{"type":"integer","description":"Payment link expiry time in seconds from creation","example":172800},"return_url":{"type":"string","format":"uri","example":"https://example.com/payment/completion"},"expires_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the collection expires","example":"2025-06-30T23:59:59Z"},"transactions":{"type":"array","description":"List of blockchain transactions associated with this collection","items":{"$ref":"#/components/schemas/Transaction"}},"payment_link":{"type":"string","format":"uri","description":"URL for the payment interface","example":"https://collections.ripple.com/link/pay/384c5f9b"},"status":{"$ref":"#/components/schemas/CollectionStatus"},"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 collection was created","example":"2025-06-17T12:00:00Z"},"updated_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the collection was last updated","example":"2025-06-17T12:30:00Z"}}}},"components/schemas/CollectionStatus":{"id":"components/schemas/CollectionStatus","kind":"json-schema","title":"CollectionStatus","data":{"type":"string","description":"The status of the collection","enum":["CREATED","CLOSED","HOLD","EXPIRED","PENDING","PROCESSING","COMPLETED","UNDERPAID","OVERPAID","CANCELLED"],"x-enum-descriptions":{"CREATED":"Collection has been created","CLOSED":"Collection has been closed","HOLD":"Collection is on hold","EXPIRED":"Collection has expired","PENDING":"Collection is pending","PROCESSING":"Collection is being processed","COMPLETED":"Collection has been completed","UNDERPAID":"Collection has been underpaid","OVERPAID":"Collection has been overpaid","CANCELLED":"Collection has been cancelled"},"example":"PENDING"}},"components/schemas/FeeMode":{"id":"components/schemas/FeeMode","kind":"json-schema","title":"FeeMode","data":{"type":"string","description":"How fees are handled in the collection","enum":["INCLUDED","EXCLUDED"],"x-enum-descriptions":{"INCLUDED":"Fee is included in the collection net amount based on the receiving currency specified by the user","EXCLUDED":"Fee is excluded from the collection net amount based on the receiving currency specified by the user"},"example":"EXCLUDED"}},"components/schemas/Transaction":{"id":"components/schemas/Transaction","kind":"json-schema","title":"Transaction","data":{"type":"object","description":"Blockchain transaction details","required":["id","parent_id","payer","beneficiary","payment_amount","fiat_equivalent","market_rate","exchange_rate","source_transaction_details","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 parent entity (collection link or channel) for this transaction","example":"e8d43598-107d-4694-9fb2-934e7484c3d4"},"settlement_id":{"type":"string","format":"uuid","nullable":true,"description":"Identifier of the settlement associated with this transaction. Null if the transaction has not been included in a settlement yet.","example":"9f3e4d2c-1a5b-4c8e-9d7f-2e1a3b4c5d6e"},"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":"Crypto 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":"Crypto asset symbol of the payment","example":"USDT"}}},"fiat_equivalent":{"type":"object","description":"Fiat equivalent amounts for payment, fee, and net","required":["gross_amount","fee_amount","net_amount"],"properties":{"gross_amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","description":"Gross amount in fiat","example":"50.00"},"currency":{"type":"string","description":"Fiat currency code","example":"USD"}}},"fee_amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","description":"Fee amount in fiat","example":"0.50"},"currency":{"type":"string","description":"Fiat currency code","example":"USD"}}},"net_amount":{"type":"object","required":["value","currency"],"properties":{"value":{"type":"string","description":"Net amount in fiat","example":"49.50"},"currency":{"type":"string","description":"Fiat 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_transaction_details":{"type":"object","description":"On-chain transaction details","required":["network","transaction_hash","block_id","source_address","destination_address","gas_fee"],"properties":{"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"}}}}},"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":"integer","format":"int64","description":"Unix timestamp (milliseconds) when transaction was created","example":1566203005000},"date_confirmed":{"type":"integer","format":"int64","description":"Unix timestamp (milliseconds) when transaction was confirmed on blockchain","example":1566203005000}}}},"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"],"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"},"example":"COMPLETED"}},"components/schemas/CreateSettlementRequest":{"id":"components/schemas/CreateSettlementRequest","kind":"json-schema","title":"CreateSettlementRequest","data":{"type":"object","description":"Request payload for creating a new settlement","required":["type","currency","amount"],"properties":{"type":{"$ref":"#/components/schemas/SettlementType"},"currency":{"type":"string","description":"Currency code for the settlement","example":"USD"},"amount":{"type":"string","description":"Settlement amount as a string to preserve precision","pattern":"^[0-9]+(\\.[0-9]{1,8})?$","example":"100.00"}}}},"components/schemas/Settlement":{"id":"components/schemas/Settlement","kind":"json-schema","title":"Settlement","data":{"type":"object","description":"Settlement information","required":["id","type","currency","gross_amount","settlement_amount","fees","status","data","transactions"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the settlement","example":"63dd59dd-88be-41a2-a246-2f6724209422"},"type":{"$ref":"#/components/schemas/SettlementType"},"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":"string","description":"Total fees applied to the settlement","example":"0.50"},"data":{"type":"object","description":"Additional settlement data including account details","properties":{"sending_account":{"$ref":"#/components/schemas/SettlementAccountDetails"},"receiving_account":{"$ref":"#/components/schemas/SettlementAccountDetails"},"transaction_reference_numbers":{"type":"array","items":{"type":"string"},"description":"Bank reference numbers for the settlement transaction","example":["ABC12345"]},"description":{"type":"string","description":"Human-readable description of the settlement","example":"Monthly Payout"}}},"transactions":{"type":"array","description":"List of transactions associated with this settlement","items":{"$ref":"#/components/schemas/Transaction"}},"status":{"$ref":"#/components/schemas/SettlementStatus"},"reason":{"type":"string","nullable":true,"description":"Reason for current status (if applicable)","example":null}}}},"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/SettlementAccountDetails":{"id":"components/schemas/SettlementAccountDetails","kind":"json-schema","title":"SettlementAccountDetails","data":{"type":"object","description":"Account details for settlement transactions","required":["account_holder","institution_name","account_number","routing_number"],"properties":{"account_holder":{"type":"string","description":"Full name of the account holder","example":"John Doe"},"institution_name":{"type":"string","description":"Name of the financial institution","example":"Bank of America"},"account_number":{"type":"string","description":"Account number for the settlement","example":"XXXX6789"},"routing_number":{"type":"string","description":"Routing number for the financial institution","example":"XXXX4321"}}}},"components/schemas/CreateChannelRequest":{"id":"components/schemas/CreateChannelRequest","kind":"json-schema","title":"CreateChannelRequest","data":{"type":"object","required":["payer_id","beneficiary_id","payment_currency","channel_currency"],"properties":{"payer_id":{"type":"string","format":"uuid","description":"Unique identifier of the payer partner","example":"e471b938-98ad-45e4-b144-53a556ea047d"},"beneficiary_id":{"type":"string","format":"uuid","description":"Unique identifier of the beneficiary partner","example":"291ecf34-a01d-466a-b0fd-662a88b7a1bb"},"payment_currency":{"$ref":"#/components/schemas/CryptoCurrency"},"channel_currency":{"$ref":"#/components/schemas/FiatCurrency"}}}},"components/schemas/Channel":{"id":"components/schemas/Channel","kind":"json-schema","title":"Channel","data":{"type":"object","description":"Complete channel information","required":["id","payer","beneficiary","channel_currency","payment_currency","wallet","transactions","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 for the beneficiary partner","example":"291ecf34-a01d-466a-b0fd-662a88b7a1bb"},"name":{"type":"string","description":"Full name of the beneficiary partner","example":"Hong Kong Exports Ltd."},"email":{"type":"string","format":"email","description":"Email address of the beneficiary partner","example":"hongkong@exports.com"}}},"payment_currency":{"$ref":"#/components/schemas/CryptoCurrency"},"channel_currency":{"$ref":"#/components/schemas/FiatCurrency"},"wallet":{"$ref":"#/components/schemas/Wallet"},"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"},"transactions":{"type":"array","description":"List of blockchain transactions associated with this channel","items":{"$ref":"#/components/schemas/Transaction"}},"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/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/Wallet":{"id":"components/schemas/Wallet","kind":"json-schema","title":"Wallet","data":{"type":"object","description":"Wallet details for the channel","required":["address","currency","network"],"properties":{"address":{"type":"string","description":"Wallet address for the channel","example":"0xBb592aaaF9AcE2fbE3F735645819FA94c95a9cb5"},"currency":{"type":"string","description":"Currency held in the wallet","example":"USDC"},"network":{"$ref":"#/components/schemas/Network","description":"Blockchain network for the wallet","example":"ETHEREUM"}}}},"components/schemas/Currency":{"id":"components/schemas/Currency","kind":"json-schema","title":"Currency","data":{"type":"object","description":"Currency (crypto or fiat)","discriminator":{"propertyName":"type","mapping":{"CRYPTO":"#/components/schemas/CryptoCurrency","FIAT":"#/components/schemas/FiatCurrency"}},"oneOf":[{"$ref":"#/components/schemas/CryptoCurrency"},{"$ref":"#/components/schemas/FiatCurrency"}]}},"components/schemas/CryptoCurrency":{"id":"components/schemas/CryptoCurrency","kind":"json-schema","title":"CryptoCurrency","data":{"type":"object","description":"Metadata for a crypto asset","required":["type","asset","network"],"properties":{"type":{"type":"string","enum":["CRYPTO"],"description":"Discriminator: indicates crypto asset metadata"},"asset":{"type":"string","description":"Ticker symbol of the crypto asset","example":"USDC"},"network":{"$ref":"#/components/schemas/Network"}}}},"components/schemas/FiatCurrency":{"id":"components/schemas/FiatCurrency","kind":"json-schema","title":"FiatCurrency","data":{"type":"object","description":"Metadata for a fiat currency","required":["type","asset"],"properties":{"type":{"type":"string","enum":["FIAT"],"description":"Discriminator: indicates fiat currency metadata"},"asset":{"type":"string","description":"Fiat currency code (ISO 4217)","example":"USD"}}}},"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":"ETHEREUM"}},"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"],"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"},"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/UpdateWebhookRequest":{"id":"components/schemas/UpdateWebhookRequest","kind":"json-schema","title":"UpdateWebhookRequest","data":{"type":"object","required":["callback_url"],"properties":{"callback_url":{"type":"string","format":"uri","description":"HTTPS URL to POST events to.","example":"https://webhook-updated.partner.example/webhooks"}}}},"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":"Hex-encoded public key used to verify webhook signatures.","example":"04bfcabf3c3e5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8"}}}},"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":1},"size":{"type":"integer","example":10},"total_elements":{"type":"integer","example":100},"total_pages":{"type":"integer","example":10}},"required":["page","size","total_elements","total_pages"]}},"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","example":"e8d43598-107d-4694-9fb2-934e7484c3d4"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"0c5479ff-3772-4123-b2b7-e679e71eb570"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"01467076-8bb0-41c1-ad54-5751dd4a9e80"},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"string","format":"date-time","description":"ISO 8601 timestamp after collection was created"},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"string","format":"date-time","description":"ISO 8601 timestamp before collection was created"},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"integer","minimum":1,"default":1},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"integer","minimum":1,"default":10},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Collection"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"22a0337b-8e62-449c-91ca-a0f830c55733"},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"object","required":["id"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the collection to cancel","example":"92e001a4-311a-4a63-ab2a-f050207c5283"},"reason":{"type":"string","description":"Optional reason for cancelling the collection","example":"Collection cancelled"}}},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"e471b938-98ad-45e4-b144-53a556ea047d"},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"291ecf34-a01d-466a-b0fd-662a88b7a1bb"},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ChannelStatus"},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"string","$ref":"#/components/schemas/Network"},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"string","format":"date-time","description":"ISO 8601 timestamp after channel was created"},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"string","format":"date-time","description":"ISO 8601 timestamp before channel was created"},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"string","format":"date-time","description":"ISO 8601 timestamp after partner was created"},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"string","format":"date-time","description":"ISO 8601 timestamp before partner was created"},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"string","$ref":"#/components/schemas/PartnerType"},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"string","$ref":"#/components/schemas/PartnerStatus"},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"string","description":"External reference id for partner"},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Partner"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"63dd59dd-88be-41a2-a246-2f6724209422"},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"$ref":"#/components/schemas/SettlementType"},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"$ref":"#/components/schemas/SettlementStatus"},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"type":"string","format":"date-time","description":"ISO 8601 timestamp after settlement was created"},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"string","format":"date-time","description":"ISO 8601 timestamp before settlement was created"},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Settlement"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"$ref":"#/components/schemas/TransactionStatus"},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"type":"string","format":"date-time","description":"ISO 8601 timestamp after transaction was created"},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"type":"string","format":"date-time","description":"ISO 8601 timestamp before transaction was created"},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Transaction"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"487ba009-56cf-4ad9-8b5c-045e27893e00"},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":"string","$ref":"#/components/schemas/EventType"},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"type":"string","format":"date-time","description":"ISO 8601 timestamp after webhook was created"},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"type":"string","format":"date-time","description":"ISO 8601 timestamp before webhook was created"},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/WebhookResponse"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/WebhookResponse"}},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"5c0d9ec9-5ad8-4a43-a1b4-6f8f1f6c4c10"},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_43"}},"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/~1v0~1collections~1links/post/requestBody/content/application~1json/examples/example_with_excluded_fee":{"value":{"payer_id":"0c5479ff-3772-4123-b2b7-e679e71eb570","beneficiary_id":"01467076-8bb0-41c1-ad54-5751dd4a9e80","amount":"800.00","currency":"USD","fee_mode":"EXCLUDED","reference_id":"INV-2025-009","description":"Payment for Order #2668","link_expiry":172800,"return_url":"https://example.com/payment/completion"},"key":"example_with_excluded_fee","summary":"Example for EXCLUDED fee_mode","id":"paths/~1v0~1collections~1links/post/requestBody/content/application~1json/examples/example_with_excluded_fee"},"paths/~1v0~1collections~1links/post/requestBody/content/application~1json/examples/example_with_included_fee":{"value":{"payer_id":"0c5479ff-3772-4123-b2b7-e679e71eb570","beneficiary_id":"01467076-8bb0-41c1-ad54-5751dd4a9e80","amount":"800.00","currency":"USD","fee_mode":"INCLUDED","reference_id":"INV-2025-009","description":"Payment for Order #2668","link_expiry":172800,"return_url":"https://example.com/payment/completion"},"key":"example_with_included_fee","summary":"Example for INCLUDED fee_mode","id":"paths/~1v0~1collections~1links/post/requestBody/content/application~1json/examples/example_with_included_fee"},"paths/~1v0~1collections~1links/post/responses/201/content/application~1json/example":{"value":{"id":"e8d43598-107d-4694-9fb2-934e7484c3d4","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"},"reference_id":"INV-2025-009","gross_amount":"808.00","net_amount":"800.00","currency":"USD","fee_mode":"EXCLUDED","fee":"8.00","amount_remaining":"808.00","description":"Payment for Order #2668","link_expiry":172800,"return_url":"https://example.com/payment/completion","expires_at":"2025-06-30T23:59:59Z","transactions":[],"payment_link":"https://collections.ripple.com/link/pay/384c5f9b","status":"CREATED","reason":null,"created_at":"2025-06-17T12:00:00Z","updated_at":"2025-06-17T12:30:00Z"},"id":"paths/~1v0~1collections~1links/post/responses/201/content/application~1json/example"},"paths/~1v0~1collections~1links~1{collection_id}/get/responses/200/content/application~1json/example":{"value":{"id":"22a0337b-8e62-449c-91ca-a0f830c55733","payer":{"id":"0c5479ff-3772-4123-b2b7-e679e71eb570","name":"Nigerian Imports Ltd.","email":"nigerian@imports.com"},"reference_id":"INV-2025-009","beneficiary":{"id":"01467076-8bb0-41c1-ad54-5751dd4a9e80","name":"Hong Kong Exports Ltd.","email":"hongkong@exports.com"},"gross_amount":"800.00","net_amount":"792.00","currency":"USD","fee_mode":"INCLUDED","fee":"8.00","amount_remaining":"750.50","description":"Payment for Order #2670","link_expiry":172800,"return_url":"https://example.com/payment/completion","expires_at":"2025-06-30T23:59:59Z","transactions":[{"id":"487ba009-56cf-4ad9-8b5c-045e27893e00","parent_id":"22a0337b-8e62-449c-91ca-a0f830c55733","settlement_id":"9f3e4d2c-1a5b-4c8e-9d7f-2e1a3b4c5d6e","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"},"fiat_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_transaction_details":{"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":1566203005000,"date_confirmed":1566203005000}],"payment_link":"https://collections.ripple.com/link/pay/384c5f9b","status":"CREATED","reason":null,"created_at":"2025-06-17T12:00:00Z","updated_at":"2025-06-17T12:30:00Z"},"id":"paths/~1v0~1collections~1links~1{collection_id}/get/responses/200/content/application~1json/example"},"paths/~1v0~1collections~1links~1cancel/post/responses/200/content/application~1json/example":{"value":{"id":"92e001a4-311a-4a63-ab2a-f050207c5283","payer":{"id":"0c5479ff-3772-4123-b2b7-e679e71eb570","name":"Nigerian Imports Ltd.","email":"nigerian@imports.com"},"reference_id":"INV-2025-009","beneficiary":{"id":"01467076-8bb0-41c1-ad54-5751dd4a9e80","name":"Hong Kong Exports Ltd.","email":"hongkong@exports.com"},"gross_amount":"800.00","net_amount":"792.00","currency":"USD","fee_mode":"INCLUDED","fee":"8.00","amount_remaining":"800.00","description":"Payment for Order #2669","link_expiry":172800,"return_url":"https://example.com/payment/completion","expires_at":"2025-06-30T23:59:59Z","transactions":[],"payment_link":"https://collections.ripple.com/link/pay/124c5f9b","status":"CANCELLED","reason":"Collection cancelled","created_at":"2025-06-17T12:00:00Z","updated_at":"2025-06-17T12:30:00Z"},"id":"paths/~1v0~1collections~1links~1cancel/post/responses/200/content/application~1json/example"},"paths/~1v0~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"},"channel_currency":{"type":"FIAT","asset":"USD"},"payment_currency":{"type":"CRYPTO","asset":"USDC","network":"ETHEREUM"},"wallet":{"address":"0xBb592aaaF9AcE2fbE3F735645819FA94c95a9cb5","currency":"USDC","network":"ETHEREUM"},"payment_link":"https://collections.ripplenet.com/pay/channel/3fa85f64-5717-4562-b3fc-2c963f66afa6","transactions":[{"id":"487ba009-56cf-4ad9-8b5c-045e27893e00","parent_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","settlement_id":"9f3e4d2c-1a5b-4c8e-9d7f-2e1a3b4c5d6e","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":"USDC"},"fiat_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":"USDC","counter":"USD","rate":"1.00"},"exchange_rate":{"base":"USDC","counter":"USD","rate":"0.99"},"source_transaction_details":{"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":1566203005000,"date_confirmed":1566203005000}],"status":"ACTIVE","reason":null,"created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"}],"page":{"page":1,"size":10,"total_elements":1,"total_pages":1}},"key":"default","summary":"Example channel list response","id":"paths/~1v0~1collections~1channels/get/responses/200/content/application~1json/examples/default"},"paths/~1v0~1collections~1channels/post/requestBody/content/application~1json/examples/default":{"value":{"payer_id":"e471b938-98ad-45e4-b144-53a556ea047d","beneficiary_id":"291ecf34-a01d-466a-b0fd-662a88b7a1bb","payment_currency":{"type":"CRYPTO","asset":"USDC","network":"ETHEREUM"},"channel_currency":{"type":"FIAT","asset":"USD"}},"key":"default","summary":"Example channel creation request","id":"paths/~1v0~1collections~1channels/post/requestBody/content/application~1json/examples/default"},"paths/~1v0~1collections~1channels/post/responses/201/content/application~1json/examples/default":{"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"},"channel_currency":{"type":"FIAT","asset":"USD"},"payment_currency":{"type":"CRYPTO","asset":"USDC","network":"ETHEREUM"},"wallet":{"address":"0xBb592aaaF9AcE2fbE3F735645819FA94c95a9cb5","currency":"USDC","network":"ETHEREUM"},"payment_link":"https://collections.ripplenet.com/pay/channel/3fa85f64-5717-4562-b3fc-2c963f66afa6","transactions":[],"status":"ACTIVE","reason":null,"created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"},"key":"default","summary":"Example channel response","id":"paths/~1v0~1collections~1channels/post/responses/201/content/application~1json/examples/default"},"paths/~1v0~1collections~1channels~1{channel_id}/get/responses/200/content/application~1json/examples/default":{"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"},"channel_currency":{"type":"FIAT","asset":"USD"},"payment_currency":{"type":"CRYPTO","asset":"USDC","network":"ETHEREUM"},"wallet":{"address":"0xBb592aaaF9AcE2fbE3F735645819FA94c95a9cb5","currency":"USDC","network":"ETHEREUM"},"payment_link":"https://collections.ripplenet.com/pay/channel/3fa85f64-5717-4562-b3fc-2c963f66afa6","transactions":[{"id":"487ba009-56cf-4ad9-8b5c-045e27893e00","parent_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","settlement_id":"9f3e4d2c-1a5b-4c8e-9d7f-2e1a3b4c5d6e","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":"USDC"},"fiat_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":"USDC","counter":"USD","rate":"1.00"},"exchange_rate":{"base":"USDC","counter":"USD","rate":"0.99"},"source_transaction_details":{"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":1566203005000,"date_confirmed":1566203005000}],"status":"ACTIVE","reason":null,"created_at":"2025-09-18T22:54:00.542Z","updated_at":"2025-09-18T22:54:00.542Z"},"key":"default","summary":"Example channel response","id":"paths/~1v0~1collections~1channels~1{channel_id}/get/responses/200/content/application~1json/examples/default"},"paths/~1v0~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/~1v0~1collections~1webhooks/post/requestBody/content/application~1json/examples/create"},"paths/~1v0~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":"9abc1234..."},{"id":"1c9fe6fd-1dd8-4e9a-8de2-7f4c89b4d210","event_type":"SETTLEMENT_COMPLETED","callback_url":"https://webhook.partner.example/webhooks","signature_verification_key":"1def5678..."}],"key":"created","summary":"created","id":"paths/~1v0~1collections~1webhooks/post/responses/201/content/application~1json/examples/created"},"paths/~1v0~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":"04bfcabf3c3e5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8"},"key":"webhook","summary":"webhook","id":"paths/~1v0~1collections~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/examples/webhook"},"paths/~1v0~1collections~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/updated":{"value":{"id":"5c0d9ec9-5ad8-4a43-a1b4-6f8f1f6c4c10","event_type":"WALLET_ADDRESS_CREATED","callback_url":"https://webhook-updated.partner.example/webhooks","signature_verification_key":"1dec2311..."},"key":"updated","summary":"updated","id":"paths/~1v0~1collections~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/updated"},"paths/~1v0~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/~1v0~1collections~1webhooks~1{webhook_id}/delete/responses/200/content/application~1json/examples/deleted"}},"securitySchemeStore":{"Bearer":{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"servers":[{"url":"/_mock/pt-br/products/collections/v0/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/v0/api/collections","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/@l10n/pt-BR/products/collections/@v0/api/collections.json?download"},{"url":"/_bundle/@l10n/pt-BR/products/collections/@v0/api/collections.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Ripple Collections (alpha)","description":"The Ripple Collection APIs are used to manage collections, manage payment channels, manage partners 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/v0/api/collections","routesMapping":{}}