Skip to content

Ramp: Transfer payment schemas

2 Ramp schemas with complete fields and constraints.

← Transfer payment operations · All schemas

Fetch a transfer payment — response body

FieldTypePresenceDescription and constraints
$objectRoot
amountModelOptionalExpand Hold Bill — response body — amount
Amount of the transfer.
bank_account_idJSONRequired within parent
bank_account_id (anyOf 1)stringAlternativeUnique identifier of the bank account used for this transfer payment.
Format: uuid
Read only: true
bank_account_id (anyOf 2)nullAlternative
created_atstringOptionalTimestamp when the transfer was created.
Format: date-time
entity_idstringOptionalBusiness entity associated with this transfer.
Format: uuid
idstringOptionalUnique identifier for the transfer.
Format: uuid
payment_idstringOptionalUnique payment identifier for the transfer.
statusstringOptionalStatus of the transfer. See [Transfers Guide](/developer-api/v1/guides/transfers) for definitions.
Known values: ACH_CONFIRMED, CANCELED, COMPLETED, ERROR, INITIATED, NOT_ACKED, NOT_ENOUGH_FUNDS, PROCESSING_BY_ODFI, REJECTED_BY_ODFI, RETURNED_BY_RDFI, SUBMITTED_TO_FED, SUBMITTED_TO_RDFI, UNNECESSARY, UPLOADED
sync_statusstringRequired within parentCurrent sync status of the transfer.
Known values: NOT_SYNC_READY, SYNCED, SYNC_READY
Read only: true

Referenced models: Hold Bill — response body — amount

List transfer payments — response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand Fetch a transfer payment — response body
pageModelRequired within parentExpand List bills — response body — page
Pagination details for this response.

Referenced models: List bills — response body — page, Fetch a transfer payment — response body

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.