EQequalsmoney
Recipients

Validate a bank account

Validates the provided bank account details. You can use this before you create a recipient.

By default, this endpoint isn't enabled. If you'd like to use it, please contact us.

post/recipients/validate/account

Request

Query parameters

accountIdstring required

The ID of the account to work with.

Example:F50091
'paymentNetworkDetails'
OR
string[]

Request body

countrystring required

The country, in ISO 3166-1 alpha-2 format.

ibanstring nullable

The International Bank Account Number (IBAN).

numberstring nullable

The bank account number.

codestring nullable

The bank sort code.

Example request

{
  "country": "GB",
  "iban": "PK94XAOM0400102322019126",
  "number": "55555555",
  "code": "12-34-56"
}

Response

OK

countryCodestring nullable
nationalIdstring nullable
accountNumberstring nullable
statusstring nullable
commentstring nullable
recommendedNatIdstring nullable
recommendedAcctstring nullable
recommendedBICstring nullable
refstring nullable
groupstring nullable
bic8string nullable
dataStorestring nullable
noBranchstring nullable
isoAddrstring nullable
payBranchTypestring nullable
freeTokenstring nullable

Example response

{
  "countryCode": "GB",
  "nationalId": "string",
  "accountNumber": "string",
  "status": "PASS",
  "comment": "string",
  "recommendedNatId": "string",
  "recommendedAcct": "string",
  "recommendedBIC": "string",
  "ref": "string",
  "group": "string",
  "branchDetails": [
    {
      "bankName": "Barclays Bank",
      "branch": "London",
      "street": "1 Churchill Place",
      "city": "London",
      "postZip": "E14 5HP",
      "region": "London",
      "country": "UK",
      "codeDetails": {
        "codeName1": "string",
        "codeValue1": "string",
        "codeName2": "string",
        "codeValue2": "string",
        "codeName3": "string",
        "codeValue3": "string",
        "codeName4": "string",
        "codeValue4": "string"
      },
      "additionalData": {
        "ssiAvailable": "Y",
        "payServiceAvailable": "Y",
        "contactsAvailable": "N",
        "messageAvailable": "N",
        "holidayAvailable": "Y",
        "sepaDetails": {
          "ctStatus": "NO",
          "ddStatus": "NO",
          "bbStatus": "NO"
        },
        "bankToken": "string",
        "branchTypeLabel": "string"
      }
    }
  ],
  "headOfficeDetails": {
    "bankName": "Barclays Bank",
    "branch": "London",
    "street": "1 Churchill Place",
    "city": "London",
    "postZip": "E14 5HP",
    "region": "London",
    "country": "UK",
    "codeDetails": {
      "codeName1": "string",
      "codeValue1": "string",
      "codeName2": "string",
      "codeValue2": "string",
      "codeName3": "string",
      "codeValue3": "string",
      "codeName4": "string",
      "codeValue4": "string"
    },
    "additionalData": {
      "ssiAvailable": "Y",
      "payServiceAvailable": "Y",
      "contactsAvailable": "N",
      "messageAvailable": "N",
      "holidayAvailable": "Y",
      "sepaDetails": {
        "ctStatus": "NO",
        "ddStatus": "NO",
        "bbStatus": "NO"
      },
      "bankToken": "string",
      "branchTypeLabel": "string"
    }
  },
  "paymentBicDetails": {
    "bankName": "Barclays Bank",
    "branch": "London",
    "street": "1 Churchill Place",
    "city": "London",
    "postZip": "E14 5HP",
    "region": "London",
    "country": "UK",
    "codeDetails": {
      "codeName1": "string",
      "codeValue1": "string",
      "codeName2": "string",
      "codeValue2": "string",
      "codeName3": "string",
      "codeValue3": "string",
      "codeName4": "string",
      "codeValue4": "string"
    },
    "additionalData": {
      "ssiAvailable": "Y",
      "payServiceAvailable": "Y",
      "contactsAvailable": "N",
      "messageAvailable": "N",
      "holidayAvailable": "Y",
      "sepaDetails": {
        "ctStatus": "NO",
        "ddStatus": "NO",
        "bbStatus": "NO"
      },
      "bankToken": "string",
      "branchTypeLabel": "string"
    }
  },
  "paymentNetworkDetails": [
    {
      "paymentNetwork": "SWIFT",
      "participantId": "string",
      "participantName": "string",
      "currencyCode": "AED"
    }
  ],
  "bic8": "N",
  "dataStore": "N",
  "noBranch": "N",
  "isoAddr": "N",
  "payBranchType": "D",
  "freeToken": "string"
}

Changes

No recorded changes to this operation across all 1 revision of this API.