Ramp: Create and initiate a payment — request body — body
Create and initiate a payment: request body, field body. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: 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