Ramp: Payment schemas
14 Ramp schemas with complete fields and constraints.
← Payment operations · All schemas
Create and initiate a payment — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
accounting_field_selections | array | Optional | Accounting field selections to apply to the payment. |
accounting_field_selections[] | Model | Each item | Expand Create a bill — request body — body accounting field selections item |
amount | Model | Required within parent | Expand Update a payment — request body — body amount The payment amount and currency. |
entity_id | string | Required within parent | Unique identifier of the entity to associate with this payment. Format: uuid |
external_invoice_number | JSON | Optional | |
external_invoice_number (anyOf 1) | string | Alternative | The invoice number associated with this payment. Default: null |
external_invoice_number (anyOf 2) | null | Alternative | |
external_ref | JSON | Optional | |
external_ref (anyOf 1) | string | Alternative | An external reference identifier for this payment. Default: null |
external_ref (anyOf 2) | null | Alternative | |
payment_method | Model | Required within parent | Expand Update a payment — request body — body payment method The payment method to use for this payment. |
scheduled_date | string | Required within parent | The date the payment should be initiated (YYYY-MM-DD). Format: date |
source_bank_account_id | string | Required within parent | Unique identifier of the bank account to pay from. Format: uuid |
vendor_id | string | Required within parent | Unique identifier of the vendor to pay. Format: uuid |
Referenced models: Update a payment — request body — body amount, Create a bill — request body — body accounting field selections item, Update a payment — request body — body payment method
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
Fetch a payment — response body — amount
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Required within parent | The currency of the amount in ISO 4217 format (e.g. USD). Known values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, EURC, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, OPEN_USD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDB, USDC, USDG, USDT, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, ZWL |
value | JSON | Required within parent | |
value (anyOf 1) | integer | Alternative | The non-negative amount in the smallest denomination of the currency (e.g. cents for USD). Minimum: 0 |
value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Fetch a payment — response body — check details estimated delivery date, mailed at, tracking number, tracking updates, tracking url
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
estimated_delivery_date | JSON | Required within parent | |
estimated_delivery_date (anyOf 1) | string | Alternative | Estimated date the mailed check will reach the vendor, if available. Format: date |
estimated_delivery_date (anyOf 2) | null | Alternative | |
mailed_at | JSON | Required within parent | |
mailed_at (anyOf 1) | string | Alternative | ISO 8601 timestamp the check printing provider reported mailing the check, if available. Format: date-time |
mailed_at (anyOf 2) | null | Alternative | |
tracking_number | JSON | Required within parent | |
tracking_number (anyOf 1) | string | Alternative | Carrier tracking number for the mailed check, if available. |
tracking_number (anyOf 2) | null | Alternative | |
tracking_updates | array | Required within parent | Carrier tracking updates for the mailed check, in the order returned by the carrier. Empty when no tracking updates have been received yet. |
tracking_updates[] | Model | Each item | Expand Fetch a payment — response body — check details estimated delivery date, mailed at, tracking number, tracking updates, tracking url tracking updates item |
tracking_url | JSON | Required within parent | |
tracking_url (anyOf 1) | string | Alternative | Carrier tracking URL for the mailed check, if available. |
tracking_url (anyOf 2) | null | Alternative |
Referenced models: Fetch a payment — response body — check details estimated delivery date, mailed at, tracking number, tracking updates, tracking url tracking updates item
Fetch a payment — response body — check details estimated delivery date, mailed at, tracking number, tracking updates, tracking url tracking updates item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
city | JSON | Required within parent | |
city (anyOf 1) | string | Alternative | City where the tracking event occurred, if reported by the carrier. |
city (anyOf 2) | null | Alternative | |
created_at | JSON | Required within parent | |
created_at (anyOf 1) | string | Alternative | ISO 8601 timestamp the carrier recorded for this tracking event. Format: date-time |
created_at (anyOf 2) | null | Alternative | |
postal_code | JSON | Required within parent | |
postal_code (anyOf 1) | string | Alternative | Postal code where the tracking event occurred, if reported by the carrier. |
postal_code (anyOf 2) | null | Alternative | |
state | JSON | Required within parent | |
state (anyOf 1) | string | Alternative | State where the tracking event occurred, if reported by the carrier. |
state (anyOf 2) | null | Alternative | |
status | string | Required within parent | The carrier-reported tracking status for this update. Known values: delivered, delivery_issue, in_transit, processed_for_delivery, returned_to_sender, returning_to_sender |
Fetch a payment — response body — payment method
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Unique identifier of the payment instrument. Format: uuid |
type | string | Required within parent | The type of payment method. Known values: ACH, CHECK |
List payments — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand Fetch a payment — response body |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: List bills — response body — page, Fetch a payment — response body
Preview how an address and memo are truncated when printed on a check — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request body for POST /developer/v1/payments/check-preview. Additional keys: not allowed |
address_line_1 | string | Required within parent | Primary address line of the recipient. Minimum length: 1 |
address_line_2 | JSON | Optional | |
address_line_2 (anyOf 1) | string | Alternative | Secondary address line of the recipient. Default: null |
address_line_2 (anyOf 2) | null | Alternative | |
city | string | Required within parent | City of the recipient. Minimum length: 1 |
entity_id | JSON | Optional | |
entity_id (anyOf 1) | string | Alternative | Unique identifier of the entity that would pay. Required when the business has multiple entities, because the entity name is printed in the check memo. Default: null Format: uuid |
entity_id (anyOf 2) | null | Alternative | |
external_invoice_number | JSON | Optional | |
external_invoice_number (anyOf 1) | string | Alternative | The invoice number that would be printed in the check memo. Default: null |
external_invoice_number (anyOf 2) | null | Alternative | |
owner_name | string | Required within parent | Name of the recipient the check is mailed to. Minimum length: 1 |
postal_code | string | Required within parent | Postal or ZIP code of the recipient. Minimum length: 1 |
secondary_owner_line | JSON | Optional | |
secondary_owner_line (anyOf 1) | string | Alternative | Additional recipient line, such as a care-of name. Default: null |
secondary_owner_line (anyOf 2) | null | Alternative | |
state | string | Required within parent | State or province of the recipient. Minimum length: 1 |
Preview how an address and memo are truncated when printed on a check — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A physical check's recipient address and memo as they would be printed. |
address | Model | Required within parent | Expand Preview how an address and memo are truncated when printed on a check — response body — address The recipient address as it would be printed. |
memo | string | Required within parent | The memo line as it would be printed. |
Referenced models: Preview how an address and memo are truncated when printed on a check — response body — address
Preview how an address and memo are truncated when printed on a check — response body — address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An address as it would be printed on a physical check. |
address_line_1 | string | Required within parent | First delivery line as it would be printed. |
address_line_2 | string | Required within parent | Second delivery line as it would be printed. Empty when the address fits on one line. |
city | string | Required within parent | City as it would be printed. |
owner_name | string | Required within parent | Recipient name as it would be printed. |
postal_code | string | Required within parent | Postal code as it would be printed. |
state | JSON | Required within parent | |
state (anyOf 1) | string | Alternative | Two-letter state abbreviation as it would be printed, or null when the state could not be resolved. |
state (anyOf 2) | null | Alternative |
Retry a failed payment — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
payment_method | JSON | Optional | |
payment_method (anyOf 1) | Model | Alternative | Expand Update a payment — request body — body payment method Optional updated payment method for the retry. Only ACH is supported. Default: null |
payment_method (anyOf 2) | null | Alternative | |
source_bank_account_id | JSON | Optional | |
source_bank_account_id (anyOf 1) | string | Alternative | Optional updated source bank account for the retry. Default: null Format: uuid |
source_bank_account_id (anyOf 2) | null | Alternative |
Referenced models: Update a payment — request body — body payment method
Update a payment — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | Model | Optional | Expand Update a payment — request body — body amount The payment amount and currency. |
external_invoice_number | JSON | Optional | |
external_invoice_number (anyOf 1) | string | Alternative | The invoice number associated with this payment. |
external_invoice_number (anyOf 2) | null | Alternative | |
external_ref | string | Optional | An external reference identifier for this payment. |
payment_method | Model | Optional | Expand Update a payment — request body — body payment method The payment method to use for this payment. |
scheduled_date | string | Optional | The date the payment should be initiated (YYYY-MM-DD). Format: date |
source_bank_account_id | string | Optional | Unique identifier of the bank account to pay from. Format: uuid |
Referenced models: Update a payment — request body — body amount, Update a payment — request body — body payment method
Update a payment — request body — body amount
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
currency | string | Required within parent | The currency of the amount in ISO 4217 format (e.g. USD). One of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, EURC, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, OPEN_USD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDB, USDC, USDG, USDT, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, ZWL |
value | integer | Required within parent | The non-negative amount in the smallest denomination of the currency (e.g. cents for USD). Minimum: 0 |
Update a payment — request body — body payment method
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
id | string | Required within parent | Unique identifier of the payment instrument. For ACH, this is the vendor bank account ID. For CHECK, this is the vendor address ID. Format: uuid |
type | string | Required within parent | The type of payment method. One of: ACH, CHECK |