1.1 UK Open Banking API v4
Table 1-1 UK Open Banking API v4
| Sr. No. | Resource | Operation Type | API Endpoint | Mandatory Status | Scope of API |
|---|---|---|---|---|---|
| 1 | account-access-consents | POST | POST /account-access-consents | Mandatory | accounts |
| 2 | account-access-consents | GET | GET /account-access-consents/{ConsentId} | Mandatory | accounts |
| 3 | account-access-consents | DELETE | DELETE /account-access-consents/{ConsentId} | Mandatory | accounts |
| 4 | accounts | GET | GET /accounts | Mandatory | accounts |
| 5 | accounts | GET | GET /accounts/{AccountId} | Mandatory | accounts |
| 6 | balances | GET | GET /accounts/{AccountId}/balances | Mandatory | accounts |
| 7 | transactions | GET | GET /accounts/{AccountId}/transactions | Mandatory | accounts |
| 8 | beneficiaries | GET | GET /beneficiaries | Optional | accounts |
| 9 | direct-debits | GET | GET /accounts/{AccountId}/direct-debits* | Conditional | accounts |
| 10 | standing-orders | GET | GET /accounts/{AccountId}/standing-orders** | Conditional | accounts |
| 11 | standing-orders | GET | GET /standing-orders** | Optional | accounts |
| 12 | party | GET | GET /accounts/{AccountId}/party | Conditional | accounts |
| 13 | party | GET | GET /party | Conditional | accounts |
| 14 | scheduled-payments | GET | GET /accounts/{AccountId}/scheduled-payments** | Conditional | accounts |
| 15 | statements | GET | GET /accounts/{AccountId}/statements* | Conditional | accounts |
| 16 | statements | GET | GET /accounts/{AccountId}/statements/{StatementId}* | Conditional | accounts |
| 17 | statements | GET | GET /accounts/{AccountId}/statements/{StatementId}/file | Optional | accounts |
| 18 | statements | GET | GET /accounts/{AccountId}/statements/{StatementId}/transactions* | Conditional | accounts |
| 19 | domestic-payment-consents | POST | POST /domestic-payment-consents | Mandatory | payments |
| 20 | domestic-payment-consents | GET | GET /domestic-payment-consents/{ConsentId} | Mandatory | payments |
| 21 | domestic-payment-consents | GET | GET /domestic-payment-consents/{ConsentId}/funds-confirmation | Mandatory | payments |
| 22 | domestic-payments | POST | POST /domestic-payments* | Mandatory | payments |
| 23 | domestic-payments | GET | GET /domestic-payments/{DomesticPaymentId}* | Mandatory | payments |
| 24 | domestic-scheduled-payment-consents | POST | POST /domestic-scheduled-payment-consents | Conditional | payments |
| 25 | domestic-scheduled-payment-consents | GET | GET /domestic-scheduled-payment-consents/{ConsentId} | Mandatory (if resource POST implemented) | payments |
| 26 | domestic-scheduled-payments | POST | POST /domestic-scheduled-payments* | Conditional | payments |
| 27 | domestic-scheduled-payments | GET | GET /domestic-scheduled-payments/{DomesticScheduledPaymentId}* | Mandatory (if resource POST implemented) | payments |
| 28 | domestic-standing-order-consents | POST | POST /domestic-standing-order-consents | Conditional | payments |
| 29 | domestic-standing-order-consents | GET | GET /domestic-standing-order-consents/{ConsentId} | Mandatory (if resource POST implemented) | payments |
| 30 | domestic-standing-orders | POST | POST /domestic-standing-orders* | Conditional | payments |
| 31 | domestic-standing-orders | GET | GET /domestic-standing-orders/{DomesticStandingOrderId}* | Mandatory (if resource POST implemented) | payments |
| 32 | international-payment-consents | POST | POST /international-payment-consents | Conditional | payments |
| 33 | international-payment-consents | GET | GET /international-payment-consents/{ConsentId} | Mandatory (if resource POST implemented) | payments |
| 34 | international-payment-consents | GET | GET /international-payment-consents/{ConsentId}/funds-confirmation | Mandatory (if resource POST implemented) | payments |
| 35 | international-payments | POST | POST /international-payments | Conditional | payments |
| 36 | international-payments | GET | GET /international-payments/{InternationalPaymentId} | Mandatory (if resource POST implemented) | payments |
| 37 | international-scheduled-payment-consents | POST | POST /international-scheduled-payment-consents | Conditional | payments |
| 38 | international-scheduled-payment-consents | GET | GET /international-scheduled-payment-consents/{ConsentId} | Mandatory (if resource POST implemented) | payments |
| 39 | international-scheduled-payment-consents | GET | GET /international-scheduled-payment-consents/{ConsentId}/funds-confirmation | Mandatory (if immediate debit supported) | payments |
| 40 | international-scheduled-payments | POST | POST /international-scheduled-payments | Conditional | payments |
| 41 | international-scheduled-payments | GET | GET /international-scheduled-payments/{InternationalScheduledPaymentId} | Mandatory (if resource POST implemented) | payments |
| 42 | international-standing-order-consents | POST | POST /international-standing-order-consents | Conditional | payments |
| 43 | international-standing-order-consents | GET | GET /international-standing-order-consents/{ConsentId} | Mandatory (if resource POST implemented) | payments |
| 44 | international-standing-orders | POST | POST /international-standing-orders | Conditional | payments |
| 45 | international-standing-orders | GET | GET /international-standing-orders/{InternationalStandingOrderPaymentId} | Mandatory (if resource POST implemented) | payments |
| 46 | file-payment-consents | POST | POST /file-payment-consents | Conditional | payments |
| 47 | file-payment-consents | POST | POST /file-payment-consents/{ConsentId}/file | Conditional | payments |
| 48 | file-payment-consents | GET | GET /file-payment-consents/{ConsentId} | Mandatory (if resource POST implemented) | payments |
| 49 | file-payment-consents | GET | GET /file-payment-consents/{ConsentId}/file | Conditional | payments |
| 50 | file-payments | POST | POST /file-payments | Conditional | payments |
| 51 | file-payments | GET | GET /file-payments/{FilePaymentId} | Mandatory (if resource POST implemented) | payments |
| 52 | file-payments | GET | GET /file-payments/{FilePaymentId}/payment-details | Conditional | payments |
| 53 | funds-confirmation-consent | POST | POST /funds-confirmation-consents | Mandatory | fundsconfirmations |
| 54 | funds-confirmation-consent | GET | GET /funds-confirmation-consents/{ConsentId} | Mandatory | fundsconfirmations |
| 55 | funds-confirmation-consent | DELETE | DELETE /funds-confirmation-consents/{ConsentId} | Mandatory | fundsconfirmations |
| 56 | funds-confirmation | POST | POST /funds-confirmations | Mandatory | fundsconfirmations |
Note:
* API not integrated with the host
** AISP API integrated with Payments host along with Accounts host
Parent topic: UK Open Banking APIs