TransferRealtime

Create a realtime RFP

Create a Realtime Request For Payment (RFP) between a Column account and a counterparty.

post/transfers/realtime/request-for-payment

Request

  • Base URL: https://api.column.com
  • URL: https://api.column.com/transfers/realtime/request-for-payment
  • Auth: HTTP basic

Headers

Idempotency-Keystring

Idempotency keys can be up to 255 characters long and are case sensitive. Column reserves the right to expire idempotency keys after 30 days. Only ASCII printable characters (code 32 - 126) are allowed for idempotency keys.

Request body

account_number_idstring

Source account number ID

amountinteger required

RFP amount in smallest unit

bank_account_idstring

Source bank account ID

counterparty_idstring required

Counterparty ID

currency_code'USD' required

ISO 4217 currency code

descriptionstring

Free-form RFP description

Response

Successful response

accepted_atstring date-time nullable

The timestamp when the Realtime RFP was accepted

account_number_idstring required

ID of the account number that is sending/receiving the RFP

amountinteger required

Amount (in cents) of the funds that will be transferred between originator and counterparty accounts. e.g. $1.75 would be represented by 175

bank_account_idstring required

ID of the bank account that is sending/receiving the RFP

canceled_atstring date-time nullable

The timestamp at which the Realtime RFP was canceled

completed_atstring date-time nullable

The timestamp at which the Realtime RFP was completed

counterparty_idstring required

ID of the counterparty that is receiving/sending the RFP

currency_codestring required

The three-letter currency code defined in ISO 4217. e.g. USD

descriptionstring required

A description of the RFP visible in account statements

end_to_end_idstring nullable

A unique identifier for the transfer that is passed through to the receiving bank. This is used for reconciliation purposes between originator and receiver.

expired_atstring date-time nullable

The timestamp when the Realtime RFP expired

idstring required

The unique id of the RFP object

idempotency_keystring nullable

The idempotency key specified in the Realtime RFP

initiated_atstring date-time nullable

The timestamp when the Realtime RFP was initiated

is_incomingboolean required

Indicates the Realtime RFP is incoming (true) or outgoing (false)

is_on_usboolean required

Indicates the Realtime RFP is between two bank accounts held at Column

presented_atstring date-time nullable

Time the RFP was presented

realtime_transfer_idstring nullable

Realtime transfer object of a credit transfer that was sent/received to settle an accepted RFP

received_atstring date-time nullable

Time the RFP was received

rejected_atstring date-time nullable

The timestamp at which the Realtime transfer was rejected after acceptance without posting

rejection_additional_infostring nullable

Contains further information on the rejection reason in free-formatted text, if available

rejection_codestring nullable

Code representing a reason for Realtime payment rejection

rejection_code_descriptionstring nullable

Description for the rejection_code

statusstring required

The current status of the Realtime transfer. Possible statuses are initiated, presented, received, accepted, completed, rejected, expired, canceled.

Changes

No recorded changes to this operation across all 1 revision of this API.