TransferWire

Receive a wire return request

Simulates an incoming wire return request for a simulated incoming wire transfer.

post/simulate/receive-wire-return-request

Request

Base URL: https://api.column.com
URL: https://api.column.com/simulate/receive-wire-return-request
Auth: HTTP basic

Request body

wire_transfer_idstring required

The ID of the wire transfer

Response

Successful response

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

beneficiary_account_numberstring required

The external account number to which the wire is being sent

beneficiary_namestring required

The name of the person who is receiving the wire

beneficiary_referencestring required

Reference information for the beneficiary included in the wire transfer.

business_function_codestring required

The business function code specified in the wire transfer. Possible business function codes are BTR, CTP, CTR, DRC, or DRW.

completed_atstring date-time nullable required

The timestamp when the wire was completed

counterparty_idstring required

ID of the counterparty that is receiving/sending the transfer

created_atstring date-time required

The timestamp when the wire was created

creditor_agent_namestring required

Name of the creditor's financial institution.

creditor_agent_routing_numberstring required

Routing number of the creditor's financial institution.

creditor_tax_idstring required

A Tax Identification Number (TIN) or Employer Identification Number (EIN) of exactly 9 numeric characters for the creditor. This field is only required when the counterparty routing number is one of the Treasury tax payment RTNs ('091036164' or '091036177') for an outgoing wire transfer.

currency_codestring required

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

debtor_agent_namestring required

Name of the debtor's financial institution.

debtor_agent_routing_numberstring required

Routing number of the debtor's financial institution.

descriptionstring required

A description of the transfer visible in account statements. This field contains "originator to beneficiary" information and will be transmitted to the RDFI. The description has a 140 character limit.

fi_to_fi_information_line_1string required

Financial institution to financial institution information, most often used by a FI to explain the reason for a wire reversal

fi_to_fi_information_line_2string required

Financial institution to financial institution information line 2.

fi_to_fi_information_line_3string required

Financial institution to financial institution information line 3.

fi_to_fi_information_line_4string required

Financial institution to financial institution information line 4.

fi_to_fi_information_line_5string required

Financial institution to financial institution information line 5.

fi_to_fi_information_line_6string required

Financial institution to financial institution information line 6.

hold_atstring date-time nullable

The timestamp when the wire transfer entered the hold state.

idstring required

The unique ID of the object

idempotency_keystring required

The idempotency key specified in the wire transfer

imadstring required

Stands for Input/Output Message Accountability Data. A unique number set by the originating bank given to each Fedwire payment when using the Federal Reserve Bank Service and can be used to investigate and track wire transfers. IMAD will be populated asynchronously and will not be populated on the completed event. IMAD will also not be populated for on-us wire transfers.

initiated_atstring date-time nullable required

The timestamp when the wire was initiated

instructed_agent_namestring required

Name of the instructed financial institution.

instructed_agent_routing_numberstring required

Routing number of the instructed financial institution.

instructing_agent_namestring required

Name of the instructing financial institution.

instructing_agent_routing_numberstring required

Routing number of the instructing financial institution.

is_incomingboolean required

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

is_on_usboolean required

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

manual_review_atstring date-time nullable required

The timestamp when the wire went into the manual review state

omadstring required

Stands for Input/Output Message Accountability Data. A unique number set by the Fed given to each Fedwire payment when using the Federal Reserve Bank Service and can be used to investigate and track wire transfers. OMAD will be populated asynchronously and will not be populated on the completed event. OMAD will also not be populated for on-us wire transfers.

originator_account_numberstring required

The external account number from which the wire is originated

originator_namestring required

The name of the person or entity that is originating the wire

originator_to_beneficiary_information_line_1string required

Originator to beneficiary information line 1.

originator_to_beneficiary_information_line_2string required

Originator to beneficiary information line 2.

originator_to_beneficiary_information_line_3string required

Originator to beneficiary information line 3.

originator_to_beneficiary_information_line_4string required

Originator to beneficiary information line 4.

pending_submission_atstring date-time nullable required

The timestamp when the wire was marked PENDING_SUBMISSION

pre_review_atstring date-time

The timestamp at which transfer approval became required for the wire transfer, which then waits for an approval decision before being initiated. Only set when transfer approvals are enabled for the platform, or for the API key that created the transfer.

previous_message_referencestring required

The previous message identifier included in the raw wire message

raw_beneficiary_addressstring required

The unstructured beneficiary address extracted from the raw wire message

raw_messagestring

The raw Fedwire message for this wire transfer.

raw_originator_addressstring required

The unstructured originator address extracted from the raw wire message

receiver_di_namestring required

The name of the person / entity that received the wire

receiver_di_routing_numberstring required

The routing number of the bank that received the wire

rejected_atstring date-time nullable required

The timestamp when the wire was rejected

return_additional_infostring

Contains additional freeform text from the RDFI if provided (only populated for wire returns)

return_reasonstring

Reason the original transfer was returned. Possible values: invalid_beneficiary_account_number, beneficiary_mismatch, beneficiary_request, originator_request, account_closed, account_blocked, incorrect_amount, fraud, missing_originator_data, missing_beneficiary_data, compliance, other.

reversal_pair_transfer_idstring required

If the transfer is the original transfer of a wire reversal, this field is the unique ID of the reversal transfer. If the transfer is the reversal transfer of a wire reversal, this field is the unique ID of the original transfer.

sender_di_namestring required

The name of the person / entity that sent the wire

sender_di_routing_numberstring required

The routing number of the bank that sent the wire

sender_referencestring required

The sender reference field parsed out from the raw wire message

The current status of the wire transfer. Possible values: INITIATED, PRE_REVIEW, COMPLETED, REJECTED, MANUAL_REVIEW, HOLD, and CANCELED.

submitted_atstring date-time nullable required

The timestamp when the wire was submitted

subtype_codestring required

The subtype code specified in the wire transfer

tax_record_period_typestring required

The Tax Month in the tax remittance component. This field is only required when the counterparty routing number is one of the Treasury tax payment RTNs for an outgoing wire transfer. Possible values are MM01 through MM12 (January through December).

tax_type_codestring required

Tax Type Code of exactly 5 alphanumeric characters (capital letters and numbers). This field is only required when the counterparty routing number is one of the Treasury tax payment RTNs for an outgoing wire transfer.

tax_yearstring required

A Tax Year of exactly 4 numerical characters. This field is only required when the counterparty routing number is one of the Treasury tax payment RTNs for an outgoing wire transfer.

type_codestring required

The type code specified in the wire transfer

ultimate_originator_counterparty_idstring required

ID of the ultimate originating counterparty that sent the transfer in an outgoing wire transfer. If present, this will replace the originator field in the outgoing wire message.

updated_atstring date-time required

The timestamp when the wire was updated

wire_drawdown_request_idstring required

ID of the wire drawdown request if the wire is sent in response to a wire drawdown request

Changes

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