Endpoints for authentication
Ripple Collections (alpha) (0.0.1)
The Ripple Collection APIs are used to manage collections, manage payment channels, manage partners and settlements.
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.
Filter channels by specific channel identifier
Filter channels by payer identifier
Filter channels by beneficiary identifier
Filter channels by status
Filter channels by payment currency network
Filter channels by wallet address
ISO 8601 timestamp after channel was created
ISO 8601 timestamp before channel was created
- Mock serverhttps://docs.ripple.com/_mock/products/collections/v0/api/collections/v0/collections/channels
- https://api.test.ripple.com/v0/collections/channels
- https://api.ripple.com/v0/collections/channels
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.ripple.com/_mock/products/collections/v0/api/collections/v0/collections/channels?id=3fa85f64-5717-4562-b3fc-2c963f66afa6&payer_id=e471b938-98ad-45e4-b144-53a556ea047d&beneficiary_id=291ecf34-a01d-466a-b0fd-662a88b7a1bb&status=ACTIVE&payment_currency=USDC&network=ETHEREUM&wallet_address=0xBb592aaaF9AcE2fbE3F735645819FA94c95a9cb5&since=2025-06-17T12%3A00%3A00Z&until=2025-06-17T12%3A00%3A00Z&page=1&size=10' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "content": [ { … } ], "page": { "page": 1, "size": 10, "total_elements": 1, "total_pages": 1 } }
Unique identifier of the payer partner
Unique identifier of the beneficiary partner
Metadata for a crypto asset
- Mock serverhttps://docs.ripple.com/_mock/products/collections/v0/api/collections/v0/collections/channels
- https://api.test.ripple.com/v0/collections/channels
- https://api.ripple.com/v0/collections/channels
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.ripple.com/_mock/products/collections/v0/api/collections/v0/collections/channels \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"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"
}
}'Channel created successfully.
Unique identifier for the channel
Payer partner details
Unique identifier for the payer partner
Beneficiary partner details
Unique identifier for the beneficiary partner
Full name of the beneficiary partner
Metadata for a crypto asset
Metadata for a fiat currency
Wallet details for the channel
Wallet address for the channel
URL for payer UI to access this channel
List of blockchain transactions associated with this channel
Unique identifier for the transaction
Identifier of the parent entity (collection link or channel) for this transaction
Identifier of the settlement associated with this transaction. Null if the transaction has not been included in a settlement yet.
Payer partner details
Unique identifier for the payer partner
Full name of the payer partner
Beneficiary partner details
Unique identifier of the beneficiary partner
Full name of the beneficiary partner
Crypto payment amount and asset
Fiat equivalent amounts for payment, fee, and net
Market rate reference for the transaction
Exchange rate applied on the transaction
On-chain transaction details
Supported blockchain networks
Blockchain transaction hash
Blockchain block identifier containing this transaction
Blockchain address from which funds were sent
Blockchain address to which funds were sent
Transaction status
ISO 8601 timestamp of the transaction
Unix timestamp (milliseconds) when transaction was created
Status of the channel
ISO 8601 timestamp when the channel was created
{ "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" }
- Mock serverhttps://docs.ripple.com/_mock/products/collections/v0/api/collections/v0/collections/channels/{channel_id}
- https://api.test.ripple.com/v0/collections/channels/{channel_id}
- https://api.ripple.com/v0/collections/channels/{channel_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.ripple.com/_mock/products/collections/v0/api/collections/v0/collections/channels/3fa85f64-5717-4562-b3fc-2c963f66afa6 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Successful response
Unique identifier for the channel
Payer partner details
Unique identifier for the payer partner
Beneficiary partner details
Unique identifier for the beneficiary partner
Full name of the beneficiary partner
Metadata for a crypto asset
Metadata for a fiat currency
Wallet details for the channel
Wallet address for the channel
URL for payer UI to access this channel
List of blockchain transactions associated with this channel
Unique identifier for the transaction
Identifier of the parent entity (collection link or channel) for this transaction
Identifier of the settlement associated with this transaction. Null if the transaction has not been included in a settlement yet.
Payer partner details
Unique identifier for the payer partner
Full name of the payer partner
Beneficiary partner details
Unique identifier of the beneficiary partner
Full name of the beneficiary partner
Crypto payment amount and asset
Fiat equivalent amounts for payment, fee, and net
Market rate reference for the transaction
Exchange rate applied on the transaction
On-chain transaction details
Supported blockchain networks
Blockchain transaction hash
Blockchain block identifier containing this transaction
Blockchain address from which funds were sent
Blockchain address to which funds were sent
Transaction status
ISO 8601 timestamp of the transaction
Unix timestamp (milliseconds) when transaction was created
Status of the channel
ISO 8601 timestamp when the channel was created
{ "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" }