List Payments
The purpose of this endpoint is to deliver payments related to a specific Principal (principalId).
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:
- Get Scheduled Payments for Account
- Get Scheduled Payments Bulk
- Get Scheduled Payments for Specific Accounts
- Get Bulk Direct Debits
- Get Direct Debits for Specific Accounts
Data Adapter APIβ
List Paymentsβ
Loading...
Consumer Data Standards Associationsβ
Get Scheduled Payments for Accountβ
Loading...
CDR Error Mappingβ
| Title | Status Code | Adapter URN - Error Code | Detail | CDR Status Code | CDR URN - Error Code |
|---|---|---|---|---|---|
| Invalid Resource | 404 | urn:au-cds:error:cds-all:Resource/Invalid | The requested resource identifier is permanently unavailable. | 404 | urn:au-cds:error:cds-all:Resource/Invalid |
| Legal Block | 451 | urn:dio:error:cds-all:Resource/LegalBlock | This status code indicates that the server is denying access to the resource as a consequence of a legal demand. | 422 | urn:au-cds:error:cds-all:Resource/Unavailable |
| Call Center Block | 451 | urn:dio:error:cds-all:Resource/CallCenterBlock | This status code indicates that the consumer should call the Call Center for further information. | 422 | urn:au-cds:error:cds-all:Resource/Invalid |
| Ineligible Block | 451 | urn:dio:error:cds-all:Resource/IneligibleBlock | This status code indicates that the Customer is ineligible for CDR Data Sharing. | 422 | urn:au-cds:error:cds-all:Resource/Invalid |
Get Scheduled Payments Bulkβ
Loading...
CDR Error Mappingβ
| Title | Status Code | Adapter URN - Error Code | Detail | CDR Status Code | CDR URN - Error Code |
|---|---|---|---|---|---|
| Invalid Resource | 404 | urn:au-cds:error:cds-all:Resource/Invalid | The requested resource identifier is permanently unavailable. | 404 | urn:au-cds:error:cds-all:Resource/Invalid |
| Legal Block | 451 | urn:dio:error:cds-all:Resource/LegalBlock | This status code indicates that the server is denying access to the resource as a consequence of a legal demand. | 422 | urn:au-cds:error:cds-all:Resource/Unavailable |
| Call Center Block | 451 | urn:dio:error:cds-all:Resource/CallCenterBlock | This status code indicates that the consumer should call the Call Center for further information. | 422 | urn:au-cds:error:cds-all:Resource/Invalid |
| Ineligible Block | 451 | urn:dio:error:cds-all:Resource/IneligibleBlock | This status code indicates that the Customer is ineligible for CDR Data Sharing. | 422 | urn:au-cds:error:cds-all:Resource/Invalid |
Get Scheduled Payments For Specific Accountsβ
Loading...
CDR Error Mappingβ
| Title | Status Code | Adapter URN - Error Code | Detail | CDR Status Code | CDR URN - Error Code |
|---|---|---|---|---|---|
| Invalid Resource | 404 | urn:au-cds:error:cds-all:Resource/Invalid | The requested resource identifier is permanently unavailable. | 404 | urn:au-cds:error:cds-all:Resource/Invalid |
| Legal Block | 451 | urn:dio:error:cds-all:Resource/LegalBlock | This status code indicates that the server is denying access to the resource as a consequence of a legal demand. | 422 | urn:au-cds:error:cds-all:Resource/Unavailable |
| Call Center Block | 451 | urn:dio:error:cds-all:Resource/CallCenterBlock | This status code indicates that the consumer should call the Call Center for further information. | 422 | urn:au-cds:error:cds-all:Resource/Invalid |
| Ineligible Block | 451 | urn:dio:error:cds-all:Resource/IneligibleBlock | This status code indicates that the Customer is ineligible for CDR Data Sharing. | 422 | urn:au-cds:error:cds-all:Resource/Invalid |
Get Bulk Direct Debitsβ
Loading...
CDR Error Mappingβ
| Title | Status Code | Adapter URN - Error Code | Detail | CDR Status Code | CDR URN - Error Code |
|---|---|---|---|---|---|
| Invalid Resource | 404 | urn:au-cds:error:cds-all:Resource/Invalid | The requested resource identifier is permanently unavailable. | 500 | urn:au-cds:error:cds-all:Resource/Invalid |
| Legal Block | 451 | urn:dio:error:cds-all:Resource/LegalBlock | This status code indicates that the server is denying access to the resource as a consequence of a legal demand. | 422 | urn:au-cds:error:cds-all:Resource/Unavailable |
| Call Center Block | 451 | urn:dio:error:cds-all:Resource/CallCenterBlock | This status code indicates that the consumer should call the Call Center for further information. | 422 | urn:au-cds:error:cds-all:Resource/Invalid |
| Ineligible Block | 451 | urn:dio:error:cds-all:Resource/IneligibleBlock | This status code indicates that the Customer is ineligible for CDR Data Sharing. | 422 | urn:au-cds:error:cds-all:Resource/Invalid |
Get Direct Debits For Specific Accountsβ
Loading...
CDR Error Mappingβ
| Title | Status Code | Adapter URN - Error Code | Detail | CDR Status Code | CDR URN - Error Code |
|---|---|---|---|---|---|
| Invalid Resource | 404 | urn:au-cds:error:cds-all:Resource/Invalid | The requested resource identifier is permanently unavailable. | 500 | urn:au-cds:error:cds-all:Resource/Invalid |
| Legal Block | 451 | urn:dio:error:cds-all:Resource/LegalBlock | This status code indicates that the server is denying access to the resource as a consequence of a legal demand. | 422 | urn:au-cds:error:cds-all:Resource/Unavailable |
| Call Center Block | 451 | urn:dio:error:cds-all:Resource/CallCenterBlock | This status code indicates that the consumer should call the Call Center for further information. | 422 | urn:au-cds:error:cds-all:Resource/Invalid |
| Ineligible Block | 451 | urn:dio:error:cds-all:Resource/IneligibleBlock | This status code indicates that the Customer is ineligible for CDR Data Sharing. | 422 | urn:au-cds:error:cds-all:Resource/Invalid |
Data Adapter version to CDR version mappingβ
| Data Adapter Version | CDR Version | Transformation Notes |
|---|---|---|
| ListBankingPayments V0 | ScheduledPayments V1 | This is a 1:1 mapping. No transformation required. |
| ListBankingPayments V1 | ScheduledPayments V2 | This is a 1:1 mapping. No transformation required. |
| ListBankingPayments V1 | Scheduled Payments V1 | By 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 V1 | GetScheduledPayments V2 |
|---|---|
| accountId | accountId |
| biller | biller |
| domestic | digitalWallet |
| international | domestic |
| payeeId | international |
| nickname | payeeId |
| 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β
paymentTypein the Data Adapter is used to differentiate between the payments used to split between the Consumer Data Standards payment endpoints