Skip to content

Recipient Accounts

The recipient is the person receiving the funds. Sometimes called the beneficiary.

If using the pre-global versioned APIs (legacy), be sure to check the endpoint version path, as our recipient account endpoints use a mixture of v1 and v2.

All recipient IDs are cross compatible with either version.

Schemas
Operations

Recipient Account

idinteger, (int64)

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

Example:40000000
creatorIdinteger, (int64)

Account entity that owns the recipient account.

Example:41000000
profileIdinteger, (int64)

Specific profile that owns the recipient account.

Example:30000000
nameobject

Recipient name details.

currencystring

3-character currency code.

Example:"GBP"
countrystring

2-character country code.

Example:"GB"
typestring

Recipient account type.

Example:"SortCode"
legalEntityTypestring

Entity type of recipient account.

Example:"PERSON"
activeboolean

Status of the recipient account.

Example:true
detailsobject

Contains the details of the recipient account specific to its currency and type. The fields required (in the request) or present (in the response) vary depending on currency route and recipient type (e.g., sort code, IBAN, SWIFT, email).

commonFieldMapobject

Map of key lookup fields for the account.

Example:
{
  "accountNumberField": "accountNumber",
  "bankCodeField": "sortCode"
}
hashstring

Account hash for tracking changes to recipient details. This is useful for re-running any validation checks on the recipient, for example against fraud engines. The hash remains constant unless the recipient's name or information in the details object changes.

Example:"666ef880f8aa6113fa112ba6531d3ed2c26dd9fgbd7de5136bfb827a6e800479"
accountSummarystring

Summary of account details for ease of lookup. Can be used to display recipient details in your UI.

Example:"(04-00-75) 37778842"
longAccountSummarystring

Longer account details summary. Can be used to display recipient details in your UI.

Example:"GBP account ending in 8842"
displayFieldsArray of objects

Lookup fields (key/label/value) for rendering in your front-end. Allows you to build a UI containing all the dynamic fields for a recipient individually.

Example:
[
  {
    "key": "details/sortCode",
    "label": "UK sort code",
    "value": "04-00-75"
  },
  {
    "key": "details/accountNumber",
    "label": "Account number",
    "value": "37778842"
  }
]
isInternalboolean

Indicates whether recipient is internal.

Example:false
ownedByCustomerboolean

Inidicates if recipient account belongs to profile owner.

Example:false
ultimateBeneficiaryobject or null

The details for the ultimate beneficiary of this recipient.

confirmationsobject

Contains verification results for the recipient's details. Only populated for currencies with recipient verification enabled (CNY, KRW, INR, IDR, EUR).

See the Recipient verification guides for details about how to handle this verification data by currency.

{
  "id": 40000000,
  "creatorId": 41000000,
  "profileId": 30000000,
  "name": {
    "fullName": "John Doe",
    "givenName": null,
    "familyName": null,
    "middleName": null,
    "patronymicName": null,
    "cannotHavePatronymicName": null
  },
  "currency": "GBP",
  "country": "GB",
  "type": "SortCode",
  "legalEntityType": "PERSON",
  "active": true,
  "details": {
    "reference": null,
    "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"
    }
  ],
  "isInternal": false,
  "ownedByCustomer": false,
  "ultimateBeneficiary": {
    "accountNumber": "37778842",
    "bankName": "Wise Payments Limited",
    "bankCode": "026073150",
    "name": {
      "fullName": "John Doe"
    },
    "address": {
      "country": "US",
      "firstLine": "string",
      "postCode": "string",
      "city": "string",
      "state": "string"
    },
    "bankAddress": {
      "country": "US",
      "firstLine": "string",
      "postCode": "string",
      "city": "string",
      "state": "string"
    }
  },
  "confirmations": {
    "acceptedOutcomes": false,
    "acceptedAt": null,
    "quoteId": null,
    "outcomes": [
      { … }
    ]
  }
}