Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Wise recipient API

Recipient or beneficiary is the one who will receive the funds.Recipient account endpoints use a mixture of our v1 and v2 APIs. Please ensure you address the right version to get the expected results.{% admonition type="info" %}All recipient IDs are cross compatible with v1 and v2.{% /admonition %}

Wise recipient API is one of 47 APIs that Wise publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include recipient. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 11 operations across 8 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0.

Requests are made against 2 base URLs: https://api.wise.com, https://api.wise-sandbox.com.

11 operations 8 paths 5 schemas 1 DELETE5 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
Base URL
https://api.wise.com/v2
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Basic
Resource Areas
1

Authentication & Security 4

Wise recipient API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (UserToken). It accepts HTTP bearer tokens (JWT) (PersonalToken). It accepts HTTP bearer tokens (JWT) (ClientCredentialsToken). It accepts HTTP basic authentication (BasicAuth).

  • UserToken — User Access Token for making API calls on behalf of a Wise user. Can be obtained via two OAuth 2.0 flows: - registrationcode grant: For partners creating users…
  • PersonalToken — Personal API Token for individual personal or small business users. Generated from Wise.com Settings Connect and manage apps API tokens. Has limited API access…
  • ClientCredentialsToken — Application-level token for partner operations that don't require a specific user context, such as bulk settlement and card spend controls. Obtained via POST /…
  • BasicAuth — Basic Authentication using your Client ID and Client Secret as the username and password. Client credentials are provided by Wise when your partnership begins.…

Paths & Operations 11

Across 8 paths, the API surfaces 11 operations — 1 DELETE, 5 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

recipient 11

Recipient or beneficiary is the one who will receive the funds. Recipient account endpoints use a mixture of our v1 and v2 APIs. Please ensure you address the right version to get…

GET
/v1/accountsdeprecated
List recipient accounts (v1)
recipientListV1 3 params → 200429
POST
/v1/accounts
Create a recipient account
recipientCreate 2 params body → 200400401429
GET
/v2/accounts
List recipient accounts
recipientList 11 params → 200401403429
GET
/v1/accounts/{accountId}deprecated
Get account by ID (v1)
recipientGetV1 2 params → 200429
GET
/v2/accounts/{accountId}
Get account by ID
recipientGet 2 params → 200429
DELETE
/v2/accounts/{accountId}
Deactivate a recipient account
recipientDeactivate 2 params → 200429
GET
/v1/quotes/{quoteId}/account-requirements
Retrieve recipient account requirements dynamically
recipientAccountRequirementsGet 5 params → 200401403404429
POST
/v1/quotes/{quoteId}/account-requirements
Retrieve recipient account requirements dynamically (step-by-step)
recipientAccountRequirementsPost 4 params body → 200429
POST
/v1/accounts/{accountId}/quotes/{quoteId}/compatibilitydeprecated
Check account and quote compatibility (v1)
recipientCompatibilityCheckV1 3 params → 200429
POST
/v2/accounts/{accountId}/quotes/{quoteId}/compatibility
Check account and quote compatibility
recipientCompatibilityCheck 3 params → 200429
PATCH
/v2/accounts/{accountId}/confirmations
Accept confirmation outcomes
recipientConfirmationsAccept 3 params body → 200429

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are recipient (18 properties), recipient-v1 (12 properties), recipient-create-request (6 properties), confirmations (4 properties). Each schema is shown below with its type and property counts.

recipient
object
The accountSummary and longAccountSummary fields can be used to represent the recipient's details in your UI. The displayFields array allows you to build a UI…
18 properties
recipient-v1
object
Deprecated v1 recipient account object. For new integrations, use the v2 resource which includes additional fields such as displayFields, accountSummary, and l…
12 properties
confirmations
object
Verification results for the recipient's details. Only populated for currencies with recipient verification enabled (KRW, INR, IDR, EUR). See the [Verifying Re…
4 properties
account-requirements-response
array
Dynamic account-requirements response used to build recipient forms. The structure and the fields returned vary by currency, recipient type, route, and sometim…
recipient-create-request
object
Create a recipient (beneficiary) account request for POST /v1/accounts. The required fields inside details depend on currency/route; use the account-requiremen…
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wise-recipient-api-openapi.yml Raw ↑

Other APIs Wise publishes across the network.

Wise 3ds API
Wise activity API
Wise address API
Wise balance API
Wise balance-statement API
Wise bank-account-details API
Wise batch-group API
Wise bulk-settlement API
Wise card API
Wise card-kiosk-collection API
Wise card-order API
Wise card-sensitive-details API