Ramp: Fetch a payment — response body
Fetch a payment: response body. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Fetch a payment — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
amount | Model | Required within parent | Expand Fetch a payment — response body — amount The payment amount and currency. Read only: true |
check_details | JSON | Required within parent | |
check_details (anyOf 1) | Model | Alternative | Expand Fetch a payment — response body — check details estimated delivery date, mailed at, tracking number, tracking updates, tracking url Check-specific delivery tracking details. Populated only for check-funded payments. Read only: true |
check_details (anyOf 2) | null | Alternative | |
customer_friendly_payment_id | JSON | Required within parent | |
customer_friendly_payment_id (anyOf 1) | string | Alternative | Customer-friendly payment identifier for non-card payment methods, if available. Payments sharing the same value belong to the same payment or batch payment. |
customer_friendly_payment_id (anyOf 2) | null | Alternative | |
entity_id | string | Required within parent | Unique identifier of the entity making the payment. Format: uuid |
external_invoice_number | JSON | Required within parent | |
external_invoice_number (anyOf 1) | string | Alternative | The invoice number associated with this payment. |
external_invoice_number (anyOf 2) | null | Alternative | |
external_ref | JSON | Required within parent | |
external_ref (anyOf 1) | string | Alternative | An external reference identifier for this payment. |
external_ref (anyOf 2) | null | Alternative | |
failure_reason | JSON | Required within parent | |
failure_reason (anyOf 1) | string | Alternative | The reason for the payment failure, if applicable. Known values: ACCOUNT_HOLDER_DECEASED, CARD_DECLINED, CARD_DETAILS_INVALID, CARD_INSUFFICIENT_FUNDS, CARD_PROCESSING_ERROR, CARD_REVERIFICATION_REQUIRED, CHECK_ATTACHMENT_REJECTED, CHECK_DELIVERY_FAILURE, CHECK_DEPOSIT_REJECTED, CHECK_DEPOSIT_RETURNED, CHECK_EXPIRED, CHECK_VOIDED, CHECK_WITHDRAWAL_INSUFFICIENT_BALANCE, CHECK_WITHDRAWAL_RECIPIENT_NAME_MISMATCH, CHECK_WITHDRAWAL_RETURNED, DEBIT_DISPUTED, DUPLICATE_ACH_ENTRY, FAILURE_NOT_RECOGNIZED, INTERNATIONAL_DIRECT_DEBIT_INSTRUMENT_UNAVAILABLE, INTERNATIONAL_PROVIDER_UNAVAILABLE, INVALID_BANK_BRANCH, INVALID_ROUTING_NUMBER, MANDATE_DATA_MISMATCH, MISSING_PAYEE_BANK_ACCOUNT, MISSING_PAYER_BANK_ACCOUNT, PAYEE_ACCOUNT_CLOSED, PAYEE_ACCOUNT_FROZEN, PAYEE_ACCOUNT_INVALID_BENEFICIARY_DETAILS, PAYEE_ACCOUNT_NON_TRANSACTIONAL, PAYEE_ACCOUNT_NOT_FOUND, PAYEE_ACCOUNT_REJECTED_PAYMENT, PAYEE_ACCOUNT_WRONG_CURRENCY, PAYEE_ACCOUNT_WRONG_NAME, PAYER_ACCOUNT_CLOSED, PAYER_ACCOUNT_DEBIT_BLOCK, PAYER_ACCOUNT_FROZEN, PAYER_ACCOUNT_INSUFFICIENT_FUNDS, PAYER_ACCOUNT_NON_TRANSACTIONAL, PAYER_ACCOUNT_NOT_FOUND, PAYER_ACCOUNT_WRONG_CURRENCY, PAYER_ACCOUNT_WRONG_NAME, PAYER_OUTSTANDING_BALANCE, PAYMENT_FREEZE, PAYMENT_RETURNED_BY_PROVIDER, PROVIDER_ACCOUNT_FROZEN, QUOTE_REJECTED_BY_PROVIDER, QUOTE_TRANSFER_TOO_EXPENSIVE, SETTLEMENT_PAYMENT_CANCELED, UNRESOLVED_COMPLIANCE_RFI, UNRESOLVED_NO_DQ_INSUFFICIENT_FUNDS, UNSUPPORTED_BY_BANKING_PARTNER, WIRE_INCORRECT_ACCOUNT_NUMBER, WIRE_INCORRECT_BENEFICIARY_DETAILS Read only: true |
failure_reason (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the payment. Format: uuid |
is_cancelable | boolean | Required within parent | Whether this payment can be canceled. Read only: true |
payment_method | Model | Required within parent | Expand Fetch a payment — response body — payment method The payment method used for this payment. Read only: true |
scheduled_date | string | Required within parent | The date the payment is scheduled to be initiated. Format: date |
source_bank_account_id | string | Required within parent | Unique identifier of the bank account the payment is sent from. Format: uuid |
status | string | Required within parent | The current status of the payment. Known values: CANCELED, COMPLETED, ERROR, PROCESSING, SCHEDULED Read only: true |
status_detail | JSON | Required within parent | |
status_detail (anyOf 1) | string | Alternative | The detailed processing status for an ACH payment. Null for other payment methods. Known values: CANCELED, DEBITING, DELIVERED, FAILED, INITIATED, SCHEDULED, TRANSFERRING_TO_VENDOR Read only: true |
status_detail (anyOf 2) | null | Alternative | |
vendor_id | string | Required within parent | Unique identifier of the vendor being paid. Format: uuid |
Referenced models: Fetch a payment — response body — amount, Fetch a payment — response body — payment method, Fetch a payment — response body — check details estimated delivery date, mailed at, tracking number, tracking updates, tracking url