v4

OpenAPI 3.1.02026-08-012402353.8 MB

Sandbox: Create an Inbound Wire Drawdown request

Simulates receiving an Inbound Wire Drawdown Request.

post/simulations/inbound_wire_drawdown_requests

Request body

amountinteger required

The amount being requested in cents.

creditor_account_numberstring required

The creditor's account number.

creditor_address_line1string

A free-form address field set by the sender representing the first line of the creditor's address.

creditor_address_line2string

A free-form address field set by the sender representing the second line of the creditor's address.

creditor_address_line3string

A free-form address field set by the sender representing the third line of the creditor's address.

creditor_namestring

A free-form name field set by the sender representing the creditor's name.

creditor_routing_numberstring required

The creditor's routing number.

currencystring required

The ISO 4217 code for the amount being requested. Will always be "USD".

debtor_account_numberstring

The debtor's account number.

debtor_address_line1string

A free-form address field set by the sender representing the first line of the debtor's address.

debtor_address_line2string

A free-form address field set by the sender representing the second line of the debtor's address.

debtor_address_line3string

A free-form address field set by the sender.

debtor_namestring

A free-form name field set by the sender representing the debtor's name.

debtor_routing_numberstring

The debtor's routing number.

end_to_end_identificationstring

A free-form reference string set by the sender, to help identify the transfer.

instruction_identificationstring

The sending bank's identifier for the wire transfer.

recipient_account_number_idstring required

The Account Number to which the recipient of this request is being requested to send funds from.

unique_end_to_end_transaction_referencestring

The Unique End-to-end Transaction Reference (UETR) of the transfer.

unstructured_remittance_informationstring

A free-form message set by the sender.

Example request

{
  "amount": 10000,
  "creditor_account_number": "987654321",
  "creditor_address_line1": "33 Liberty Street",
  "creditor_address_line2": "New York, NY, 10045",
  "creditor_name": "Ian Crease",
  "creditor_routing_number": "101050001",
  "currency": "USD",
  "debtor_account_number": "987654321",
  "debtor_address_line1": "33 Liberty Street",
  "debtor_address_line2": "New York, NY, 10045",
  "debtor_name": "Ian Crease",
  "debtor_routing_number": "101050001",
  "instruction_identification": null,
  "recipient_account_number_id": "account_number_v18nkfqm6afpsrvy82b2"
}

Response

Inbound Wire Drawdown Request

amountinteger required

The amount being requested in cents.

created_atstring date-time required

The ISO 8601 date and time at which the inbound wire drawdown request was created.

creditor_account_numberstring required

The creditor's account number.

creditor_address_line1string nullable required

A free-form address field set by the sender.

creditor_address_line2string nullable required

A free-form address field set by the sender.

creditor_address_line3string nullable required

A free-form address field set by the sender.

creditor_namestring nullable required

A name set by the sender.

creditor_routing_numberstring required

The creditor's routing number.

currencystring required

The ISO 4217 code for the amount being requested. Will always be "USD".

debtor_address_line1string nullable required

A free-form address field set by the sender.

debtor_address_line2string nullable required

A free-form address field set by the sender.

debtor_address_line3string nullable required

A free-form address field set by the sender.

debtor_namestring nullable required

A name set by the sender.

end_to_end_identificationstring nullable required

A free-form reference string set by the sender, to help identify the drawdown request.

idstring required

The Wire drawdown request identifier.

input_message_accountability_datastring nullable required

A unique identifier available to the originating and receiving banks, commonly abbreviated as IMAD. It is created when the wire is submitted to the Fedwire service and is helpful when debugging wires with the originating bank.

instruction_identificationstring nullable required

The sending bank's identifier for the drawdown request.

recipient_account_number_idstring required

The Account Number from which the recipient of this request is being requested to send funds.

type'inbound_wire_drawdown_request' required

A constant representing the object's type. For this resource it will always be inbound_wire_drawdown_request.

unique_end_to_end_transaction_referencestring nullable required

The Unique End-to-end Transaction Reference (UETR) of the drawdown request.

unstructured_remittance_informationstring nullable required

A free-form message set by the sender.

Example response

{
  "amount": 10000,
  "created_at": "2020-01-31T23:59:59Z",
  "creditor_account_number": "987654321",
  "creditor_address_line1": "33 Liberty Street",
  "creditor_address_line2": "New York, NY, 10045",
  "creditor_address_line3": null,
  "creditor_name": "Ian Crease",
  "creditor_routing_number": "101050001",
  "currency": "USD",
  "debtor_address_line1": "33 Liberty Street",
  "debtor_address_line2": "New York, NY, 10045",
  "debtor_address_line3": null,
  "debtor_name": "Ian Crease",
  "end_to_end_identification": "Invoice 29582",
  "id": "inbound_wire_drawdown_request_u5a92ikqhz1ytphn799e",
  "input_message_accountability_data": "20220118MMQFMP0P000001",
  "instruction_identification": "202201180000001",
  "recipient_account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "type": "inbound_wire_drawdown_request",
  "unique_end_to_end_transaction_reference": "9a21e10a-7600-4a24-8ff3-2cbc5943c27a",
  "unstructured_remittance_information": "INVOICE 2468"
}