API Reference

Conduct a Confirmation of Payee (CoP) account name check

post
https://www.api.external.test.mercury.global/api/v1/cop/account-name-check

Verifies whether the provided accountName matches the legal owner name of the destination bank account.

response.data.matched gives the result; response.data.reasonCode and reasonCodeDescription explain it.
When response.isSuccess is false, see response.error.

Pass the returned confirmationOfPayeeCheckId to POST /api/v1/payments to link the check to a payment.

Body Params

The account name check details

Request body for a Confirmation of Payee account name check

string
required

The Mercury-assigned reference returned from POST /api/v1/client. Must belong to an Active client under your distributor account.

string

The name to verify against the destination bank account

string
enum
required

The ownership type of the destination account. Must be one of: Joint, Personal, Business (case-sensitive).

Allowed:
string
required

The destination UK account number (UK accounts only)

string
required

The destination UK sort code. Must be exactly 6 digits, e.g. 040004.

string
required

The currency code. Must be from GET /api/v1/lookup/cop-eligible-currencies, e.g. GBP.

string
required

The country code of the destination account. Must be from GET /api/v1/lookup/cop-eligible-countries, e.g. GB.

string | null

Optional. The secondary reference data (e.g. a building society roll number). Provide this if the SRD pre-check returned secondaryReferenceDataRequired: true.

int32

Optional. The confirmationOfPayeeCheckId returned by the SRD pre-check. Provide this if the SRD pre-check returned secondaryReferenceDataRequired: true.

Responses

401

Missing or invalid x-api-key, x-nonce or Authorization signature. The response has no body.

Updated 6 days ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 days ago

Did this page help you?