Swagger for Payment Initiation API Specification
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://openbanking.org.uk https://developer.openbanking.org.uk/reference-implementation/open-banking/v1.3
auth: o a u t h 2
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Swagger for Payment Initiation API Specification
| method | path | what the vendor says it does |
|---|---|---|
POST | /domestic-payment-consents | Create Domestic Payment Consents Domestic Payments |
GET | /domestic-payment-consents/{ConsentId} | Get Domestic Payment Consents Domestic Payments |
GET | /domestic-payment-consents/{ConsentId}/funds-confirmation | Get Domestic Payment Consents Funds Confirmation Domestic Payments |
POST | /domestic-payments | Create Domestic Payments Domestic Payments |
GET | /domestic-payments/{DomesticPaymentId} | Get Domestic Payments Domestic Payments |
GET | /domestic-payments/{DomesticPaymentId}/payment-details | Get Payment Details Payment Details |
POST | /domestic-scheduled-payment-consents | Create Domestic Scheduled Payment Consents Domestic Scheduled Payments |
GET | /domestic-scheduled-payment-consents/{ConsentId} | Get Domestic Scheduled Payment Consents Domestic Scheduled Payments |
POST | /domestic-scheduled-payments | Create Domestic Scheduled Payments Domestic Scheduled Payments |
GET | /domestic-scheduled-payments/{DomesticScheduledPaymentId} | Get Domestic Scheduled Payments Domestic Scheduled Payments |
GET | /domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-details | Get Payment Details Payment Details |
POST | /domestic-standing-order-consents | Create Domestic Standing Order Consents Domestic Standing Orders |
GET | /domestic-standing-order-consents/{ConsentId} | Get Domestic Standing Order Consents Domestic Standing Orders |
POST | /domestic-standing-orders | Create Domestic Standing Orders Domestic Standing Orders |
GET | /domestic-standing-orders/{DomesticStandingOrderId} | Get Domestic Standing Orders Domestic Standing Orders |
GET | /domestic-standing-orders/{DomesticStandingOrderId}/payment-details | Get Payment Details Payment Details |
POST | /file-payment-consents | Create File Payment Consents File Payments |
GET | /file-payment-consents/{ConsentId} | Get File Payment Consents File Payments |
GET | /file-payment-consents/{ConsentId}/file | Get File Payment Consents File Payments |
POST | /file-payment-consents/{ConsentId}/file | Create File Payment Consents File Payments |
POST | /file-payments | Create File Payments File Payments |
GET | /file-payments/{FilePaymentId} | Get File Payments File Payments |
GET | /file-payments/{FilePaymentId}/payment-details | Get Payment Details Payment Details |
GET | /file-payments/{FilePaymentId}/report-file | Get File Payments File Payments |
POST | /international-payment-consents | Create International Payment Consents International Payments |
GET | /international-payment-consents/{ConsentId} | Get International Payment Consents International Payments |
GET | /international-payment-consents/{ConsentId}/funds-confirmation | Get International Payment Consents Funds Confirmation International Payments |
POST | /international-payments | Create International Payments International Payments |
GET | /international-payments/{InternationalPaymentId} | Get International Payments International Payments |
GET | /international-payments/{InternationalPaymentId}/payment-details | Get Payment Details Payment Details |
POST | /international-scheduled-payment-consents | Create International Scheduled Payment Consents International Scheduled Payments |
GET | /international-scheduled-payment-consents/{ConsentId} | Get International Scheduled Payment Consents International Scheduled Payments |
GET | /international-scheduled-payment-consents/{ConsentId}/funds-confirmation | Get International Scheduled Payment Consents Funds Confirmation International Scheduled Payments |
POST | /international-scheduled-payments | Create International Scheduled Payments International Scheduled Payments |
GET | /international-scheduled-payments/{InternationalScheduledPaymentId} | Get International Scheduled Payments International Scheduled Payments |
GET | /international-scheduled-payments/{InternationalScheduledPaymentId}/payment-details | Get Payment Details Payment Details |
POST | /international-standing-order-consents | Create International Standing Order Consents International Standing Orders |
GET | /international-standing-order-consents/{ConsentId} | Get International Standing Order Consents International Standing Orders |
POST | /international-standing-orders | Create International Standing Orders International Standing Orders |
GET | /international-standing-orders/{InternationalStandingOrderPaymentId} | Get International Standing Orders International Standing Orders |
and 1 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/OpenBankingUK/read-write-api-specs/master/dist/openapi/p
Swagger for Account and Transaction API Specification
| method | path | what the vendor says it does |
|---|---|---|
POST | /account-access-consents | Create Account Access Consents Account Access |
GET | /account-access-consents/{ConsentId} | Get Account Access Consents Account Access |
DELETE | /account-access-consents/{ConsentId} | Delete Account Access Consents Account Access |
GET | /accounts | Get Accounts Accounts |
GET | /accounts/{AccountId} | Get Accounts Accounts |
GET | /accounts/{AccountId}/balances | Get Balances Balances |
GET | /accounts/{AccountId}/beneficiaries | Get Beneficiaries Beneficiaries |
GET | /accounts/{AccountId}/direct-debits | Get Direct Debits Direct Debits |
GET | /accounts/{AccountId}/offers | Get Offers Offers |
GET | /accounts/{AccountId}/parties | Get Parties Parties |
GET | /accounts/{AccountId}/party | Get Parties Parties |
GET | /accounts/{AccountId}/product | Get Products Products |
GET | /accounts/{AccountId}/scheduled-payments | Get Scheduled Payments Scheduled Payments |
GET | /accounts/{AccountId}/standing-orders | Get Standing Orders Standing Orders |
GET | /accounts/{AccountId}/statements | Get Statements Statements |
GET | /accounts/{AccountId}/statements/{StatementId} | Get Statements Statements |
GET | /accounts/{AccountId}/statements/{StatementId}/file | Get Statements Statements |
GET | /accounts/{AccountId}/statements/{StatementId}/transactions | Get Transactions Transactions |
GET | /accounts/{AccountId}/transactions | Get Transactions Transactions |
GET | /balances | Get Balances Balances |
GET | /beneficiaries | Get Beneficiaries Beneficiaries |
GET | /direct-debits | Get Direct Debits Direct Debits |
GET | /offers | Get Offers Offers |
GET | /party | Get Parties Parties |
GET | /products | Get Products Products |
GET | /scheduled-payments | Get Scheduled Payments Scheduled Payments |
GET | /standing-orders | Get Standing Orders Standing Orders |
GET | /statements | Get Statements Statements |
GET | /transactions | Get Transactions Transactions |
specification origin: https://raw.githubusercontent.com/OpenBankingUK/read-write-api-specs/master/dist/openapi/a
Latest Swagger specification for OpenData
| method | path | what the vendor says it does |
|---|---|---|
GET | /atms | Gets a list of all `ATM` objects. ATM |
GET | /branches | Gets a list of all `Branch` objects. Branch |
GET | /business-current-accounts | Gets a list of all `Branch Current Account` objects. BCA |
GET | /commercial-credit-cards | Gets a list of all `Commerical Credit Card` objects. CCC |
GET | /personal-current-accounts | Gets a list of all `Personal Current Account` objects. PCA |
GET | /unsecured-sme-loans | Gets a list of all `Unsercured SME Lending` objects. SME |
specification origin: https://raw.githubusercontent.com/OpenBankingUK/opendata-api-spec-compiled/master/opendata
Swagger for Confirmation of Funds API Specification
| method | path | what the vendor says it does |
|---|---|---|
POST | /funds-confirmation-consents | Create Funds Confirmation Consent Funds Confirmations |
GET | /funds-confirmation-consents/{ConsentId} | Get Funds Confirmation Consent Funds Confirmations |
DELETE | /funds-confirmation-consents/{ConsentId} | Delete Funds Confirmation Consent Funds Confirmations |
POST | /funds-confirmations | Create Funds Confirmation Funds Confirmations |
specification origin: https://raw.githubusercontent.com/OpenBankingUK/read-write-api-specs/master/dist/openapi/c
Swagger for Event Notification API Specification - TPP Endpoints
| method | path | what the vendor says it does |
|---|---|---|
POST | /event-notifications | Send an event notification Event Notification |
specification origin: https://raw.githubusercontent.com/OpenBankingUK/read-write-api-specs/master/dist/openapi/e
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.