{"items":[{"type":"separator","version":"v0","versionFolderId":"3a2d3fa8","label":"Get started"},{"type":"link","fsPath":"@l10n/pt-BR/products/collections/@v0/index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/pt-br/products/collections/v0","routeSlug":"/pt-br/products/collections/v0","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"type":"link","fsPath":"@l10n/pt-BR/products/collections/@v0/guides/authentication.md","metadata":{"type":"markdown"},"label":"Authentication","link":"/pt-br/products/collections/v0/guides/authentication","separatorLine":true,"routeSlug":"/pt-br/products/collections/v0/guides/authentication","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"type":"separator","version":"v0","versionFolderId":"3a2d3fa8","label":"Concepts"},{"type":"link","fsPath":"@l10n/pt-BR/products/collections/@v0/concepts/partners.md","metadata":{"type":"markdown"},"label":"Partners","link":"/pt-br/products/collections/v0/concepts/partners","routeSlug":"/pt-br/products/collections/v0/concepts/partners","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"type":"link","fsPath":"@l10n/pt-BR/products/collections/@v0/concepts/collections.md","metadata":{"type":"markdown"},"label":"Collections","link":"/pt-br/products/collections/v0/concepts/collections","routeSlug":"/pt-br/products/collections/v0/concepts/collections","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"type":"link","fsPath":"@l10n/pt-BR/products/collections/@v0/concepts/channels.md","metadata":{"type":"markdown"},"label":"Channels","link":"/pt-br/products/collections/v0/concepts/channels","routeSlug":"/pt-br/products/collections/v0/concepts/channels","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"type":"link","fsPath":"@l10n/pt-BR/products/collections/@v0/concepts/transactions.md","metadata":{"type":"markdown"},"label":"Transactions","link":"/pt-br/products/collections/v0/concepts/transactions","separatorLine":true,"routeSlug":"/pt-br/products/collections/v0/concepts/transactions","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"type":"separator","version":"v0","versionFolderId":"3a2d3fa8","label":"Guides"},{"type":"link","fsPath":"@l10n/pt-BR/products/collections/@v0/guides/verifying-webhooks.md","metadata":{"type":"markdown"},"label":"Verify webhook signatures","link":"/pt-br/products/collections/v0/guides/verifying-webhooks","routeSlug":"/pt-br/products/collections/v0/guides/verifying-webhooks","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"type":"link","fsPath":"@l10n/pt-BR/products/collections/@v0/guides/idempotency.md","metadata":{"type":"markdown"},"label":"Retry requests safely","link":"/pt-br/products/collections/v0/guides/idempotency","separatorLine":true,"routeSlug":"/pt-br/products/collections/v0/guides/idempotency","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"type":"separator","version":"v0","versionFolderId":"3a2d3fa8","label":"API Reference"},{"type":"group","fsPath":"@l10n/pt-BR/products/collections/@v0/api/collections.yml","link":"/pt-br/products/collections/v0/api/collections","routeSlug":"/pt-br/products/collections/v0/api/collections","label":"Collections API","items":[{"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","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"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."}},"httpPath":"/v2/oauth/token","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"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."}},"httpPath":"/v2/oauth/token/test","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"}],"version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"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."}},"httpPath":"/v0/collections/links","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"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."}},"httpPath":"/v0/collections/links","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"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."}},"httpPath":"/v0/collections/links/{collection_id}","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"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."}},"httpPath":"/v0/collections/links/cancel","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"}],"version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"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."}},"httpPath":"/v0/collections/channels","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"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."}},"httpPath":"/v0/collections/channels","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"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."}},"httpPath":"/v0/collections/channels/{channel_id}","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"}],"version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"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."}},"httpPath":"/v0/collections/partners","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"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."}},"httpPath":"/v0/collections/partners","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"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."}},"httpPath":"/v0/collections/partners/{partner_id}","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"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."}},"httpPath":"/v0/collections/partners/{partner_id}","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"}],"version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"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)."}},"httpPath":"/v0/collections/settlements","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"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)."}},"httpPath":"/v0/collections/settlements/{settlement_id}","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"}],"version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"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)."}},"httpPath":"/v0/collections/transactions","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"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)"}},"httpPath":"/v0/collections/transactions/{transaction_id}","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"}],"version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"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"}},"httpPath":"/v0/collections/webhooks","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"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."}},"httpPath":"/v0/collections/webhooks","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"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"}},"httpPath":"/v0/collections/webhooks/{webhook_id}","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"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"}},"httpPath":"/v0/collections/webhooks/{webhook_id}","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"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"}},"httpPath":"/v0/collections/webhooks/{webhook_id}","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"}],"version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"}],"metadata":{"type":"openapi","title":"Ripple Collections (alpha)","version":"0.0.1","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. "},"version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"type":"separator","version":"v0","versionFolderId":"3a2d3fa8","label":"Announcements"},{"type":"link","fsPath":"@l10n/pt-BR/products/collections/@v0/announcements/version-status.md","metadata":{"type":"markdown"},"label":"Version status","link":"/pt-br/products/collections/v0/announcements/version-status","separatorLine":true,"routeSlug":"/pt-br/products/collections/v0/announcements/version-status","version":"v0","isDefault":false,"versionFolderId":"3a2d3fa8"},{"type":"separator","version":"v1","versionFolderId":"3a2d3fa8","label":"Get started"},{"type":"link","fsPath":"@l10n/pt-BR/products/collections/@v1/index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/pt-br/products/collections","routeSlug":"/pt-br/products/collections","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"type":"link","fsPath":"@l10n/pt-BR/products/collections/@v1/guides/authentication.md","metadata":{"type":"markdown"},"label":"Authentication","link":"/pt-br/products/collections/guides/authentication","separatorLine":true,"routeSlug":"/pt-br/products/collections/guides/authentication","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"type":"separator","version":"v1","versionFolderId":"3a2d3fa8","label":"Concepts"},{"type":"link","fsPath":"@l10n/pt-BR/products/collections/@v1/concepts/partners.md","metadata":{"type":"markdown"},"label":"Partners","link":"/pt-br/products/collections/concepts/partners","routeSlug":"/pt-br/products/collections/concepts/partners","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"type":"link","fsPath":"@l10n/pt-BR/products/collections/@v1/concepts/accounts.md","metadata":{"type":"markdown"},"label":"Accounts","link":"/pt-br/products/collections/concepts/accounts","routeSlug":"/pt-br/products/collections/concepts/accounts","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"type":"link","fsPath":"@l10n/pt-BR/products/collections/@v1/concepts/collections.md","metadata":{"type":"markdown"},"label":"Collections","link":"/pt-br/products/collections/concepts/collections","routeSlug":"/pt-br/products/collections/concepts/collections","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"type":"link","fsPath":"@l10n/pt-BR/products/collections/@v1/concepts/channels.md","metadata":{"type":"markdown"},"label":"Channels","link":"/pt-br/products/collections/concepts/channels","routeSlug":"/pt-br/products/collections/concepts/channels","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"type":"link","fsPath":"@l10n/pt-BR/products/collections/@v1/concepts/transactions.md","metadata":{"type":"markdown"},"label":"Transactions","link":"/pt-br/products/collections/concepts/transactions","routeSlug":"/pt-br/products/collections/concepts/transactions","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"type":"link","fsPath":"@l10n/pt-BR/products/collections/@v1/concepts/settlements.md","metadata":{"type":"markdown"},"label":"Settlements","link":"/pt-br/products/collections/concepts/settlements","routeSlug":"/pt-br/products/collections/concepts/settlements","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"type":"link","fsPath":"@l10n/pt-BR/products/collections/@v1/concepts/webhooks.md","metadata":{"type":"markdown"},"label":"Webhooks","link":"/pt-br/products/collections/concepts/webhooks","separatorLine":true,"routeSlug":"/pt-br/products/collections/concepts/webhooks","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"type":"separator","version":"v1","versionFolderId":"3a2d3fa8","label":"Guides"},{"type":"link","fsPath":"@l10n/pt-BR/products/collections/@v1/guides/verifying-webhooks.md","metadata":{"type":"markdown"},"label":"Verify webhook signatures","link":"/pt-br/products/collections/guides/verifying-webhooks","routeSlug":"/pt-br/products/collections/guides/verifying-webhooks","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"type":"link","fsPath":"@l10n/pt-BR/products/collections/@v1/guides/idempotency.md","metadata":{"type":"markdown"},"label":"Retry requests safely","link":"/pt-br/products/collections/guides/idempotency","separatorLine":true,"routeSlug":"/pt-br/products/collections/guides/idempotency","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"type":"separator","version":"v1","versionFolderId":"3a2d3fa8","label":"API Reference"},{"type":"group","fsPath":"@l10n/pt-BR/products/collections/@v1/api/collections.yml","link":"/pt-br/products/collections/api/collections","routeSlug":"/pt-br/products/collections/api/collections","label":"Collections API","items":[{"type":"link","label":"API Environments","link":"/pt-br/products/collections/api/collections/section/api-environments","routeSlug":"/pt-br/products/collections/api/collections/section/api-environments","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"type":"group","label":"Authentication","link":"/pt-br/products/collections/api/collections/authentication","routeSlug":"/pt-br/products/collections/api/collections/authentication","items":[{"label":"Request an access token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/authentication/authenticate","routeSlug":"/pt-br/products/collections/api/collections/authentication/authenticate","metadata":{"seo":{"title":"Request an access token","description":"Request an access token for authentication with Ripple APIs."}},"httpPath":"/v2/oauth/token","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"label":"Test access token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/authentication/testauthtoken","routeSlug":"/pt-br/products/collections/api/collections/authentication/testauthtoken","metadata":{"seo":{"title":"Test access token","description":"Test if an access token can be used for authentication with Ripple APIs and how much time remains on it."}},"httpPath":"/v2/oauth/token/test","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"}],"version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"type":"group","label":"Accounts","link":"/pt-br/products/collections/api/collections/accounts","routeSlug":"/pt-br/products/collections/api/collections/accounts","items":[{"label":"List accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/accounts/listaccountsv1","routeSlug":"/pt-br/products/collections/api/collections/accounts/listaccountsv1","metadata":{"seo":{"title":"List accounts","description":"Retrieves a list of accounts, filterable by query parameters."}},"httpPath":"/v1/collections/accounts","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"label":"Create an account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/accounts/createaccountv1","routeSlug":"/pt-br/products/collections/api/collections/accounts/createaccountv1","metadata":{"seo":{"title":"Create an account","description":"Creates a new payment account for a beneficiary partner. The account type (CRYPTO or FIAT) is determined by the currency specified. Account creation is subject to the beneficiary's partner eligibility."}},"httpPath":"/v1/collections/accounts","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"label":"Get account by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/accounts/getaccountbyidv1","routeSlug":"/pt-br/products/collections/api/collections/accounts/getaccountbyidv1","metadata":{"seo":{"title":"Get account by ID","description":"Retrieves the details of a specific account by its ID."}},"httpPath":"/v1/collections/accounts/{account_id}","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"label":"List transactions for an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/accounts/listtransactionsbyaccountidv1","routeSlug":"/pt-br/products/collections/api/collections/accounts/listtransactionsbyaccountidv1","metadata":{"seo":{"title":"List transactions for an account","description":"Retrieves a paginated list of transactions associated with a specific account. Replaces the embedded transactions array in channel/collection responses for better scalability and pagination support."}},"httpPath":"/v1/collections/accounts/{account_id}/transactions","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"}],"version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"type":"group","label":"Collection Links","link":"/pt-br/products/collections/api/collections/collection-links","routeSlug":"/pt-br/products/collections/api/collections/collection-links","items":[{"label":"List collections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/collection-links/listcollectionsv1","routeSlug":"/pt-br/products/collections/api/collections/collection-links/listcollectionsv1","metadata":{"seo":{"title":"List collections","description":"Retrieves a list of collections using account-based routing, filterable by query parameters."}},"httpPath":"/v1/collections/links","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"label":"Create a collection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/collection-links/createcollectionv1","routeSlug":"/pt-br/products/collections/api/collections/collection-links/createcollectionv1","metadata":{"seo":{"title":"Create a collection","description":"Creates a new payment link for a collection using account-based routing. The collection is associated with an account which determines the available payment rails and currency. The amount is denominated in the account's currency."}},"httpPath":"/v1/collections/links","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"label":"Get collection details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/collection-links/getcollectionbyidv1","routeSlug":"/pt-br/products/collections/api/collections/collection-links/getcollectionbyidv1","metadata":{"seo":{"title":"Get collection details","description":"Retrieves the details of a specific collection by its ID using account-based routing."}},"httpPath":"/v1/collections/links/{collection_id}","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"}],"version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"type":"group","label":"Collection Channels","link":"/pt-br/products/collections/api/collections/collection-channels","routeSlug":"/pt-br/products/collections/api/collections/collection-channels","items":[{"label":"List channels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/collection-channels/listchannelsv1","routeSlug":"/pt-br/products/collections/api/collections/collection-channels/listchannelsv1","metadata":{"seo":{"title":"List channels","description":"Retrieves a list of channels using account-based routing, filterable by query parameters."}},"httpPath":"/v1/collections/channels","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"label":"Create a channel","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/collection-channels/createchannelv1","routeSlug":"/pt-br/products/collections/api/collections/collection-channels/createchannelv1","metadata":{"seo":{"title":"Create a channel","description":"Creates a new payment channel using account-based routing. The channel is associated with an account which determines the available payment rails (crypto networks or fiat rails) based on the account's currency."}},"httpPath":"/v1/collections/channels","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"label":"Get channel details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/collection-channels/getchannelbyidv1","routeSlug":"/pt-br/products/collections/api/collections/collection-channels/getchannelbyidv1","metadata":{"seo":{"title":"Get channel details","description":"Retrieves the details of a specific channel by its ID using account-based routing."}},"httpPath":"/v1/collections/channels/{channel_id}","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"label":"Add payment methods to a channel","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/collection-channels/addpaymentmethodsv1","routeSlug":"/pt-br/products/collections/api/collections/collection-channels/addpaymentmethodsv1","metadata":{"seo":{"title":"Add payment methods to a channel","description":"Adds one or more payment methods (currencies) to an existing channel. Each currency must be supported by the channel's associated account. Returns the updated channel."}},"httpPath":"/v1/collections/channels/{channel_id}/payment-methods","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"}],"version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"type":"group","label":"Partners","link":"/pt-br/products/collections/api/collections/partners","routeSlug":"/pt-br/products/collections/api/collections/partners","items":[{"label":"List partners","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/partners/listpartnersv1","routeSlug":"/pt-br/products/collections/api/collections/partners/listpartnersv1","metadata":{"seo":{"title":"List partners","description":"Retrieves a list of partners, filterable by ID or type."}},"httpPath":"/v1/collections/partners","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"label":"Create a partner","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/partners/createpartnerv1","routeSlug":"/pt-br/products/collections/api/collections/partners/createpartnerv1","metadata":{"seo":{"title":"Create a partner","description":"This API allows users to add new parties who can transact."}},"httpPath":"/v1/collections/partners","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"label":"Get partner by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/partners/getpartnerbyidv1","routeSlug":"/pt-br/products/collections/api/collections/partners/getpartnerbyidv1","metadata":{"seo":{"title":"Get partner by ID","description":"This API allows users to retrieve a specific partner by their ID."}},"httpPath":"/v1/collections/partners/{partner_id}","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"label":"Update a partner","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/partners/updatepartnerv1","routeSlug":"/pt-br/products/collections/api/collections/partners/updatepartnerv1","metadata":{"seo":{"title":"Update a partner","description":"API to update a partner to use in collections API."}},"httpPath":"/v1/collections/partners/{partner_id}","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"}],"version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"type":"group","label":"Settlements","link":"/pt-br/products/collections/api/collections/settlements","routeSlug":"/pt-br/products/collections/api/collections/settlements","items":[{"label":"List settlements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/settlements/listsettlementsv1","routeSlug":"/pt-br/products/collections/api/collections/settlements/listsettlementsv1","metadata":{"seo":{"title":"List settlements","description":"API to fetch first party payouts (settlements) with enhanced v1 response format."}},"httpPath":"/v1/collections/settlements","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"label":"Create a settlement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/settlements/createsettlementv1","routeSlug":"/pt-br/products/collections/api/collections/settlements/createsettlementv1","metadata":{"seo":{"title":"Create a settlement","description":"API to initiate a first party payout (settlement to our customer)."}},"httpPath":"/v1/collections/settlements","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"label":"Get settlement by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/settlements/getsettlementbyidv1","routeSlug":"/pt-br/products/collections/api/collections/settlements/getsettlementbyidv1","metadata":{"seo":{"title":"Get settlement by ID","description":"API to fetch a first party payout (settlement to our customer) with enhanced v1 response format."}},"httpPath":"/v1/collections/settlements/{settlement_id}","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"}],"version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"type":"group","label":"Transactions","link":"/pt-br/products/collections/api/collections/transactions","routeSlug":"/pt-br/products/collections/api/collections/transactions","items":[{"label":"List Transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/transactions/listtransactionsv1","routeSlug":"/pt-br/products/collections/api/collections/transactions/listtransactionsv1","metadata":{"seo":{"title":"List Transactions","description":"API to fetch transactions across collection links or channels using account-based routing."}},"httpPath":"/v1/collections/transactions","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"label":"Get transaction by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/transactions/gettransactionbyidv1","routeSlug":"/pt-br/products/collections/api/collections/transactions/gettransactionbyidv1","metadata":{"seo":{"title":"Get transaction by ID","description":"API to fetch a transaction (payment from a payer to beneficiary) using account-based routing."}},"httpPath":"/v1/collections/transactions/{transaction_id}","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"}],"version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"type":"group","label":"Webhooks","link":"/pt-br/products/collections/api/collections/webhooks","routeSlug":"/pt-br/products/collections/api/collections/webhooks","items":[{"label":"List webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/webhooks/listwebhooks","routeSlug":"/pt-br/products/collections/api/collections/webhooks/listwebhooks","metadata":{"seo":{"title":"List webhooks","description":"List webhooks"}},"httpPath":"/v1/collections/webhooks","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"label":"Create webhooks","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/webhooks/createwebhooks","routeSlug":"/pt-br/products/collections/api/collections/webhooks/createwebhooks","metadata":{"seo":{"title":"Create webhooks","description":"Creates one webhook per event type supplied."}},"httpPath":"/v1/collections/webhooks","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"label":"Get a webhook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/webhooks/getwebhook","routeSlug":"/pt-br/products/collections/api/collections/webhooks/getwebhook","metadata":{"seo":{"title":"Get a webhook","description":"Get a webhook"}},"httpPath":"/v1/collections/webhooks/{webhook_id}","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"label":"Update a webhook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/webhooks/updatewebhook","routeSlug":"/pt-br/products/collections/api/collections/webhooks/updatewebhook","metadata":{"seo":{"title":"Update a webhook","description":"Update a webhook"}},"httpPath":"/v1/collections/webhooks/{webhook_id}","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"label":"Delete a webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/webhooks/deletewebhook","routeSlug":"/pt-br/products/collections/api/collections/webhooks/deletewebhook","metadata":{"seo":{"title":"Delete a webhook","description":"Delete a webhook"}},"httpPath":"/v1/collections/webhooks/{webhook_id}","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"}],"version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"type":"group","label":"Transfers","link":"/pt-br/products/collections/api/collections/transfers","routeSlug":"/pt-br/products/collections/api/collections/transfers","items":[{"label":"List transfers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/transfers/listtransfersv1","routeSlug":"/pt-br/products/collections/api/collections/transfers/listtransfersv1","metadata":{"seo":{"title":"List transfers","description":"Retrieves a list of transfers, filterable by query parameters."}},"httpPath":"/v1/collections/transfers","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"label":"Create a transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/transfers/createtransferv1","routeSlug":"/pt-br/products/collections/api/collections/transfers/createtransferv1","metadata":{"seo":{"title":"Create a transfer","description":"Moves funds between two of your accounts. When the accounts hold different currencies,the transfer is quoted at creation and the quote is applied when you confirm; transfersbetween same-currency accounts move at par. A new transfer starts as PENDING and mustbe confirmed before it expires (expires_at)."}},"httpPath":"/v1/collections/transfers","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"label":"Get transfer by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/transfers/gettransferbyidv1","routeSlug":"/pt-br/products/collections/api/collections/transfers/gettransferbyidv1","metadata":{"seo":{"title":"Get transfer by ID","description":"Retrieves the details of a specific transfer by its ID."}},"httpPath":"/v1/collections/transfers/{transfer_id}","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"label":"Confirm a transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/transfers/confirmtransferv1","routeSlug":"/pt-br/products/collections/api/collections/transfers/confirmtransferv1","metadata":{"seo":{"title":"Confirm a transfer","description":"Confirms a PENDING transfer so the funds move. For a cross-currency transfer this locksin the quoted rate; same-currency transfers move at par. Pass an Idempotency-Key headerto safely retry the same confirmation."}},"httpPath":"/v1/collections/transfers/{transfer_id}/confirm","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"label":"Cancel a transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/collections/api/collections/transfers/canceltransferv1","routeSlug":"/pt-br/products/collections/api/collections/transfers/canceltransferv1","metadata":{"seo":{"title":"Cancel a transfer","description":"Cancels a previously-created PENDING transfer. A transfer that is not PENDINGreturns 422. Supports request deduplication via the Idempotency-Key header."}},"httpPath":"/v1/collections/transfers/{transfer_id}/cancel","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"}],"version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"}],"metadata":{"type":"openapi","title":"Ripple Collections","version":"1.0.0","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. "},"version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"},{"type":"separator","version":"v1","versionFolderId":"3a2d3fa8","label":"Announcements"},{"type":"link","fsPath":"@l10n/pt-BR/products/collections/@v1/announcements/whats-new-v1.md","metadata":{"type":"markdown"},"label":"What's new in v1","link":"/pt-br/products/collections/announcements/whats-new-v1","separatorLine":true,"routeSlug":"/pt-br/products/collections/announcements/whats-new-v1","version":"v1","isDefault":true,"versionFolderId":"3a2d3fa8"}]}