Ramp: Hold Bill — response body — payment amount, bank debit trace id, customer friendly payment id, details, effective date, id, payment date, payment method, trace id details approval status, is same day, source bank account id, vendor account id
Hold Bill: response body, field payment / amount, bank_debit_trace_id, customer_friendly_payment_id, details, effective_date, id, payment_date, payment_method, trace_id / details / approval_status, is_same_day, source_bank_account_id, vendor_account_id. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Hold Bill — response body — payment amount, bank debit trace id, customer friendly payment id, details, effective date, id, payment date, payment method, trace id details approval status, is same day, source bank account id, vendor account id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approval_status | JSON | Required within parent | |
approval_status (anyOf 1) | string | Alternative | Approval status of the payment, if payment-step approvals are used. Known values: APPROVED, INITIALIZED, PENDING, REJECTED, TERMINATED |
approval_status (anyOf 2) | null | Alternative | |
is_same_day | boolean | Required within parent | Specifies whether the payment is configured for same-day delivery. Read only: true |
source_bank_account_id | JSON | Required within parent | |
source_bank_account_id (anyOf 1) | string | Alternative | Unique identifier of the bank account associated with this bill payment, if it exists. Format: uuid |
source_bank_account_id (anyOf 2) | null | Alternative | |
vendor_account_id | JSON | Required within parent | |
vendor_account_id (anyOf 1) | string | Alternative | Unique identifier of the vendor account associated with this bill payment, if it exists. Format: uuid |
vendor_account_id (anyOf 2) | null | Alternative |