Skip to content

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).

What's new in v1

The v1 API introduces account-based routing, which allows you to create and manage payment accounts for your beneficiaries. Accounts serve as the central routing point for collections, channels, and settlements, replacing direct partner-to-partner routing.

Key changes from v0:

  • Accounts: A new resource that represents a payment account for a beneficiary. Collections and channels are now created against an account rather than directly between partners.
  • Account-based collections and channels: When creating a collection or channel, you specify an account_id to route payments through the beneficiary's account.
  • Account-based settlements: Settlements are now tied to accounts, providing clearer fund flow tracking.
  • Webhooks for account events: New event types (ACCOUNT_CREATED, ACCOUNT_STATUS_CHANGED, ACCOUNT_BALANCE_UPDATED) allow you to track account lifecycle changes in real time.

Key features

Ripple Collections consists of these key features:

  • Accounts and virtual wallets: Create and manage payment accounts with 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 account and beneficiary. When a payment is made, the system automatically credits the correct account's sub-ledger.
  • 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 accounts, collections, channels, partners, and settlements.

Accounts

An account represents a payment account for a beneficiary, serving as the routing point for collections, channels, and settlements. Account-related actions you can perform with this API are:

Collections

A collection is a one-time payment request from a payer to a beneficiary's account, 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.

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:

Channels

A payment channel represents a persistent way to collect from a payer into a beneficiary's account. 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 into a beneficiary's account, recorded against either a collection link or a channel. Transaction-related actions you can perform with this API are:

  • List transactions: Retrieve a list of all transactions, 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.

Settlements

A settlement represents the transfer of collected funds from Ripple to your designated account. Settlement-related actions you can perform with this API are:

 
Next page