TransferRealtime

Reject a realtime RFP

Reject an outstanding Realtime RFP by its ID. Only incoming Realtime RFPs in status presented or received can be rejected.

patch/transfers/realtime/request-for-payment/{realtime_rfp_id}/reject

Request

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

Path parameters

realtime_rfp_idstring required

Request body

rejection_reasonstring

Optional rejection reason text

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.