Wire Transfers

Wire transfers move funds between your Increase account and any other account accessible by Fedwire.

The Wire Transfer object
{ "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "amount": 100, "approval": { "approved_at": "2020-01-31T23:59:59Z", "approved_by": null }, "beneficiary_address_line1": null, "beneficiary_address_line2": null, "beneficiary_address_line3": null, "beneficiary_name": null, "cancellation": null, "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "currency": "USD", "external_account_id": "external_account_ukk55lr923a3ac0pp7iv", "id": "wire_transfer_5akynk7dqsq25qwk9q2u", "idempotency_key": null, "inbound_wire_drawdown_request_id": null, "message_to_recipient": "Message to recipient", "network": "wire", "originator_address_line1": null, "originator_address_line2": null, "originator_address_line3": null, "originator_name": null, "pending_transaction_id": null, "reversal": null, "routing_number": "101050001", "source_account_number_id": null, "status": "complete", "submission": null, "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "wire_transfer" }
Attributes
account_id
string

The Account to which the transfer belongs.

account_number
string

The destination account number.

amount
integer

The transfer amount in USD cents.

approval
dictionary
Nullable

If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.

beneficiary_address_line1
string
Nullable

The beneficiary's address line 1.

beneficiary_address_line2
string
Nullable

The beneficiary's address line 2.

beneficiary_address_line3
string
Nullable

The beneficiary's address line 3.

beneficiary_name
string
Nullable

The beneficiary's name.

cancellation
dictionary
Nullable

If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.

created_at
string

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

created_by
dictionary
Nullable

What object created the transfer, either via the API or the dashboard.

currency
enum

The ISO 4217 code for the transfer's currency. For wire transfers this is always equal to usd.

external_account_id
string
Nullable

The identifier of the External Account the transfer was made to, if any.

id
string

The wire transfer's identifier.

idempotency_key
string
Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

inbound_wire_drawdown_request_id
string
Nullable

The ID of an Inbound Wire Drawdown Request in response to which this transfer was sent.

message_to_recipient
string
Nullable

The message that will show on the recipient's bank statement.

network
string

The transfer's network.

originator_address_line1
string
Nullable

The originator's address line 1.

originator_address_line2
string
Nullable

The originator's address line 2.

originator_address_line3
string
Nullable

The originator's address line 3.

originator_name
string
Nullable

The originator's name.

pending_transaction_id
string
Nullable

The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer requires approval by someone else in your organization.

reversal
dictionary
Nullable

If your transfer is reversed, this will contain details of the reversal.

routing_number
string

The American Bankers' Association (ABA) Routing Transit Number (RTN).

source_account_number_id
string
Nullable

The Account Number that was passed to the wire's recipient.

status
enum

The lifecycle status of the transfer.

submission
dictionary
Nullable

After the transfer is submitted to Fedwire, this will contain supplemental details.

transaction_id
string
Nullable

The ID for the transaction funding the transfer.

type
string

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

Sandbox: Reverse a Wire Transfer

Simulates the reversal of a Wire Transfer by the Federal Reserve due to error conditions. This will also create a Transaction to account for the returned funds. This Wire Transfer must first have a status of complete.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/wire_transfers/wire_transfer_5akynk7dqsq25qwk9q2u/reverse" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
wire_transfer_id
string
Required

The identifier of the Wire Transfer you wish to reverse.

Sandbox: Submit a Wire Transfer

Simulates the submission of a Wire Transfer to the Federal Reserve. This transfer must first have a status of pending_approval or pending_creating.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/wire_transfers/wire_transfer_5akynk7dqsq25qwk9q2u/submit" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
wire_transfer_id
string
Required

The identifier of the Wire Transfer you wish to submit.

List Wire Transfers
curl \ --url "${INCREASE_URL}/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 Wire Transfers to those belonging to the specified Account.

external_account_id
string

Filter Wire Transfers to those made to the specified External Account.

idempotency_key
string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

200 character maximum
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.

Create a Wire Transfer
curl -X "POST" \ --url "${INCREASE_URL}/wire_transfers" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "amount": 100, "beneficiary_address_line1": "33 Liberty Street", "beneficiary_address_line2": "New York", "beneficiary_address_line3": "NY 10045", "beneficiary_name": "Ian Crease", "message_to_recipient": "New account transfer", "routing_number": "101050001" }'
Parameters
account_id
string
Required

The identifier for the account that will send the transfer.

account_number
string

The account number for the destination account.

34 character maximum
amount
integer
Required

The transfer amount in USD cents.

beneficiary_address_line1
string

The beneficiary's address line 1.

35 character maximum
beneficiary_address_line2
string

The beneficiary's address line 2.

35 character maximum
beneficiary_address_line3
string

The beneficiary's address line 3.

35 character maximum
beneficiary_name
string
Required

The beneficiary's name.

35 character maximum
external_account_id
string

The ID of an External Account to initiate a transfer to. If this parameter is provided, account_number and routing_number must be absent.

inbound_wire_drawdown_request_id
string

The ID of an Inbound Wire Drawdown Request in response to which this transfer is being sent.

message_to_recipient
string
Required

The message that will show on the recipient's bank statement.

140 character maximum
originator_address_line1
string

The originator's address line 1. This is only necessary if you're transferring from a commingled account. Otherwise, we'll use the associated entity's details.

35 character maximum
originator_address_line2
string

The originator's address line 2. This is only necessary if you're transferring from a commingled account. Otherwise, we'll use the associated entity's details.

35 character maximum
originator_address_line3
string

The originator's address line 3. This is only necessary if you're transferring from a commingled account. Otherwise, we'll use the associated entity's details.

35 character maximum
originator_name
string

The originator's name. This is only necessary if you're transferring from a commingled account. Otherwise, we'll use the associated entity's details.

35 character maximum
require_approval
boolean

Whether the transfer requires explicit approval via the dashboard or API.

routing_number
string

The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.

9 character maximum
source_account_number_id
string

The ID of an Account Number that will be passed to the wire's recipient

Retrieve a Wire Transfer
curl \ --url "${INCREASE_URL}/wire_transfers/wire_transfer_5akynk7dqsq25qwk9q2u" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
wire_transfer_id
string
Required

The identifier of the Wire Transfer.

Approve a Wire Transfer
curl -X "POST" \ --url "${INCREASE_URL}/wire_transfers/wire_transfer_5akynk7dqsq25qwk9q2u/approve" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
wire_transfer_id
string
Required

The identifier of the Wire Transfer to approve.

Cancel a pending Wire Transfer
curl -X "POST" \ --url "${INCREASE_URL}/wire_transfers/wire_transfer_5akynk7dqsq25qwk9q2u/cancel" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
wire_transfer_id
string
Required

The identifier of the pending Wire Transfer to cancel.