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, "beneficiary_address_line1": null, "beneficiary_address_line2": null, "beneficiary_address_line3": null, "beneficiary_name": null, "beneficiary_reference": null, "created_at": "2020-01-31T23:59:59Z", "description": "Inbound wire transfer", "id": "inbound_wire_transfer_f228m6bmhtcxjco9pwp0", "input_message_accountability_data": null, "originator_address_line1": null, "originator_address_line2": null, "originator_address_line3": null, "originator_name": null, "originator_routing_number": null, "originator_to_beneficiary_information": null, "originator_to_beneficiary_information_line1": null, "originator_to_beneficiary_information_line2": null, "originator_to_beneficiary_information_line3": null, "originator_to_beneficiary_information_line4": null, "reversal": null, "sender_reference": null, "status": "accepted", "type": "inbound_wire_transfer" }
Attributes
account_id
string

The Account to which the transfer belongs.

account_number_id
string

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

amount
integer

The amount in USD cents.

beneficiary_address_line1
string
Nullable

A free-form address field set by the sender.

beneficiary_address_line2
string
Nullable

A free-form address field set by the sender.

beneficiary_address_line3
string
Nullable

A free-form address field set by the sender.

beneficiary_name
string
Nullable

A name set by the sender.

beneficiary_reference
string
Nullable

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

created_at
string

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

description
string

An Increase-constructed description of 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.

originator_address_line1
string
Nullable

The address of the wire originator, set by the sending bank.

originator_address_line2
string
Nullable

The address of the wire originator, set by the sending bank.

originator_address_line3
string
Nullable

The address of the wire originator, set by the sending bank.

originator_name
string
Nullable

The originator of the wire, set by the sending bank.

originator_routing_number
string
Nullable

The American Banking Association (ABA) routing number of the bank originating the transfer.

originator_to_beneficiary_information
string
Nullable

An Increase-created concatenation of the Originator-to-Beneficiary lines.

originator_to_beneficiary_information_line1
string
Nullable

A free-form message set by the wire originator.

originator_to_beneficiary_information_line2
string
Nullable

A free-form message set by the wire originator.

originator_to_beneficiary_information_line3
string
Nullable

A free-form message set by the wire originator.

originator_to_beneficiary_information_line4
string
Nullable

A free-form message set by the wire originator.

reversal
dictionary
Nullable

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

sender_reference
string
Nullable

The sending bank's reference number for the wire transfer.

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.

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.

account_number_id
string

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

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.

amount
integer
Required

The transfer amount in cents. Must be positive.

beneficiary_address_line1
string

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

200 character maximum
beneficiary_address_line2
string

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

200 character maximum
beneficiary_address_line3
string

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

200 character maximum
beneficiary_name
string

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

200 character maximum
beneficiary_reference
string

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

200 character maximum
originator_address_line1
string

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

200 character maximum
originator_address_line2
string

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

200 character maximum
originator_address_line3
string

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

200 character maximum
originator_name
string

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

200 character maximum
originator_routing_number
string

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

200 character maximum
originator_to_beneficiary_information_line1
string

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

200 character maximum
originator_to_beneficiary_information_line2
string

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

200 character maximum
originator_to_beneficiary_information_line3
string

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

200 character maximum
originator_to_beneficiary_information_line4
string

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

200 character maximum
sender_reference
string

The sending bank will set sender_reference 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.