v5

latestOpenAPI 3.1.02026-07-262421791.5 MB

recipient

Check account and quote compatibility (v1)

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

{% admonition type="info" %} Use this version if you are fetching recipients through the v1 API. There are no functional differences between v1 and v2, but the field paths referenced in the response differ between the v1 and v2 recipient resources. {% /admonition %}

Use this endpoint to check the compatibility of a recipient account with a quote before creating a transfer. This validation includes:

Re-validating the recipient account details
Checking all required fields are present (e.g., recipient address for USD transfers)
Verifying account details with the recipient's bank (for supported currencies)

This endpoint is optional but recommended to identify potential issues before transfer creation.

{% admonition type="info" %} The confirmations field is only populated for currencies with recipient verification enabled. If absent, only standard validations apply. {% /admonition %}

post/v1/accounts/{accountId}/quotes/{quoteId}/compatibility

Path parameters

accountIdinteger required

Recipient account ID.

quoteIdstring uuid required

Quote ID.

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

Compatibility result including any verification outcomes. See Verifying Recipient Details for details on handling the confirmations object.

accountIdinteger

Recipient account ID.

quoteIdstring

Quote ID.

Example response

{
  "accountId": 40000000,
  "quoteId": "00000000-0000-0000-0000-000000000000",
  "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"
          }
        ]
      }
    ]
  }
}