Sign in

v1

latestOpenAPI 3.0.32026-07-248079274.0 KB
Tools

Confirmation of Payee

Verify your payee's account details before adding them to our system or initiating a payment.

post/tools/confirmation-of-payee

Headers

Company-Idstring uuid

Unique ID assigned by Acquired.com for your company.

Request body

scheme'faster_payments'

Specifies the payment scheme to be used. The only accepted value is faster_payments.

sort_codestring

The 6-digit sort code of the bank account. Must only contain numeric characters.

account_numberstring

The 8-digit account number. Must only contain numeric characters.

account_namestring

The name on the bank account. Can include letters, spaces, periods, and hyphens.

account_type'personal' | 'business'

Specifies the type of account. Acceptable values are "personal" or "business".

Example request

{
  "scheme": "faster_payments",
  "sort_code": "010203",
  "account_number": "12345678",
  "account_name": "E Johnson",
  "account_type": "personal"
}

Response

Created

idstring uuid

A unique identifier assigned by Acquired.com to the Confirmation of Payee request.

status'matched' | 'not_matched' | 'partial_match'

Indicates the status of the request whether it was matched or not.

reason'account_name_does_not_match' | 'account_name_maybe_match' | 'business_account_name_match' | 'personal_account_name_match' | 'business_account_name_maybe_match' | 'personal_account_name_maybe_match' | 'incorrect_account_number' | 'invalid_customer_reference' | 'account_type_not_supported' | 'opted_out_of_cop_scheme' | 'account_has_been_switched' | 'sort_code_not_supported' | 'sort_code_not_found'

A string indicating the outcome or reason for the account name match status. This will only be returned if the status is

account_namestring

The name as it appears on the account.

Example response

{
  "id": "a7e3fde5-5b83-44f4-9915-782bc7121717",
  "status": "not_matched",
  "reason": "account_name_does_not_match",
  "account_name": "Mr E Johnson"
}