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.
Authorization header containing your API Token
Nonce used to generate the payload signature
Payload signature
Date of the request un UTC/GMT
Type of account identifier used
UK_ACCOUNT
Possible values: Full name of the counterparty contact person
John Doe
The sort code of the UK bank account
010102
The account number of the UK bank account
12345678
The IBAN (International Bank Account Number) of the account
GB33BUKB20201555555555
The BIC (Bank Identifier Code) of the account
BUKBGB22
Specifies the type of account
PERSONAL
Possible values: Unique identifier for a secondary account
e0cab2dd-739f-43de-b131-3e423e935bf1
Returns external counterparty validation
Input validation error
Forbidden
Unprocessable entity
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"
}
Last updated
Was this helpful?