githubEdit

Confirmation of Payee

Verify that a payee's account name matches their bank account details

Confirmation of Payee (CoP) is a security feature that verifies whether an account holder's name matches the account details you provide. It helps to:

  • Reduce fraud by verifying the account holder's name before sending funds

  • Prevent accidental payments to wrong accounts due to mistyped details

  • Provide confidence that money is being sent to the intended recipient

  • Alert you when the account name doesn't match or only partially matches

circle-info

The feature is also available through the Flash Connectarrow-up-right portal. You can perform CoP checks directly from the UI, view your request history, and monitor usage statistics without writing any code. This can be useful for manual verification workflows or for getting familiar with the feature before integrating it into your application via the API.

Making a CoP Request

To verify account details, execute the confirmationOfPayee mutation. You must provide the accountIdType, the relevant account details, and the accountName you wish to verify.

const bodyJSON = {
  variables: {
    input: {
      accountIdType: "BSB",
      bsb: "012003",
      accountNo: "123456789",
      accountName: "John Smith",
    },
  },
query: `
  mutation ($input: CopInput!) {
    confirmationOfPayee(input: $input) {
      success code message billable
    }
  }`,
};

The code field in the response indicates the result of the verificationarrow-up-right.

The billable field indicates whether the CoP request may be subject to a fee.

circle-info

CoP requests are billed based on your agreement with Flash Payments. Contact Flash Payments support for details on pricing.

Last updated

Was this helpful?