Counterparty Validation

This section explains how to validate external counterparty information before initiating outbound payments.

Before you initiate outbound payments we strongly recommend to use this API to check validity of the counterparty values. Our platform applies necessary checks as per respective regulations including Pay.UK Confirmation of Payee, Vocalink Modulus Validation or similar checks for IBANs.

Please contact to your account manager for more information about expected UX journey for Pay.UK CoP and error handling approaches.

Validate external counterparty

post

/v1/partner/payments/customers/{customerId}/validate-external-counterparty

Path parameters

customerIdstringrequired

Header parameters

authorizationstring

Authorization header containing your API Token

x-alg-noncestring

Nonce used to generate the payload signature

x-alg-signaturestring

Payload signature

datestring

Date of the request un UTC/GMT

Body

identifierTypestring · enumrequired

Options: UK_ACCOUNT, IBAN

contactNamestringrequired

sortCodestring | nullablerequired

The sort code of the UK bank account

Example: 010102

accountNumberstring | nullablerequired

The account number of the UK bank account

Example: 12345678

ibanstring | nullablerequired

The IBAN of the account

Example: GB33BUKB20201555555555

bicstring | nullablerequired

The BIC of the account

Example: BUKBGB22

accountTypestring · enumrequired

Options: BUSINESS, PERSONAL

secondaryAccountIdstring | nullablerequired

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'api-url/v1/partner/payments/customers/{customerId}/validate-external-counterparty' \
  --header 'Content-Type: application/json' \
  --data '{
    "identifierType": "UK_ACCOUNT",
    "contactName": "text",
    "sortCode": "010102",
    "accountNumber": "12345678",
    "iban": "GB33BUKB20201555555555",
    "bic": "BUKBGB22",
    "accountType": "BUSINESS",
    "secondaryAccountId": "text"
  }'

200

400

403

422

200

{
  "counterpartyBeneficiaryStatus": "MATCH",
  "counterpartyValidationResult": "UK_ACCOUNT_VALID",
  "similarName": "text"
}

Returns external counterparty validation