Create a recipient account

Creates a recipient account. A recipient is a person or institution who is the ultimate beneficiary of your payment.

Recipient data includes three data blocks:

• General data - the personal details of an individual and basic information about a business.
• Bank details - account numbers, routing numbers, and other region-specific bank details.
• Address details - country and street address of an individual or business.

Notes:

• Date of Birth is optional; consult the account-requirements APIs to confirm if it is needed or contact Wise Support.
• ownedByCustomer is optional but strongly recommended for self-transfers.
• Email recipients: testing transfers to email recipients in sandbox is not currently possible.

Refund recipients:

• Use refund=true query parameter.

Bank account data

There are many different variations of bank account details needed depending on recipient target currency. For example:

• GBP — sort code and account number
• BGN, CHF, DKK, EUR, GEL, GBP, NOK, PKR, PLN, RON, SEK — IBAN
• USD — routing number, account number, account type
• INR — IFSC code, account number
• etc.

Address data

Recipient address data is required only if target currency is USD, PHP, THB or TRY, or if the source currency is USD or AUD.

Address fields can include:

• Country
• State (US, Canada, Brazil)
• City
• Address line
• Zip code

accountHolderName rules

• Personal recipients: Full names must include more than one name, and both first and last name must have more than one character. Numbers are not allowed.
• Business recipients: Business names must be in full and can be a single name. The full name cannot be just a single character, but can be made up of a set of single characters (e.g. "A" is not permitted but "A 1" or "A1" is permitted).
• Special characters _()'*,. are allowed for personal and business names.
• In general the following regex describes permitted characters: [0-9A-Za-zÀ-ÖØ-öø-ÿ-_()'*,.\s].

Recipient requirements vary depending on recipient type/currency route. A GBP example is provided here.<br> Many fields may be null in examples. To determine which fields are required for which currency, use the Recipient Requirements endpoint.

Create a refund recipient account

POST /v1/accounts?refund=true

Sometimes we may need to refund the transfer back to the sender - see the transfer status here for cases when this may happen.

A refund recipient is a person or institution where we will refund transfer the money back to if necessary. This is not always a mandatory resource to create. If the funds are sent over a fast local payment network we can usually infer the refund recipient from the bank transaction that funded the transfer. Please discuss this with your Wise implementation team if you are unsure if the refund recipient is needed.

If funds are sent using a slow domestic payment network, or you are using a bulk settlement model, we may require you to share the bank details of the source bank account.

The format of the request payload for refund recipient creation will be different depending on the currency you will send transfers from. You may use the account requirements endpoint to understand the payload requirements when creating the refund recipient for a specific currency.

The refund recipient account ID returned in the response is used as sourceAccount when creating transfers.

Create an email recipient account

POST /v1/accounts

{% admonition type="warning" %} Please contact us before attempting to use email recipients. We do not recommend using this feature except for certain use cases. {% /admonition %}

If you don't know recipient bank account details you can set up an email recipient; Wise will collect bank details directly from the recipient.

Wise will email your recipient with a link to collect their bank account details securely. After the bank account details have been provided Wise will complete your transfer.

It's best to confirm that this recipient type is available to your transaction by checking if the "type": "email" class is present in the response from GET /v1/quotes/{quoteId}/account-requirements — see account requirements for more information on how to use this endpoint.

If planning to send multiple currencies to a single recipient, you will need to create a separate email recipient resource for this beneficiary, for every currency you intend to send to them. We highly encourage you to provide the {profileId} if your recipient is receiving a payment from your Business account, especially if you have multiple businesses, or have multiple users administrating your business account.

Please be aware of the following caveats:

• Testing of transfers to email recipients in sandbox is not currently possible.
• Recipients will be required to enter bank details every time a payment is made.
• We highly encourage you to provide the profileId if your recipient is receiving a payment from your Business account, especially if you have multiple businesses, or have multiple users administrating your business account.
• Please refer to our help page on how this works and any additional constraints not mentioned in this section.

{
  "currency": "GBP",
  "type": "sort_code",
  "profile": 30000000,
  "accountHolderName": "John Doe",
  "ownedByCustomer": true,
  "details": {
    "legalType": "PRIVATE",
    "sortCode": "040075",
    "accountNumber": "37778842",
    "dateOfBirth": "1961-01-01"
  },
  "ultimateBeneficiary": {
    "accountNumber": "37778842",
    "bankName": "Wise Payments Limited",
    "bankCode": "026073150",
    "name": {
      "fullName": "John Doe"
    },
    "address": {
      "country": "US"
    },
    "bankAddress": {
      "country": "US"
    }
  }
}

{
  "id": 40000000,
  "creatorId": 41000000,
  "profileId": 30000000,
  "name": {
    "fullName": "John Doe"
  },
  "currency": "GBP",
  "country": "GB",
  "type": "SortCode",
  "legalEntityType": "PERSON",
  "active": true,
  "details": {
    "sortCode": "040075",
    "accountNumber": "37778842",
    "hashedByLooseHashAlgorithm": "ad245621b974efa3ef870895c3wer419a3f01af18a8a5790b47645dba6304194"
  },
  "commonFieldMap": {
    "accountNumberField": "accountNumber",
    "bankCodeField": "sortCode"
  },
  "hash": "666ef880f8aa6113fa112ba6531d3ed2c26dd9fgbd7de5136bfb827a6e800479",
  "accountSummary": "(04-00-75) 37778842",
  "longAccountSummary": "GBP account ending in 8842",
  "displayFields": [
    {
      "key": "details/sortCode",
      "label": "UK sort code",
      "value": "04-00-75"
    },
    {
      "key": "details/accountNumber",
      "label": "Account number",
      "value": "37778842"
    }
  ],
  "ultimateBeneficiary": {
    "accountNumber": "37778842",
    "bankName": "Wise Payments Limited",
    "bankCode": "026073150",
    "name": {
      "fullName": "John Doe"
    },
    "address": {
      "country": "US"
    },
    "bankAddress": {
      "country": "US"
    }
  },
  "confirmations": {
    "outcomes": [
      {
        "type": "NAME_MATCHING",
        "timestamp": "2024-11-11T23:58:11.105916743Z",
        "outcome": "PARTIAL_FAILURE",
        "requiresCustomerAcceptance": true,
        "fieldsChecked": [
          "name/fullName",
          "details/accountNumber"
        ],
        "providedName": "John Doe",
        "resolvedName": "Joe Doe",
        "message": "The name entered is slightly different to the name on the account.",
        "recommendedUpdates": [
          {
            "path": "name/fullName",
            "value": "Joe Doe"
          }
        ]
      }
    ]
  }
}