increase-test
POST/simulations/inbound_wire_transfers

Sandbox: Create an Inbound Wire Transfer

Simulates an Inbound Wire Transfer to your account.

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

17 body fields
account_number_idstringrequired
The identifier of the Account Number the inbound Wire Transfer is for.
amountintegerrequired
The transfer amount in cents. Must be positive.
creditor_address_line1stringoptional
The sending bank will set creditor_address_line1 in production. You can simulate any value here.
creditor_address_line2stringoptional
The sending bank will set creditor_address_line2 in production. You can simulate any value here.
creditor_address_line3stringoptional
The sending bank will set creditor_address_line3 in production. You can simulate any value here.
creditor_namestringoptional
The sending bank will set creditor_name in production. You can simulate any value here.
debtor_address_line1stringoptional
The sending bank will set debtor_address_line1 in production. You can simulate any value here.
debtor_address_line2stringoptional
The sending bank will set debtor_address_line2 in production. You can simulate any value here.
debtor_address_line3stringoptional
The sending bank will set debtor_address_line3 in production. You can simulate any value here.
debtor_namestringoptional
The sending bank will set debtor_name in production. You can simulate any value here.
end_to_end_identificationstringoptional
The sending bank will set end_to_end_identification in production. You can simulate any value here.
instructing_agent_routing_numberstringoptional
The sending bank will set instructing_agent_routing_number in production. You can simulate any value here.
instruction_identificationstringoptional
The sending bank will set instruction_identification in production. You can simulate any value here.
purposestringoptional
The sending bank will set purpose in production. You can simulate any value here.
unique_end_to_end_transaction_referencestringoptional
The sending bank will set unique_end_to_end_transaction_reference in production. You can simulate any value here.
unstructured_remittance_informationstringoptional
The sending bank will set unstructured_remittance_information in production. You can simulate any value here.
wire_drawdown_request_idstringoptional
The identifier of a Wire Drawdown Request the inbound Wire Transfer is fulfilling.

3 status codes
200Inbound Wire Transfer
acceptanceobjectrequired
If the transfer is accepted, this will contain details of the acceptance.
account_idstringrequired
The Account to which the transfer belongs.
account_number_idstringrequired
The identifier of the Account Number to which this transfer was sent.
amountintegerrequired
The amount in USD cents.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the inbound wire transfer was created.
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.
debtor_account_numberstringrequired
The account number of the sender.
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.
debtor_routing_numberstringrequired
The American Bankers' Association (ABA) routing number of the sender.
descriptionstringrequired
An Increase-constructed description of the transfer.
end_to_end_identificationstringrequired
A free-form reference string set by the sender, to help identify the transfer.
idstringrequired
The inbound wire transfer's 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.
instructing_agent_routing_numberstringrequired
The American Bankers' Association (ABA) routing number of the bank that sent the wire.
instruction_identificationstringrequired
The sending bank's identifier for the wire transfer.
purposestringrequired
The reason for the wire transfer, as set by the sender.
reversalobjectrequired
If the transfer is reversed, this will contain details of the reversal.
statusstringrequired
The status of the transfer.
Allowed:pendingaccepteddeclinedreversed
typestringrequired
A constant representing the object's type. For this resource it will always be `inbound_wire_transfer`.
Allowed:inbound_wire_transfer
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 transfer.
unstructured_remittance_informationstringrequired
A free-form message set by the sender.
wire_drawdown_request_idstringrequired
The wire drawdown request the inbound wire transfer is fulfilling.
4XXError
5XXError