Guides
Explanatory and how-to content
API Reference
Technical documentation
Changelog
Release notes
Dashboard
Manage your account
Status
Service status
Swift Transfers

Swift Transfers send funds internationally.

The Swift Transfer object
{ "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "amount": 100, "bank_identification_code": "ECBFDEFFTPP", "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "creditor_address": { "city": "Frankfurt", "country": "DE", "line1": "Sonnemannstrasse 20", "line2": null, "postal_code": "60314", "state": null }, "creditor_name": "Ian Crease", "debtor_address": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "line2": null, "postal_code": "10045", "state": null }, "debtor_name": "National Phonograph Company", "id": "swift_transfer_29h21xkng03788zwd3fh", "idempotency_key": null, "instructed_amount": 100, "instructed_currency": "USD", "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4", "routing_number": null, "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "status": "initiated", "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "swift_transfer", "unique_end_to_end_transaction_reference": "9a21e10a-7600-4a24-8ff3-2cbc5943c27a", "unstructured_remittance_information": "Remittance information" }
Attributes
account_id
string

The Account to which the transfer belongs.

More about Accounts.
account_number
string

The creditor’s account number.

amount
integer

The transfer amount in USD cents.

bank_identification_code
string

The bank identification code (BIC) of the creditor.

created_at
string

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

created_by
dictionary

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

creditor_address
dictionary

The creditor’s address.

creditor_name
string

The creditor’s name.

debtor_address
dictionary

The debtor’s address.

debtor_name
string

The debtor’s name.

id
string

The Swift 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.

instructed_amount
integer

The amount that was instructed to be transferred in minor units of the instructed_currency.

instructed_currency
string

The ISO 4217 currency code of the instructed amount.

pending_transaction_id
string
Nullable

The ID for the pending transaction representing the transfer.

More about Pending Transactions.
routing_number
string
Nullable

The creditor’s bank account routing or transit number. Required in certain countries.

source_account_number_id
string

The Account Number included in the transfer as the debtor’s account number.

More about Account Numbers.
status
enum

The lifecycle status of the transfer.

transaction_id
string
Nullable

The ID for the transaction funding the transfer. This will be populated after the transfer is initiated.

More about Transactions.
type
string

A constant representing the object’s type. For this resource it will always be swift_transfer.

unique_end_to_end_transaction_reference
string

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

unstructured_remittance_information
string

The unstructured remittance information that was included with the transfer.

List Swift Transfers
curl \ --url "${INCREASE_URL}/swift_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 Swift Transfers to those that originated from the specified Account.

More about Accounts.
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
status.in
array of strings

Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

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 Swift Transfer
curl -X "POST" \ --url "${INCREASE_URL}/swift_transfers" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "bank_identification_code": "ECBFDEFFTPP", "creditor_address": { "city": "Frankfurt", "country": "DE", "line1": "Sonnemannstrasse 20", "postal_code": "60314" }, "creditor_name": "Ian Crease", "debtor_address": { "city": "New York", "country": "US", "line1": "33 Liberty Street", "postal_code": "10045", "state": "NY" }, "debtor_name": "National Phonograph Company", "instructed_amount": 100, "instructed_currency": "USD", "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "unstructured_remittance_information": "New Swift transfer" }'
Parameters
account_id
string
Required

The identifier for the account that will send the transfer.

More about Accounts.
account_number
string
Required

The creditor’s account number.

34 character maximum
bank_identification_code
string
Required

The bank identification code (BIC) of the creditor. If it ends with the three-character branch code, this must be 11 characters long. Otherwise this must be 8 characters and the branch code will be assumed to be XXX.

11 character maximum
creditor_address
dictionary
Required

The creditor’s address.

creditor_name
string
Required

The creditor’s name.

35 character maximum
debtor_address
dictionary
Required

The debtor’s address.

debtor_name
string
Required

The debtor’s name.

35 character maximum
instructed_amount
integer
Required

The amount, in minor units of instructed_currency, to send to the creditor.

instructed_currency
enum
Required

The ISO 4217 currency code of the instructed amount.

require_approval
boolean

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

routing_number
string

The creditor’s bank account routing or transit number. Required in certain countries.

35 character maximum
source_account_number_id
string
Required

The Account Number to include in the transfer as the debtor’s account number.

More about Account Numbers.
unstructured_remittance_information
string
Required

Unstructured remittance information to include in the transfer.

140 character maximum
Retrieve a Swift Transfer
curl \ --url "${INCREASE_URL}/swift_transfers/swift_transfer_29h21xkng03788zwd3fh" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
swift_transfer_id
string
Required

The identifier of the Swift Transfer.

More about Swift Transfers.
Approve a Swift Transfer
curl -X "POST" \ --url "${INCREASE_URL}/swift_transfers/swift_transfer_29h21xkng03788zwd3fh/approve" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
swift_transfer_id
string
Required

The identifier of the Swift Transfer to approve.

More about Swift Transfers.
Cancel a pending Swift Transfer
curl -X "POST" \ --url "${INCREASE_URL}/swift_transfers/swift_transfer_29h21xkng03788zwd3fh/cancel" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
swift_transfer_id
string
Required

The identifier of the pending Swift Transfer to cancel.

More about Swift Transfers.