This page outlines the lifecycle of a payment in Ripple Payments Direct, provides more details about each payment state, and explains how to find the current state of a payment.
A payment typically moves through the following phases in Ripple Payments Direct:
Initiated: The payment process begins when you submit a payment request that references an accepted quote. Ripple Payments Direct creates a payment in the
INITIATEDstate.Validating: The payment state changes to
VALIDATINGwhile the platform runs internal checks, such as validating payment details, checking limits, and reserving funds from your available balance.- If these checks succeed, the payment continues to
TRANSFERRING. - If a predictable, user-correctable issue is found (for example, invalid or missing data, account status, or compliance rules), the payment moves to the terminal
DECLINEDstate. - If an unexpected platform or system issue prevents processing, the payment moves to the terminal
FAILEDstate.
- If these checks succeed, the payment continues to
Transferring: As the payment moves through the network to the beneficiary, the payment state becomes
TRANSFERRING. The payment amount is debited from your available balance, and Ripple or a downstream partner works to complete the payment.- If a predictable, user-correctable issue is discovered at this stage (for example, the destination bank rejects the payment due to compliance rules or account status), the payment moves to the terminal
DECLINEDstate. - If an unexpected platform or system error occurs, the payment moves to the terminal
FAILEDstate.
- If a predictable, user-correctable issue is discovered at this stage (for example, the destination bank rejects the payment due to compliance rules or account status), the payment moves to the terminal
Completed: If the payment does not enter
DECLINEDorFAILEDduring the earlier phases, and the payout network successfully credits the beneficiary, the payment reaches the terminalCOMPLETEDstate. In most cases, this means the beneficiary has received the funds.Returned: In some cases, a payment that previously reached
COMPLETEDmay later be sent back by a downstream institution or the beneficiary’s bank. When this happens, the payment moves to the terminalRETURNEDstate and the funds are returned to the originator. Returns are managed by Ripple and payout partners; customers cannot directly trigger returns.
The diagram below shows a simplified view of how a payment can move between states:
The Payment states section on this page provides reference descriptions for each state. For more details about how returns work and how to reconcile them, see Payment returns.
The paymentState field of the payment object indicates the current state of a payment. This section describes each possible value and what it means for your payment, including the new DECLINED state.
Ripple Payments Direct 2.0 supports the following payment states:
| State | Description |
|---|---|
QUOTED | A quote has been created, but you haven't accepted it yet. The quote describes the proposed exchange rate, fees, and amounts for a potential payment. When you accept the quote and create a payment, the payment’s first state transition is from QUOTED to INITIATED. |
INITIATED | You, the payment originator, have initiated a payment by submitting a payment request that references an accepted quote. Ripple Payments Direct creates a payment record with a unique identifier and sets paymentState to INITIATED. |
VALIDATING | Ripple validates the payment details and reserves funds from your available balance. The platform performs checks such as data validation, limits, account status, and compliance rules. If these checks succeed, the payment moves to TRANSFERRING. If the request is predictably invalid or violates business, risk, or regulatory rules, the payment moves to DECLINED. If an unexpected platform or system error occurs, the payment moves to FAILED. |
TRANSFERRING | The payment is moving through the network to the ultimate beneficiary. Funds have been reserved or debited from your available balance while Ripple and payout partners attempt to complete the payment. If a partner or internal service rejects the payment for a predictable, user-correctable reason, the payment moves to DECLINED. If an unexpected platform or system error prevents completion, the payment moves to FAILED. |
DECLINED | The payment was declined because the payment instruction is not acceptable in its current form. Typical causes include invalid or missing data, account status or limit issues, authorization problems, or regulatory and compliance rules enforced by Ripple or a downstream partner. The payment will not be completed or retried automatically. Any reserved funds are released back to the originator’s available balance. To proceed, correct the issue described in the error message and submit a new payment. |
COMPLETED | The payment has been successfully processed, and the beneficiary has been credited according to the agreed quote. This is a terminal state for payments that finish successfully. |
FAILED | The payment could not be completed due to an unexpected platform, system, or network error that Ripple does not classify as a predictable decline. The failure reason, if available, is returned in the error details. Reserved funds for the payment are released and returned to the originator’s available balance where applicable. |
RETURNED | The payment was previously marked as COMPLETED but was later returned by a downstream institution (for example, the beneficiary’s bank) after the beneficiary was initially credited. This is a terminal state. The funds are returned to the originator, and the return is visible in your payment reports and notifications. Customers cannot directly trigger returns. |
DECLINED: The platform or a downstream partner has refused to process the payment because the request is invalid or cannot be accepted in its current form. The issue is usually user-correctable (for example, fixing data, limits, or account status) and the payment is not retried automatically.FAILED: An unexpected platform or system error prevents the payment from being processed. These errors are not primarily about the validity of the payment instruction itself.RETURNED: The payment was completed and the beneficiary was initially credited, but the funds were later sent back, resulting in a terminalRETURNEDstate.
You can check a payment's current state and its state transitions either in the Ripple Payments UI or by using the Ripple Payments Direct 2.0 API.
In the Ripple Payments web UI, open the payment details for the payment you want to inspect.
- The Payment Details tab shows the payment’s transition through states on a timeline. Each entry shows the state and the timestamp when the payment reached that state.
- The Payment Object JSON tab includes the full payment object. The
paymentStatefield shows the current state of the payment.
You can also check the payment state using the Payments API:
- To check the current state of a specific payment, call the
GET /payments/{paymentId}endpoint. The response body includes thepaymentStatefield. - To check a payment’s state transition history, call the
GET /payments/{paymentId}/state-transitionsendpoint. The response shows each state, when the payment reached it, and the order of transitions over time.