Change Log
Confirmation of Payee Verification Updates
Applies to: Payment Instruments API, Confirmation of Payee, Webhooks
What's Changed:
- Account owner name:
account_owner_namehas moved from the instrument'sdetailsinto thebsb_accountidentifier, where it is required. - Verification details: The verification object keeps
status,verified_atandlatest_error. The CoP fields,methodandresult, have moved into adetailsobject. - Registered account owner names:
registered_account_namehas been replaced byregistered_account_owner_names, a list of up to five names registered against the account. - NPP capabilities:
can_receive_npp_paymentsandcan_send_npp_paymentsshow whether the account can receive and send NPP payments, when the financial institution returns them. - Verification failed webhook: A new
payment_instrument_bank_account_verification_failedevent has been added for verifications that cannot be completed. Thepayment_instrument_bank_account_verification_completedevent is now only sent when a verification completes. - Webhook payloads: The verification webhook payloads no longer include the account details (
identifier,account_owner_nameandregistered_account_owner_names). Retrieve the payment instrument to see them.
Action Required:
- Send
account_owner_nameinside thebsb_accountidentifier when creating bank account payment instruments. - Read the verification result from
details.verification.details. - Subscribe to the
payment_instrument_bank_account_verification_failedevent to be notified of failed verifications.
See the updated guides for details: