Skip to content

Wise Platform API

The Wise Platform API is a REST-based interface that enables programmatic access to Wise's payment infrastructure. All endpoints return JSON-formatted responses and use standard HTTP methods and status codes.

New to wise?

We strongly recommend first reading our Getting Started Guide to help you set up credentials and make your first call.

Before you begin

To use this API reference effectively, you should have:

  • Received Valid API credentials from Wise (Client ID and Client Secret)
  • Understand OAuth 2.0 authentication
  • Be familiar with RESTful API concepts

Core API resources

ResourcePurpose
QuoteExchange rate and fee calculations
RecipientBeneficiary account management
TransferPayment creation and execution
BalanceMulti-currency account operations
ProfileAccount ownership details
RateCurrent and historical exchange rates

Not sure which workflow to build?
Start with our Integration Guides for step-by-step implementation examples.

Languages
Servers
Production Environment
https://api.wise.com/
Sandbox Environment
https://api.wise-sandbox.com/

3D Secure Authentication

To manage certain aspects of the 3D Secure (3DS) authentication, you will need to integrate with the following APIs.

Operations

Activity

Activity represents a snapshot of a performed action for a profile.

Operations

Additional Customer Verification

In certain situations, additional evidence is required to verify customers and ensure we’re compliant with the KYC regulations.

Additional Verification APIs support a list of evidences that can be found in the Supported Evidences guide.

If you use the Customer Account with Partner KYC model and your customers are primarily based in the EU, refer to this Onboarding EU customers guide for instructions on how to use these APIs.

If you use the Customer Account with Partner KYC model and you are onboarding high risk business customers based primarily based in the US, refer to this Onboarding High Risk US Businesses guide for instructions on how to use these APIs.

Operations

Address

Manage physical addresses associated with user profiles.

Address requirements vary by country — use the address requirements endpoints to dynamically discover which fields are needed before creating an address.

SchemasOperations

Balance

Create and manage balance accounts within a multi-currency account.

Each profile can hold multiple balance accounts in different currencies. A STANDARD balance is limited to one per currency, while SAVINGS balances (Jars) allow multiple in the same currency. Creating the first balance for a profile automatically creates the multi-currency account.

Balances include an investmentState field. Only balances with NOT_INVESTED can be operated on via the API. Invested balances should be shown but not actionable.

For a complete guide on multi-currency accounts, see Multi-Currency Accounts.

SchemasOperations

Balance

Represents a balance account within a profile.

idinteger(int64)

Balance ID.

Example: 200001
currencystring

Currency code (ISO 4217 Alphabetic Code).

Example: "EUR"
typestring
Enum ValueDescription
STANDARD

Standard balance account. Only one per currency per profile.

SAVINGS

Savings balance (Jar). Multiple allowed per currency.

namestring or null

Name of the balance. Required for SAVINGS balances.

Example: null
iconobject or null

Icon for the balance.

Example: null
icon.​typestring

Icon type.

Value"EMOJI"
icon.​valuestring

Icon value (e.g., emoji character).

investmentStatestring

Investment state of the balance.

Enum ValueDescription
NOT_INVESTED

Balance is not invested.

INVESTED

Balance is invested in assets.

INVESTING

Balance is being invested into assets.

DIVESTING

Balance is being divested from assets.

UNKNOWN

Investment state is unknown.

Example: "NOT_INVESTED"
amountobject

Available balance that can be used to fund transfers.

amount.​valuenumber

Amount value.

Example: 310.86
amount.​currencystring

Currency code (ISO 4217 Alphabetic Code).

Example: "EUR"
reservedAmountobject

Amount reserved for transactions.

reservedAmount.​valuenumber

Amount value.

Example: 0
reservedAmount.​currencystring

Currency code (ISO 4217 Alphabetic Code).

Example: "EUR"
cashAmountobject

Cash amount in the account.

cashAmount.​valuenumber

Amount value.

Example: 310.86
cashAmount.​currencystring

Currency code (ISO 4217 Alphabetic Code).

Example: "EUR"
totalWorthobject

Current total worth.

totalWorth.​valuenumber

Amount value.

Example: 310.86
totalWorth.​currencystring

Currency code (ISO 4217 Alphabetic Code).

Example: "EUR"
creationTimestring(date-time)

Date when the balance was created.

Example: "2020-05-20T14:43:16.658Z"
modificationTimestring(date-time)

Date when the balance was last modified.

Example: "2020-05-20T14:43:16.658Z"
visibleboolean

Whether the balance is visible to the user.

Example: true
{
  "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
}

Create a Balance Account

Request

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.

Security
UserToken or PersonalToken
Path
profileIdinteger(int64)required

The profile ID.

Headers
X-idempotence-uuidstring(uuid)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.

Bodyapplication/jsonrequired
currencystringrequired

Currency code (ISO 4217 Alphabetic Code).

Example: "EUR"
typestringrequired
Enum ValueDescription
STANDARD

Standard balance account. Only one per currency per profile.

SAVINGS

Savings balance (Jar). Multiple allowed per currency.

namestring

Name of the balance. Required for SAVINGS type balances.

curl -i -X POST \
  'https://api.wise.com/v4/profiles/{profileId}/balances' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-idempotence-uuid: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -d '{
    "currency": "EUR",
    "type": "STANDARD"
  }'

Responses

Created - Balance successfully created.

Bodyapplication/json
idinteger(int64)

Balance ID.

Example: 200001
currencystring

Currency code (ISO 4217 Alphabetic Code).

Example: "EUR"
typestring
Enum ValueDescription
STANDARD

Standard balance account. Only one per currency per profile.

SAVINGS

Savings balance (Jar). Multiple allowed per currency.

namestring or null

Name of the balance. Required for SAVINGS balances.

Example: null
iconobject or null

Icon for the balance.

Example: null
icon.​typestring

Icon type.

Value"EMOJI"
icon.​valuestring

Icon value (e.g., emoji character).

investmentStatestring

Investment state of the balance.

Enum ValueDescription
NOT_INVESTED

Balance is not invested.

INVESTED

Balance is invested in assets.

INVESTING

Balance is being invested into assets.

DIVESTING

Balance is being divested from assets.

UNKNOWN

Investment state is unknown.

Example: "NOT_INVESTED"
amountobject

Available balance that can be used to fund transfers.

amount.​valuenumber

Amount value.

Example: 310.86
amount.​currencystring

Currency code (ISO 4217 Alphabetic Code).

Example: "EUR"
reservedAmountobject

Amount reserved for transactions.

reservedAmount.​valuenumber

Amount value.

Example: 0
reservedAmount.​currencystring

Currency code (ISO 4217 Alphabetic Code).

Example: "EUR"
cashAmountobject

Cash amount in the account.

cashAmount.​valuenumber

Amount value.

Example: 310.86
cashAmount.​currencystring

Currency code (ISO 4217 Alphabetic Code).

Example: "EUR"
totalWorthobject

Current total worth.

totalWorth.​valuenumber

Amount value.

Example: 310.86
totalWorth.​currencystring

Currency code (ISO 4217 Alphabetic Code).

Example: "EUR"
creationTimestring(date-time)

Date when the balance was created.

Example: "2020-05-20T14:43:16.658Z"
modificationTimestring(date-time)

Date when the balance was last modified.

Example: "2020-05-20T14:43:16.658Z"
visibleboolean

Whether the balance is visible to the user.

Example: true
Response
application/json
{
  "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
}

List Balances for a Profile

Request

Retrieves the user's multi-currency account balance accounts. Returns all balance accounts the profile has in the types specified.

The types parameter must include at least one type. To return more than one type, comma-separate the values.

Security
UserToken or PersonalToken
Path
profileIdinteger(int64)required

The profile ID.

Query
typesstringrequired

Comma-separated list of balance types to return. Acceptable values are STANDARD and SAVINGS.

Example: types=STANDARD
curl -i -X GET \
  'https://api.wise.com/v4/profiles/{profileId}/balances?types=STANDARD' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK - Successfully retrieved balances.

Bodyapplication/jsonArray [
idinteger(int64)

Balance ID.

Example: 200001
currencystring

Currency code (ISO 4217 Alphabetic Code).

Example: "EUR"
typestring
Enum ValueDescription
STANDARD

Standard balance account. Only one per currency per profile.

SAVINGS

Savings balance (Jar). Multiple allowed per currency.

namestring or null

Name of the balance. Required for SAVINGS balances.

Example: null
iconobject or null

Icon for the balance.

Example: null
icon.​typestring

Icon type.

Value"EMOJI"
icon.​valuestring

Icon value (e.g., emoji character).

investmentStatestring

Investment state of the balance.

Enum ValueDescription
NOT_INVESTED

Balance is not invested.

INVESTED

Balance is invested in assets.

INVESTING

Balance is being invested into assets.

DIVESTING

Balance is being divested from assets.

UNKNOWN

Investment state is unknown.

Example: "NOT_INVESTED"
amountobject

Available balance that can be used to fund transfers.

amount.​valuenumber

Amount value.

Example: 310.86
amount.​currencystring

Currency code (ISO 4217 Alphabetic Code).

Example: "EUR"
reservedAmountobject

Amount reserved for transactions.

reservedAmount.​valuenumber

Amount value.

Example: 0
reservedAmount.​currencystring

Currency code (ISO 4217 Alphabetic Code).

Example: "EUR"
cashAmountobject

Cash amount in the account.

cashAmount.​valuenumber

Amount value.

Example: 310.86
cashAmount.​currencystring

Currency code (ISO 4217 Alphabetic Code).

Example: "EUR"
totalWorthobject

Current total worth.

totalWorth.​valuenumber

Amount value.

Example: 310.86
totalWorth.​currencystring

Currency code (ISO 4217 Alphabetic Code).

Example: "EUR"
creationTimestring(date-time)

Date when the balance was created.

Example: "2020-05-20T14:43:16.658Z"
modificationTimestring(date-time)

Date when the balance was last modified.

Example: "2020-05-20T14:43:16.658Z"
visibleboolean

Whether the balance is visible to the user.

Example: true
]
Response
application/json
[
  {
    "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
  }
]

Retrieve a Balance by ID

Request

Returns a balance based on the specified balance ID.

Security
UserToken or PersonalToken
Path
profileIdinteger(int64)required

The profile ID.

balanceIdinteger(int64)required

The balance ID.

curl -i -X GET \
  'https://api.wise.com/v4/profiles/{profileId}/balances/{balanceId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK - Successfully retrieved the balance.

Bodyapplication/json
idinteger(int64)

Balance ID.

Example: 200001
currencystring

Currency code (ISO 4217 Alphabetic Code).

Example: "EUR"
typestring
Enum ValueDescription
STANDARD

Standard balance account. Only one per currency per profile.

SAVINGS

Savings balance (Jar). Multiple allowed per currency.

namestring or null

Name of the balance. Required for SAVINGS balances.

Example: null
iconobject or null

Icon for the balance.

Example: null
icon.​typestring

Icon type.

Value"EMOJI"
icon.​valuestring

Icon value (e.g., emoji character).

investmentStatestring

Investment state of the balance.

Enum ValueDescription
NOT_INVESTED

Balance is not invested.

INVESTED

Balance is invested in assets.

INVESTING

Balance is being invested into assets.

DIVESTING

Balance is being divested from assets.

UNKNOWN

Investment state is unknown.

Example: "NOT_INVESTED"
amountobject

Available balance that can be used to fund transfers.

amount.​valuenumber

Amount value.

Example: 310.86
amount.​currencystring

Currency code (ISO 4217 Alphabetic Code).

Example: "EUR"
reservedAmountobject

Amount reserved for transactions.

reservedAmount.​valuenumber

Amount value.

Example: 0
reservedAmount.​currencystring

Currency code (ISO 4217 Alphabetic Code).

Example: "EUR"
cashAmountobject

Cash amount in the account.

cashAmount.​valuenumber

Amount value.

Example: 310.86
cashAmount.​currencystring

Currency code (ISO 4217 Alphabetic Code).

Example: "EUR"
totalWorthobject

Current total worth.

totalWorth.​valuenumber

Amount value.

Example: 310.86
totalWorth.​currencystring

Currency code (ISO 4217 Alphabetic Code).

Example: "EUR"
creationTimestring(date-time)

Date when the balance was created.

Example: "2020-05-20T14:43:16.658Z"
modificationTimestring(date-time)

Date when the balance was last modified.

Example: "2020-05-20T14:43:16.658Z"
visibleboolean

Whether the balance is visible to the user.

Example: true
Response
application/json
{
  "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
}

Remove a Balance Account

Request

Closes a balance account for the user's profile.

Balance accounts must have a zero balance to be closed. Bank account details for the balance will also be deactivated and may not be restored.

Security
UserToken or PersonalToken
Path
profileIdinteger(int64)required

The profile ID.

balanceIdinteger(int64)required

The balance ID.

curl -i -X DELETE \
  'https://api.wise.com/v4/profiles/{profileId}/balances/{balanceId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

No Content - Balance successfully removed.

Convert or Move Money Between Balances

Request

This endpoint allows conversion and movement of funds between balance accounts.

Convert across balance accounts: Convert funds between two STANDARD balance accounts in different currencies. Requires a quote created with "payOut": "BALANCE".

Move money between balances:

  • Add money to a same-currency jar (move from STANDARD to SAVINGS without conversion)
  • Add money to another-currency jar (convert money using a quote)
  • Withdraw money from a jar (move from SAVINGS to STANDARD without conversion)

Either amount or quoteId is required. Use quoteId for cross-currency movements.

Security
UserToken or PersonalToken
Path
profileIdinteger(int64)required

The profile ID.

Headers
X-idempotence-uuidstring(uuid)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.

Bodyapplication/jsonrequired
quoteIdstring(uuid)

Quote ID. Required for cross-currency movements. Quote must be created with payOut: BALANCE.

sourceBalanceIdinteger(int64)

Source balance ID. Required when moving between balances (with targetBalanceId).

targetBalanceIdinteger(int64)

Target balance ID. Required when moving between balances (with sourceBalanceId).

amountobject

Amount to move. Required for same-currency movements. Either amount or quoteId must be provided.

amount.​valuenumber

Amount value.

amount.​currencystring

Currency code (ISO 4217 Alphabetic Code).

curl -i -X POST \
  'https://api.wise.com/v2/profiles/{profileId}/balance-movements' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-idempotence-uuid: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -d '{
    "quoteId": "00000000-0000-0000-0000-000000000000"
  }'

Responses

Created - Movement completed successfully.

Bodyapplication/json
idinteger(int64)

Movement transaction ID.

Example: 30000001
typestring

Type of movement.

Enum"DEPOSIT""WITHDRAWAL""CONVERSION"
Example: "CONVERSION"
statestring

State of the movement.

Enum"PENDING""COMPLETED""CANCELLED""REVERSED"
Example: "COMPLETED"
balancesAfterArray of objects

Balance states after the movement.

balancesAfter[].​idinteger(int64)

Balance ID.

Example: 1
balancesAfter[].​valuenumber

Balance value after movement.

Example: 10000594.71
balancesAfter[].​currencystring

Currency code.

Example: "GBP"
creationTimestring(date-time)

When the movement was created.

Example: "2017-11-21T09:55:49.275Z"
sourceAmountobject

Source amount of the movement.

sourceAmount.​valuenumber
Example: 113.48
sourceAmount.​currencystring
Example: "EUR"
targetAmountobject

Target amount of the movement.

targetAmount.​valuenumber
Example: 100
targetAmount.​currencystring
Example: "GBP"
ratenumber

Exchange rate applied to the conversion.

Example: 0.88558
feeAmountsArray of objects

Fee amounts charged for the movement.

feeAmounts[].​valuenumber
Example: 0.56
feeAmounts[].​currencystring
Example: "EUR"
stepsArray of objects

Steps involved in the movement.

steps[].​idinteger(int64)

Step ID.

Example: 369588
steps[].​typestring

Step type.

Example: "CONVERSION"
steps[].​creationTimestring(date-time)

When the step was created.

Example: "2017-11-21T09:55:49.276Z"
steps[].​balancesAfterArray of objects
steps[].​sourceAmountobject
steps[].​targetAmountobject
steps[].​feeobject
steps[].​ratenumber

Exchange rate applied.

Example: 0.88558
Response
application/json
{
  "id": 30000001,
  "type": "CONVERSION",
  "state": "COMPLETED",
  "balancesAfter": [
    {
      "id": 1,
      "value": 10000594.71,
      "currency": "GBP"
    }
  ],
  "creationTime": "2017-11-21T09:55:49.275Z",
  "sourceAmount": {
    "value": 113.48,
    "currency": "EUR"
  },
  "targetAmount": {
    "value": 100,
    "currency": "GBP"
  },
  "rate": 0.88558,
  "feeAmounts": [
    {
      "value": 0.56,
      "currency": "EUR"
    }
  ],
  "steps": [
    {
      "id": 369588,
      "type": "CONVERSION",
      "creationTime": "2017-11-21T09:55:49.276Z",
      "balancesAfter": [ … ],
      "sourceAmount": { … },
      "targetAmount": { … },
      "fee": { … },
      "rate": 0.88558
    }
  ]
}

Retrieve Deposit Limits

Request

Returns the deposit limit for a profile based on regulatory requirements.

Useful for personal profiles located in countries that have hold limits. We advise calling this API before depositing money into an account if the profile is located in Singapore or Malaysia.

Security
UserToken or PersonalToken
Path
profileIdinteger(int64)required

The profile ID.

Query
currencystringrequired

Currency code (ISO 4217 Alphabetic Code). The deposit limit will be returned in this currency.

Example: currency=SGD
curl -i -X GET \
  'https://api.wise.com/v1/profiles/{profileId}/balance-capacity?currency=SGD' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK - Successfully retrieved deposit limits.

Bodyapplication/json
hasLimitboolean

True if there is a regulatory hold limit for the profile's country.

Example: true
depositLimitobject

Amount of money that can be added to the account.

depositLimit.​amountnumber

Deposit limit amount.

Example: 2000
depositLimit.​currencystring

Currency code (ISO 4217 Alphabetic Code).

Example: "SGD"
Response
application/json
{
  "hasLimit": true,
  "depositLimit": {
    "amount": 2000,
    "currency": "SGD"
  }
}

Add an Excess Money Account

Request

If a balance goes over the regulatory hold limit, excess funds are automatically moved to another account at the end of the day.

Use this endpoint to specify a recipient where excess money will be transferred.

Primarily used for Singapore and Malaysia customers.

Security
UserToken or PersonalToken
Path
profileIdinteger(int64)required

The profile ID.

Bodyapplication/jsonrequired
recipientIdinteger(int64)required

ID of the recipient for excess money transfers.

Example: 148393305
curl -i -X POST \
  'https://api.wise.com/v1/profiles/{profileId}/excess-money-account' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "recipientId": 148393305
  }'

Responses

OK - Excess money account configured successfully.

Bodyapplication/json
userProfileIdinteger(int64)

ID of the profile.

Example: 12321323
recipientIdinteger(int64)

ID of the recipient for excess money transfers.

Example: 148393305
Response
application/json
{
  "userProfileId": 12321323,
  "recipientId": 148393305
}

Get Total Funds

Request

Provides an overview of your account's total valuation and available liquidity across all balances.

Returns total worth, total available (including overdraft), total cash, and overdraft details.

Example (Assuming GBP and USD has 1:1 exchange rate)

ScenarioGBP balanceUSD balanceTotal WorthTotal AvailableOverdraft UsageOverdraft Limit
Positive account value with no overdraft200002000200000
Positive account value with overdraft2000-10019002400100500
Negative account value with overdraft0-100-100400100500
Security
UserToken or PersonalToken
Path
profileIdinteger(int64)required

The profile ID.

currencystringrequired

Currency code (ISO 4217 Alphabetic Code). All values will be converted to this currency.

Example: EUR
curl -i -X GET \
  'https://api.wise.com/v1/profiles/{profileId}/total-funds/EUR' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK - Successfully retrieved total funds.

Bodyapplication/json
totalWorthobject

Total worth of the account, including cash ledger balance and valuation of any asset portfolio if invested.

totalWorth.​valuenumber

Amount value.

Example: 2000
totalWorth.​currencystring

Currency code (ISO 4217 Alphabetic Code).

Example: "EUR"
totalAvailableobject

Total available balance, which is the sum of cash ledger balance and any approved overdraft limit.

totalAvailable.​valuenumber

Amount value.

Example: 2500
totalAvailable.​currencystring

Currency code (ISO 4217 Alphabetic Code).

Example: "EUR"
totalCashobject

Total cash balance across all balances, including group balances but excluding asset portfolios.

totalCash.​valuenumber

Amount value.

Example: 2000
totalCash.​currencystring

Currency code (ISO 4217 Alphabetic Code).

Example: "EUR"
overdraftobject

Overdraft details for the account.

overdraft.​limitobject

Maximum overdraft available through an overdraft program. Zero if no approved overdraft.

overdraft.​usedobject

Portion of the approved overdraft limit currently being utilized.

overdraft.​availableobject

Amount of overdraft currently available (limit minus used).

overdraft.​availableByCurrencyArray of objects

Available overdraft amounts converted to each currency the customer has a balance in.

Response
application/json
{
  "totalWorth": {
    "value": 2000,
    "currency": "EUR"
  },
  "totalAvailable": {
    "value": 2500,
    "currency": "EUR"
  },
  "totalCash": {
    "value": 2000,
    "currency": "EUR"
  },
  "overdraft": {
    "limit": {
      "value": 500,
      "currency": "EUR"
    },
    "used": {
      "value": 0,
      "currency": "EUR"
    },
    "available": {
      "value": 500,
      "currency": "EUR"
    },
    "availableByCurrency": [
      { … }
    ]
  }
}

Balance Statement

Balance statements contain transactional activities on a Wise Multi-Currency Account, including deposits, withdrawals, conversions, card transactions, and fees.

Statements can be retrieved in multiple formats: JSON, CSV, PDF, XLSX, CAMT.053, MT940, or QIF.

Operations

Bank Account Details

Bank account details allow users to receive money into their Wise Multi-Currency Account. Each currency balance can have local bank details (for domestic payments) and international bank details (for SWIFT payments) where available.

Bank account details can be retrieved for existing balances, or new details can be ordered for currencies where they're available but not yet issued.

SchemasOperations

Batch Group

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

Workflow:

  1. Create a batch group with a source currency
  2. Add transfers to the group (up to 1000)
  3. Complete the batch group to close it for modifications
  4. Fund the batch group from a balance or via direct debit

Individual transfers in the group follow standard transfer lifecycle and can be tracked separately.

SchemasOperations

Bulk Settlement

Bulk settlement allows partners to settle multiple transfers in a single bank transfer at the end of a settlement period. This model splits transfer creation/funding from final settlement, allowing Wise to process transfers before receiving funds based on a partner's guarantee.

Use the settlement journal endpoint to submit a list of transfers to be settled, along with the settlement reference that matches your bank transfer payment.

Operations

Card

Manage your customers' cards programmatically. These APIs allow you to retrieve card details, control card status, manage spending permissions, and access sensitive card data securely.

Key capabilities:

  • List and retrieve card details for a profile
  • Update card status (active, frozen, blocked)
  • Control spending permissions (e-commerce, ATM, contactless, etc.)
  • Access sensitive card data (PAN, CVV, PIN) via encrypted JWE payloads

Sensitive card details: Wise is a PCI DSS compliant provider and stores all card data securely. The scope for PCI compliance depends on your use case and will impact how you integrate. For all sensitive card details endpoints, follow the detailed guide.

For ordering new cards, see the Card Order API. For transaction history, see the Card Transaction API.

SchemasOperations

Card Kiosk Collection

These APIs are designed to allow you to print and encrypt your card directly from a kiosk machine. The card information will be sent to our card manufacturer to configure and print the card on-site on a kiosk machine.

The card printing process will automatically begin once the request is received by our card manufacturer.

During the printing process, you will be notified via webhook about any card production status change.

Before using these APIs, make sure to read the guide on kiosk collection.

Please reach out to your Implementation Manager for more information on these APIs.

Testing: In the sandbox environment, use the card production simulation API to test your integration with various production statuses and error scenarios.

Production status flow

These statuses represent the lifecycle of a card production:

  • READY - Card is ready for production. The produce card endpoint can be called.
  • IN_PROGRESS - Card is being produced at the kiosk machine (chip encryption and printing in progress).
  • PRODUCED - Card has been successfully produced and collected from the kiosk. This is a final state.
  • PRODUCTION_ERROR - Card production failed. Check the errorCode to identify the issue, resolve it, then retry using the produce card endpoint.

A card with production status PRODUCED will trigger an asynchronous call to update the associated card order to PRODUCED status.

Card production status flow

Operations

Card Order

With this set of APIs, you will be able to create cards for your customers. You can also retrieve and view the status of your current card orders, as well as the list of available card programs for the user.

On production, each personal profile can order at most 1 physical card and 3 virtual cards. On sandbox, we allow up to 10 physical cards and 30 virtual cards for testing purpose. However, no more than 3 virtual cards can be ordered per day. This limit includes cards and card orders.

Card order status flow

The card order response will contain the status field. The initial status is PLACED or REQUIREMENTS_FULFILLED depending on the requirement fulfillment state:

  • PLACED - The card order is created. The card will be generated once it has fulfilled all the requirements
  • REQUIREMENTS_FULFILLED - The card order has fulfilled all the requirements and the card should be generated in a short while
  • CARD_DETAILS_CREATED - The card has been generated
  • PRODUCED - The physical card has been produced and waiting to be picked up by delivery vendor (physical card only)
  • COMPLETED - The card has been activated and is ready to use. The card order is completed
  • CANCELLED - The card order has been cancelled. This can happen if you reach out to Wise Support to cancel a card order
  • RETURNED - Delivery failed, the physical card has been returned and will be blocked (physical card only)

Card order status state machine

SchemasOperations

Card Transaction

Retrieve information on transactions made on your users' cards.

Transaction types

The possible type values are:

  • ACCOUNT_CREDIT - Receiving money on the card, excluding Visa OCT or Mastercard MoneySend
  • ACCOUNT_FUNDING - Sending money to another card or e-wallet
  • CASH_ADVANCE - Cash disbursement
  • CASH_WITHDRAWAL - ATM withdrawal
  • CHARGEBACK - Currently unused. Reserved for future use
  • CREDIT_TRANSACTION - Visa OCT and Mastercard MoneySend
  • ECOM_PURCHASE - Online purchase
  • POS_PURCHASE - Purchase via a POS terminal
  • REFUND - Partial or full refund of an existing card transaction

Transaction states

The possible state values are:

  • IN_PROGRESS - The transaction has been authorized but not captured
  • COMPLETED - The transaction has been captured and/or settled
  • DECLINED - The transaction has been declined
  • CANCELLED - The transaction has been cancelled
  • UNKNOWN - Default fallback status if the state cannot be confirmed

The transition from CANCELLED to COMPLETED is an edge case. Wise releases the customer funds after 7 days (30 days for pre-authorization) if the merchant has not captured the transaction, and the state becomes CANCELLED. However, the merchant can decide to capture the transaction at a later date, at which point the state will become COMPLETED.

Transaction state flow

Decline reasons

The decline reason field provides information about the specific issue that led to the transaction being declined, helping the merchant and the customer troubleshoot the problem.

While the decline reason field provides valuable information, it may not cover all possible reasons for a decline, such as technical issues or unforeseen circumstances.

New decline reasons may be added in the future, and not all decline reasons are currently documented. Review this documentation regularly to ensure accuracy.

Exercise caution when communicating decline reasons to your customers, as some may not be relevant or may cause confusion.

  • ACCOUNT_INACTIVE - Balance related to the transaction is not active. Ensure that all outstanding actions have been completed before using the card, as this may help avoid potential issues or declines
  • ACCOUNT_SUSPENDED - The transaction has been declined pending further compliance checks. It may have been flagged for potential sanctions issues
  • ATM_PIN_CHANGE_NOT_ALLOWED - PIN change via ATM terminal is not allowed
  • BLOCKED_COUNTRY - Transactions were made in unsupported countries. Check this link to see if the country is included in the list of supported nations. It is possible for a merchant to be based in a supported country and have an address registered in a blocked country, albeit infrequently
  • BLOCKED_SUBSCRIPTION - The system cannot facilitate this transaction as the customer has opted out of recurring payments with this merchant
  • CARD_EXPIRED - The card provided has reached its expiration date, making it invalid for this transaction
  • CARD_FROZEN - The customer or the customer service team has put this card on a temporary hold. If the card has not been frozen by the customer, it may be worth investigating further. To resume spending, advise the customer to unfreeze the card
  • CARD_INACTIVE - The card is either not active or has not been received by the customer, so the transaction cannot proceed
  • CARD_BLOCKED - The card has been blocked and cannot be used anymore
  • CARD_PARTNER_SUSPENDED - The internal team has deactivated the account for compliance reasons related to AML, fraud, or EDD. Contact the team if this is believed to be an error
  • CHIP_PIN_ENTRY_TRIES_EXCEEDED - The PIN is restricted on the chip of the card due to excessive incorrect entries. The blocked PIN can be unlocked at an ATM using specific steps that vary depending on the machine and country, such as PIN management or PIN operations followed by unblocking the PIN
  • CONNECTION_ISSUE - A connection problem occurred during the transaction
  • CONTACTLESS_PIN_ENTRY_REQUIRED - Contactless payment systems sometimes require a PIN for authentication purposes to protect users' accounts from potential fraud or tampering. In Europe, contactless payment transactions that follow one after the other require PIN verification as an additional security measure
  • CREDIT_TRANSACTIONS_NOT_SUPPORTED - Credit is not supported for this specific transaction. Review the Acceptable Use Policy for further information
  • CUMULATIVE_LIMIT_EXCEEDED - In certain jurisdictions, there are restrictions on the amount that can be spent. Refer to spending limits for further details
  • DECLINED_ADVICE - There is a problem with the message from the processor, so it might not be accepted because it could be incomplete or unsafe. This does not indicate a problem with the card. Advise the customer that there was a technical issue with the payment and to try again later
  • INCORRECT_CVV - The customer entered the wrong security code. Advise the customer to check their card details and try again. If the saved card details are correct, they should remove their card details from the merchant's website and add them back again
  • INCORRECT_EXPIRY_DATE - The customer entered the wrong expiration date for their card. If the saved card details are correct, they should remove their card details from the merchant's website and add them back again
  • INCORRECT_PIN - The customer entered their PIN incorrectly. Advise the customer to check their PIN and try again. If the PIN is correct and still fails, suggest resetting the PIN
  • INSUFFICIENT_FUNDS - The customer does not have enough money in their account to make the payment. Advise the customer to add money to their account and try again. In most cases, this will resolve the issue
  • INVALID_3DS_UCAF - The 3D Secure checks failed during the transaction. The customer should try again and request authentication
  • INCORRECT_ARQC - ARQC (Authorization Request Cryptogram) is a cryptogram generated by the card during a transaction, which is validated on the server side. If incorrect, it could indicate a faulty card, a fraudulent attack, or an issue with the POS terminal
  • INCORRECT_ICVV - ICVV (Integrated Circuit Card Verification Value) is a security feature used to validate the authenticity of a card during chip-based transactions. There were problems reading the chip on the card, which may indicate an issue with the card's chip, the terminal, or the transaction process. Wait and try again
  • INVALID_MERCHANT - Transaction from a specific merchant is declined by scheme. The merchant should clarify the exact cause with the scheme
  • INVALID_TRANSACTION - Certain types of transactions are not supported. The customer should ask the merchant to use a different payment method or try a different merchant
  • MANDATE_DCC_NON_SUPPORTED_FOR_CARD_COUNTRY - The transaction was declined because the system does not support conversions for Brazilian cards when BRL is involved. BRL will not be automatically exchanged to other currencies. If the customer wants to continue with the payment, they need to change the currency
  • MANDATE_LOCAL_CASH_WITHDRAWAL_NOT_ALLOWED - ATM withdrawal services are not provided in the country where the transaction is taking place
  • NON_SUPPORTED_CURRENCY - The currency in this transaction is not supported
  • NON_SUPPORTED_MCC_FOR_COUNTRY - Transactions in this category are not supported for customers in the country of purchase. Consider using an alternative payment method or changing merchant
  • PAYMENT_METHOD_DAILY_LIMIT_EXCEEDED - The customer has reached the daily spending limit for the card or their profile. Advise if they would like to update card or profile limit
  • PAYMENT_METHOD_LIFETIME_LIMIT_EXCEEDED - The customer has reached the lifetime spending limit. Advise if they would like to increase their lifetime limit
  • PAYMENT_METHOD_MONTHLY_LIMIT_EXCEEDED - The customer has reached the monthly spending limit for the card or their profile. Advise if they would like to update card or profile limit
  • PAYMENT_METHOD_NOT_ALLOWED - This payment type has been disabled. Advise if they would like to enable the payment type
  • PAYMENT_METHOD_TRANSACTION_LIMIT_EXCEEDED - The customer has exceeded the transaction limit for the card. Advise if they would like to update their card limit
  • PIN_ENTRY_TRIES_EXCEEDED - The customer has reached the maximum number of allowed online PIN entry attempts. Consider implementing a reset PIN feature within the app to help the customer regain access to their card
  • PRE_ACTIVATED_CARD_PIN_ENTRY_REQUIRED - The customer has attempted to make a contactless payment at a POS or ATM, but their card has not been activated for chip and PIN transactions. To modify the card activation strategy for all cards, contact the implementation manager
  • PROCESSING_ERROR - The system is currently experiencing technical difficulties. Advise the customer to try again after a brief period
  • RESTRICTED_MODE - Although rare, restricted mode can occur. Advise the customer to replace their card promptly as the system should have already informed them. In this mode, more secure payment methods like chip and PIN, contactless, mobile wallets, and online payments with 3DS are allowed, while less secure methods like magnetic stripe and online payments without 3DS are not permitted
  • REVERSAL_NOT_MATCHING_AUTH_CURRENCY - The merchant has issued a reversal instruction for a different currency than what was originally requested during the authorization process
  • SCA_SOFT_DECLINE - The transaction cannot proceed due to SCA regulations. Suggest the customer contact the merchant and use a more secure authentication method such as 3DS. For example, the customer can try chip and PIN, or a mobile wallet like Apple Pay or Google Pay
  • SCHEME_BLOCKED_TRANSACTION - This transaction has been flagged by the scheme and cannot be processed
  • SECURITY_CVM_FAILURE - The system has detected that the POS terminal was misconfigured and failed security checks. Suggest the customer use an alternative payment method like contactless or mobile wallets, or recommend asking the merchant to accept a signature instead
  • SECURITY_MAGSTRIPE_SECURE_ELEMENTS_INCORRECT_OR_MISSING - The merchant has entered the wrong type of purchase. Advise the customer to contact the merchant and ask them to correct this issue
  • SECURITY_PIN_ENTRY_REQUIRED - To proceed with this transaction, the customer is required to enter their PIN
  • SUSPECTED_FRAUD - This transaction has been labeled as high-risk by Wise
  • SUSPECTED_FRAUD_AML - This transaction has been flagged as high-risk based on AML compliance protocols. This reason cannot be disclosed to end customers
  • SUSPECTED_FRAUD_COMPLIANCE - The compliance system has flagged this transaction as high-risk. This reason cannot be disclosed to end customers
  • SUSPECTED_FRAUD_CORE_FRAUD - This transaction has been blocked based on fraud policies and procedures
  • SUSPECTED_FRAUD_SANCTIONS - This transaction has been flagged as high-risk based on sanctions list analysis. This reason cannot be disclosed to end customers. This classification is final and cannot be appealed
  • SUSPECTED_FRAUD_SOFT_DECLINE - This e-commerce transaction cannot be processed due to high risk factors. The merchant must complete 3DS before the transaction can be approved
  • TRANSACTION_TYPE_NOT_SUPPORTED - There are restrictions on this type of transaction, and sometimes the scheme will not allow it. Check if spend control is set up to block this transaction
  • UNEXPECTED_ERROR - There may have been a communication error between the merchant's system and the server, but the POS system may have already notified the user of this issue
Operations