Counterparty Validation
This section explains how to validate external counterparty information before initiating outbound payments.
Introduction
Payments to UK Accounts
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 · enumRequiredExample:
Type of account identifier used
UK_ACCOUNTPossible values: contactNamestringRequiredExample:
Full name of the counterparty contact person
John DoesortCodestring | nullableOptionalExample:
The sort code of the UK bank account
010102accountNumberstring | nullableOptionalExample:
The account number of the UK bank account
12345678ibanstring | nullableOptionalExample:
The IBAN (International Bank Account Number) of the account
GB33BUKB20201555555555bicstring | nullableOptionalExample:
The BIC (Bank Identifier Code) of the account
BUKBGB22accountTypestring · enumRequiredExample:
Specifies the type of account
PERSONALPossible values: secondaryAccountIdstring | nullableOptionalExample:
Unique identifier for a secondary account
e0cab2dd-739f-43de-b131-3e423e935bf1Responses
200
Returns external counterparty validation
application/json
400
Input validation error
application/json
403
Forbidden
application/json
422
Unprocessable entity
application/json
post
/v1/partner/payments/customers/{customerId}/validate-external-counterpartyLast updated
Was this helpful?