# Get a payment by ID V2

Gets a payment by ID.

Endpoint: GET /v3/payments/{paymentId}
Version: 2026.03
Security: Bearer

## Path parameters:

  - `paymentId` (string, required)
    Unique identifier of the payment to get.
    Example: "7ea3399c-1234-5678-8d8f-d320ea406630"

## Response 200 fields (application/json):

  - `paymentId` (string, required)
    The unique ID that identifies this payment. This value is the same as the quote ID.
    Example: "7ea3399c-1234-5678-8d8f-d320ea406630"

  - `cryptoTransactionHash` (string)
    Transaction hash of the crypto payment on the destination blockchain network
    Example: "0x2b1f8b57dd6008143ff926ea9d9cd2365774cd0c5e6f379558a88c61c52071eb"

  - `initiatedAt` (string)
    The time at which the payment was initiated, specified in UTC.
    Example: "2019-08-24T14:15:22Z"

  - `expiresAt` (string)
    The time at which this payment expires, specified in UTC.
    Example: "2019-08-24T14:15:22Z"

  - `jitFundingExpiresAt` (string)
    The time at which JIT funding for this payment expires, specified in UTC.
    Example: "2019-08-24T14:15:22Z"

  - `lastStateUpdatedAt` (string)
    The time at which the payment state was last updated for this payment, specified in UTC.
    Example: "2019-08-24T14:15:22Z"

  - `paymentState` (string, required)
    Current state of a payment.

The payment lifecycle currently uses the following values: 
- QUOTED 
- INITIATED 
- VALIDATING 
- TRANSFERRING 
- COMPLETED 
- FAILED 
- RETURNED 
- DECLINED 
- AWAITING_FUNDING

Additional states may be introduced in the future without breaking existing integrations.
    Example: "INITIATED"

  - `originator` (object)
    Payment originator and source details.

  - `originator.originatorIdentityId` (string)
    The unique ID associated with the payment originator's identity record.
    Example: "7ea3399c-1234-5678-8d8f-d320ea406630"

  - `originator.originatorIdentityIdVersion` (integer)
    The current version of the originator's identity record.
    Example: 1

  - `originator.originatorIdentityNickName` (string)
    Nickname associated with the originator's identity record.
    Example: "Successful Business Sender"

  - `originator.internalId` (string)
    An ID associated with this payment, if provided by the customer during payment initiation.
    Example: "Invoice-123"

  - `originator.sourceCurrency` (string)
    originator's currency
    Example: "USD"

  - `originator.sourceAmount` (number)
    The amount sent by the originator in this payment. This field can hold a value with up to 6 decimal places.
    Example: 100

  - `originator.payin` (string)
    Details about how this payment is funded.
    Example: "FUNDED"

  - `destination` (object)

  - `destination.beneficiaryFinancialInstrumentId` (string)
    The financial instrument ID, the identity ID of the payment beneficiary is related to.
    Example: "7ea3399c-1234-5678-8d8f-d320ea406630"

  - `destination.destinationAmount` (number)
    The amount received by the payment beneficiary. This field can hold a value with up to 6 decimal places.
    Example: 1234.111223

  - `destination.destinationCountry` (string)
    The country where the beneficiary is located specified in Alpha-2 Code format as defined in the ISO CountryCode ISO 3166-1 list. If the beneficiary is an individual, then this value is their country of residence. If the beneficiary is an institution, then this value is their the country of incorporation.
    Example: "US"

  - `destination.destinationCurrency` (string)
    The currency code of the currency in which the beneficiary will receive this payment.
    Example: "USD"

  - `destination.destinationBlockchainNetwork` (string)
    The name of the blockchain network on which the beneficiary will receive this payment.
    Example: "Ethereum, TRON"

  - `destination.beneficiaryIdentityId` (string)
    The unique ID associated with the payment beneficiary's identity record.
    Example: "7ea3399c-1234-5678-8d8f-d320ea406630"

  - `destination.beneficiaryIdentityVersion` (integer)
    The current version of the beneficiary's identity record.
    Example: 1

  - `destination.beneficiaryIdentityNickName` (string)
    Nickname associated with the beneficiary's identity record.
    Example: "Successful business beneficiary"

  - `destination.payout` (string)
    The payout category for this payment.
    Example: "BANK"

  - `adjustedExchangeRate` (object)
    Foreign Exchange (FX) rate used to calculate the quote.

  - `adjustedExchangeRate.adjustedRate` (number)
    Value of the Foreign Exchange (FX) rate.
    Example: 2

  - `fees` (array)
    A summary of fees included in payment quote.

  - `fees.totalFee` (number)
    The value of the total fee included in this quote.
    Example: 12.23

  - `fees.feeCurrency` (string)
    The currency in which fees are charged.
    Example: "USD"

  - `fees.feeBreakdown` (array)
    An array of fees that provides a breakdown of how the total fees is calculated for this quote.

  - `fees.feeBreakdown.calculatedFee` (number)
    Value of the fee when the configured fee unit is applied against the value.
    Example: 2.43

  - `fees.feeBreakdown.feeName` (string)
    The name of the fee.
    Example: "Service fee"

  - `fees.feeBreakdown.feeDescription` (string)
    Description of the fee.
    Example: "The service fee charged for this transaction."

  - `taxes` (array)
    A summary of taxes included in the payment quote.

  - `taxes.totalTaxes` (number)
    The value of the total taxes included in this quote.
    Example: 5.12

  - `taxes.taxCurrency` (string)
    The currency in which taxes are charged.
    Example: "USD"

  - `taxes.taxBreakdown` (array)
    An array of taxes with details such as tax description, rate, name and tax amount.

  - `taxes.taxBreakdown.taxAmount` (number)
    tax amount for this tax line item.
    Example: 2.43

  - `taxes.taxBreakdown.taxName` (string)
    The name of the tax.
    Example: "ISS/ VAT/ GST etc"

  - `taxes.taxBreakdown.taxDescription` (string)
    GST service fee tax .
    Example: "The service fee tax charged for this transaction."

  - `taxes.taxBreakdown.taxRate` (number)
    The tax rate applied to calculate the tax amount.
    Example: 5

  - `sourceOfCash` (string)
    Source of Cash may be required depending on corridor and payout partner. Valid Source of Cash values vary by corridor.
    Example: "EMIN"

  - `purposeCode` (string)
    Purpose Code may be required depending on corridor and payout partner. Valid Purpose Code values vary by corridor.
    Example: "PAYR"

  - `transactionDetails` (object)
    A summary of the payment category.

  - `transactionDetails.paymentProduct` (string,null)
    The Ripple payments product used to make this payment.

  - `transactionDetails.flowType` (string,null)
    Specifies the type of payment you're making as categorized by the identity type of the payment originator and beneficiary.

  - `transactionDetails.thirdPartyPayment` (boolean,null)
    Flag to indicate if this payment is initiated on behalf of a third-party originator.

  - `transactionDetails.businessUseCase` (string,null)
    Indicates the type of payment you're making.

  - `errors` (array)

  - `errors.code` (string, required)
    A unique identifier for  the error
    Example: "SYS_003"

  - `errors.type` (string, required)
    A high-level categorization of the error, indicating the type of issue that occurred
    Example: "SYSTEM_ERROR"

  - `errors.title` (string, required)
    A brief, user-friendly description of the error
    Example: "Internal Server Error"

  - `errors.description` (string, required)
    A more detailed explanation of the error, potentially including information about what caused the error and the next steps
    Example: "The payout category value must be one of BANK, EWALLET, CASH_PICKUP, or ATM."

  - `errors.timestamp` (string, required)
    Example: "2024-11-21T14:15:22Z"

  - `paymentLabels` (array)
    Application-defined labels for grouping and categorizing payments (e.g., campaign IDs, workflow tags, or batch identifiers). Labels are optional and mutable; they can be added or removed over the payment's lifetime.
    Example: ["batchId=aaaaaaaa-1111-bbbb-abab-123412341234"]

  - `receiverRelationship` (string)
    The relationship to the debtor.
    Example: "SUBS"

  - `paymentMemo` (string)
    Optional, transaction-specific memo carried with the payment for beneficiary reconciliation.
Validation rules (required, allowed characters, max length) vary by corridor. Consult the data requirements for your corridor.
Not stored in PII; persisted on the payment object and forwarded to compliance and payout partners.
Where possible, the memo will also be delivered to the final beneficiary's credit record, but delivery cannot be guaranteed in all cases due to payout partner or downstream constraints.
If omitted, Ripple may generate a memo automatically.
    Example: "ORDER 2025-09-001 PAYMENT"

  - `payoutExecutionDetails` (object)
    Metadata about the payout execution, including the payment rail used, timing, and tracking references.

payoutExecutionDetails is an optional field that should be treated as informational only. Do not build required workflows that depend on its presence, as availability varies by corridor and partner.

When present, trackingReferences provides network-specific identifiers useful for audit, reconciliation, or customer inquiry resolution. Use the referenceType field on each tracking reference to identify what a value represents rather than relying on its position in the array.

Coverage will expand as additional corridors and partners are onboarded.

  - `payoutExecutionDetails.paymentRailUsed` (string)
    The payment rail or network used to execute the payout (e.g., FEDWIRE, ACH, RTP, SEPA, SWIFT).
    Example: "FEDWIRE"

  - `payoutExecutionDetails.payoutStartTime` (string)
    The time at which the payout execution started, specified in UTC.
    Example: "2026-02-18T14:22:15.789Z"

  - `payoutExecutionDetails.payoutEndTime` (string)
    The timestamp when the payout execution completed or was last updated, as reported by the payout partner.
Specified in UTC using ISO 8601 format. For in-progress payouts, this may represent the last status update time.
    Example: "2026-02-18T14:25:30.123Z"

  - `payoutExecutionDetails.trackingReferences` (array)
    A list of tracking references for this transaction, such as transaction IDs and confirmation numbers.

  - `payoutExecutionDetails.trackingReferences.referenceType` (string)
    The type or category of this tracking reference. Known values include IMAD and OMAD for Fedwire transfers, but additional types may be provided depending on the payment rail and payout partner.
    Example: "IMAD"

  - `payoutExecutionDetails.trackingReferences.value` (string)
    The tracking reference value. Use this to locate the transaction with the payout partner or payment rail operator. Format varies by referenceType.
    Example: "TXN-RTP-20260218-456789"

  - `payoutExecutionDetails.trackingReferences.displayName` (string)
    A human-readable name for this tracking reference, suitable for display in user interfaces.
    Example: "IMAD Number"

  - `payoutExecutionDetails.trackingReferences.description` (string)
    A detailed description of what this tracking reference represents and how it can be used.
    Example: "Input Message Accountability Data (IMAD) for Fedwire transfer tracking"

## Response 400 fields (application/json):

  - `errors` (object, required)

  - `errors.code` (string, required)
    A unique identifier for  the error
    Example: "SYS_003"

  - `errors.type` (string, required)
    A high-level categorization of the error, indicating the type of issue that occurred
    Example: "SYSTEM_ERROR"

  - `errors.title` (string, required)
    A brief, user-friendly description of the error
    Example: "Internal Server Error"

  - `errors.description` (string, required)
    A more detailed explanation of the error, potentially including information about what caused the error and the next steps
    Example: "The payout category value must be one of BANK, EWALLET, CASH_PICKUP, or ATM."

  - `errors.timestamp` (string, required)
    Example: "2024-11-21T14:15:22Z"

  - `status` (string, required)
    Error Response Status
    Example: 400

## Response 404 fields (application/json):

  - `errors` (object, required)

  - `errors.code` (string, required)
    A unique identifier for  the error
    Example: "SYS_003"

  - `errors.type` (string, required)
    A high-level categorization of the error, indicating the type of issue that occurred
    Example: "SYSTEM_ERROR"

  - `errors.title` (string, required)
    A brief, user-friendly description of the error
    Example: "Internal Server Error"

  - `errors.description` (string, required)
    A more detailed explanation of the error, potentially including information about what caused the error and the next steps
    Example: "The payout category value must be one of BANK, EWALLET, CASH_PICKUP, or ATM."

  - `errors.timestamp` (string, required)
    Example: "2024-11-21T14:15:22Z"

  - `status` (string, required)
    Error Response Status
    Example: 400

## Response 500 fields (application/json):

  - `errors` (object, required)

  - `errors.code` (string, required)
    A unique identifier for  the error
    Example: "SYS_003"

  - `errors.type` (string, required)
    A high-level categorization of the error, indicating the type of issue that occurred
    Example: "SYSTEM_ERROR"

  - `errors.title` (string, required)
    A brief, user-friendly description of the error
    Example: "Internal Server Error"

  - `errors.description` (string, required)
    A more detailed explanation of the error, potentially including information about what caused the error and the next steps
    Example: "The payout category value must be one of BANK, EWALLET, CASH_PICKUP, or ATM."

  - `errors.timestamp` (string, required)
    Example: "2024-11-21T14:15:22Z"

  - `status` (string, required)
    Error Response Status
    Example: 400