TransferRealtime

Cancel a held realtime transfer

Abort an outgoing realtime transfer in a hold state. The held funds return to the available balance and nothing is ever routed or sent. Completed outgoing transfers require a return request instead.

post/transfers/realtime/{realtime_transfer_id}/cancel

Request

  • Base URL: https://api.column.com
  • URL: https://api.column.com/transfers/realtime/{realtime_transfer_id}/cancel
  • Auth: HTTP basic

Path parameters

realtime_transfer_idstring required

Request body

commentstring nullable

An optional reviewer comment recorded with the approval or rejection when the held transfer requires approval. Ignored for holds that do not require approval.

Response

Successful response

accepted_atstring date-time nullable

The timestamp when the realtime transfer was accepted without posting

account_number_idstring required

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

allow_overdraftboolean required

Allows the account to go negative for an outgoing transfer. The bank account needs to have is_overdraftable enabled with an overdraft reserve account linked to it

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 transfer

blocked_atstring date-time nullable

The timestamp when the realtime transfer was blocked after accepting without posting

canceled_atstring date-time nullable

The timestamp when a held realtime transfer was canceled and the funds returned to the available balance

completed_atstring date-time nullable

The timestamp when the realtime transfer was completed

counterparty_idstring required

ID of the counterparty that is receiving/sending the transfer

created_atstring date-time required

The timestamp when the realtime transfer was created

currency_codestring required

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

descriptionstring required

A description of the transfer 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. This ID may not be populated on an incoming Realtime transfer.

hold_atstring date-time nullable

The timestamp when the realtime transfer entered the hold state

idstring required

The unique ID of the object

idempotency_keystring nullable

The idempotency key specified in the realtime transfer

initiated_atstring date-time nullable

The timestamp when the realtime transfer was initiated

is_incomingboolean required

Indicates whether the realtime transfer was incoming ( true or outgoing false ).

is_on_usboolean required

Indicates whether the realtime transfer was between two bank accounts held at Column

manual_review_approved_atstring date-time nullable

The timestamp when the realtime transfer was approved after manual review

manual_review_atstring date-time nullable

The timestamp when the realtime transfer went into the manual review state

manual_review_rejected_atstring date-time nullable

The timestamp when the realtime transfer was rejected after manual review

pending_atstring date-time nullable

The timestamp when the realtime transfer was accepted without posting and is pending

pre_review_atstring date-time nullable

The timestamp when transfer approval became required for the realtime transfer

realtime_rfp_idstring nullable

The linked realtime request for payment ID

rejected_atstring date-time nullable

The timestamp when the realtime transfer was rejected after acceptance without posting

rejection_additional_infostring nullable

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

rejection_codestring nullable

Code representing a reason for rejecting realtime payment

rejection_code_descriptionstring nullable

Description for the rejection_reason_code

return_pair_transfer_idstring nullable

Provides a reference to a pair return transfer created when return was accepted. It is either the original transfer or the return transfer ID.

status'pre_review' | 'hold' | 'canceled' | 'initiated' | 'pending' | 'accepted' | 'completed' | 'blocked' | 'rejected' | 'manual_review' | 'manual_review_approved' | 'manual_review_rejected' required

The current status of the realtime transfer. Possible statuses are pre_review, hold, canceled, initiated, pending, accepted, completed, blocked, rejected, manual_review, manual_review_approved, manual_review_rejected.

ultimate_debtor_counterparty_idstring nullable

ID of the ultimate debtor counterparty that was set on the transfer

updated_atstring date-time required

The timestamp when the realtime transfer was updated

Changes

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