A settlement represents the transfer of collected funds from Ripple to your designated account.
Collections and channels bring funds in, crediting an account's sub-ledger. A settlement moves those funds out, to the destination you have configured. In v1, settlements are tied to accounts, which gives you a clear trail from the account that received the money to the payout that disbursed it.
Every transaction included in a settlement carries that settlement's settlement_id. Cross-referencing the two is how you confirm that received funds and paid-out funds agree.
- A settlement draws from an account balance.
- It covers one or more transactions, each stamped with its
settlement_id. - Settlement progress emits
SETTLEMENT_INITIATED,SETTLEMENT_COMPLETED, andSETTLEMENT_FAILEDwebhook events.
- Create a settlement: Initiate a new settlement for an account.
- List settlements: Retrieve a list of all settlements, which can be filtered by
id,type, orstatus. - Get settlement by ID: View the full details and current status of a single settlement.