Openbanking Payment Initiation Openapi
Openbanking Payment Initiation Openapi is an Open Banking API specification for starting payments from a customer's bank account.
- Base URL:
https://openbanking.org.uk - Auth: OAuth 2.0 client-credentials — the tool fetches a token from
https://authserver.example/tokenusing yourclientId/clientSecret, then calls the API.
Operations
getdomesticpaymentconsentsconsentid— GET /domestic-payment-consents/{ConsentId} — Get Domestic Payment Consentsgetdomesticpaymentconsentsconsentidfundsconfirma— GET /domestic-payment-consents/{ConsentId}/funds-confirmation — Get Domestic Payment Consents Funds Confirmationgetdomesticpaymentsdomesticpaymentid— GET /domestic-payments/{DomesticPaymentId} — Get Domestic Paymentsgetdomesticpaymentsdomesticpaymentidpaymentdetai— GET /domestic-payments/{DomesticPaymentId}/payment-details — Get Payment Detailsgetdomesticscheduledpaymentconsentsconsentid— GET /domestic-scheduled-payment-consents/{ConsentId} — Get Domestic Scheduled Payment Consentsgetdomesticscheduledpaymentsdomesticscheduledpay— GET /domestic-scheduled-payments/{DomesticScheduledPaymentId} — Get Domestic Scheduled Payments
Inputs
clientId/clientSecret— your openbanking-payment-initiation-openapi OAuth app credentialsscope— OAuth scopes (optional; defaults from the spec)operation— one of the operations above- path parameters when an operation's path contains
{...} query— optional JSON object of query paramsbody— JSON object for create/update ops
Example
operation: getdomesticpaymentconsentsconsentid
clientId: <your client id>
clientSecret: <your client secret>
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
erroroperationresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
clientId |
string | yes | — | OAuth client ID for openbanking-payment-initiation-openapi. |
clientSecret |
string | yes | — | OAuth client secret for openbanking-payment-initiation-openapi. |
operation |
string | yes | — | One of: getdomesticpaymentconsentsconsentid, getdomesticpaymentconsentsconsentidfundsconfirma, getdomesticpaymentsdomesticpaymentid, getdomesticpaymentsdomesticpaymentidpaymentdetai, getdomesticscheduledpaymentconsentsconsentid, getdomesticscheduledpaymentsdomesticscheduledpay |
scope |
string | no | payments |
OAuth scopes (space-separated); default from the spec. |
ConsentId |
string | no | — | Path parameter ConsentId (required by some operations). |
DomesticPaymentId |
string | no | — | Path parameter DomesticPaymentId (required by some operations). |
DomesticScheduledPaymentId |
string | no | — | Path parameter DomesticScheduledPaymentId (required by some operations). |
query |
string | no | — | Query-string parameters as a JSON object string, e.g. {"limit": 50}. Parsed and url-encoded onto the request. |