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

List Activities for a Profile

Request

List of activities belonging to user profile.

Activities represent snapshots of performed actions and can be filtered by various parameters to narrow down the results.

Security
UserToken or PersonalToken
Path
profileIdinteger(int64)required

The unique identifier of the profile.

Query
monetaryResourceTypestring

Filter activity by resource type.

Enum"ACCRUAL_CHARGE""ACQUIRING_PAYMENT""ASSETS_WITHDRAWAL""BALANCE_CASHBACK""BALANCE_INTEREST""BALANCE_TRANSACTION""BANK_DETAILS_ORDER""BATCH_TRANSFER""CARD_CASHBACK""CARD_ORDER"
Example: monetaryResourceType=TRANSFER
statusstring

Filter by activity status.

Enum ValueDescription
REQUIRES_ATTENTION

Requires an end user attention.

IN_PROGRESS

Indicates that this activity has yet to be completed. (Example: In progress Top Up)

UPCOMING

Indicates that this activity is scheduled to happen in the future. By default these activities will only be shown 2 days before the date. (Example: A scheduled transfer)

COMPLETED

Indicates that this activity is at its end state. (Example: A completed Top Up)

CANCELLED

Indicates that this activity is cancelled. (Example: A Top Up is cancelled)

Example: status=IN_PROGRESS
sincestring(date-time)

Filter activity list after a certain timestamp. Use ISO 8601 format.

Example: since=2025-03-10T11:56:30.376Z
untilstring(date-time)

Filter activity list until a certain timestamp. Use ISO 8601 format.

Example: until=2025-03-30T23:59:59.999Z
nextCursorstring

Pagination cursor returned from a previous response. Use the cursor value from the response to fetch the next page of activities.

Example: nextCursor=
sizeinteger[ 1 .. 100 ]

Desired size of query. Min 1, max 100, and default value is 10 if not specified.

Default 10
curl -i -X GET \
  'https://api.wise.com/v1/profiles/{profileId}/activities?monetaryResourceType=TRANSFER&status=IN_PROGRESS&since=2025-03-10T11%3A56%3A30.376Z&until=2025-03-30T23%3A59%3A59.999Z&size=10' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK - Successfully retrieved activities.

Bodyapplication/json
cursorstring or null

Pagination cursor. Pass this value as the nextCursor query parameter to fetch the next page of results. Returns null when there are no more pages.

activitiesArray of objects

Array of activity objects.

activities[].​idstring

Activity id.

Example: "TU9ORVRBUllfQUNUSVZJVFk6OjE0NTU4OTk4OjpDQVJEX1RSQU5TQUNUSU9OOjozNDMwNDk="
activities[].​typestring
Enum"ACQUIRING_PAYMENT""AUTO_CONVERSION""BALANCE_ADJUSTMENT""BALANCE_ASSET_FEE""BALANCE_CASHBACK""BALANCE_DEPOSIT""BALANCE_HOLD_FEE""BALANCE_INTEREST""BANK_DETAILS_ORDER""BATCH_TRANSFER"
activities[].​resourceobject

The resource associated with the activity.

activities[].​titlestring

Title of the Activity.

Value can be formatted with custom tags to put emphasis on important wordings.

Supported custom tags:

  • <strong>: Indicates strong emphasis on words that the end user should pay attention to.
  • <positive>: Indicates a positive transaction (e.g., top up to balance is successful).
  • <negative>: Indicates a negative transaction (e.g., amount is deducted from a balance).
  • <strikethrough>: (Coming soon) Indicates the negation of an activity (e.g., transfer is cancelled).
Example: "<strong>Test Payment</strong>"
activities[].​descriptionstring

A short description that briefly summarizes the activity.

activities[].​primaryAmountstring

A currency formatted text that describe the primary amount of transaction.

Value of this field is intended to have units in it and should not be treated as a numeric value.

One example of primaryAmount would be: "Topping up 100 USD balance with 80 GBP". In this case 100 USD would be the primaryAmount of the activity.

Example: "150 JPY"
activities[].​secondaryAmountstring

A currency formatted text that describe the secondary amount of transaction.

Value of this field is intended to have units in it and should not be treated as a numeric value. Value can be empty if there is no good candidate as secondary amount.

One example of secondaryAmount would be: "Topping up 100 USD balance with 80 GBP". In this case 80 GBP would be the secondaryAmount of the activity.

Example: "1.50 SGD"
activities[].​statusstring
Enum ValueDescription
REQUIRES_ATTENTION

Requires an end user attention.

IN_PROGRESS

Indicates that this activity has yet to be completed. (Example: In progress Top Up)

UPCOMING

Indicates that this activity is scheduled to happen in the future. By default these activities will only be shown 2 days before the date. (Example: A scheduled transfer)

COMPLETED

Indicates that this activity is at its end state. (Example: A completed Top Up)

CANCELLED

Indicates that this activity is cancelled. (Example: A Top Up is cancelled)

activities[].​createdOnstring(date-time)

Timestamp when the activity was created.

Example: "2023-01-01T00:00:00.000Z"
activities[].​updatedOnstring(date-time)

Timestamp when the activity was last modified.

Example: "2023-01-01T00:00:00.000Z"
Response
application/json
{
  "cursor": "WyJQUklPUklUWSIsMTAwMDAxNjY5NzA4MjI0MDAwMDE2MDk5OV0=",
  "activities": [
    {
      "id": "TU9ORVRBUllfQUNUSVZJVFk6OjE0NTU4OTk4OjpDQVJEX1RSQU5TQUNUSU9OOjozNDMwNDk=",
      "type": "CARD_PAYMENT",
      "resource": { … },
      "title": "<strong>Test Payment</strong>",
      "description": "",
      "primaryAmount": "150 JPY",
      "secondaryAmount": "1.50 SGD",
      "status": "COMPLETED",
      "createdOn": "2023-01-01T00:00:00.000Z",
      "updatedOn": "2023-01-01T00:00:00.000Z"
    }
  ]
}

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