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.

SecurityCommonAuth
Request
query Parameters
accountId
required
string

The ID of the account to work with.

Example: accountId=F50091
Request Body schema: application/json

Body

country
required
string <= 2 characters

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

iban
string or null

The International Bank Account Number (IBAN).

number
string or null

The bank account number.

code
string or null

The bank sort code.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

415

Unsupported Media Type

422

Unable to process the request

429

Too Many Requests

500

Internal Server Error

post/recipients/validate/account
Request samples
application/json
{
  • "country": "GB",
  • "iban": "PK94XAOM0400102322019126",
  • "number": "55555555",
  • "code": "12-34-56"
}
Response samples
application/json
{
  • "countryCode": "GB",
  • "nationalId": "string",
  • "accountNumber": "string",
  • "status": "PASS",
  • "comment": "string",
  • "recommendedNatId": "string",
  • "recommendedAcct": "string",
  • "recommendedBIC": "string",
  • "ref": "string",
  • "group": "string",
  • "branchDetails": [
    ],
  • "headOfficeDetails": {
    },
  • "paymentBicDetails": {
    },
  • "bic8": "N",
  • "dataStore": "N",
  • "noBranch": "N",
  • "isoAddr": "N",
  • "payBranchType": "D",
  • "freeToken": "string"
}