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
identifierTypestring · enumRequiredPossible values:
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 · enumRequiredPossible values:
secondaryAccountIdstring | nullableRequired
Responses
200
Returns external counterparty validation
application/json
post
POST /v1/partner/payments/customers/{customerId}/validate-external-counterparty HTTP/1.1
Host: api-url
Content-Type: application/json
Accept: */*
Content-Length: 201

{
  "identifierType": "UK_ACCOUNT",
  "contactName": "text",
  "sortCode": "010102",
  "accountNumber": "12345678",
  "iban": "GB33BUKB20201555555555",
  "bic": "BUKBGB22",
  "accountType": "BUSINESS",
  "secondaryAccountId": "text"
}
{
  "counterpartyBeneficiaryStatus": "MATCH",
  "counterpartyValidationResult": "UK_ACCOUNT_VALID",
  "similarName": "text"
}

Last updated

Was this helpful?