Introduction

Ripple Collections allows you to collect payments on behalf of your customers. You can manage virtual accounts and payment transfers and enable integration with your existing systems. By using this API, you can programmatically create payment links for your users, track the status of payments, and manage your partners (payers and beneficiaries).

Key features

Ripple Collections consists of these key features:

• Virtual accounts and wallets: Create and manage unique virtual accounts or deposit addresses for each of your customers and their end-users. This allows for automated reconciliation, as incoming funds are instantly matched to the correct party.
• Automated reconciliation: Every collection is tied to a specific payer and beneficiary. When a payment is made, the system automatically credits the correct user's sub-ledger account.
• Secure payment collections: Create and manage payment links for collecting funds. Each collection has a unique ID which you can track from creation to completion. You can also cancel collections as needed.
• Partner management: Create and manage the entities (businesses or individuals) involved in your transactions. This includes payers (the source of funds) and beneficiaries (the recipients of funds).
• Real-time visibility: Gain real-time insight into the status of all your collections and payments. You can get detailed information on each transaction, including amounts, currencies, fees, and timestamps.

Core concepts

The core concepts of Ripple Collections are related to collections, channels, partners, settlements.

Collections

A collection is a payment request initiated on behalf of a beneficiary to a payer which is one-time use with a link expiry. Collection-related actions you can perform with this API are:

• Create a collection: Generate a new payment link for a specific transaction.
• List collections: Retrieve a list of all collections, which can be filtered by id, payer_id, beneficiary_id, since or until.
• Get collection details: View the full details and current status of a single collection.
• Cancel a collection: Invalidate a payment link, preventing further payments from being made against it.

Partners

A partner represents a party involved in a transaction, either as a payer (sending money) or a beneficiary (receiving money). Each partner is assigned a unique ID. Partner-related actions you can perform with this API are:

• Create a partner: Add a new business or individual to your system.
• List partners: View all existing partners. You can filter this list by id or type (business or individual).
• Get a partner by ID: Retrieve specific information about a partner using their ID.
• Update a partner: Modify the details of an existing partner.

Channels

A payment channel represents a persistent way to collection on behalf of a beneficiary to a payer. Channel-related actions you can perform with this API are:

• Create a channel: Generate a new payment channel between a beneficiary and payer.
• List channels: Retrieve a list of all channels, which can be filtered by id, payer_id, or beneficiary_id.
• Get channel details: View the full details and current status of a single channel.

Transactions

A transaction represents a payment from a payer to beneficiary which is applicable in both collection links or channels. Transactions-related actions you can perform with this API are:

• List transactions: Retrieve a list of all transaction, which can be filtered by id, payer_id, or beneficiary_id.
• Get transaction details: View the full details and current status of a single transaction.

In addition to the core concepts, you can also perform settlement-related actions using this API, such as List settlements and Get settlement by ID.