Verify a beneficiary account

APIs//

Verify a beneficiary account

Request

Security

basicAuth

Headers

WP-Api-Versionstringrequired

Example:2025-01-01

WP-CorrelationIdstring

Optional ID to trace requests, if not provided, it is generated.

Example:15cd16b2-7b82-41cb-9b11-21be9dacad88

Bodyapplication/json

merchantobjectrequired

Note: View our bank coverage guide for country specific requirements.

instructionsArray of objectsrequired

Note: Currently only one instruction is accepted.

{
  "merchant": {
    "entity": "default"
  },
  "instructions": [
    {
      "party": {
        "type": "beneficiary",
        "payoutInstrument": {
          "type": "bankAccount",
          "currency": "GBP",
          "iban": "GB41CITI18500818404062",
          "accountHolderName": "John Smith",
          "accountNumber": "123456",
          "bankCode": "184758",
          "bankName": "Demo Bank",
          "branchCode": "1234",
          "swiftBic": "DBbic01",
          "accountType": "checking",
          "address": {
            "type": "personal",
            "address1": "Main Bvd",
            "address2": "No 1",
            "city": "London",
            "postalCode": "012345",
            "countryCode": "GB"
          }
        },
        "personalDetails": {
          "type": "personal",
          "title": "Mr",
          "firstName": "John",
          "middleName": "",
          "lastName": "Smith",
          "dateOfBirth": "2000-01-01",
          "companyName": "Co Name",
          "dateOfIncorporation": "2025-01-01",
          "email": "john@domain.com",
          "phones": [
            {
              "number": "7777777777",
              "prefix": "44"
            }
          ]
        }
      },
      "expandableKeyValuePairs": {
        "key": "value"
      }
    }
  ]
}

Responses

OK response if the request is valid

Bodyapplication/json

outcomestringrequired

All possible outcomes and description can be found in the below table:

outcome	message
fullMatch	Account Details Matched
businessAccountNameMatched	Account name matches but the account is a business account, not a personal account
partialMatch	Close match found
businessAccountCloseMatch	Close match found for account name but the account is a business account, not a personal account
noMatch	Account name and account type do not match
accountDoesNotExist	Account does not exist
noResponse	The bank did not respond to the account name check request. Try again later.
	Unexpected system error occurred. Try again later.
accountNotSupported	Account does not support account name check requests
accountSwitched	The account has been switched using the Current Account Switching Service
notEnrolled	The account name check could not be completed as the bank does not accept account name check requests
wrongParticipant	The account name check cannot be completed for the account number and sort code provided
secondaryAccountIdNotFound	The secondary account id is not valid
personalAccountNameMatched	The account name matches but the account is a personal account, not a business account
personalAccountCloseMatch	Close match found for account name but the account is a personal account, not a business account
accountActive	Account is active but Name match unavailable for this account
cannotValidate	Unable to Validate the Account Details
accountClosed	The Account is either Closed or Unavailable to receive payments

messagestring

Description message.

actualAccountHolderNamestring

Account owner name after the payload is processed. Availability is subject to market standard.

Response

{
  "outcome": "fullMatch",
  "message": "Account Details Matched",
  "actualAccountHolderName": ""
}