[ARCHIVE] Clarification on Payee type and PayeeUType in PayeeDetail response

Archived 2023.09.10. Refer to CDS Payload Conventions

Question

In the description for CDS BankingPayeeDetail, the sample response message includes for Payee a Type of BILLER, and a PayeeUType of domestic. The enumeration for PayeeUType shows the options:

• domestic
• biller
• international

Are these options mutually exclusive?

If so, how can there be a PayeeUType value that does not agree with the Payee Type value?

Answer

The suffix UType means Union Type, as described in CDS Object conventions. A Union Type discriminates, or points to, a particular object in a union of objects. 

The type property provides the Payee type, This is an enumeration, with possible values  of BILLER, INTERNATIONAL and DOMESTIC, for example:
type: BILLER

The payeeUType provides a reference to the respective Payee Detail object, for example:
payeeUType: domestic

The CDS BankingPayeeDetail documentation incorrectly describes this is an enumeration. It is a union discriminator that refers to one of three possible Payee Detail objects. The three possible values biller, domestic, and international, refer to objects with schemas described in BankingBillerPayee, BankingDomesticPayee, and BankingInternationalPayee.

For completeness, the sample response message for CDS BankingPayeeDetail shows samples of all possible payee detail objects: biller, domestic, and international. However only the payee detail object corresponding to the value of  PayeeUType is required in a response.

Frequently the PayeeUType aligns with the Payee Type value. For example, a Payee Type of DOMESTIC has a corresponding PayeeUType of domestic with the accompanying BankingDomesticPayee detail object.

However, there are circumstances in which the object referred to by PayeeUType might not align with the Payee Type value.

For example, a bank might offer a service whereby an international payment can be proxied via a domestic account number. In this case it would be valid to label the payee as INTERNATIONAL/domestic, with the values type: INTERNATIONAL, PayeeUType: domestic.

See:

• issue 336