Sign in

v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
recipient

Retrieve recipient account requirements dynamically (step-by-step)

POST the same recipient account payload that you will POST to /v1/accounts.

Use this endpoint after setting any field that has refreshRequirementsOnChange=true in the GET response, to discover any additional required fields.

See the GET endpoint for a full overview of how the account requirements flow works.

post/v1/quotes/{quoteId}/account-requirements

Path parameters

quoteIdstring required

Quote ID (supports long or UUID based IDs).

Query parameters

originatorLegalEntityType'BUSINESS' | 'PRIVATE'

Legal entity type override for the actual sender.

Headers

Accept-Minor-Version1

Set to 1 to enable v1.1.

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.

Request body

currencystring

3 character currency code.

typestring

Recipient account type (currency/route-specific), e.g. sort_code, iban, email.

profileinteger

Personal or business profile ID of the sender. It is highly advised to pass the business profile ID in this field if your business account is managed by multiple users, so that the recipient can be accessed by all users authorized on the business account.

accountHolderNamestring

Recipient full name.

ownedByCustomerboolean

Indicates whether the recipient account is owned by the profile owner (self-transfer), such as a user sending money to their own account in another country or currency. Set to true for self-transfers. We strongly recommend setting this field, as distinguishing self-transfers from third-party transfers improves routing and processing efficiency.

Example request

{
  "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"
    }
  }
}

Response

Updated account requirements based on provided data.

typestring

Requirement group identifier (route/payout-method specific).

titlestring

Human-readable title for the requirement group.

usageInfostring

Optional usage/help text.

Example response

[
  {
    "type": "south_korean_paygate",
    "title": "PayGate",
    "usageInfo": null,
    "fields": [
      {
        "name": "E-mail",
        "group": [
          {
            "key": "email",
            "name": "E-mail",
            "type": "text",
            "refreshRequirementsOnChange": false,
            "required": true,
            "displayFormat": null,
            "example": "example@example.ex",
            "minLength": null,
            "maxLength": null,
            "validationRegexp": "^[^\\s]+@[^\\s]+\\.[^\\s]{2,}$",
            "validationAsync": null,
            "valuesAllowed": null
          }
        ]
      },
      {
        "name": "Recipient type",
        "group": [
          {
            "key": "legalType",
            "name": "Recipient type",
            "type": "select",
            "refreshRequirementsOnChange": false,
            "required": true,
            "displayFormat": null,
            "example": "",
            "minLength": null,
            "maxLength": null,
            "validationRegexp": null,
            "validationAsync": null,
            "valuesAllowed": [
              {
                "key": "PRIVATE",
                "name": "Person"
              }
            ]
          }
        ]
      },
      {
        "name": "Full Name",
        "group": [
          {
            "key": "accountHolderName",
            "name": "Full Name",
            "type": "text",
            "refreshRequirementsOnChange": false,
            "required": true,
            "displayFormat": null,
            "example": "",
            "minLength": 2,
            "maxLength": 140,
            "validationRegexp": "^[0-9A-Za-zÀ-ÖØ-öø-ÿ-_()'*,.%#^@{}~<>+$\"\\[\\]\\\\ ]+$",
            "validationAsync": null,
            "valuesAllowed": null
          }
        ]
      },
      {
        "name": "Recipient's Date of Birth",
        "group": [
          {
            "key": "dateOfBirth",
            "name": "Recipient's Date of Birth",
            "type": "date",
            "refreshRequirementsOnChange": false,
            "required": true,
            "displayFormat": null,
            "example": "",
            "minLength": null,
            "maxLength": null,
            "validationRegexp": "^\\d{4}\\-\\d{2}\\-\\d{2}$",
            "validationAsync": null,
            "valuesAllowed": null
          }
        ]
      },
      {
        "name": "Recipient Bank Name",
        "group": [
          {
            "key": "bankCode",
            "name": "Recipient Bank Name",
            "type": "select",
            "refreshRequirementsOnChange": false,
            "required": true,
            "displayFormat": null,
            "example": "Choose recipient bank",
            "minLength": null,
            "maxLength": null,
            "validationRegexp": null,
            "validationAsync": null,
            "valuesAllowed": [
              {
                "key": "",
                "name": "Choose recipient bank"
              },
              {
                "key": "004",
                "name": "Example Bank A"
              },
              {
                "key": "011",
                "name": "Example Bank B"
              }
            ]
          }
        ]
      },
      {
        "name": "Account number (KRW accounts only)",
        "group": [
          {
            "key": "accountNumber",
            "name": "Account number (KRW accounts only)",
            "type": "text",
            "refreshRequirementsOnChange": false,
            "required": true,
            "displayFormat": null,
            "example": "1254693521232",
            "minLength": 10,
            "maxLength": 16,
            "validationRegexp": null,
            "validationAsync": null,
            "valuesAllowed": null
          }
        ]
      }
    ]
  }
]