increase-test
POST/simulations/inbound_wire_drawdown_requests

Sandbox: Create an Inbound Wire Drawdown request

Simulates receiving an Inbound Wire Drawdown Request.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

19 body fields
amountintegerrequired
The amount being requested in cents.
creditor_account_numberstringrequired
The creditor's account number.
creditor_address_line1stringoptional
A free-form address field set by the sender representing the first line of the creditor's address.
creditor_address_line2stringoptional
A free-form address field set by the sender representing the second line of the creditor's address.
creditor_address_line3stringoptional
A free-form address field set by the sender representing the third line of the creditor's address.
creditor_namestringoptional
A free-form name field set by the sender representing the creditor's name.
creditor_routing_numberstringrequired
The creditor's routing number.
currencystringrequired
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being requested. Will always be "USD".
debtor_account_numberstringoptional
The debtor's account number.
debtor_address_line1stringoptional
A free-form address field set by the sender representing the first line of the debtor's address.
debtor_address_line2stringoptional
A free-form address field set by the sender representing the second line of the debtor's address.
debtor_address_line3stringoptional
A free-form address field set by the sender.
debtor_namestringoptional
A free-form name field set by the sender representing the debtor's name.
debtor_routing_numberstringoptional
The debtor's routing number.
end_to_end_identificationstringoptional
A free-form reference string set by the sender, to help identify the transfer.
instruction_identificationstringoptional
The sending bank's identifier for the wire transfer.
recipient_account_number_idstringrequired
The Account Number to which the recipient of this request is being requested to send funds from.
unique_end_to_end_transaction_referencestringoptional
The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr)) of the transfer.
unstructured_remittance_informationstringoptional
A free-form message set by the sender.

3 status codes
200Inbound Wire Drawdown Request
account_idstringrequired
The Account from which the recipient of this request is being requested to send funds.
amountintegerrequired
The amount being requested in cents.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the inbound wire drawdown request was created.
creditor_account_numberstringrequired
The creditor's account number.
creditor_address_line1stringrequired
A free-form address field set by the sender.
creditor_address_line2stringrequired
A free-form address field set by the sender.
creditor_address_line3stringrequired
A free-form address field set by the sender.
creditor_namestringrequired
A name set by the sender.
creditor_routing_numberstringrequired
The creditor's routing number.
currencystringrequired
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being requested. Will always be "USD".
debtor_address_line1stringrequired
A free-form address field set by the sender.
debtor_address_line2stringrequired
A free-form address field set by the sender.
debtor_address_line3stringrequired
A free-form address field set by the sender.
debtor_namestringrequired
A name set by the sender.
end_to_end_identificationstringrequired
A free-form reference string set by the sender, to help identify the drawdown request.
idstringrequired
The Wire drawdown request identifier.
input_message_accountability_datastringrequired
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_identificationstringrequired
The sending bank's identifier for the drawdown request.
recipient_account_number_idstringrequired
The Account Number from which the recipient of this request is being requested to send funds.
typestringrequired
A constant representing the object's type. For this resource it will always be `inbound_wire_drawdown_request`.
Allowed:inbound_wire_drawdown_request
unique_end_to_end_transaction_referencestringrequired
The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr)) of the drawdown request.
unstructured_remittance_informationstringrequired
A free-form message set by the sender.
4XXError
5XXError