Inbound Wire Transfers

An Inbound Wire Transfer is a wire transfer initiated outside of Increase to your account.

The Inbound Wire Transfer object
{ "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 }
Attributes
account_id
string

The Account to which the transfer belongs.

More about Accounts.
account_number_id
string

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

More about Account Numbers.
amount
integer

The amount in USD cents.

created_at
string

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

creditor_address_line1
string
Nullable

A free-form address field set by the sender.

creditor_address_line2
string
Nullable

A free-form address field set by the sender.

creditor_address_line3
string
Nullable

A free-form address field set by the sender.

creditor_name
string
Nullable

A name set by the sender.

debtor_address_line1
string
Nullable

A free-form address field set by the sender.

debtor_address_line2
string
Nullable

A free-form address field set by the sender.

debtor_address_line3
string
Nullable

A free-form address field set by the sender.

debtor_name
string
Nullable

A name set by the sender.

description
string

An Increase-constructed description of the transfer.

end_to_end_identification
string
Nullable

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

id
string

The inbound wire transfer's identifier.

input_message_accountability_data
string
Nullable

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_number
string
Nullable

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

instruction_identification
string
Nullable

The sending bank's identifier for the wire transfer.

reversal
dictionary
Nullable

Information about the reversal of the inbound wire transfer if it has been reversed.

status
enum

The status of the transfer.

type
string

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

unique_end_to_end_transaction_reference
string
Nullable

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

unstructured_remittance_information
string
Nullable

A free-form message set by the sender.

wire_drawdown_request_id
string
Nullable

The wire drawdown request the inbound wire transfer is fulfilling.

More about Wire Drawdown Requests.
List Inbound Wire Transfers
curl \ --url "${INCREASE_URL}/inbound_wire_transfers?account_id=account_in71c4amph0vgo2qllky" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

Filter Inbound Wire Transfers to ones belonging to the specified Account.

More about Accounts.
account_number_id
string

Filter Inbound Wire Transfers to ones belonging to the specified Account Number.

More about Account Numbers.
created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

status.in
array of strings

Filter Inbound Wire Transfers to those with the specified status. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

wire_drawdown_request_id
string

Filter Inbound Wire Transfers to ones belonging to the specified Wire Drawdown Request.

Retrieve an Inbound Wire Transfer
curl \ --url "${INCREASE_URL}/inbound_wire_transfers/inbound_wire_transfer_f228m6bmhtcxjco9pwp0" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
inbound_wire_transfer_id
string
Required

The identifier of the Inbound Wire Transfer to get details for.

Reverse an Inbound Wire Transfer
curl -X "POST" \ --url "${INCREASE_URL}/inbound_wire_transfers/inbound_wire_transfer_f228m6bmhtcxjco9pwp0/reverse" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "reason": "creditor_request" }'
Parameters
inbound_wire_transfer_id
string
Required

The identifier of the Inbound Wire Transfer to reverse.

reason
enum
Required

Reason for the reversal.

Sandbox: Create an Inbound Wire Transfer

Simulates an Inbound Wire Transfer to your account.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/inbound_wire_transfers" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "amount": 1000 }'
Parameters
account_number_id
string
Required

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

More about Account Numbers.
amount
integer
Required

The transfer amount in cents. Must be positive.

creditor_address_line1
string

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

200 character maximum
creditor_address_line2
string

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

200 character maximum
creditor_address_line3
string

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

200 character maximum
creditor_name
string

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

200 character maximum
debtor_address_line1
string

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

200 character maximum
debtor_address_line2
string

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

200 character maximum
debtor_address_line3
string

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

200 character maximum
debtor_name
string

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

200 character maximum
end_to_end_identification
string

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

200 character maximum
instructing_agent_routing_number
string

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

200 character maximum
instruction_identification
string

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

200 character maximum
unique_end_to_end_transaction_reference
string

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

200 character maximum
unstructured_remittance_information
string

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

200 character maximum
wire_drawdown_request_id
string

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