Deprecated APIs

Deprecated APIs are those that are no longer the standard version and have been marked as such. They will continue to work for the foreseeable future, but should not be used for new integrations.

Endpoints
GET/v1/borderless-accounts?profileId={{profileId}}
POST/v1/borderless-accounts/{{borderlessAccountId}}/conversions

Get account balance

GET /v1/borderless-accounts?profileId={{profileId}}

Get available balances for all activated currencies in your multi-currency account.

Use profile ID obtained earlier to make this call.

Response
idinteger

Multi-currency account ID

profileIdinteger

Personal or business profile ID

recipientIdinteger

Recipient ID you can use for a multi-currency account deposit

creationTimetimestamp

Date when multi-currency account was opened

modificationTimetimestamp

Date when multi-currency account setup was modified.

activeboolean

Is multi-currency account active or inactive

eligibleboolean

Ignore

balances[n].balanceTypetext

AVAILABLE

balances[n].currencytext

Currency code

balances[n].amount.valuedecimal

Available balance in specified currency

balances[n].amount.currencytext

Currency code

balances[n].reservedAmount.valuedecimal

Reserved amount from your balance

balances[n].reservedAmount.currencytext

Reserved amount currency code

balances[n].bankDetailsgroup

Bank account details assigned to your multi-currency account. Available for EUR, GBP, USD, AUD, NZD

balances[n].bankDetails.idinteger

Bank account details ID

balances[n].bankDetails.currencytext

Bank account currency

balances[n].bankDetails.bankCodetext

Bank account code

balances[n].bankDetails.accountNumbertext

Bank account number

balances[n].bankDetails.swifttext

Bank account swift code

balances[n].bankDetails.ibantext

Bank account iban

balances[n].bankDetails.bankName

Bank name

balances[n].bankDetails.accountHolderNametext

Bank account holder name

balances[n].bankDetails.bankAddress.addressFirstLinetext

Bank address street and house

balances[n].bankDetails.bankAddress.postCodetext

Bank address zip code

balances[n].bankDetails.bankAddress.citytext

Bank address city

balances[n].bankDetails.bankAddress.countrytext

Bank address country

balances[n].bankDetails.bankAddress.stateCodetext

Bank address state code

Example Request
curl -X GET https://api.sandbox.transferwise.tech/v1/borderless-accounts?profileId={{profileId}} \
     -H 'Authorization: Bearer <your api token>'
Example Response
[
  {
    "id": 64,
    "profileId": 33333333,
    "recipientId": 13828530,
    "creationTime": "2018-03-14T12:31:15.678Z",
    "modificationTime": "2018-03-19T15:19:42.111Z",
    "active": true,
    "eligible": true,
    "balances": [
      {
        "balanceType": "AVAILABLE",
        "currency": "GBP",
        "amount": {
          "value": 10999859,
          "currency": "GBP"
        },
        "reservedAmount": {
          "value": 0,
          "currency": "GBP"
        },
        "bankDetails": null
      },
      {
        "balanceType": "AVAILABLE",
        "currency": "EUR",
        "amount": {
          "value": 9945236.2,
          "currency": "EUR"
        },
        "reservedAmount": {
          "value": 0,
          "currency": "EUR"
        },
        "bankDetails": {
          "id": 90,
          "currency": "EUR",
          "bankCode": "DEKTDE7GXXX",
          "accountNumber": "DE51 7001 1110 6050 1008 91",
          "swift": "DEKTDE7GXXX",
          "iban": "DE51 7001 1110 6050 0008 91",
          "bankName": "Handelsbank",
          "accountHolderName": "Oliver Wilson",
          "bankAddress": {
            "addressFirstLine": "Elsenheimer Str. 41",
            "postCode": "80687",
            "city": "München",
            "country": "Germany",
            "stateCode": null
          }
        }
      }
    ]
  }
]

Convert currencies between balances

POST /v1/borderless-accounts/{{borderlessAccountId}}/conversions

Convert funds between your multi-currency account currencies. Quote which is used in this call must be created with "payOut": "BALANCE".

Note that this call needs an extra field in header called "X-idempotence-uuid".

Request Fields
quoteIdinteger

Conversion quote ID

X-idempotence-uuiduuid

Unique identifier assigned by you. Used for idempotency check purposes. Should your call fail for technical reasons then you can use the same value again for making retry call.

Example Request
curl -X POST https://api.sandbox.transferwise.tech/v1/borderless-accounts/{{borderlessAccountId}}/conversions \
     -H 'Authorization: Bearer <your api token>'  \
     -H 'Content-Type: application/json' \
     -H 'X-idempotence-uuid: <generated uuid>' \
     -d '{
            "quoteId": <conversion quote ID>
         }'
Example Response
{
  "id": 1,
  "type": "CONVERSION",
  "state": "COMPLETED",
  "balancesAfter": [
    {
      "value": 10000594.71,
      "currency": "GBP"
    },
    {
      "value": 9998887.01,
      "currency": "EUR"
    }
  ],
  "creationTime": "2017-11-21T09:55:49.275Z",
  "steps": [
    {
      "id": 369588,
      "type": "CONVERSION",
      "creationTime": "2017-11-21T09:55:49.276Z",
      "balancesAfter": [
        {
          "value": 9998887.01,
          "currency": "EUR"
        },
        {
          "value": 10000594.71,
          "currency": "GBP"
        }
      ],
      "channelName": null,
      "channelReferenceId": null,
      "tracingReferenceCode": null,
      "sourceAmount": {
        "value": 113.48,
        "currency": "EUR"
      },
      "targetAmount": {
        "value": 100,
        "currency": "GBP"
      },
      "fee": {
        "value": 0.56,
        "currency": "EUR"
      },
      "rate": 0.88558
    }
  ],
  "sourceAmount": {
    "value": 113.48,
    "currency": "EUR"
  },
  "targetAmount": {
    "value": 100,
    "currency": "GBP"
  },
  "rate": 0.88558,
  "feeAmounts": [
    {
      "value": 0.56,
      "currency": "EUR"
    }
  ]
}

Get status of a one time token

GET /v1/identity/one-time-token/status

Retrieve necessary information to clear a OTT.

Request

Header
One-Time-Tokentext

Text value of a OTT.

Response

oneTimeTokenPropertiesOneTimeToken

Properties of OneTimeToken

Example Request
curl -X GET https://api.sandbox.transferwise.tech/v1/identity/one-time-token/status \
     -H 'Authorization: Bearer <your api token>'
     -H 'One-Time-Token: <one time token>'
Example Response
{
  "oneTimeTokenProperties": {
    "oneTimeToken": "9f5f5812-2609-4e48-8418-b64437c0c7cd",
    "challenges": [
      {
        "primaryChallenge": {
          "type": "PIN",
          "viewData": {
            "attributes": {
              "userId": 6146956
            }
          }
        },
        "alternatives": [],
        "required": true,
        "passed": false
      }
    ],
    "validity": 3600,
    "actionType": "BALANCE__GET_STATEMENT",
    "userId": 6146956
  }
}