v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
recipient

List recipient accounts (v1)

{% admonition type="warning" %} This is a deprecated v1 endpoint. For new integrations please use the v2 list endpoint. {% /admonition %}

Fetch a list of the user's recipient accounts. Use the currency and profile parameters to filter by currency and/or the owning user profile ID. This endpoint does not support pagination, so please filter by currency to ensure a reasonable response time.

Both query parameters are optional.

get/v1/accounts

Query parameters

profileIdinteger

Filter by personal or business profile, returns only those owned by this profile.

currencystring

Filter responses by currency.

Headers

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Response

Array of v1 recipient account objects.

idinteger

Recipient account ID.

businessinteger nullable

Business profile ID (if applicable).

profileinteger

Personal or business profile ID.

accountHolderNamestring

Recipient full name.

currencystring

3 character currency code.

countrystring

2 character country code.

typestring

Recipient type.

userinteger

User that created or owns this recipient.

activeboolean

Status of the recipient.

ownedByCustomerboolean

Whether this account is owned by the sending user.

Example response

[
  {
    "id": 40000000,
    "profile": 30000000,
    "accountHolderName": "John Doe",
    "currency": "GBP",
    "country": "GB",
    "type": "sort_code",
    "details": {
      "legalType": "PRIVATE",
      "sortCode": "040075",
      "accountNumber": "37778842"
    },
    "user": 10000000,
    "active": true,
    "ultimateBeneficiary": {
      "accountNumber": "37778842",
      "bankName": "Wise Payments Limited",
      "bankCode": "026073150",
      "name": {
        "fullName": "John Doe"
      },
      "address": {
        "country": "US"
      },
      "bankAddress": {
        "country": "US"
      }
    }
  }
]