Skip to main content

List Payments

The purpose of this endpoint is to deliver payments related to a specific Principal (principalId).

Note

The current build supports adapter V0 and V1 for payments but a V1 payments will be downgraded to CDR GetScheduledPaymentsV1 as GetScheduledPaymentsV2 will not be supported by our data sharing API until the Helios release.

This Data Adapter endpoint is used to deliver the responses for the following Consumer Data Standards endpoints:

Data Adapter API​

List Payments​

Loading...

Consumer Data Standards Associations​

Get Scheduled Payments for Account​

Loading...

CDR Error Mapping​

TitleStatus CodeAdapter URN - Error CodeDetailCDR Status CodeCDR URN - Error Code
Invalid Resource404urn:au-cds:error:cds-all:Resource/InvalidThe requested resource identifier is permanently unavailable.404urn:au-cds:error:cds-all:Resource/Invalid
Legal Block451urn:dio:error:cds-all:Resource/LegalBlockThis status code indicates that the server is denying access to the resource as a consequence of a legal demand.422urn:au-cds:error:cds-all:Resource/Unavailable
Call Center Block451urn:dio:error:cds-all:Resource/CallCenterBlockThis status code indicates that the consumer should call the Call Center for further information.422urn:au-cds:error:cds-all:Resource/Invalid
Ineligible Block451urn:dio:error:cds-all:Resource/IneligibleBlockThis status code indicates that the Customer is ineligible for CDR Data Sharing.422urn:au-cds:error:cds-all:Resource/Invalid

Get Scheduled Payments Bulk​

Loading...

CDR Error Mapping​

TitleStatus CodeAdapter URN - Error CodeDetailCDR Status CodeCDR URN - Error Code
Invalid Resource404urn:au-cds:error:cds-all:Resource/InvalidThe requested resource identifier is permanently unavailable.404urn:au-cds:error:cds-all:Resource/Invalid
Legal Block451urn:dio:error:cds-all:Resource/LegalBlockThis status code indicates that the server is denying access to the resource as a consequence of a legal demand.422urn:au-cds:error:cds-all:Resource/Unavailable
Call Center Block451urn:dio:error:cds-all:Resource/CallCenterBlockThis status code indicates that the consumer should call the Call Center for further information.422urn:au-cds:error:cds-all:Resource/Invalid
Ineligible Block451urn:dio:error:cds-all:Resource/IneligibleBlockThis status code indicates that the Customer is ineligible for CDR Data Sharing.422urn:au-cds:error:cds-all:Resource/Invalid

Get Scheduled Payments For Specific Accounts​

Loading...

CDR Error Mapping​

TitleStatus CodeAdapter URN - Error CodeDetailCDR Status CodeCDR URN - Error Code
Invalid Resource404urn:au-cds:error:cds-all:Resource/InvalidThe requested resource identifier is permanently unavailable.404urn:au-cds:error:cds-all:Resource/Invalid
Legal Block451urn:dio:error:cds-all:Resource/LegalBlockThis status code indicates that the server is denying access to the resource as a consequence of a legal demand.422urn:au-cds:error:cds-all:Resource/Unavailable
Call Center Block451urn:dio:error:cds-all:Resource/CallCenterBlockThis status code indicates that the consumer should call the Call Center for further information.422urn:au-cds:error:cds-all:Resource/Invalid
Ineligible Block451urn:dio:error:cds-all:Resource/IneligibleBlockThis status code indicates that the Customer is ineligible for CDR Data Sharing.422urn:au-cds:error:cds-all:Resource/Invalid

Get Bulk Direct Debits​

Loading...

CDR Error Mapping​

TitleStatus CodeAdapter URN - Error CodeDetailCDR Status CodeCDR URN - Error Code
Invalid Resource404urn:au-cds:error:cds-all:Resource/InvalidThe requested resource identifier is permanently unavailable.500urn:au-cds:error:cds-all:Resource/Invalid
Legal Block451urn:dio:error:cds-all:Resource/LegalBlockThis status code indicates that the server is denying access to the resource as a consequence of a legal demand.422urn:au-cds:error:cds-all:Resource/Unavailable
Call Center Block451urn:dio:error:cds-all:Resource/CallCenterBlockThis status code indicates that the consumer should call the Call Center for further information.422urn:au-cds:error:cds-all:Resource/Invalid
Ineligible Block451urn:dio:error:cds-all:Resource/IneligibleBlockThis status code indicates that the Customer is ineligible for CDR Data Sharing.422urn:au-cds:error:cds-all:Resource/Invalid

Get Direct Debits For Specific Accounts​

Loading...

CDR Error Mapping​

TitleStatus CodeAdapter URN - Error CodeDetailCDR Status CodeCDR URN - Error Code
Invalid Resource404urn:au-cds:error:cds-all:Resource/InvalidThe requested resource identifier is permanently unavailable.500urn:au-cds:error:cds-all:Resource/Invalid
Legal Block451urn:dio:error:cds-all:Resource/LegalBlockThis status code indicates that the server is denying access to the resource as a consequence of a legal demand.422urn:au-cds:error:cds-all:Resource/Unavailable
Call Center Block451urn:dio:error:cds-all:Resource/CallCenterBlockThis status code indicates that the consumer should call the Call Center for further information.422urn:au-cds:error:cds-all:Resource/Invalid
Ineligible Block451urn:dio:error:cds-all:Resource/IneligibleBlockThis status code indicates that the Customer is ineligible for CDR Data Sharing.422urn:au-cds:error:cds-all:Resource/Invalid

Data Adapter version to CDR version mapping​

Data Adapter VersionCDR VersionTransformation Notes
ListBankingPayments V0ScheduledPayments V1This is a 1:1 mapping. No transformation required.
ListBankingPayments V1ScheduledPayments V2This is a 1:1 mapping. No transformation required.
ListBankingPayments V1Scheduled Payments V1By dropping any digital wallet payments. See below for further information.

Transformation Details​

ListPayments (V1): Downgrading from GetScheduledPayments V2 to V1.

In GetScheduledPaymentsV2 there is an additional digital wallet field in scheduledpayments.paymentset.to. The table below displays the additional value (in bold) for V2 compared to V1.

GetScheduledPayments V1GetScheduledPayments V2
accountIdaccountId
billerbiller
domesticdigitalWallet
internationaldomestic
payeeIdinternational
nicknamepayeeId
nickname

When Biza receives a request for GetScheduledPaymentsV2 but the Data Holder only supports ListPayments V1, Biza Haas will downgrade to GetScheduledPaymentsV1 by dropping the payment type that contains the digital wallet from the response.

Supplemental Fields​

No supplemental fields are specified.

Endpoint Specific Guidance​

  • paymentType in the Data Adapter is used to differentiate between the payments used to split between the Consumer Data Standards payment endpoints