Payin Deposit Detail

Endpoints

GET/v1/profiles/{{profileId}}/transfers/{{transferId}}/deposit-details/bank-transfer

The Payin Deposit Detail resource

Fields

payinBankobject

Information about the receiving bank.

payinBank.bankNametext

Bank name.

payinBank.bankAddressobject (can be null)

Bank address.

payinBank.bankAddress.countrytext

Country ISO 2 code

payinBank.bankAddress.firstLinetext

Street address

payinBank.bankAddress.postCodetext

Post code / zip code

payinBank.bankAddress.citytext

City

payinBank.bankAddress.statetext (can be null)

State. Can be null.

payinBankAccountobject

Bank account details to use to send the payment to.

payinBankAccount.currencytext

ISO 4217 source currency code

payinBankAccount.detailsarray of objects

Account details

payinBankAccount.details[n].typetext

Account details type e.g. accountNumber, iban etc.

payinBankAccount.details[n].labeltext

Account details label that should be displayed in your user interface.

payinBankAccount.details[n].valuetext

Account details value - the value of account details (like iban, account number etc).

wiseInformationobject

Information about the receiving Wise entity, the owner of the bank account.

wiseInformation.localCompanyNametext

Wise local company name.

wiseInformation.localAddressobject (can be null)

Wise local address.

wiseInformation.localAddress.countrytext

Country ISO 2 code

wiseInformation.localAddress.firstLinetext

Street address

wiseInformation.localAddress.postCodetext

Post code / zip code

wiseInformation.localAddress.citytext

City

wiseInformation.localAddress.statetext (can be null)

State. Can be null.

Payin Deposit Detail Object

{
  "payinBank": {
    "bankName": "TransferWise Europe SA",
    "bankAddress": {
      "country": "BE",
      "firstLine": "Avenue Louise 54, Room s52",
      "postCode": "1050",
      "city": "Brussels",
      "state": null
    }
  },
  "payinBankAccount": {
    "currency": "EUR",
    "details": [
      {
        "type": "iban",
        "label": "IBAN",
        "value": "BE11111111111111"
      },
      {
        "type": "bic",
        "label": "Bank code (BIC/SWIFT)",
        "value": "TRWIBEB1XXX"
      },
      {
        "type": "recipientName",
        "label": "Recipient name",
        "value": "TransferWise Europe SA"
      }
    ]
  },
  "wiseInformation": {
    "localCompanyName": "TransferWise Europe SA",
    "localAddress": {
      "country": "United Kingdom",
      "firstLine": "6th Floor, The Tea Building, 56 Shoreditch High Street",
      "postCode": "E1 6JJ",
      "city": "London",
      "state": null
    }
  }
}

Retrieve the bank transfer deposit details for a transfer

GET /v1/profiles/{{profileId}}/transfers/{{transferId}}/deposit-details/bank-transfer

The payin deposit details API allows you to get the bank details for the account that the customer should send funds to when paying for a Wise transfer via a bank transfer. These details will be provided in the local format for that currency and usually contain bank account information - like iban, swift code etc. It also includes the name and address of the receiving bank (payinBank) and the name and address of the Wise entity that owns the bank account (wiseInformation) as sometimes these are required to make a payment.

The payinBankAccount field allows the bank details to be displayed dynamically in a user interface, by displaying the label and value fields.

Currently, this API supports the following currencies:

Request

profileIdtext

Profile id.

transferIdtext

Transfer id.

Response

Returns a payin deposit detail object.

Example Request

curl -X GET https://api.transferwise.com/v1/profiles/{{profileId}}/transfers/{{transferId}}/deposit-details/bank-transfer \
     -H 'Authorization: Bearer {{API token}}' \
     -H 'x-mock-response-name: get-deposit-details-success'