Payees

Introduction

The following notes on payee related issues are gathered from archived articles and Subject Matter Expert responses to support issues.  

Definition of a Payee

Payees include any saved payees in a customer's address book. This may include BSB and account numbers, not just payIds.

In cases of any uncertainty or ambiguity regarding what constitutes a payee, the general rule of thumb is to align the CDR data with the data in existing digital channels.

Payees are treated as customer-level data. Payees are related directly to the customer rather than to  accounts.

Payee APIs

• CDS, Banking, Get Payees
• CDS, Banking, Get Payee Detail

Payee scope

bank:payees:read - this scope allows access to payee information stored by the customer.

An ADR may request payee information without requesting any other scope.

Payee nickname and description

If a DH (Data Holder) allows a customer to specify a short name and a longer description for a payee, the DH should populate both fields. If a DH allows only a single label it should populate only the nickname field. If a DH does not allow the user to define any value, the DH should determine one or more default values to supply in the mandatory field at its discretion.

BankingScheduledPaymentToV2

In the BankingScheduledPaymentToV2 schema, the payee can be represented either by a payeeId, by an accountId, or by one of several payee objects which hold full payee details. The toUType field is set to indicate which of these options is to be used for obtaining payee information. See Data Formats, Schemas, UType.

Internal routing

Where a DH uses internal routing and systems for offering payments, the payee information should still be shared.

Mandatory fields for an international payee

The only mandatory fields for an international payee are the name, country and address of the bank which, for an internal customer, are known by definition. 

Nominated linked accounts and payees

The handling of nominated accounts is at the discretion of the Data Holder (DH). Although nominated accounts can be used to support payments as a registered payment target, in the CDR banking regime, payees are not account aligned.