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

Path parameters

customerIdstringRequired

Header parameters

authorizationstringOptional

Authorization header containing your API Token

x-alg-noncestringOptional

Nonce used to generate the payload signature

x-alg-signaturestringOptional

Payload signature

datestringOptional

Date of the request un UTC/GMT

Body

application/json

identifierTypestring · enumRequired

Type of account identifier used

Example: UK_ACCOUNTPossible values:

contactNamestringRequired

Full name of the counterparty contact person

Example: John Doe

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 (International Bank Account Number) of the account

Example: GB33BUKB20201555555555

bicstring | nullableRequired

The BIC (Bank Identifier Code) of the account

Example: BUKBGB22

accountTypestring · enumRequired

Specifies the type of account

Example: PERSONALPossible values:

secondaryAccountIdstring | nullableRequired

Unique identifier for a secondary account

Example: e0cab2dd-739f-43de-b131-3e423e935bf1

Responses

200

Returns external counterparty validation

application/json

400

Input validation error

application/json

403

Forbidden

application/json

422

Unprocessable entity

application/json

post

HTTPcURLJavaScriptPython

POST /v1/partner/payments/customers/{customerId}/validate-external-counterparty HTTP/1.1
Host: api-url
Content-Type: application/json
Accept: */*
Content-Length: 237

{
  "identifierType": "UK_ACCOUNT",
  "contactName": "John Doe",
  "sortCode": "010102",
  "accountNumber": "12345678",
  "iban": "GB33BUKB20201555555555",
  "bic": "BUKBGB22",
  "accountType": "PERSONAL",
  "secondaryAccountId": "e0cab2dd-739f-43de-b131-3e423e935bf1"
}

{
  "counterpartyBeneficiaryStatus": "PARTIAL_MATCH",
  "counterpartyValidationResult": "UK_ACCOUNT_VALID",
  "similarName": "John Doe"
}