v4

OpenAPI 3.1.02026-08-012402353.8 MB

Retrieve a Swift Transfer

get/swift_transfers/{swift_transfer_id}

Path parameters

swift_transfer_idstring required

The identifier of the Swift Transfer.

Response

Swift Transfer

account_idstring required

The Account to which the transfer belongs.

account_numberstring required

The creditor's account number.

amountinteger required

The transfer amount in USD cents.

bank_identification_codestring required

The bank identification code (BIC) of the creditor.

created_atstring date-time required

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

creditor_namestring required

The creditor's name.

debtor_namestring required

The debtor's name.

idstring required

The Swift transfer's identifier.

idempotency_keystring nullable required

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_amountinteger required

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

instructed_currency'USD' required

The ISO 4217 currency code of the instructed amount.

intermediary_bank_identification_codestring nullable required

The bank identification code (BIC) of the intermediary bank, if the transfer is routed through one.

pending_transaction_idstring nullable required

The ID for the pending transaction representing the transfer.

routing_numberstring nullable required

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

source_account_number_idstring required

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

The lifecycle status of the transfer.

transaction_idstring nullable required

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

type'swift_transfer' required

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

unique_end_to_end_transaction_referencestring required

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

unstructured_remittance_informationstring required

The unstructured remittance information that was included with the transfer.

Example response

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number": "987654321",
  "amount": 100,
  "bank_identification_code": "FRNYUS33XXX",
  "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",
  "intermediary_bank_identification_code": null,
  "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"
}