Sign in

v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-012382333.4 MB

Sandbox: Create an Inbound Wire Transfer

Simulates an Inbound Wire Transfer to your account.

post/simulations/inbound_wire_transfers

Request body

account_number_idstring required

The identifier of the Account Number the inbound Wire Transfer is for.

amountinteger required

The transfer amount in cents. Must be positive.

creditor_address_line1string

The sending bank will set creditor_address_line1 in production. You can simulate any value here.

creditor_address_line2string

The sending bank will set creditor_address_line2 in production. You can simulate any value here.

creditor_address_line3string

The sending bank will set creditor_address_line3 in production. You can simulate any value here.

creditor_namestring

The sending bank will set creditor_name in production. You can simulate any value here.

debtor_address_line1string

The sending bank will set debtor_address_line1 in production. You can simulate any value here.

debtor_address_line2string

The sending bank will set debtor_address_line2 in production. You can simulate any value here.

debtor_address_line3string

The sending bank will set debtor_address_line3 in production. You can simulate any value here.

debtor_namestring

The sending bank will set debtor_name in production. You can simulate any value here.

end_to_end_identificationstring

The sending bank will set end_to_end_identification in production. You can simulate any value here.

instructing_agent_routing_numberstring

The sending bank will set instructing_agent_routing_number in production. You can simulate any value here.

instruction_identificationstring

The sending bank will set instruction_identification in production. You can simulate any value here.

unique_end_to_end_transaction_referencestring

The sending bank will set unique_end_to_end_transaction_reference in production. You can simulate any value here.

unstructured_remittance_informationstring

The sending bank will set unstructured_remittance_information in production. You can simulate any value here.

wire_drawdown_request_idstring

The identifier of a Wire Drawdown Request the inbound Wire Transfer is fulfilling.

Example request

{
  "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "amount": 1000
}

Response

Inbound Wire Transfer

account_idstring required

The Account to which the transfer belongs.

account_number_idstring required

The identifier of the Account Number to which this transfer was sent.

amountinteger required

The amount in USD cents.

created_atstring date-time required

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

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.

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.

descriptionstring required

An Increase-constructed description of the transfer.

end_to_end_identificationstring nullable required

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

idstring required

The inbound wire transfer's 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.

instructing_agent_routing_numberstring nullable required

The American Banking Association (ABA) routing number of the bank that sent the wire.

instruction_identificationstring nullable required

The sending bank's identifier for the wire transfer.

status'pending' | 'accepted' | 'declined' | 'reversed' required

The status of the transfer.

type'inbound_wire_transfer' required

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

unique_end_to_end_transaction_referencestring nullable required

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

unstructured_remittance_informationstring nullable required

A free-form message set by the sender.

wire_drawdown_request_idstring nullable required

The wire drawdown request the inbound wire transfer is fulfilling.

Example response

{
  "acceptance": null,
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "amount": 100,
  "created_at": "2020-01-31T23:59:59Z",
  "creditor_address_line1": null,
  "creditor_address_line2": null,
  "creditor_address_line3": null,
  "creditor_name": null,
  "debtor_address_line1": null,
  "debtor_address_line2": null,
  "debtor_address_line3": null,
  "debtor_name": null,
  "description": "Inbound wire transfer",
  "end_to_end_identification": null,
  "id": "inbound_wire_transfer_f228m6bmhtcxjco9pwp0",
  "input_message_accountability_data": null,
  "instructing_agent_routing_number": null,
  "instruction_identification": null,
  "reversal": null,
  "status": "accepted",
  "type": "inbound_wire_transfer",
  "unique_end_to_end_transaction_reference": null,
  "unstructured_remittance_information": null,
  "wire_drawdown_request_id": null
}