Wise Platform API

Base URL Sandbox

https://api.sandbox.transferwise.tech

Base URL LIVE

https://api.transferwise.com

Welcome to the Wise Platform API documentation. You can explore the different ways to use our API and choose the right one for you below.

• Payouts
• Banks
• Affiliates
• Connected Applications
• Receive Money
• Open Banking

Payouts

This lets you automate how you use your Wise account. You can automate payments, connect your business tools, and create ways to manage your finances.

What are the benefits associated with automating your payouts and third party payments?

• Power your cross-border and domestic payouts with a single API integration.
• Pay out directly to bank accounts or email recipients.
• Monitor payments received to your Wise local bank details (AUD, EUR, GBP, NZD, USD, PLN, SGD, CAD, HUF, TRY).
• Get statements for reconciliation and accounting purposes.
• Fully automate transfer creation and track statuses.
• Always get the mid-market exchange rates and our low cost transparent fees.
• Use our platform to create and build your own tool to manage your finances.

Third-Party Payouts allows marketplaces and financial institutions (banks and payment service providers) to use Wise as a payout option for their customers. It’s different from Payouts since it doesn’t require your company to be the originator of payments. Instead, Wise will act as a third-party to your customers when they initiate a payment through your site.

In addition there will also be a dedicated account manager who will be your primary contact to solve all questions and support issues should these arise.

Please note that subscribing to third party payouts service requires your company to complete enhanced due diligence process performed by Wise compliance team. Please contact our sales team for more info how to get started.

Our Payouts and third party payments guide will help you get started with the technical integration.

Banks

Our bank integration lets banks build Wise payments seamlessly into their own desktop and mobile apps. Banks can also build their own native user experience directly onto our API, co-branded with Wise.

Please visit our Postman collection for more details and examples of how to use our API, including how to implement payment initiation, user linking, creation and others.

What are the benefits for my bank?

• Provide your customers access to some of the fastest and cheapest cross-border payments available to consumers and businesses today.
• Offer competitive, fair, and transparent pricing to customers at the mid-market exchange rate.
• Reduce your operational costs of cross-border payments.
• Stop losing out on cross-border revenues because your customers are finding better alternatives.

How does it work?

• Transparent and fair pricing - Your customers will get the same price no matter if they make transfers via your bank integration or directly via Wise.
• Same great Wise service - Your customers get access to our 24/7 customer support.
• Custom solution - We’ll work together to find and build a solution that works for your bank. There’s no one-size-fits-all approach. Together we’ll decide:
  • How do we set up flow of funds?
  • How do we handle customer support?
  • How do we harmonise customer onboarding and AML processes?

See what some of our bank partners have to say

• Monzo and Wise in United Kingdom
• N26 and Wise in Germany and Europe
• EQ and Wise in Canada
• Novo and Wise in the USA

An example native user experience based on the Wise Platform API

Please contact banks@wise.com to get started.

Take a look at our technical integration here – Bank Integration Guide.

Affiliates

When you apply to the Wise affiliates program you can get access to our API to help you build your own valuable content for your customers or readers.

The Wise Platform API lets you to:

• Get the real-time mid-market exchange rates for any currency route.
• Get up to 30 days of historical mid-market exchange rates for any currency route.
• Get a Wise quote for any supported currency route, which includes our fees and estimated delivery time.

The Affiliates Integration Guide helps you get started with the technical integration.

Please visit our Postman collection for more details and examples of how to use our API, including how to get comparison, rates as well as pricing and speed data.

Connected Applications

With Connected Applications, you can let your customers connect their Wise accounts to your product. Say you’re an accounting software – doing this could let your customers automate reconciliation. If you’re a payroll company, you could push customer payments right into Wise. You could even push Wise notifications through your app. Whatever you want to build, you likely could!

The Connected Apps Integration Guide helps you get started with the technical integration.

Receive Money

You can receive money to the local bank details that come with your Wise account (USD, EUR, GBP, AUD, NZD and PLN) and reconcile these incoming payments via the API.

You’re also able to create a webhook subscription to receive event callbacks to your server when payments are received. Here’s more information about the webhooks.

Please note that we don't send any information over webhook calls that might contain personally identifiable information (PII) about the sender (including the payment reference).

To reconcile incoming payments you might also need to match the information received via webhooks with the information that can be obtained from the statements.

Please visit our Postman collection for more details and examples of how to use our API, including how to set up webhook subscritions and get the account statements for reconciliation.

Checkout flows

We currently don’t offer the option to build Wise into your checkout flow as a payment option to receive money. Note though that Wise can be added as a payout option on your site for beneficiaries to choose to receive their payout through to an email address, directly to a bank account or any other mechanism we support in our standard product.

Open Banking

Under the Second Payment Services Directive (PSD2) we are opening up the standardized version of our API to the rest of the world. Find out more about our Open Banking Guide.

Australian Consumer Data Right API

We support the Australian Government's Consumer Data Right (CDR) legislation to give Australians greater control over their data. As a CDR participant, we are established as a Data Holder. In order to provide data to other participants, we have provided Banking APIs as per the standards. Find out more about our Consumer Data Right initiative.

Versioning

The Wise Platform API is continuously evolving as we offer new features and coverage to our API customers. Here we explain how our API versioning is maintained so you know what to expect.

It's important to us that third-party integrations are not adversely affected by changes and we endeavor to uphold these standards as part of making convenience and transparency part of our company's mission. We are regularly reviewing our policies to make sure we're delivering the best possible API developer experience.

These policies apply to both our REST API and our webhooks (push-based event API).

Breaking changes

A breaking change refers to any change that would require a client to update their application in order to continue working with the API as originally intended. If an API field or resource is removed or renamed, then a breaking change has taken place. In this case we will increment the version of the affected API endpoints to prevent breaking existing customer integrations.

Under our current policy API endpoints are not all versioned together, if API endpoint compatibility has changed in the new version as a result of a breaking change we will provide clear instructions in our documentation on which API calls must be used together.

Continuity (non-breaking) changes

Wise reserves the right to make additive changes to our API without incrementing the version number or notifying clients. We may add new resources, fields, and relationships to an existing version of the API and these will not be considered breaking changes.

For example, if we add a new relationship to the Transfer resource for a “parent_order”, we will neither bump the API version nor notify our customers before releasing the update. We will, however, update our API documentation explaining the purpose of the changes.

As such, clients should design their applications to be flexible enough to not break when new fields are added to resources.

Removal of existing API endpoints

It is not standard policy for Wise to remove or disable API versions, and we will not take this action lightly. However in some cases it may be necessary; for example if the affected API does not meet new regulatory requirements and there is no alternative to making a breaking change and disabling an old API.

In the extremely rare case that this is necessary we will not remove API endpoints without notice to clients who may be affected, and formal warning of at least 6 months as long as this complies with our regulatory obligations.

Contact Us

Having issues while calling our API endpoints?
Check our API status at https://status.transferwise.com/ If you would like to receive status change notifications, feel free to sign up here.

Have a technical question about API?
Send email to api@wise.com

Making lots of payments?
We have a dedicated team to talk to you. Get in touch

Have a question about how Wise works?
Search Wise Help Centre. https://wise.com/help

Want more information about your payments?
Lookup Wise Support Centre details. https://wise.com/contact

Payouts and third party payments Guide

The payouts and third party payments API guide/documentation is available here: Payouts guide

Third-Party Payouts Guide

The payouts and third party payments API guide/documentation is available here: Payouts and third party payments guide

Bank Integrations Guide

The bank integration documentation is available here: Wise for Banks API documentation

Multi-Currency Accounts Guide

The multi-currency accounts guide is available here: Multi-Currency Accounts Guide

Affiliates Integration Guide

The affiliates integration guide is available here: Affiliates Integration Guide.

Connected Apps Integration Guide

The connected apps integration guide is available here: Connected Apps Integration Guide.

Open Banking Guide

The open banking guide is available here: Open Banking Guide.

Australian Consumer Data Right API Guide

The Australian CDR API guide is available here: Australian CDR API Guide.

Global Currencies Guide

The global currencies guide is available here: Global Currencies Guide.

Card Issuance Guide

The card issuance documentation is available here: Wise for Card issuance documentation

SWIFT Receive Implementation Guide

The SWIFT Receive integration documentation is available here: SWIFT Receive Implementation Guide

Create/Update

Example Request:

curl -X POST https://api.sandbox.transferwise.tech/v1/addresses \
     -H "Authorization: Bearer <your api token>" \
     -H "Content-Type: application/json" \
     -d '{ 
          "profile": <your profile id>,
          "details": {
            "country": "EE",
            "firstLine": "Narva mnt 5-1",
            "postCode": "10113",
            "city": "Tallinn",
            "occupations": [
              {
                "code": "Software Engineer",
                "format": "FREE_FORM"
              }
            ]
          }
        }'

Example Response:

{
  "id": 236532,
  "profile": <your profile id>,
  "details": {
    "country": "EE",
    "firstLine": "Narva mnt 5-1",
    "postCode": "10113",
    "city": "Tallinn",
    "state": "",
    "occupation": null,
    "occupations": [
      {
        "code": "Software Engnieer",
        "format": "FREE_FORM"
      }
    ]
  }
}

Adds address info to user profile. List of required fields are different for different countries.

State field is required for US, CA, BR and AU addresses.

Occupations is required for CA, IN, JP and within the US for the states AZ and NM. If you serve any of these jurisdictions we recommend submitting occupation for all customers for simplicity, however if this is an issue we can discuss alternative solutions.

Request

POST https://api.sandbox.transferwise.tech/v1/addresses

Response

Get By Id

Example Request:

curl -X GET https://api.sandbox.transferwise.tech/v1/addresses/{addressId} \
     -H "Authorization: Bearer <your api token>"

Example Response:

{
  "id": 236532,
  "profile": <your profile id>,
  "details": {
    "country": "EE",
    "firstLine": "Narva mnt 5-1",
    "postCode": "10113",
    "city": "Tallinn",
    "state": "",
    "occupation": null,
    "occupations": null
  }
}

Get address info by id.

Request

GET https://api.sandbox.transferwise.tech/v1/addresses/{addressId}

List

Example Request:

curl -X GET https://api.sandbox.transferwise.tech/v1/addresses?profile={profileId} \
     -H "Authorization: Bearer <your api token>" 

Example Response:

[
    {
        "id": 7099091,
        "profile": <your profile id>,
        "details": {
            "country": "EE",
            "firstLine": "Veerenni 29",
            "postCode": "12991",
            "city": "Tallinn",
            "state": null,
            "occupation": null,
            "occupations": null
        }
    }
]

List of addresses belonging to user profile.

Request

GET https://api.sandbox.transferwise.tech/v1/addresses?profile={profileId}

Requirements

Example Request:

curl -X GET https://api.sandbox.transferwise.tech/v1/address-requirements \
     -H "Authorization: Bearer <your api token>"

Example Response:

[
  {
    "type": "address",
    "fields": [
      {
        "name": "Country",
        "group": [
          {
            "key": "country",
            "type": "select",
            "refreshRequirementsOnChange": true,
            "required": true,
            "displayFormat": null,
            "example": "Germany",
            "minLength": null,
            "maxLength": null,
            "validationRegexp": null,
            "validationAsync": null,
            "valuesAllowed": [
              {
                "key": "AX",
                "name": "Åland Islands"
              },
              ...
              {
                "key": "ZM",
                "name": "Zambia"
              }
            ]
          }
        ]
      },
      {
        "name": "City",
        "group": [
          {
            "key": "city",
            "type": "text",
            "refreshRequirementsOnChange": false,
            "required": true,
            "displayFormat": null,
            "example": "London",
            "minLength": null,
            "maxLength": null,
            "validationRegexp": null,
            "validationAsync": null,
            "valuesAllowed": null
          }
        ]
      },
      {
        "name": "Postal code",
        "group": [
          {
            "key": "postCode",
            "type": "text",
            "refreshRequirementsOnChange": false,
            "required": true,
            "displayFormat": null,
            "example": "10025",
            "minLength": null,
            "maxLength": null,
            "validationRegexp": null,
            "validationAsync": null,
            "valuesAllowed": null
          }
        ]
      }
      ...
    ]
  }
]

Request

GET https://api.sandbox.transferwise.tech/v1/address-requirements
POST https://api.sandbox.transferwise.tech/v1/address-requirements

GET and POST address-requirements endpoints help you to figure out which fields are required to create a valid address for different countries. You could even build a dynamic user interface on top of these endpoints. This is a step-by-step guide on how these endpoints work.

1. Call GET /v1/address-requirements to get list of fields you need to fill with values in "details" section for creating a valid address. Response contains 4 required top level fields:

• country (select field with list of values)
• city (text field)
• postCode (text field)
• firstLine (text field)

2. Analyze the list of fields. Because refreshRequirementsOnChange for field 'country' is marked as true then this indicates that there are additional fields required depending on the selected value.

3. Call POST /v1/address-requirements with selected country value to expose sub fields.
   For example posting {"details": {"country" : "US"}} will also add "state" to list of fields.
   But posting {"details": {"country" : "GB"}} will not.

4. If you choose "US" as country you will notice that "state" field also has refreshRequirementsOnChange=true. This means you would need to make another POST call to /v1/address-requirements with a specific state value.
   For example posting {"details": { "country" : "US", "state": "AZ" }} will also add "occupation" to list of fields.
   But posting {"details": { "country" : "US", "state": "AL" }} will not.

5. So once you get to the point where you have provided values for all fields which have refreshRequirementsOnChange=true then you have complete set of fields to compose a valid request to create an address object. For example this is a valid request to create address in US Arizona:
   POST /v1/addresses:
   { "profile" : your-profile-id,
   "details": {
   "country" : "US",
   "state": "AZ",
   "city": "Phoenix",
   "postCode": "10025",
   "firstLine": "50 Sunflower Ave.",
   "occupation": "software engineer"
   } }
   

Response

Balance Account

Balance accounts are included as part of the Wise Multi-Currency Account. Please refer to our multi-currency account guide for more information on the general use of the endpoints included below.

Balance account object

Example Balance Account:

{
  "id": 22656,
  "currency": "EUR",
  "type": "STANDARD",
  "name": null,
  "icon": null,
  "investmentState": "NOT_INVESTED",
  "amount": {
    "value": 0,
    "currency": "EUR"
  },
  "reservedAmount": {
    "value": 0,
    "currency": "EUR"
  },
  "cashAmount": {
    "value": 0,
    "currency": "EUR"
  },
  "totalWorth": {
    "value": 0,
    "currency": "EUR"
  },
  "creationTime": "2020-05-20T14:43:16.658Z",
  "modificationTime": "2020-05-20T14:43:16.658Z",
  "visible": true,
}

Create balance account

Example Request:

curl -L -X POST 'https://api.sandbox.transferwise.tech/v3/profiles/{{profileId}}/balances' \
  -H 'Authorization: Bearer <your api token>' \
  -H 'Content-Type: application/json' \
  -H 'X-idempotence-uuid: <uuid>' \
  --data-raw '{
      "currency": "EUR",
      "type": "STANDARD"
  }'

Example Response:

{
  "id": 22656,
  "currency": "EUR",
  "type": "STANDARD",
  "name": null,
  "icon": null,
  "investmentState": "NOT_INVESTED",
  "amount": {
    "value": 0,
    "currency": "EUR"
  },
  "reservedAmount": {
    "value": 0,
    "currency": "EUR"
  },
  "cashAmount": {
    "value": 0,
    "currency": "EUR"
  },
  "totalWorth": {
    "value": 0,
    "currency": "EUR"
  },
  "creationTime": "2020-05-20T14:43:16.658Z",
  "modificationTime": "2020-05-20T14:43:16.658Z",
  "visible": true,
}

Purpose

This endpoint opens a balance within the specified profile, in the currency and type specified in the request.

For STANDARD balances, only one can be created for a currency. For SAVINGS balances, multiples in the same currency can be opened.

When sending the request, the currency and type are required. If creating a SAVINGS type balance, a name is also required.

Request

List balance accounts

Example Request:

curl -X GET https://api.sandbox.transferwise.tech/v4/profiles/{{profileId}}/balances?types=STANDARD \
     -H "Authorization: Bearer <your api token>"

Example Response:

[
  {
    "id": 22656,
    "currency": "EUR",
    "type": "STANDARD",
    "name": null,
    "icon": null,
    "investmentState": "NOT_INVESTED",
    "amount": {
      "value": 0,
      "currency": "EUR"
    },
    "reservedAmount": {
      "value": 0,
      "currency": "EUR"
    },
    "cashAmount": {
      "value": 0,
      "currency": "EUR"
    },
    "totalWorth": {
      "value": 0,
      "currency": "EUR"
    },
    "creationTime": "2020-05-20T14:43:16.658Z",
    "modificationTime": "2020-05-20T14:43:16.658Z",
    "visible": true,
  },
  ...
]

Purpose

Retrieve the user's multi-currency account balance accounts. It returns all balance accounts the profile has in the types specified.

Parameters

A parameter of type must be passed and include at least a single type. To return more than one type, comma separate the values. Acceptable values are STANDARD and SAVINGS.

Get balance account by ID

Example Request:

curl -X GET https://api.sandbox.transferwise.tech/v4/profiles/{{profileId}}/balances/{{balanceId}} \
     -H "Authorization: Bearer <your api token>"

Example Response:

{
  "id": 22656,
  "currency": "EUR",
  "type": "STANDARD",
  "name": null,
  "icon": null,
  "investmentState": "NOT_INVESTED",
  "amount": {
    "value": 0,
    "currency": "EUR"
  },
  "reservedAmount": {
    "value": 0,
    "currency": "EUR"
  },
  "cashAmount": {
    "value": 0,
    "currency": "EUR"
  },
  "totalWorth": {
    "value": 0,
    "currency": "EUR"
  },
  "creationTime": "2020-05-20T14:43:16.658Z",
  "modificationTime": "2020-05-20T14:43:16.658Z",
  "visible": true,
}

Purpose

This endpoint returns a balance based on the specified balance ID.

Delete a balance

Example Request:

curl -X DELETE https://api.sandbox.transferwise.tech/v3/profiles/{{profileId}}/balances/{{balanceId}} \
     -H "Authorization: Bearer {{access-token}}"

Example Response:

{
  "id": 22656,
  "currency": "EUR",
  "type": "STANDARD",
  "name": null,
  "icon": null,
  "amount": {
    "value": 0.00,
    "currency": "EUR"
  },
  "reservedAmount": {
    "value": 0.00,
    "currency": "EUR"
  },
  "creationTime": "2020-05-20T14:43:16.658Z",
  "modificationTime": "2020-05-20T14:43:16.658Z",
  "visible": true,
}

Purpose

Close a balance account for the users profile. Balance accounts must have a zero balance in order for it to be closed. Bank account details for a balance account will also be deactivated and may not be restored in the future.

Get balance account statement

Example Request:

curl -X GET https://api.sandbox.transferwise.tech/v1/profiles/{profileId}/balance-statements/{balanceId}/statement.json?
intervalStart=2018-03-01T00:00:00.000Z&intervalEnd=2018-03-15T23:59:59.999Z&type=COMPACT \
     -H "Authorization: Bearer <your api token>"

Example Response:

{
  "accountHolder": {
    "type": "PERSONAL",
    "address": {
      "addressFirstLine": "Veerenni 24",
      "city": "Tallinn",
      "postCode": "12112",
      "stateCode": "",
      "countryName": "Estonia"
    },
    "firstName": "Oliver",
    "lastName": "Wilson"
  },
  "issuer": {
    "name": "TransferWise Ltd.",
    "firstLine": "56 Shoreditch High Street",
    "city": "London",
    "postCode": "E1 6JJ",
    "stateCode": "",
    "country": "United Kingdom"
  },
  "bankDetails": null,
  "transactions": [
    {
      "type": "DEBIT",
      "date": "2018-04-30T08:47:05.832Z",
      "amount": {
        "value": -7.76,
        "currency": "EUR"
      },
      "totalFees": {
        "value": 0.04,
        "currency": "EUR"
      },
      "details": {
        "type": "CARD",
        "description": "Card transaction of 6.80 GBP issued by Tfl.gov.uk/cp TFL TRAVEL CH",
        "amount": {
          "value": 6.8,
          "currency": "GBP"
        },
        "category": "Transportation Suburban and Loca",
        "merchant": {
          "name": "Tfl.gov.uk/cp",
          "firstLine": null,
          "postCode": "SW1H 0TL  ",
          "city": "TFL TRAVEL CH",
          "state": "   ",
          "country": "GB",
          "category": "Transportation Suburban and Loca"
        }
      },
      "exchangeDetails": {
        "forAmount": {
          "value": 6.8,
          "currency": "GBP"
        },
        "rate": null
      },
      "runningBalance": {
        "value": 16.01,
        "currency": "EUR"
      },
      "referenceNumber": "CARD-249281"
    },
    {
      "type": "CREDIT",
      "date": "2018-04-17T07:47:00.227Z",
      "amount": {
        "value": 200,
        "currency": "EUR"
      },
      "totalFees": {
        "value": 0,
        "currency": "EUR"
      },
      "details": {
        "type": "DEPOSIT",
        "description": "Received money from HEIN LAURI with reference SVWZ+topup card",
        "senderName": "HEIN LAURI",
        "senderAccount": "EE76 1700 0170 0049 6704 ",
        "paymentReference": "SVWZ+topup card"
      },
      "exchangeDetails": null,
      "runningBalance": {
        "value": 207.69,
        "currency": "EUR"
      },
      "referenceNumber": "TRANSFER-34188888"
    },
    {
      "type": "CREDIT",
      "date": "2018-04-10T05:58:34.681Z",
      "amount": {
        "value": 9.94,
        "currency": "EUR"
      },
      "totalFees": {
        "value": 0,
        "currency": "EUR"
      },
      "details": {
        "type": "CONVERSION",
        "description": "Converted 8.69 GBP to 9.94 EUR",
        "sourceAmount": {
          "value": 8.69,
          "currency": "GBP"
        },
        "targetAmount": {
          "value": 9.94,
          "currency": "EUR"
        },
        "fee": {
          "value": 0.03,
          "currency": "GBP"
        },
        "rate": 1.147806
      },
      "exchangeDetails": null,
      "runningBalance": {
        "value": 9.94,
        "currency": "EUR"
      },
      "referenceNumber": "CONVERSION-1511237"
    }
  ],
  "endOfStatementBalance": {
    "value": 9.94,
    "currency": "EUR"
  },
  "query": {
    "intervalStart": "2018-03-01T00:00:00Z",
    "intervalEnd": "2018-04-30T23:59:59.999Z",
    "currency": "EUR",
    "accountId": 64
  }
}

Purpose

This endpoint allows for statements to be generated for the provided balanceId, with the response in JSON. To generate in CSV or PDF, replace statement.json with statement.csv or statement.pdf respectively in the above URL. Note that the PDF includes Wise branding.

The period between intervalStart and intervalEnd cannot exceed 469 days (around 1 year 3 months).

Request

GET https://api.sandbox.transferwise.tech/v1/profiles/{{profileId}}/balance-statements/{{balanceId}}/statement.json? currency=EUR&intervalStart=2018-03-01T00:00:00.000Z&intervalEnd=2018-03-15T23:59:59.999Z&type=COMPACT

Response

Convert across balance accounts

Example Request:

curl -X POST https://api.sandbox.transferwise.tech/v2/profiles/{profileId}/balance-movements \
     -H "Authorization: Bearer <your api token>"  \
     -H "Content-Type: application/json" \
     -H "X-idempotence-uuid: <your generated uuid> \
     -d '{
            "quoteId": <conversion quote id>
         }'

Example Response:

{
  "id": <conversion transaction id>,
  "type": "CONVERSION",
  "state": "COMPLETED",
  "balancesAfter": [
    {
      "id": 1,
      "value": 10000594.71,
      "currency": "GBP"
    },
    {
      "id": 2,
      "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"
    }
  ]
}

This endpoint allows the conversion of funds between two STANDARD balance accounts in different currencies. You first must generate a quote with "payOut": "BALANCE".

Interested in moving money in/out of Jar? Check Move money between balances

Request

POST https://api.sandbox.transferwise.tech/v2/profiles/{profileId}/balance-movements

Please also note that this call needs an extra field in the header called "X-idempotence-uuid". This should be generated and used for any subsequent retry call in the case that the initial POST fails.

Move money between balances

Example Request:

curl -X POST https://api.sandbox.transferwise.tech/v2/profiles/{profileId}/balance-movements \
     -H "Authorization: Bearer <your api token>"  \
     -H "Content-Type: application/json" \
     -H "X-idempotence-uuid: <your generated uuid> \
     -d '{
            "amount": {
              value: <decimal>,
              currency: <currency>
            }
            "sourceBalanceId": <source id>,
            "targetBalanceId": <target balance id>,
            "quoteId": <conversion quote id>
         }'

Example Response:

{
  "id": <conversion transaction id>,
  "type": "CONVERSION",
  "state": "COMPLETED",
  "balancesAfter": [
    {
      "id": 1,
      "value": 10000594.71,
      "currency": "GBP"
    },
    {
      "id": 2,
      "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"
    }
  ]
}

This endpoint allows the following money movements:

• Add money to same-currency Jar (i.e move money from STANDARD to SAVINGS balance without conversion, amount is provided as request parameter);
• Add money to another-currency Jar (i.e. convert money, amount is determined by provided quoteId);
• Withdraw money from Jar (i.e move money from SAVINGS to STANDARD balance without conversion, amount is provided as request parameter).

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

Interested in converting money from one balance to another? Check Convert across balance accounts

Request

POST https://api.sandbox.transferwise.tech/v2/profiles/{profileId}/balance-movements

Deprecated

Get Account Balance

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": <your profile id>,
        "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
                    }
                }
            }
        ]
    }
]

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

Request

GET https://api.sandbox.transferwise.tech/v1/borderless-accounts?profileId={profileId}

Use profile id obtained earlier to make this call.

Response

Get Account Statement

Example Request:

curl -X GET https://api.sandbox.transferwise.tech/v3/profiles/{profileId}/borderless-accounts/{borderlessAccountId}/statement.json?
currency=EUR&intervalStart=2018-03-01T00:00:00.000Z&intervalEnd=2018-03-15T23:59:59.999Z&type=COMPACT \
     -H "Authorization: Bearer <your api token>"

Example Response:

{
  "accountHolder": {
    "type": "PERSONAL",
    "address": {
      "addressFirstLine": "Veerenni 24",
      "city": "Tallinn",
      "postCode": "12112",
      "stateCode": "",
      "countryName": "Estonia"
    },
    "firstName": "Oliver",
    "lastName": "Wilson"
  },
  "issuer": {
    "name": "TransferWise Ltd.",
    "firstLine": "56 Shoreditch High Street",
    "city": "London",
    "postCode": "E1 6JJ",
    "stateCode": "",
    "country": "United Kingdom"
  },
  "bankDetails": null,
  "transactions": [
    {
      "type": "DEBIT",
      "date": "2018-04-30T08:47:05.832Z",
      "amount": {
        "value": -7.76,
        "currency": "EUR"
      },
      "totalFees": {
        "value": 0.04,
        "currency": "EUR"
      },
      "details": {
        "type": "CARD",
        "description": "Card transaction of 6.80 GBP issued by Tfl.gov.uk/cp TFL TRAVEL CH",
        "amount": {
          "value": 6.8,
          "currency": "GBP"
        },
        "category": "Transportation Suburban and Loca",
        "merchant": {
          "name": "Tfl.gov.uk/cp",
          "firstLine": null,
          "postCode": "SW1H 0TL  ",
          "city": "TFL TRAVEL CH",
          "state": "   ",
          "country": "GB",
          "category": "Transportation Suburban and Loca"
        }
      },
      "exchangeDetails": {
        "forAmount": {
          "value": 6.8,
          "currency": "GBP"
        },
        "rate": null
      },
      "runningBalance": {
        "value": 16.01,
        "currency": "EUR"
      },
      "referenceNumber": "CARD-249281"
    },
    {
      "type": "CREDIT",
      "date": "2018-04-17T07:47:00.227Z",
      "amount": {
        "value": 200,
        "currency": "EUR"
      },
      "totalFees": {
        "value": 0,
        "currency": "EUR"
      },
      "details": {
        "type": "DEPOSIT",
        "description": "Received money from HEIN LAURI with reference SVWZ+topup card",
        "senderName": "HEIN LAURI",
        "senderAccount": "EE76 1700 0170 0049 6704 ",
        "paymentReference": "SVWZ+topup card"
      },
      "exchangeDetails": null,
      "runningBalance": {
        "value": 207.69,
        "currency": "EUR"
      },
      "referenceNumber": "TRANSFER-34188888"
    },
    {
      "type": "CREDIT",
      "date": "2018-04-10T05:58:34.681Z",
      "amount": {
        "value": 9.94,
        "currency": "EUR"
      },
      "totalFees": {
        "value": 0,
        "currency": "EUR"
      },
      "details": {
        "type": "CONVERSION",
        "description": "Converted 8.69 GBP to 9.94 EUR",
        "sourceAmount": {
          "value": 8.69,
          "currency": "GBP"
        },
        "targetAmount": {
          "value": 9.94,
          "currency": "EUR"
        },
        "fee": {
          "value": 0.03,
          "currency": "GBP"
        },
        "rate": 1.147806
      },
      "exchangeDetails": null,
      "runningBalance": {
        "value": 9.94,
        "currency": "EUR"
      },
      "referenceNumber": "CONVERSION-1511237"
    }
  ],
  "endOfStatementBalance": {
    "value": 9.94,
    "currency": "EUR"
  },
  "query": {
    "intervalStart": "2018-03-01T00:00:00Z",
    "intervalEnd": "2018-04-30T23:59:59.999Z",
    "currency": "EUR",
    "accountId": 64
  }
}

Get multi-currency account statement for one currency and for specified time range. The period between intervalStart and intervalEnd cannot exceed 455 days (around 1 year 3 month).

Request

GET https://api.sandbox.transferwise.tech/v1/profiles/{profileId}/balance-statements/{balanceId}/statement.json? currency=EUR&intervalStart=2018-03-01T00:00:00.000Z&intervalEnd=2018-03-15T23:59:59.999Z&type=COMPACT

Note that you can also download statements in PDF and CSV formats if you replace statement.json with statement.csv or statement.pdf respectively in the above URL.

Response

Convert Currencies

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: <your generated uuid> \
     -d '{
            "quoteId": <conversion quote id>
         }'

Example Response:

{
  "id": <conversion transaction id>,
  "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"
    }
  ]
}

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

POST https://api.sandbox.transferwise.tech/v1/borderless-accounts/{borderlessAccountId}/conversions

Get account details

Example Request:

curl -X GET https://api.sandbox.transferwise.tech/v1/profiles/{profile-id}/account-details \
     -H "Authorization: Bearer <your api token>"

Example Response:

[
  {
    "id": 1,
    "currency": {
      "code": "EUR",
      "name": "Euro"
    },
    "title": "Your EUR account details",
    "subtitle": "IBAN, SWIFT/BIC",
    "status": "ACTIVE",
    "deprecated": false,
    "receiveOptions": [
      {
        "type": "LOCAL",
        "title": "Inside EU and SEPA",
        "description": {
          "title": "Your EUR account details",
          "body": "<p>Use the details below to add or receive EUR from bank accounts inside EU and SEPA.</p><a href=\"https://wise.com/help/17/borderless-account/2827505/how-do-i-use-my-eur-bank-details\" rel=\"noopener\" target=\"_blank\">See how to use EUR account details</a>",
          "cta": null
        },
        "summaries": [
          {
            "type": "TIME",
            "title": "Incoming payments take 1–2 working days to be added to your account",
            "description": null
          },
          {
            "type": "INFO",
            "title": "SEPA includes countries in the EU and EEA",
            "description": {
              "title": "What’s SEPA?",
              "body": "\n<p>SEPA stands for the Single Euro Payments Area. Within this area, cross-border euro payments must cost the same as a regular, local one. It’s EU law.</p>\n<p>SEPA covers all the countries within the EU. It also includes other European countries like Monaco, Norway, and Switzerland.</p>\n<p>So if your sender is sending from a euro bank account in one of these countries, they shouldn’t have to pay much — if anything — to send money to your EUR account details.</p>\n<h5>Good to know</h5>\n<ul><li>SEPA payments to your EUR account details usually take 1–2 working days.</li><li>Just because a country uses euros, doesn’t mean it’s in SEPA. Please check the list below if you’re unsure.</li></ul>\n<p><a href=\"https://wise.com/help/15/paying-for-your-transfer/2968880/sepa-countries-and-ibans\" rel=\"noopener\" target=\"_blank\">See the full list of SEPA countries</a></p>",
              "cta": null
            }
          }
        ],
        "details": [
          {
            "type": "ACCOUNT_HOLDER",
            "title": "Account holder",
            "body": "John Doe",
            "description": null,
            "hidden": false
          },
          {
            "type": "SWIFT_CODE",
            "title": "BIC",
            "body": "TRWIBEB1XXX",
            "description": null,
            "hidden": false
          },
          {
            "type": "IBAN",
            "title": "IBAN",
            "body": "BE58 9671 0000 0000",
            "description": {
              "title": "Did they ask for an account number?",
              "body": "\n<p>For most kinds of payments, senders should use your IBAN number. But if they specifically ask for an account number, you can give them this:</p>\n<p><strong>1395167</strong></p>",
              "cta": {
                "label": "IBAN",
                "content": "BE58 9671 0000 0000"
              }
            },
            "hidden": false
          },
          {
            "type": "ADDRESS",
            "title": "Address",
            "body": "Avenue Louise 54, Room S52\nBrussels\n1050\nBelgium",
            "description": {
              "title": "Did they ask for a bank address?",
              "body": "\n<p>If your sender asks for a bank address, you can give them:</p>\n<p><strong>Avenue Louise 54, Room S52<br>Brussels<br>1050<br>Belgium</strong></p>\n<h5>What about the bank name?</h5>\n<p>You can use TransferWise as the bank name. That’s because in the Eurozone we’re directly plugged into the same payment networks as the big banks. It’s what keeps our payments fast and low-cost.</p>",
              "cta": {
                "label": "Address",
                "content": "Avenue Louise 54, Room S52\nBrussels\n1050\nBelgium"
              }
            },
            "hidden": false
          }
        ],
        "alert": null,
        "shareText": ""
      },
      {
        "type": "INTERNATIONAL",
        "title": "Outside EU and SEPA",
        "description": {
          "title": "Your EUR account details",
          "body": "<p>Use the details below to add or receive EUR from bank accounts outside EU and SEPA.</p><a href=\"https://wise.com/help/17/borderless-account/2827505/how-do-i-use-my-eur-bank-details\" rel=\"noopener\" target=\"_blank\">See how to use EUR account details</a>",
          "cta": null
        },
        "summaries": [
          {
            "type": "TIME",
            "title": "Incoming payments take 4–5 working days to be added to your account",
            "description": null
          }
        ],
        "details": [
          {
            "type": "ACCOUNT_HOLDER",
            "title": "Account holder",
            "body": "John Doe",
            "description": null,
            "hidden": false
          },
          {
            "type": "SWIFT_CODE",
            "title": "SWIFT/BIC",
            "body": "TRWIBEB1XXX",
            "description": null,
            "hidden": false
          },
          {
            "type": "IBAN",
            "title": "IBAN",
            "body": "BE58 9671 0000 0000",
            "description": {
              "title": "Did they ask for an account number?",
              "body": "\n<p>For most kinds of payments, senders should use your IBAN number. But if they specifically ask for an account number, you can give them this:</p>\n<p><strong>1395167</strong></p>",
              "cta": {
                "label": "IBAN",
                "content": "BE58 9671 0000 0000"
              }
            },
            "hidden": false
          },
          {
            "type": "ADDRESS",
            "title": "Address",
            "body": "Avenue Louise 54, Room S52\nBrussels\n1050\nBelgium",
            "description": {
              "title": "Did they ask for a bank address?",
              "body": "\n<p>If your sender asks for a bank address, you can give them:</p>\n<p><strong>Avenue Louise 54, Room S52<br>Brussels<br>1050<br>Belgium</strong></p>\n<h5>What about the bank name?</h5>\n<p>You can use TransferWise as the bank name. That’s because in the Eurozone we’re directly plugged into the same payment networks as the big banks. It’s what keeps our payments fast and low-cost.</p>",
              "cta": {
                "label": "Address",
                "content": "Avenue Louise 54, Room S52\nBrussels\n1050\nBelgium"
              }
            },
            "hidden": false
          }
        ],
        "alert": null,
        "shareText": ""
      }
    ],
    "bankFeatures": [
      {
        "key": "LOCAL_RECEIVE",
        "title": "Receive locally",
        "supported": true
      },
      {
        "key": "SWIFT",
        "title": "Receive internationally (SWIFT)",
        "supported": true
      },
      {
        "key": "DIRECT_DEBITS",
        "title": "Set up Direct Debits",
        "supported": true
      },
      {
        "key": "PLATFORM_RECEIVE",
        "title": "Receive from PayPal and Stripe",
        "supported": true
      }
    ]
  },
  {
    "id": null,
    "currency": {
      "code": "TRY",
      "name": "Turkish lira"
    },
    "title": "Your TRY account details",
    "subtitle": "IBAN",
    "status": "AVAILABLE",
    "deprecated": false,
    "receiveOptions": [],
    "bankFeatures": [
      {
        "key": "LOCAL_RECEIVE",
        "title": "Receive locally",
        "supported": true
      },
      {
        "key": "SWIFT",
        "title": "Receive internationally (SWIFT)",
        "supported": false
      },
      {
        "key": "DIRECT_DEBITS",
        "title": "Set up Direct Debits",
        "supported": false
      },
      {
        "key": "PLATFORM_RECEIVE",
        "title": "Receive from PayPal and Stripe",
        "supported": false
      }
    ]
  }
]

Purpose

This endpoint returns a list with all the AVAILABLE and ACTIVE account details for the given profile, including examples. Account receive options can also include local and international details to receive money on the currency balance.

Example bank account details are returned for any currency where bank account details have not been requested and issued. Examples will always include an id of null.

Request

GET https://api.sandbox.transferwise.tech/v1/profiles/{profile-id}/account-details

Response

Important response fields to pay attention:

status (text) AVAILABLE: Account details do not exist for the user but may be created ACTIVE: Account details are ready to be used by this user

deprecated (boolean) Important! When the value is true, Wise issued another account details for the same currency. The users should not use the deprecated account anymore, but they still need to be informed as they might have external references pointing to the old one.

receiveOptions (array) This array will contain the available receive options for the given currency. LOCAL: local bank details to receive money in the account currency INTERNATIONAL: SWIFT bank details to receive money internationally in the account currency.

receiveOptions.details (array) It returns all the details that need to be displayed to users to make transfers to this account. This array will vary from currency to currency as each one has its requirements. For example, EUR will return ACCOUNT_HOLDER, SWIFT_CODE, IBAN and ADDRESS, whereas GBP will return ACCOUNT_HOLDER, BANK_CODE, ACCOUNT_NUMBER, IBAN and ADDRESS.

Each element in this array will contain the following attributes:

type: String informing the account detail type title: Label to display in the UI body: Value to display in the UI description: When present, it has the content to show a tooltip/popup hint hidden: If the field should be displayed or not in the UI

Here is an example of how wise.com displays the GBP receiveOptions.details for local payments:

Create account details order

Creates an order which will issue account details. It should use the same currency as the balance previously created. Fulfilling all the requirements will complete the order. That means reaching status DONE.

The possible values for a requirement are: PENDING_USER: The requriement has some pending action from the user. PENDING_TW: The requirement has some pending action from Wise. DONE: The requirement is completed

The more common requirements are: VERIFICATION: The user needs to be fully verified before complete this requirement. TOP_UP: A fee will be charged and must be paid using through wise.com before complete this requirement.

Example Request:

curl -L -g -X POST 'https://api.sandbox.transferwise.tech/v1/profiles/{profile-id}/account-details-orders' \
  -H 'Authorization: Bearer <your api token>' \
  -H 'Content-Type: application/json' \
  --data-raw '{
      "currency": "EUR"
  }'

Example Response:

{
  "status": "PENDING_USER",
  "currency": "EUR",
  "requirements": [
    {
      "type": "VERIFICATION",
      "status": "PENDING_USER"
    }
  ]
}

Request

POST https://api.sandbox.transferwise.tech/v1/profiles/{profile-id}/account-details-orders

Response

List bank account details orders

Example Request:

curl -X GET https://api.sandbox.transferwise.tech/v1/profiles/{{profileId}}/account-details-orders \
     -H "Authorization: Bearer {{access-token}}" \
     -H "Accept-Language: {{ISO 639-1}}" 

Example Response:

[
  {
    "status": "PENDING_USER",
    "currency": "EUR",
    "requirements": [
      {
        "type": "TOP_UP",
        "status": "PENDING_USER",
      },
      {
        "type": "VERIFICATION",
        "status": "PENDING_USER",
      }
    ]
  },
  ...
]

Purpose

This endpoint returns the bank account assignment requests for a profile and multi-currency account.

Batch Groups

A batch group is a named collection of transfers that can be managed as a single unit. Batch groups are primarily used for funding multiple transfers with a single pay in.

The Batch Group resource

Example batch group resource with bank transfer pay in details

{
    "id": "54a6bc09-cef9-49a8-9041-f1f0c654cd89",
    "version": 123,
    "name": "My batch group",
    "sourceCurrency": "GBP",
    "status": "COMPLETED",
    "transferIds": [
        123,
        456
    ],
    "payInDetails": [
        {
            "type": "bank_transfer",
            "reference": "B123",
            "amount": 123.45,
            "currency": "GBP",
            "name": "Wise",
            "bankCode": "231470",
            "accountNumber": "77643994",
            "iban": null
        }
    ]
}

Example batch group resource with additional details (USD source currency):

{
    "id": "54a6bc09-cef9-49a8-9041-f1f0c654cd89",
    "version": 123,
    "name": "My batch group",
    "sourceCurrency": "USD",
    "status": "COMPLETED",
    "transferIds": [
        123,
        456
    ],
    "payInDetails": [
        {
            "type": "bank_transfer",
            "reference": "B123",
            "amount": 123.45,
            "currency": "USD",
            "name": "Wise Inc",
            "bankCode": "091000019",
            "bankAddress": {
                "name": "Some Bank",
                "firstLine": "1 Some Street",
                "postCode": "10001",
                "city": "Some City",
                "stateCode": "NY",
                "country": "US"
            },
            "accountNumber": "123456789012",
            "accountType": "checking",
            "iban": null,
            "transferWiseAddress": {
                "name": "Wise Inc",
                "firstLine": "19 W 24th Street Floor 9",
                "postCode": "10010",
                "city": "New York",
                "country": "United States",
                "stateCode": "NY"
            }
        }
    ]
}

Example batch group resource with additional details (NOK source currency):

{
    "id": "54a6bc09-cef9-49a8-9041-f1f0c654cd89",
    "version": 123,
    "name": "My batch group",
    "sourceCurrency": "NOK",
    "status": "COMPLETED",
    "transferIds": [
        234,
        456
    ],
    "payInDetails": [
        {
            "type": "bank_transfer",
            "reference": "B5323",
            "amount": 12504.54,
            "currency": "NOK",
            "name": "TransferWise Ltd",
            "bankCode": "8301",
            "bankAddress": {
                "name": "CitiBank Europe Plc",
                "firstLine": "Bolette brygge 1",
                "postCode": "0252",
                "city": "Oslo",
                "country": "Norway",
                "stateCode": null
            },
            "transferWiseAddress": {
                "name": "TransferWise Ltd",
                "firstLine": "6th Floor, The Tea Building, 56 Shoreditch High Street",
                "postCode": "E1 6JJ",
                "city": "London",
                "country": "United Kingdom",
                "stateCode": null
            },
            "accountNumber": "9910728",
            "iban": null,
            "bban": "83019910728"
        }
    ]
}

Example batch group resource with additional details (HKD source currency):

{
    "id": "54a6bc09-cef9-49a8-9041-f1f0c654cd89",
    "version": 123,
    "name": "My batch group",
    "sourceCurrency": "HKD",
    "status": "COMPLETED",
    "transferIds": [
        234,
        456
    ],
    "payInDetails": [
        {
            "type": "bank_transfer",
            "reference": "B5323",
            "amount": 12504.54,
            "currency": "NOK",
            "name": "TransferWise Ltd",
            "bankCode": "8301",
            "bankAddress": {
                "name": "DBS Bank Hong Kong Limited",
                "firstLine": "99 Queen's Road Central",
                "postCode": null,
                "city": "Central",
                "country": "Hong Kong",
                "stateCode": null
            },
            "accountNumber": "478000216470",
            "iban": null,
            "fpsIdentifier": "hkd@wise.com"
        }
    ]
}

Many Batch Group API endpoints return a batch group resource. Batch group resources have the following properties:

Batch Group Status

Pay In Details

Pay In Details describe how the batch group can be funded. They are only populated when a batch group is in the COMPLETED state.

The following fields are always populated:

These fields are populated when type is bank_transfer:

Pay In Details Account Type

Pay In Details Bank Codes

Pay In Details Address

Bank transfer pay in details may contain bank and Wise's addresses for some source currencies.

These currencies include: USD, NOK.

Create Batch Group

Create a new batch group.

Example Request:

curl -X POST https://api.sandbox.transferwise.tech/v3/profiles/{profileId}/batch-groups \
     -H "Authorization: Bearer <your api token>" \
     -H "Content-Type: application/json" \
     -d '{
           "sourceCurrency": "GBP",
           "name": "my-batch-group"
         }'

Example Response:

{
  "id": "54a6bc09-cef9-49a8-9041-f1f0c654cd88",
  "version": 0,
  "name": "my-batch-group",
  "sourceCurrency": "GBP",
  "status": "NEW",
  "transferIds": [],
  "payInDetails": []
}

Request

POST https://api.sandbox.transferwise.tech/v3/profiles/{profileId}/batch-groups

Response

A batch group resource.

Error responses

See errors page for a general description of API error responses. For all requests “401 Unauthorized” and 5xx series errors are possible.

Get Batch Group

Get an existing batch group.

Example Request:

curl -X GET https://api.sandbox.transferwise.tech/v3/profiles/{profileId}/batch-groups/{batchGroupId} \
     -H "Authorization: Bearer <your api token>"

Example Response:

{
    "id": "54a6bc09-cef9-49a8-9041-f1f0c654cd88",
    "version": 1234,
    "name": "my-batch-group",
    "sourceCurrency": "GBP",
    "status": "NEW",
    "transferIds": [
        123,
        456
    ],
    "payInDetails": []
}

Request

GET https://api.sandbox.transferwise.tech/v3/profiles/{profileId}/batch-groups/{batchGroupId}

Response

A batch group resource.

Error responses

See errors page for a general description of API error responses. For all requests “401 Unauthorized” and 5xx series errors are possible.

Create Batch Group Transfer

Create a transfer in the batch group, using a previously created recipient account and quote. Please see quote creation and recipient account creation documentation.

Example Request:

curl -X POST https://api.sandbox.transferwise.tech/v3/profiles/{profileId}/batch-groups/{batchGroupId}/transfers \
     -H "Authorization: Bearer <your api token>" \
     -H "Content-Type: application/json" \
     -d '{
           <transfer properties>
         }'

Request

POST https://api.sandbox.transferwise.tech/v3/profiles/{profileId}/batch-groups/{batchGroupId}/transfers

For the request body format please see this documentation.

Response

Please see the documentation.

Error responses

See errors page for a general description of API error responses. For all requests “401 Unauthorized” and 5xx series errors are possible.

Complete Batch Group

Completes the batch group and allows funding to proceed. Note: this action prevents any further modification.

Example Request:

curl -X PATCH https://api.sandbox.transferwise.tech/v3/profiles/{profileId}/batch-groups/{batchGroupId} \
     -H "Authorization: Bearer <your api token>" \
     -H "Content-Type: application/json" \
     -d '{
           "status": "COMPLETED",
           "version": 1234
         }'

Example Response:

{
    "id": "54a6bc09-cef9-49a8-9041-f1f0c654cd88",
    "version": 1234,
    "name": "my-batch-group",
    "sourceCurrency": "GBP",
    "status": "COMPLETED",
    "transferIds": [
        123,
        456
    ],
    "payInDetails": [
        {
            "type": "bank_transfer",
            "reference": "XYZ123",
            "amount": 123.45,
            "currency": "GBP",
            "name": "Wise",
            "bankCode": "231470",
            "accountNumber": "77643994",
            "iban": null
        }
    ]
}

Request

PATCH https://api.sandbox.transferwise.tech/v3/profiles/{profileId}/batch-groups/{batchGroupId}

Response

A batch group resource.

Error responses

See errors page for a general description of API error responses. For all requests “401 Unauthorized” and 5xx series errors are possible.

Cancel Batch Group

Cancel a batch group. Cancelling closes the group to further modification and initiates the cancellation of all transfers in the batch group. Only batches that are not funded can be cancelled. Cancellation is final it cannot be undone.

Example Request:

curl -X PATCH https://api.sandbox.transferwise.tech/v3/profiles/{profileId}/batch-groups/{batchGroupId} \
     -H "Authorization: Bearer <your api token>" \
     -H "Content-Type: application/json" \
     -d '{
          "status": "CANCELLED",
          "version": 1234
        }'

Example Response:

{
    "id": "54a6bc09-cef9-49a8-9041-f1f0c654cd88",
    "version": 12345,
    "name": "my-batch-group",
    "sourceCurrency": "GBP",
    "status": "MARKED_FOR_CANCELLATION",
    "transferIds": [
        123,
        456
    ],
    "payInReferences": []
}

Request

PATCH https://api.sandbox.transferwise.tech/v3/profiles/{profileId}/batch-groups/{batchGroupId}

Response

A batch group resource.

Error responses

See errors page for a general description of API error responses. For all requests “401 Unauthorized” and 5xx series errors are possible.

Fund Batch Group

Funds all the transfers in a batch, they are paid out immediately. Applicable when funding from a multi-currency account. The Batch Group must first be completed, and there needs to be enough funds in the account for the whole batch otherwise an insufficient funds error will be returned.

This endpoint is SCA protected when it applies, you can find more info here.

Example Request:

curl -X POST https://api.sandbox.transferwise.tech/v3/profiles/{profileId}/batch-payments/{batchGroupId}/payments \
     -H "Authorization: Bearer <your api token>" \
     -H "Content-Type: application/json" \
     -d '{
           "type": "BALANCE"
         }'

Example Response:

{
    "id": "54a6bc09-cef9-49a8-9041-f1f0c654cd88",
    "name": "my-batch-group",
    "fileName": null,
    "alreadyPaid": true,
    "shortId": 12345,
    "userId": 123,
    "profileId": 56789,
    "sourceCurrency": "GBP",
    "status": "COMPLETED",
    "groupType": "API",
    "transferIds": [
      123,
      456
    ]
}

Request

POST https://api.sandbox.transferwise.tech/v3/profiles/{profileId}/batch-payments/{batchGroupId}/payments

Response

You need to save transfer id for tracking its status later.

Error responses

See errors page for a general description of API error responses. For all requests “401 Unauthorized” and 5xx series errors are possible.

Fund Batch Group via Direct Debit

Funds all the transfers in a batch via direct debit. The Batch Group must be in the completed state. To use this funding method, you need to link an external bank account first. More info on how to create a direct debit account here.

Example Request:

curl -X POST https://api.sandbox.transferwise.tech/v1/profiles/{{profileId}}/batch-groups/{{batchGroupId}}/payment-initiations \
     -H "Authorization: Bearer <your api token>" \
     -H "Content-Type: application/json" \
     -d '{
           "type": "DIRECT_DEBIT",
           "accountId": 1
         }'

Example Response:

{
  "id": 12345,
  "batchGroupId": "068e186d-9632-4937-b753-af3e53f4d0b0",
  "reference": "B1234567",
  "userId": 123,
  "profileId": 2,
  "createdTime": "2022-01-01T19:51:41.423404Z",
  "status": "NEW",
  "type": "DIRECT_DEBIT",
  "accountId": 1
}

POST https://api.sandbox.transferwise.tech/v1/profiles/{{profileId}}/batch-groups/{{batchGroupId}}/payment-initiations

Response

You need to save payment initiation ID for tracking its status later.

Get Payment Initiations status of a Batch Group

Get payment initiation info by id. In addition to webhooks, this endpoint can be used for polling the status of payment initiation.

Example Request:

curl -X GET https://api.sandbox.transferwise.tech/v1/profiles/{{profileId}}/batch-groups/{{batchGroupId}}/payment-initiations/{{paymentInitiationId}} \
     -H "Authorization: Bearer <your api token>" \
     -H "Content-Type: application/json" 

Example Response:

{
  "id": 12345,
  "batchGroupId": "068e186d-9632-4937-b753-af3e53f4d0b0",
  "userId": 123,
  "profileId": 2,
  "createdTime": "2022-01-01T19:51:41.423404Z" ,
  "status": "PROCESSING",
  "type": "DIRECT_DEBIT",
  "accountId": 1,
  "transferId": 12345
}

GET https://api.sandbox.transferwise.tech/v1/profiles/{{profileId}}/batch-groups/{{batchGroupId}}/payment-initiations/{{paymentInitiationId}}

Response

You need to save payment initiation ID for tracking its status later.

Request comparison quotes

Example Request:

curl -X GET https://api.transferwise.com/v3/comparisons/?sourceCurrency=GBP&targetCurrency=EUR&sendAmount=10000

Example Response:

{
  "sourceCurrency": "GBP",
  "targetCurrency": "EUR",
  "sourceCountry": null,
  "targetCountry": null,
  "providerCountry": null,
  "providerType": null,
  "sendAmount": 10000.0,
  "providers": [
    {
      "id": 39,
      "alias": "transferwise",
      "name": "Wise",
      "logo": "https://dq8dwmysp7hk1.cloudfront.net/logos/transferwise.svg",
      "type": "moneyTransferProvider",
      "partner": false,
      "quotes": [
        {
          "rate": 1.15989,
          "fee": 37.12,
          "receivedAmount": 11555.84,
          "dateCollected": "2019-10-22T14:36:43Z",
          "sourceCountry": null,
          "targetCountry": null,
          "markup": 0.0,
          "deliveryEstimation": {
            "duration": {
              "min": "PT20H8M16.305111S",
              "max": "PT20H8M16.305111S"
            },
            "providerGivesEstimate": true
          }
        }
      ]
    },
    {
      "id": 1,
      "alias": "barclays",
      "name": "Barclays",
      "logo": "https://dq8dwmysp7hk1.cloudfront.net/logos/barclays.svg",
      "type": "bank",
      "partner": false,
      "quotes": [
        {
          "rate": 1.12792426,
          "fee": 0.0,
          "receivedAmount": 11279.24,
          "dateCollected": "2019-10-22T14:00:04Z",
          "sourceCountry": "GB",
          "targetCountry": "ES",
          "markup": 2.75592858,
          "deliveryEstimation": {
            "duration": {
              "min": "PT24H",
              "max": "PT24H"
            },
            "providerGivesEstimate": true
          }
        },
        ...
        {
          "rate": 1.12792426,
          "fee": 0.0,
          "receivedAmount": 11279.24,
          "dateCollected": "2019-10-22T14:00:04Z",
          "sourceCountry": "GB",
          "targetCountry": "FI",
          "markup": 2.75592858,
          "deliveryEstimation": {
            "duration": {
              "min": "PT24H",
              "max": "PT24H"
            },
            "providerGivesEstimate": true
          },
          ...
        }
        ...
      ]
    }
  ]
}

The comparison API can be used to request price and speed information about various money transfer providers. This includes not only Wise but other providers in the market.

Price Estimation

The quotes (price / speed) provided by this API are based off of real quotes collected from 3rd party websites. We collect both the advertised exchange rate and fee for each provider for various amounts. When a comparison is requested we calculate the markup % on the collected exchange rate on the mid-market rate at the time of collection, we then apply this markup % on the current mid-market rate to provide a realistic estimate of what each provider offers. We collect data for all providers ~ once per hour to ensure we provide as accurate and up to date information as possible.

Note: Today, we only provide estimations for FX transactions with a Bank Transfer pay-in / pay-out option. This is important to stress as many providers offer significantly different fees / exchange rates when used debit / credit card, cash etc.

For more details on the data collection process please see the following page:

https://wise.com/gb/compare/disclaimer

If you have questions or suspect any data to be inaccurate or incomplete please contact us at:

comparison@wise.com

Delivery Estimation

Similar to price, we collect speed data for most (if not all) providers which we have price information for. Many providers display speed estimates to their customers in a number of different ways.

Some examples:

• "The transfer should be complete within 2-5 days"
• "The money should arrive in your account within 48 hours"
• "Should arrive by 26th Aug"
• "Could take up to 4 working days"

The below API intends to model these in a consistent format by providing a min / max range for all delivery estimations. An estimate that states "up to X" will have "max" set to a duration but "min" as null, a "from X" will have "min" set to a duration and "max" as null. Finally for those providers who offer a specific, point in time estimation (like Wise), the API will surface a duration where min/max are equal.

Quotes structure

In order to provide the most flexible and accurate data for clients, we surface a denormalised list of quotes per provider where each quote represents a unique collection of comparison "dimensions".

A single given provider may expose multiple quotes for the same currency route. The most common example is where a provider offers different pricing for one country vs another country which uses the same currency. e.g:

Provider X:

• GBP EUR 1000 [GB -> ES] fee: 10, rate: 1.5
• GBP EUR 1000 [GB -> DE] fee: 8, rate: 1.5
• GBP EUR 1000 [GB -> FR] fee: 10, rate: 1.35

The same principle applies for speed. I.e a provider may have different speed estimates for different target countries and hence we expose these as discrete quotes - where a quote is a unique combination of route / country / speed / price factors.

A client may choose to reduce this set of quotes down to a single or several quotes in order to display a relevant quote to a given user. An example where we take the cheapest quote for a given currency route (and also surface the target country) can be seen at the below link:

https://wise.com/gb/compare/?sourceCurrency=GBP&targetCurrency=EUR&sendAmount=1000

Request

GET https://api.transferwise.com/v3/comparisons/?sourceCurrency=GBP&targetCurrency=EUR&sendAmount=10000

Response

Get Currency Pairs

Example Request:

curl -X GET https://api.sandbox.transferwise.tech/v1/currency-pairs \
     -H "Authorization: Bearer <your api token>"

Example Response:

{
    "sourceCurrencies": [
        {
            "currencyCode": "GBP",
            "maxInvoiceAmount": 1000000,
            "targetCurrencies": [
                {
                    "currencyCode": "EUR",
                    "minInvoiceAmount": 1,
                    "fixedTargetPaymentAllowed": true
                },
                {
                    "currencyCode": "INR",
                    "minInvoiceAmount": 1,
                    "fixedTargetPaymentAllowed": true
                },
                {
                    "currencyCode": "USD",
                    "minInvoiceAmount": 1,
                    "fixedTargetPaymentAllowed": true
                },
...
                {
                    "currencyCode": "VND",
                    "minInvoiceAmount": 1,
                    "fixedTargetPaymentAllowed": true
                },
                {
                    "currencyCode": "ZAR",
                    "minInvoiceAmount": 1,
                    "fixedTargetPaymentAllowed": true
                }
            ],
            "totalTargetCurrencies": 47
        }
    ],
    "total": 19
}

Get list of allowed currency pairs that you can setup in your transfers.

Request

GET https://api.sandbox.transferwise.tech/v1/currency-pairs

Response

Multi-Currency Account

The Wise multi-currency account (MCA) enables users to hold, convert, and fund transfers (single or batches) with balances in up to 56 currencies. Please note that of the 50+ currency balances that we support, 10+ of these come with local account details.

Please refer to our multi-currency account guide for more information on the general use of the endpoints included below.

Please see the Balances APIs for more details.

Get Available Currencies

Example Request:

curl -X GET https://api.sandbox.transferwise.tech/v2/borderless-accounts-configuration/profiles/{{personal-profile-id}}/available-currencies \
     -H "Authorization: Bearer {{access-token}}" 

Example Response:

[
  "EUR",
  "GBP",
  "USD",
  ...
]

Purpose

This endpoint returns all the currencies available for balance accounts. You can use this list to create a balance account for the currency included.

Get Payin Currencies

Example Request:

curl -X GET https://api.sandbox.transferwise.tech/v2/borderless-accounts-configuration/profiles/{{personal-profile-id}}/payin-currencies \
     -H "Authorization: Bearer {{access-token}}" 

Example Response:

[
  "EUR",
  "GBP",
  "USD",
  ...
]

Purpose

This endpoint returns all the currencies available for balance accounts that are also available to have bank account details. You can use this list to create a balance account for the currency included and then subsequently create bank account details.

Get Multi-Currency Accounts

Example Request:

curl -X GET https://api.sandbox.transferwise.tech/v4/profiles/{{profileId}}/multi-currency-account \
     -H "Authorization: Bearer {{access-token}}"

Example Response - 200: Account Exists

{
    "id": < multi-currency account Id >,
    "profileId": < profile Id >,
    "recipientId": 12345678,
    "creationTime": "2020-05-20T14:43:16.658Z",
    "modificationTime": "2020-05-20T14:43:16.658Z",
    "active": true,
    "eligible": true
}

Example Response - 404: Not Found

No Content

Purpose

This endpoint returns the multi-currency account details for the specified profileId. If the user does not yet have a multi-currency account, a 404 Not Found will be returned.

Get Eligibility

Example Request - Profile Eligibility:

curl -X GET https://api.sandbox.transferwise.tech/v4/multi-currency-account/eligibility?profileId={{profile-id}} \
     -H "Authorization: Bearer {{access-token}}"

Example Request - Country/State Eligibility:

curl -X GET https://api.sandbox.transferwise.tech/v4/multi-currency-account/eligibility?country={{country-ISO-Code}}&state={{state-ISO-code}} \
     -H "Authorization: Bearer {{access-token}}"

Example Response:

{
  "eligible": true,
  "eligibilityCode": "eligible",
  "accountType": "FULL",
  "ineligibilityReason": null
}

Purpose

This endpoint checks eligibility for a multi-currency account for either a specific profile or for a location. Customers in some countries and states/provinces may not be eligible for a multi currency account.

To check a profile, the profileId should be passed as a parameter.

To check a specific location, the country the user is in should be passed as country using 2-letter ISO 3166 codes. If the country is US, a valid 2 letter state parameter must also be passed.

Ex 1: France: https://api.sandbox.transferwise.tech/v4/multi-currency-account/eligibility?country=FR Ex 2: USA, California: https://api.sandbox.transferwise.tech/v4/multi-currency-account/eligibility?country=US&state=CA

Response

Get bank transfer deposit details for transfer

Example Request:

curl --location --request GET 'https://api.transferwise.com/v1/profiles/123456/transfers/987654/deposit-details/bank-transfer' \
--header 'Authorization: Bearer <your api token>' \
--header 'x-mock-response-name: get-deposit-details-success' \
--header 'Content-Type: application/json' \
--header 'Accept-Language: en-GB'

Example Response:

{
	"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
		}
	}
}

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 supprts the following currencies:

Request

GET https://api.transferwise.com/v1/profiles/{profileId}/transfers/{transferId}/deposit-details/bank-transfer

Response

Create (Personal)

Example Request:

curl -X POST https://api.sandbox.transferwise.tech/v1/profiles \
     -H "Authorization: Bearer <your api token>" \
     -H "Content-Type: application/json" \
     -d '{ 
          "type": "personal",
          "details": {
            "firstName": "Oliver",
            "lastName": "Wilson",
            "dateOfBirth": "1977-07-01",
            "phoneNumber": "+3725064992",
            "firstNameInKana": null,
            "lastNameInKana": null
           }
        }'

Example Response (Personal):

{
  "id": <your personal profile id>,
  "type": "personal",
  "details": {
    "firstName": "Oliver",
    "lastName": "Wilson",
    "dateOfBirth": "1977-07-01",
    "phoneNumber": "+3725064992",
    "avatar": "",
    "occupation": "",
    "occupations": null,
    "primaryAddress": null,
    "firstNameInKana": null,
    "lastNameInKana": null
  }
}

Create personal user profile. One person cannot have multiple active duplicate user profiles, creating multiple profiles with the same details will fail.

Request

POST https://api.sandbox.transferwise.tech/v1/profiles

If a customer you are creating a profile for has first or last names that exceed 30 characters (e.g. they have many middle names) then you should truncate the names at length 30 characters and submit that value.

Response

Create (Business)

Example Request:

curl -X POST https://api.sandbox.transferwise.tech/v1/profiles \
     -H "Authorization: Bearer <your api token>" \
     -H "Content-Type: application/json" \
     -d '{ 
          "type": "business",
          "details": {
            "name": "ABC Logistics Ltd",
            "registrationNumber": "12144939",
            "acn": null,
            "abn": null,
            "arbn": null,
            "companyType": "LIMITED",
            "companyRole": "OWNER",
            "webpage": "https://abc-logistics.com",
            "businessCategory":"CONSULTING_IT_BUSINESS_SERVICES",
            "businessSubCategory":"DESIGN"
          }
        }'

Example Response (Business):

{
  "id": <your business profile id>,
  "type": "business",
  "details": {
    "name": "ABC Logistics Ltd",
    "registrationNumber": "12144939",
    "acn": null,
    "abn": null,
    "arbn": null,
    "companyType": "LIMITED",
    "companyRole": "OWNER",
    "descriptionOfBusiness": "Information and communication",
    "webpage": "https://abc-logistics.com",
    "primaryAddress": 123456, //ID of placeholder
    "businessCategory": "CONSULTING_IT_BUSINESS_SERVICES",
    "businessSubCategory": "DESIGN"
   }
}

Create business user profile. You must always create a personal profile first, business profiles cannot be created without personal profile.

Request (Business)

POST https://api.sandbox.transferwise.tech/v1/profiles

Business Category

Ensure when submitting a business profile that you submit a category and associated sub-category from the list below. You should map from the information you have about the business to one of our categories and sub-categories. If this is problematic please get in touch with us to discuss alternate solutions.

The categories and their sub-categories are as follows:

• CHARITY_NON_PROFIT
• CHARITY_ALL_ACTIVITIES
• CONSULTING_IT_BUSINESS_SERVICES
• ADVERTISING_AND_MARKETING
• ARCHITECTURE
• COMPANY_ESTABLISHMENT_FORMATION_SERVICES
• DESIGN
• FINANCIAL_CONSULTING_ACCOUNTING_TAXATION_AUDITING
• IT_DEVELOPMENT
• IT_HOSTING_SERVICES
• IT_CONSULTING_AND_SERVICES
• LEGAL_SERVICES
• MANAGEMENT_CONSULTING
• SCIENTIFIC_AND_TECHNICAL_CONSULTING
• SOFTWARE_AS_A_SERVICE
• TRANSLATION_AND_LANGUAGE_SERVICES
• CONSULTING_OTHER
• SERVICES_OTHER
• FREELANCE_PLATFORMS
• RECRUITMENT_SERVICES
• MAINTENANCE_SERVICES
• FREELANCE_PLATFORMS
• DESIGN_MARKETING_COMMUNICATIONS
• ADVERTISING_AND_MARKETING
• ARCHITECTURE
• AUDIO_AND_VIDEO
• DESIGN
• PHOTOGRAPHY
• PRINT_AND_ONLINE_MEDIA
• TELECOMMUNICATIONS_SERVICES
• TRANSLATION_AND_LANGUAGE_SERVICES
• MEDIA_COMMUNICATION_ENTERTAINMENT
• ADULT_CONTENT
• AUDIO_AND_VIDEO
• FINE_ARTS
• ARTS_OTHER
• EVENTS_AND_ENTERTAINMENT
• GAMBLING_BETTING_AND_ONLINE_GAMING
• NEWSPAPERS_MAGAZINES_AND_BOOKS
• PERFORMING_ARTS
• PHOTOGRAPHY
• TELECOMMUNICATIONS_SERVICES
• VIDEO_GAMING
• EDUCATION_LEARNING
• SCHOOLS_AND_UNIVERSITIES,
• TEACHING_AND_TUTORING
• ONLINE_LEARNING
• FINANCIAL_SERVICES_PRODUCTS_HOLDING_COMPANIES
• CROWDFUNDING
• CRYPTOCURRENCY_FINANCIAL_SERVICES
• FINANCIAL_CONSULTING_ACCOUNTING_TAXATION_AUDITING
• HOLDING_COMPANIES
• INSURANCE
• INVESTMENTS
• MONEY_SERVICE_BUSINESSES
• FINANCIAL_SERVICES_OTHER
• FOOD_BEVERAGES_TOBACCO
• ALCOHOL
• FOOD_MANUFACTURING_RETAIL
• RESTAURANTS_AND_CATERING
• SOFT_DRINKS
• TOBACCO
• VITAMINS_AND_DIETARY_SUPPLEMENTS
• HEALTH_PHARMACEUTICALS_PERSONAL_CARE
• HEALTH_AND_BEAUTY_PRODUCTS_AND_SERVICES,
• DENTAL_SERVICES,
• DOCTORS_AND_MEDICAL_SERVICES,
• ELDERLY_OR_OTHER_CARE_HOME,
• FITNESS_SPORTS_SERVICES,
• MEDICAL_EQUIPMENT,
• NURSING_AND_OTHER_CARE_SERVICES,
• PHARMACEUTICALS,
• PHARMACY,
• VITAMINS_AND_DIETARY_SUPPLEMENTS
• PUBLIC_GOVERNMENT_SERVICES
• PUBLIC_ALL_SERVICES
• MAINTENANCE_SERVICES
• GOVERNMENT_SERVICES
• TELECOMMUNICATIONS_SERVICES
• UTILITY_SERVICES
• REAL_ESTATE_CONSTRUCTION
• ARCHITECTURE
• CONSTRUCTION
• REAL_ESTATE_DEVELOPMENT
• REAL_ESTATE_SALE_PURCHASE_AND_MANAGEMENT
• RETAIL_WHOLESALE_MANUFACTURING
• AGRICULTURE_SEEDS_PLANTS
• FINE_ARTS
• ARTS_OTHER
• AUTOMOTIVE_SALES_SPARE_PARTS_TRADE
• AUTOMOTIVE_MANUFACTURING
• CHEMICALS
• CLOTHING
• ELECTRICAL_PRODUCTS
• FIREARMS_WEAPONS_AND_MILITARY_GOODS_SERVICES
• HOME_ACCESSORIES_FURNITURE
• FINE_JEWELLERY_WATCHES
• FASHION_JEWELLERY
• HEALTH_AND_BEAUTY_PRODUCTS_AND_SERVICES
• LEGAL_HIGHS_AND_RELATED_ACCESSORIES
• MACHINERY
• PETS
• PRECIOUS_STONES_DIAMONDS_AND_METALS
• SPORTING_EQUIPMENT
• MANUFACTURING_OTHER
• RETAIL_WHOLESALE_MARKETPLACE_AUCTION
• RETAIL_WHOLESALE_OTHER
• TOYS_AND_GAMES
• TRAVEL_TRANSPORT_TOUR_AGENCIES
• ACCOMMODATION_HOTELS
• PASSENGER_TRANSPORT
• FREIGHT_TRANSPORT
• RIDESHARING_TRANSPORT_SHARING_SERVICES
• TRANSPORT
• TRAVEL_AGENCIES
• TOUR_OPERATORS
• TRAVEL_OR_TOUR_ACTIVITIES_OTHER
• OTHER
• OTHER_NOT_LISTED_ABOVE

Response (Business)

Update

Example Request:

curl -X PUT https://api.sandbox.transferwise.tech/v1/profiles \
     -H "Authorization: Bearer <your api token>" \
     -H "Content-Type: application/json" \
     -d '{
          "id": <your personal profile id>
          "type": "personal",
          "details": {
            "firstName": "Oliver",
            "lastName": "Wilson",
            "dateOfBirth": "1977-07-01",
            "phoneNumber": "+3725064992",
            "firstNameInKana": null,
            "lastNameInKana": null
           }
        }'

Example Response:

{
  "id": <your personal profile id>,
  "type": "personal",
  "details": {
    "firstName": "Oliver",
    "lastName": "Wilson",
    "dateOfBirth": "1977-07-01",
    "phoneNumber": "+3725064992",
    "avatar": "",
    "occupation": "",
    "occupations": null,
    "primaryAddress": null,
    "firstNameInKana": null,
    "lastNameInKana": null
  }
}

Update user profile information.

If user profile has been verified then there are restrictions on what information is allowed to change, where permitted, use the update window functionality to submit updated data.

Request

PUT https://api.sandbox.transferwise.tech/v1/profiles

Request and response is same as described in Create (Personal) and Create (Business)

Get By Id

Example Request:

curl -X GET https://api.sandbox.transferwise.tech/v1/profiles/{profileId} \
     -H "Authorization: Bearer <your api token>" 

Example Response:

{
  "id": <your personal profile id>,
  "type": "personal",
  "details": {
    "firstName": "Oliver",
    "lastName": "Wilson",
    "dateOfBirth": "1977-07-01",
    "phoneNumber": "+3725064992",
    "avatar": "",
    "occupation": "",
    "primaryAddress": null,
    "firstNameInKana": null,
    "lastNameInKana": null
  }
}

Get profile info by id.

Request

GET https://api.sandbox.transferwise.tech/v1/profiles/{profileId}

List

GET /v2/profiles

Example Request:

curl -X GET https://api.sandbox.transferwise.tech/v2/profiles \
     -H "Authorization: Bearer <your api token>"

Example Response:

[
  {
    "type": "PERSONAL",
    "id": 16155137,
    "userId": 5682283,
    "address": {
      "addressFirstLine": ".......",
      "city": "London",
      "countryIso2Code": "GB",
      "countryIso3Code": "gbr",
      "postCode": "ABC123",
      "stateCode": null
    },
    "email": "",
    "createdAt": "2021-03-25T15:18:35.000Z",
    "updatedAt": "2021-03-25T15:18:35.000Z",
    "obfuscated": false,
    "currentState": "VISIBLE",
    "firstName": "Oliver",
    "lastName": "Wilson",
    "dateOfBirth": "1967-04-03",
    "phoneNumber": "+442038087139",
    "secondaryAddresses": [],
    "fullName": "Oliver Wilson"
  },
  {
    "type": "BUSINESS",
    "id": 16155138,
    "userId": 5682283,
    "address": {
      "addressFirstLine": ".......",
      "city": "London",
      "countryIso2Code": "GB",
      "countryIso3Code": "gbr",
      "postCode": "ABC123",
      "stateCode": null
    },
    "email": "",
    "createdAt": "2021-03-25T15:18:38.000Z",
    "updatedAt": "2021-03-25T15:18:38.000Z",
    "obfuscated": false,
    "currentState": "VISIBLE",
    "businessName": "ABC Logistics Ltd",
    "registrationNumber": "07209813",
    "descriptionOfBusiness": "IT_SERVICES",
    "companyType": "LIMITED",
    "companyRole": "OWNER",
    "operationalAddresses": [],
    "fullName": "ABC Logistics Ltd"
  }
]