Wise Platform API

https://docs.wise.com/api-reference
Admin
The Wise Platform API is a REST-based interface that enables programmatic access to Wise's payment...
Tokens:396,647
Snippets:2,659
Trust Score:10
Update:4 weeks ago
Show doc for...
Tokens:
Raw
### User object example

Source: https://docs.wise.com/api-reference/user/user

Example JSON response for a User object, showing all documented fields including nested details and address objects.

```json
{
  "id": 101,
  "name": "Example Person",
  "email": "person@example.com",
  "active": true,
  "details": {
    "firstName": "Example",
    "lastName": "Person",
    "phoneNumber": "+37111111111",
    "dateOfBirth": "1977-01-01",
    "occupation": "",
    "avatar": "https://lh6.googleusercontent.com/photo.jpg",
    "primaryAddress": 111,
    "address": {
      "countryCode": "EE",
      "firstLine": "Road 123",
      "postCode": "11111",
      "city": "Tallinn",
      "state": "",
      "occupation": ""
    }
  }
}
```

--------------------------------

### Create user with registration code - response example

Source: https://docs.wise.com/api-reference/user/usercreate

Example response body for a successful user creation. It shows the user ID, name (null if not provided), email, active status, and details (null if not provided).

```json
{
  "id": 12345,
  "name": null,
  "email": "new.user@domain.com",
  "active": true,
  "details": null
}
```

--------------------------------

### displayFields example

Source: https://docs.wise.com/api-reference/recipient/recipientget

Example of the displayFields array in the response, containing lookup fields for rendering in a front-end UI. Each object includes a key, label, and value.

```json
[
  {
    "key": "details/sortCode",
    "label": "UK sort code",
    "value": "04-00-75"
  },
  {
    "key": "details/accountNumber",
    "label": "Account number",
    "value": "37778842"
  }
]
```

--------------------------------

### GET /profiles/{profileId}/account-details

Source: https://docs.wise.com/api-reference/bank-account-details

Returns a list with all the AVAILABLE and ACTIVE account details for the given profile, including examples.

```APIDOC
## GET /profiles/{profileId}/account-details

### Description
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.

### Method
GET

### Endpoint
/profiles/{profileId}/account-details

### Parameters
#### Path Parameters
- **profileId** (string) - Required - The unique identifier of the profile.

### Request Example
{}

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the account details.
- **currency** (string) - The currency of the account details.
- **type** (string) - The type of account details (e.g., local, international).

#### Response Example
[
  {
    "id": "string",
    "currency": "string",
    "type": "string"
  }
]
```

--------------------------------

### GET /address-requirements

Source: https://docs.wise.com/api-reference/address/addressrequirementsget

Retrieves the list of fields required to create a valid address. Use this as a starting point to discover required fields.

```APIDOC
## GET /address-requirements

### Description
Returns the list of fields required to create a valid address. Use this as a starting point to discover required fields.

### Method
GET

### Endpoint
/address-requirements

### Security
UserToken, PersonalToken

### Header Parameters
- **X-External-Correlation-Id** (string) - Optional - UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters.

### Response
#### Success Response (200)
- **type** (string) - Always "address". Example: address
- **fields** (array) - List of fields required for the address.
- **fields.name** (string) - Display name of the field. Example: Country
- **fields.group** (array) - Group of field properties.
- **fields.group.key** (string) - Key name to include in the JSON request. Example: country
- **fields.group.type** (string) - Display type of field. Enum: "text", "select"
- **fields.group.refreshRequirementsOnChange** (boolean) - If true, call POST address-requirements when this field value changes to discover additional required fields. Example: true
- **fields.group.required** (boolean) - Indicates if the field is mandatory. Example: true
- **fields.group.displayFormat** (string | null) - Display format pattern. Example: null
- **fields.group.example** (string) - Example value to help users understand what to input. Example: Germany
- **fields.group.minLength** (integer | null) - Minimum valid length of field value. Example: null
- **fields.group.maxLength** (integer | null) - Maximum valid length of field value. Example: null
- **fields.group.validationRegexp** (string | null) - Regexp validation pattern. Example: null
- **fields.group.validationAsync** (string | null) - Deprecated. This validation will instead be performed when submitting the request. Example: null
- **fields.group.valuesAllowed** (array) - List of allowed values (for select fields). Example: [{"key":"US","name":"United States"},{"key":"GB","name":"United Kingdom"}]
- **fields.group.valuesAllowed.key** (string) - Value key to use in the request.
- **fields.group.valuesAllowed.name** (string) - Display name for the value.

#### Response Example
{
  "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": "US", "name": "United States"},
            {"key": "GB", "name": "United Kingdom"}
          ]
        }
      ]
    }
  ]
}
```

--------------------------------

### POST /simulation/balance/topup

Source: https://docs.wise.com/api-reference/simulation/simulationbalancetopup

Simulates a top-up so that a balance can be used to fund transfers and/or card spend. Requires a user token.

```APIDOC
## POST /simulation/balance/topup

### Description
Simulates a top-up so that a balance can be used to fund transfers and/or card spend.

### Method
POST

### Endpoint
/simulation/balance/topup

### Security
UserToken

### Header Parameters
- **X-External-Correlation-Id** (string) - Optional - UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters.

### Request Body (application/json)
- **profileId** (integer) - Required - The profile ID linked to the balance account.
- **balanceId** (integer) - Required - The ID of the balance account that is going to receive the funds.
- **currency** (string) - Required - The currency to top up the balance account in. Must be the same currency as the balance account.
- **amount** (number) - Required - The amount to top up the balance account with.
- **channel** (string) - Optional - Type of top-up. Not providing a channel will default to `CARD`. Enum: "TRANSFER", "CARD".

### Request Example
{
  "profileId": 123456,
  "balanceId": 789012,
  "currency": "GBP",
  "amount": 100.00,
  "channel": "CARD"
}

### Response
#### Success Response (200)
- **transactionId** (integer) - The ID of the top-up transaction.
- **state** (string) - The state of the transaction. `COMPLETED` is always returned when using this endpoint.
- **balancesAfter** (array) - List of balance accounts after the top-up.
  - **id** (integer) - The ID of the balance account.
  - **value** (number) - The new amount available in the balance account.
  - **currency** (string) - The currency of the balance account.

#### Response Example
{
  "transactionId": 123456789,
  "state": "COMPLETED",
  "balancesAfter": [
    {
      "id": 789012,
      "value": 100.00,
      "currency": "GBP"
    }
  ]
}
```

--------------------------------

### GET /quotes/{quoteId}/account-requirements - curl example

Source: https://docs.wise.com/api-reference/recipient/recipientaccountrequirementsget

Use this curl command to retrieve recipient account requirements with a quote ID. It includes the Accept-Minor-Version header set to 1 and an optional X-External-Correlation-Id. The query parameters originatorLegalEntityType and addressRequired are shown.

```curl
curl -i -X GET \
  'https://api.wise.com/2026Q3/quotes/{quoteId}/account-requirements?originatorLegalEntityType=BUSINESS&addressRequired=false' \
  -H 'Accept-Minor-Version: 1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-External-Correlation-Id: f47ac10b-58cc-4372-a567-0e02b2c3d479'
```

--------------------------------

### POST /quotes

Source: https://docs.wise.com/api-reference/quote/quotecreateunauthenticated

Creates an example quote for illustrative purposes. This endpoint does not require a token, but an optional Authorization header with client credentials can be included for accurate partner fees.

```APIDOC
## POST /quotes

### Description
Creates an example quote for illustrative purposes. This endpoint does not require a token, but an optional Authorization header with client credentials can be included for accurate partner fees.

### Method
POST

### Endpoint
POST /quotes

### Security
ClientCredentialsToken

### Header Parameters
- **X-External-Correlation-Id** (string) - Optional - UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters.

### Request Body (application/json)
- **sourceCurrency** (string) - Required - Source (sending) currency code. Example: GBP
- **targetCurrency** (string) - Required - Target (receiving) currency code. Example: USD
- **sourceAmount** (number | null) - Optional - Amount in source currency. Either `sourceAmount` or `targetAmount` is required, never both. Example: null
- **targetAmount** (number | null) - Optional - Amount in target currency. Example: 110
- **pricingConfiguration** (object) - Optional - Required when configured for your client ID. Includes a `pricingConfiguration` to be used for pricing calculations with the quote.
  - **fee** (object) - Optional
    - **type** (string) - Optional - Identifies the type of fee to be configured. Options include only `OVERRIDE`. Example: OVERRIDE
    - **variable** (number) - Optional - The selected variable percentage, in decimal format, that should be used in the `pricingConfiguration`. Example: 0.011
    - **fixed** (number) - Optional - The selected fixed fee that should be used in the `pricingConfiguration`. Always considered in source currency. Example: 15.42

### Request Example
{
  "sourceCurrency": "GBP",
  "targetCurrency": "USD",
  "sourceAmount": null,
  "targetAmount": 110,
  "pricingConfiguration": {
    "fee": {
      "type": "OVERRIDE",
      "variable": 0.011,
      "fixed": 15.42
    }
  }
}

### Response
#### Success Response (200)
The response is not described in the source. The endpoint returns a quote object, but the exact fields are not specified.

#### Response Example
No response example is provided in the source.

```

--------------------------------

### POST /profiles/{profileId}/balances

Source: https://docs.wise.com/api-reference/balance/balancecreate

Creates a new balance account for the specified profile. Requires a currency and balance type, and a name for SAVINGS balances. Returns the created balance details.

```APIDOC
## POST /profiles/{profileId}/balances

### Description
Opens a balance within the specified profile, in the currency and type specified in the request. For STANDARD balances, only one can be created per currency. For SAVINGS balances, multiple in the same currency can be opened. When creating a SAVINGS type balance, a name is required.

### Method
POST

### Endpoint
/profiles/{profileId}/balances

### Security
UserToken, PersonalToken

### Parameters
#### Path Parameters
- **profileId** (integer) - Required - The profile ID.

#### Header Parameters
- **X-idempotence-uuid** (string) - Required - 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 a retry call.
- **X-External-Correlation-Id** (string) - Optional - UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters.

#### Request Body
- **currency** (string) - Required - Currency code (ISO 4217 Alphabetic Code). Example: EUR
- **type** (string) - Required - Type of balance account. Enum: "STANDARD", "SAVINGS"
- **name** (string) - Optional - Name of the balance. Required for SAVINGS type balances.

### Request Example
{
  "currency": "EUR",
  "type": "STANDARD",
  "name": "My Balance"
}

### Response
#### Success Response (201)
- **id** (integer) - Balance ID. Example: 200001
- **currency** (string) - Currency code (ISO 4217 Alphabetic Code). Example: EUR
- **type** (string) - Type of balance account. Enum: "STANDARD", "SAVINGS"
- **name** (string | null) - Name of the balance. Required for SAVINGS balances. Example: null
- **icon** (object | null) - Icon for the balance. Example: null
- **icon.type** (string) - Icon type. Enum: "EMOJI"
- **icon.value** (string) - Icon value (e.g., emoji character).
- **investmentState** (string) - Investment state of the balance. Enum: "NOT_INVESTED", "INVESTED", "INVESTING", "DIVESTING", "UNKNOWN"
- **amount** (object) - Available balance that can be used to fund transfers.
- **amount.value** (number) - Amount value. Example: 310.86
- **amount.currency** (string) - Currency code (ISO 4217 Alphabetic Code). Example: EUR
- **reservedAmount** (object) - Amount reserved for transactions.
- **reservedAmount.value** (number) - Amount value. Example: 0
- **reservedAmount.currency** (string) - Currency code (ISO 4217 Alphabetic Code). Example: EUR
- **cashAmount** (object) - Cash amount in the account.
- **cashAmount.value** (number) - Amount value. Example: 310.86
- **cashAmount.currency** (string) - Currency code (ISO 4217 Alphabetic Code). Example: EUR
- **totalWorth** (object) - Current total worth.
- **totalWorth.value** (number) - Amount value. Example: 310.86
- **totalWorth.currency** (string) - Currency code (ISO 4217 Alphabetic Code). Example: EUR
- **creationTime** (string) - Date when the balance was created. Example: 2020-05-20T14:43:16.658Z
- **modificationTime** (string) - Date when the balance was last modified. Example: 2020-05-20T14:43:16.658Z
- **visible** (boolean) - Whether the balance is visible to the user. Example: true

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

--------------------------------

### GET /transfers/{transferId}

Source: https://docs.wise.com/api-reference/transfer

Get transfer info by ID. To receive dynamic updates as the state of the transfer changes, see the webhooks documentation.

```APIDOC
## GET /transfers/{transferId}

### Description
Get transfer info by ID. To receive dynamic updates as the state of the transfer changes, see the webhooks documentation.

### Method
GET

### Endpoint
/transfers/{transferId}

### Parameters
#### Path Parameters
- **transferId** (string) - Required - The unique identifier of the transfer.

### Response
#### Success Response (200)
- **transfer** (object) - The transfer object.

#### Response Example
{
  "id": "TRF123456",
  "status": "incoming_payment_waiting"
}
```

--------------------------------

### Create KYC Review with curl

Source: https://docs.wise.com/api-reference/kyc-review/kycreviewcreate

Sends a POST request to create a KYC Review. Requires a profile ID in the path and a Bearer token. The body includes the type (e.g., QUOTE) and triggerData with the underlying product ID. Optionally includes X-External-Correlation-Id for correlation.

```bash
curl -i -X POST \
  'https://api.wise.com/2026Q3/profiles/{profileId}/kyc-reviews' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-External-Correlation-Id: f47ac10b-58cc-4372-a567-0e02b2c3d479' \
  -d '{
    "type": "QUOTE",
    "triggerData": {
      "id": "ba83a43a-f623-46f0-956d-196c13e2ab01"
    }
  }'
```

--------------------------------

### GET /profiles/{profileId}/third-party-transfers/{transferId}

Source: https://docs.wise.com/api-reference/third-party-transfer

Gets third party transfer info by ID. Dynamic updates are available via webhooks.

```APIDOC
## GET /profiles/{profileId}/third-party-transfers/{transferId}

### Description
Gets third party transfer info by ID. To receive dynamic updates as the state of the transfer changes, see the webhooks documentation.

### Method
GET

### Endpoint
/profiles/{profileId}/third-party-transfers/{transferId}

### Parameters
#### Path Parameters
- **profileId** (string) - Required - The ID of the profile.
- **transferId** (string) - Required - The ID of the third-party transfer.
```

--------------------------------

### POST /user/signup/registration_code

Source: https://docs.wise.com/api-reference/user/usercreate

Creates a new user with a registration code. Requires a valid ClientCredentialsToken and a unique email address. Returns the created user's details.

```APIDOC
## POST /user/signup/registration_code

### Description
Creates a new user in Wise using an email address and a registration code. The email must be unique; if it already exists, a warning is returned. The registration code is used later to obtain an access token for the new user.

### Method
POST

### Endpoint
https://api.wise.com/2026Q3/user/signup/registration_code

### Headers
- **Authorization** (string) - Required - Bearer token (JWT) for authentication.
- **Content-Type** (string) - Required - application/json
- **X-External-Correlation-Id** (string, uuid, <= 36 characters) - Optional - UUID for correlating requests across systems. If provided, Wise echoes it back in the response.

### Request Body
- **email** (string, email) - Required - New user's email address.
- **registrationCode** (string, >= 32 characters) - Required - Randomly generated registration code unique to this user and request. Must be stored securely to obtain access token later.
- **language** (string) - Optional - User default language for UI and email communication. Allowed values: EN, US, PT, ES, FR, DE, IT, JA, RU, PL, HU, TR, RO, NL, HK. Default: EN.

### Request Example
```json
{
  "email": "user@email.com",
  "registrationCode": "a]#Et6(yLW@mq4Ky_+EAjXxpHGq7*&lr",
  "language": "EN"
}
```

### Responses

#### Success Response (200)
- **id** (integer, int64) - User ID.
- **name** (string or null) - User's full name.
- **email** (string) - User's email.
- **active** (boolean) - If user is active or not.
- **details** (object or null) - User details.

#### Response Example (200)
```json
{
  "id": 12345,
  "name": null,
  "email": "new.user@domain.com",
  "active": true,
  "details": null
}
```

#### Error Responses
- **409** - Conflict: Email already exists. Warning: "You're already a member. Please login".
- **429** - Too Many Requests: Rate limit exceeded.

```

--------------------------------

### commonFieldMap example

Source: https://docs.wise.com/api-reference/recipient/recipientget

Example of the commonFieldMap object in the response, showing key lookup fields for the account. The fields vary depending on currency route and recipient type.

```json
{
  "accountNumberField": "accountNumber",
  "bankCodeField": "sortCode"
}
```
Tokens:
Raw