Skip to content

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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
accounting_field_selectionsarrayOptionalAccounting field selections to apply to the payment.
accounting_field_selections[]ModelEach itemExpand Create a bill — request body — body accounting field selections item
amountModelRequired within parentExpand Update a payment — request body — body amount
The payment amount and currency.
entity_idstringRequired within parentUnique identifier of the entity to associate with this payment.
Format: uuid
external_invoice_numberJSONOptional
external_invoice_number (anyOf 1)stringAlternativeThe invoice number associated with this payment.
Default: null
external_invoice_number (anyOf 2)nullAlternative
external_refJSONOptional
external_ref (anyOf 1)stringAlternativeAn external reference identifier for this payment.
Default: null
external_ref (anyOf 2)nullAlternative
payment_methodModelRequired within parentExpand Update a payment — request body — body payment method
The payment method to use for this payment.
scheduled_datestringRequired within parentThe date the payment should be initiated (YYYY-MM-DD).
Format: date
source_bank_account_idstringRequired within parentUnique identifier of the bank account to pay from.
Format: uuid
vendor_idstringRequired within parentUnique 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

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.