Sign in

v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
recipient

Deactivate a recipient account

Deletes a recipient by changing its status to inactive ("active": false).

Requesting to delete a recipient that is already inactive returns HTTP 403 (Forbidden).

{% admonition type="info" %} Only active recipients can be deleted and a recipient cannot be reactivated, however you can create a new recipient with the same details instead if necessary. {% /admonition %}

delete/v2/accounts/{accountId}

Path parameters

accountIdinteger required

Recipient account 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

Recipient returned with active=false.

idinteger

ID of the recipient. Use the returned id as sourceAccount to specify the refund recipient when creating transfers.

creatorIdinteger

Account entity that owns the recipient account.

profileIdinteger

Specific profile that owns the recipient account.

currencystring

3 character currency code.

countrystring

2 character country code.

typestring

Recipient type.

legalEntityTypestring

Entity type of recipient.

activeboolean

Status of the recipient.

commonFieldMapobject

Map of key lookup fields on the account.

hashstring

Account hash for change tracking.

accountSummarystring

Summary of account details for ease of lookup.

longAccountSummarystring

Account details summary.

isInternalboolean

Indicates whether recipient is internal.

ownedByCustomerboolean

If recipient account belongs to profile owner.

Example response

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