# Ripple Collections

The Ripple Collection APIs are used to manage accounts, payment channels, partners, transactions, transfers and settlements.
## API Environments
The Ripple Collection APIs offers the following environments:
| Environment | Base URL | Description |
|  --- | --- | --- |
| Sandbox | `https://docs.ripple.com/products/collections/_mock/api/collections` | Sandbox environment with mock data which does not require auth. |
| UAT | `https://api.test.ripple.com` | UAT environment with simulated transactions. |
| Production | `https://api.ripple.com` | Production environment |

For guides on API authentication, idempotency, and webhook verification, see the sidebar.

Version: 1.0.0

## Servers

```
https://api.test.ripple.com
```

```
https://api.ripple.com
```

## Security

### Bearer

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

 - [Ripple Collections](https://docs.ripple.com/_bundle/@l10n/pt-BR/products/collections/@v1/api/collections.yaml)

## Authentication

 - [POST /v2/oauth/token](https://docs.ripple.com/pt-br/products/collections/api/collections/authentication/authenticate.md): Request an access token for authentication with Ripple APIs. You need to request a token for the environment you want to authenticate with. **Note**: The length of the access token isn't fixed, hence
 - [GET /v2/oauth/token/test](https://docs.ripple.com/pt-br/products/collections/api/collections/authentication/testauthtoken.md): Test if an access token can be used for authentication with Ripple APIs and how much time remains on it.
## Accounts

 - [GET /v1/collections/accounts](https://docs.ripple.com/pt-br/products/collections/api/collections/accounts/listaccountsv1.md): Retrieves a list of accounts, filterable by query parameters.
 - [POST /v1/collections/accounts](https://docs.ripple.com/pt-br/products/collections/api/collections/accounts/createaccountv1.md): 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
 - [GET /v1/collections/accounts/{account_id}](https://docs.ripple.com/pt-br/products/collections/api/collections/accounts/getaccountbyidv1.md): Retrieves the details of a specific account by its ID.
## Collection Channels

 - [GET /v1/collections/channels](https://docs.ripple.com/pt-br/products/collections/api/collections/collection-channels/listchannelsv1.md): Retrieves a list of channels using account-based routing, filterable by query parameters.
 - [POST /v1/collections/channels](https://docs.ripple.com/pt-br/products/collections/api/collections/collection-channels/createchannelv1.md): 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
 - [GET /v1/collections/channels/{channel_id}](https://docs.ripple.com/pt-br/products/collections/api/collections/collection-channels/getchannelbyidv1.md): Retrieves the details of a specific channel by its ID using account-based routing.
## Partners

 - [GET /v1/collections/partners](https://docs.ripple.com/pt-br/products/collections/api/collections/partners/listpartnersv1.md): Retrieves a list of partners, filterable by ID or type.
 - [POST /v1/collections/partners](https://docs.ripple.com/pt-br/products/collections/api/collections/partners/createpartnerv1.md): This API allows users to add new parties who can transact.
 - [GET /v1/collections/partners/{partner_id}](https://docs.ripple.com/pt-br/products/collections/api/collections/partners/getpartnerbyidv1.md): This API allows users to retrieve a specific partner by their ID.
 - [PUT /v1/collections/partners/{partner_id}](https://docs.ripple.com/pt-br/products/collections/api/collections/partners/updatepartnerv1.md): API to update a partner to use in collections API.
## Settlements

 - [GET /v1/collections/settlements](https://docs.ripple.com/pt-br/products/collections/api/collections/settlements/listsettlementsv1.md): API to fetch first party payouts (settlements) with enhanced v1 response format.
 - [POST /v1/collections/settlements](https://docs.ripple.com/pt-br/products/collections/api/collections/settlements/createsettlementv1.md): API to initiate a first party payout (settlement to our customer).
 - [GET /v1/collections/settlements/{settlement_id}](https://docs.ripple.com/pt-br/products/collections/api/collections/settlements/getsettlementbyidv1.md): API to fetch a first party payout (settlement to our customer) with enhanced v1 response format.
## Transactions

 - [GET /v1/collections/transactions](https://docs.ripple.com/pt-br/products/collections/api/collections/transactions/listtransactionsv1.md): API to fetch transactions received through channels using account-based routing.
 - [GET /v1/collections/transactions/{transaction_id}](https://docs.ripple.com/pt-br/products/collections/api/collections/transactions/gettransactionbyidv1.md): API to fetch a transaction (payment from a payer to beneficiary) using account-based routing.
## Webhooks

 - [GET /v1/collections/webhooks](https://docs.ripple.com/pt-br/products/collections/api/collections/webhooks/listwebhooks.md)
 - [POST /v1/collections/webhooks](https://docs.ripple.com/pt-br/products/collections/api/collections/webhooks/createwebhooks.md): Creates one webhook per event type supplied.
 - [GET /v1/collections/webhooks/{webhook_id}](https://docs.ripple.com/pt-br/products/collections/api/collections/webhooks/getwebhook.md)
 - [DELETE /v1/collections/webhooks/{webhook_id}](https://docs.ripple.com/pt-br/products/collections/api/collections/webhooks/deletewebhook.md)
## Transfers

 - [GET /v1/collections/transfers](https://docs.ripple.com/pt-br/products/collections/api/collections/transfers/listtransfersv1.md): Retrieves a list of transfers, filterable by query parameters.
 - [POST /v1/collections/transfers](https://docs.ripple.com/pt-br/products/collections/api/collections/transfers/createtransferv1.md): 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; transfers between same-currency acc
 - [GET /v1/collections/transfers/{transfer_id}](https://docs.ripple.com/pt-br/products/collections/api/collections/transfers/gettransferbyidv1.md): Retrieves the details of a specific transfer by its ID.
 - [POST /v1/collections/transfers/{transfer_id}/confirm](https://docs.ripple.com/pt-br/products/collections/api/collections/transfers/confirmtransferv1.md): Confirms a `PENDING` transfer so the funds move. For a cross-currency transfer this locks in the quoted rate; same-currency transfers move at par. Pass an `Idempotency-Key` header to safely retry the
 - [POST /v1/collections/transfers/{transfer_id}/cancel](https://docs.ripple.com/pt-br/products/collections/api/collections/transfers/canceltransferv1.md): Cancels a previously-created `PENDING` transfer. A transfer that is not `PENDING` returns 422. Supports request deduplication via the `Idempotency-Key` header.
