Ramp: Fetch a transfer payment — response body

Fetch a transfer payment: response body. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Fetch a transfer payment — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`amount`	Model	Optional	Expand Hold Bill — response body — amount Amount of the transfer.
`bank_account_id`	JSON	Required within parent
`bank_account_id (anyOf 1)`	string	Alternative	Unique identifier of the bank account used for this transfer payment. Format: uuid Read only: true
`bank_account_id (anyOf 2)`	null	Alternative
`created_at`	string	Optional	Timestamp when the transfer was created. Format: date-time
`entity_id`	string	Optional	Business entity associated with this transfer. Format: uuid
`id`	string	Optional	Unique identifier for the transfer. Format: uuid
`payment_id`	string	Optional	Unique payment identifier for the transfer.
`status`	string	Optional	Status 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_status`	string	Required within parent	Current sync status of the transfer. Known values: NOT_SYNC_READY, SYNCED, SYNC_READY Read only: true