...
The direct-debits resource is used by an AISP to retrieve the direct debits for a specific account identified by AccountId or to retrieve direct debits for all accounts that the PSU customer has consented to.
This resource description should be read in conjunction with a compatible Account Information Services API Profile.
...
S.No. | Resource | HTTP Operation | Endpoint | Mandatory | Scope | Grant Type | Idempotency Key | Parameter | Request Object | Response Object |
2.1 | direct-debits | GET | GET /accounts/{AccountId}/direct-debits | Conditional | accounts | Authorization Authorisation Code | No | | | OBReadDirectDebit |
2.2 | direct-debits | GET | GET /direct-debits | Conditional | accounts | Authorization Authorisation Code | No | Pagination | | OBReadDirectDebit |
...
An ASPSP may provide this endpoint for AISPs to retrieve direct-debits for all accounts that the PSU customer has consented to. This will retrieve the direct-debit resources for all authorised accounts linked to the account-request.
...
4.1.1 Get Direct Debits Request
GET /direct-debits
AuthorizationAuthorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-fapi-auth-date: Tue, 18 Mar 2020 19:43:31 GMT+03:00
x-fapi-customer-ip-address: 204.35.213.15
x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f
Accept: application/json
|
...
{
"Data": {
"DirectDebit": [
{
"AccountId": "00345897",
"DirectDebitId": "2257",
"MandateIdentification": "Instalment",
"DirectDebitStatusCode": "Active",
"Name": "Asif Khan",
"PreviousPaymentDateTime": "2020-03-24T09:31:55.590Z"590+03:00”,
"Frequency": "Monthly",
"PreviousPaymentAmount": {
"Amount": "1000",
"Currency": "BHD"
}
},
{
"AccountId": "00178956",
"DirectDebitId": "1567",
"MandateIdentification": "Investment",
"DirectDebitStatusCode": "Active",
"Name": "Daniel d’souza",
"PreviousPaymentDateTime": "2020-03-24T09:31:55.590Z"590+03:00”,
"Frequency": "Monthly",
"PreviousPaymentAmount": {
"Amount": "10000",
"Currency": "BHD"
}
}
]
},
"Links": {
"Self": "www.TBC.com"
},
"Meta": {
"TotalPages": 01,
"FirstAvailableDateTime": "2020-03-24T09:10:17.596Z"596+03:00”,
"LastAvailableDateTime": "2020-03-24T09:10:17.596Z"596+03:00”
}
}
|
4.2. Specific Account
...
GET /accounts/00345897/direct-debits
AuthorizationAuthorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-fapi-auth-date: Tue, 24 Mar 2020 19:43:31 GMT+03:00
x-fapi-customer-ip-address: 204.35.213.15
x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f
Accept: application/jsonjsonn
|
4.2.2 Get Account Direct Debits Response
200 OK
x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f
Content-Type: application/json
|
{
"Data": {
"DirectDebit": [
{
"AccountId": "00345897",
"DirectDebitId": "2257",
"MandateIdentification": "Instalment",
"DirectDebitStatusCode": "Active",
"Name": "Asif Khan",
"PreviousPaymentDateTime": "2020-03-24T09:31:55.590Z"590+03:00”,
"Frequency": "Monthly",
"PreviousPaymentAmount": {
"Amount": "1000",
"Currency": "BHD"
}
}
]
},
"Links": {
"Self": "www.TBC.com"
},
"Meta": {
"TotalPages": 01,
"FirstAvailableDateTime": "2020-03-24T09:10:17.596Z"596+03:00”,
"LastAvailableDateTime": "2020-03-24T09:10:17.596Z"596+03:00”
}
}
|