Retrieve Regular Payment Details
Retrieve beneficiaries, direct debits, scheduled payments, standing orders date for the consented accounts.
Pre- requisite
- Open Banking Consent journey should be successfully completed.
- Generate access token using the Generate Access Token endpoint before making any data retrieval calls and ensure using the same customer identifier that was used in the created consent.
:blue-book: Regular Payment Endpoints
The following is the list of regular payment endpoints:
| Endpoint | Description |
|---|---|
| Get Beneficiaries | Retrieve all active and inactive beneficiaries of a given account. Key data includes beneficiary name, type, bank name, identifier (such as IBAN), etc. |
| Get Direct Debits | Retrieve direct debit mandates of the given account. Key data includes direct debit name, status, frequency, previous payment details, etc. |
| Get Scheduled Payments | Retrieve scheduled payments details of a given account. Key data includes scheduled date, amount, type, etc. |
| Get Standing Orders | Retrieve standing orders details of a given account. Key data includes scheduled frequency, payment schedule amount and date, etc. |
Updated 2 months ago