Open Banking

Payment Initiation API

Swagger for Payment Initiation API Specification

Finance & banking#openapi#financial

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Swagger for Payment Initiation API Specification

Endpoints 41

Domestic Payments

  • POSTCreate Domestic Payment Consents/domestic-payment-consents
  • GETGet Domestic Payment Consents/domestic-payment-consents/:ConsentId
  • GETGet Domestic Payment Consents Funds Confirmation/domestic-payment-consents/:ConsentId/funds-confirmation
  • POSTCreate Domestic Payments/domestic-payments
  • GETGet Domestic Payments/domestic-payments/:DomesticPaymentId

Payment Details

  • GETGet Payment Details/domestic-payments/:DomesticPaymentId/payment-details
  • GETGet Payment Details/domestic-scheduled-payments/:DomesticScheduledPaymentId/payment-details
  • GETGet Payment Details/domestic-standing-orders/:DomesticStandingOrderId/payment-details
  • GETGet Payment Details/file-payments/:FilePaymentId/payment-details
  • GETGet Payment Details/international-payments/:InternationalPaymentId/payment-details
  • GETGet Payment Details/international-scheduled-payments/:InternationalScheduledPaymentId/payment-details
  • GETGet Payment Details/international-standing-orders/:InternationalStandingOrderPaymentId/payment-details

Domestic Scheduled Payments

  • POSTCreate Domestic Scheduled Payment Consents/domestic-scheduled-payment-consents
  • GETGet Domestic Scheduled Payment Consents/domestic-scheduled-payment-consents/:ConsentId
  • POSTCreate Domestic Scheduled Payments/domestic-scheduled-payments
  • GETGet Domestic Scheduled Payments/domestic-scheduled-payments/:DomesticScheduledPaymentId

Domestic Standing Orders

  • POSTCreate Domestic Standing Order Consents/domestic-standing-order-consents
  • GETGet Domestic Standing Order Consents/domestic-standing-order-consents/:ConsentId
  • POSTCreate Domestic Standing Orders/domestic-standing-orders
  • GETGet Domestic Standing Orders/domestic-standing-orders/:DomesticStandingOrderId

File Payments

  • POSTCreate File Payment Consents/file-payment-consents
  • GETGet File Payment Consents/file-payment-consents/:ConsentId
  • GETGet File Payment Consents/file-payment-consents/:ConsentId/file
  • POSTCreate File Payment Consents/file-payment-consents/:ConsentId/file
  • POSTCreate File Payments/file-payments
  • GETGet File Payments/file-payments/:FilePaymentId
  • GETGet File Payments/file-payments/:FilePaymentId/report-file

International Payments

  • POSTCreate International Payment Consents/international-payment-consents
  • GETGet International Payment Consents/international-payment-consents/:ConsentId
  • GETGet International Payment Consents Funds Confirmation/international-payment-consents/:ConsentId/funds-confirmation
  • POSTCreate International Payments/international-payments
  • GETGet International Payments/international-payments/:InternationalPaymentId

International Scheduled Payments

  • POSTCreate International Scheduled Payment Consents/international-scheduled-payment-consents
  • GETGet International Scheduled Payment Consents/international-scheduled-payment-consents/:ConsentId
  • GETGet International Scheduled Payment Consents Funds Confirmation/international-scheduled-payment-consents/:ConsentId/funds-confirmation
  • POSTCreate International Scheduled Payments/international-scheduled-payments
  • GETGet International Scheduled Payments/international-scheduled-payments/:InternationalScheduledPaymentId

International Standing Orders

  • POSTCreate International Standing Order Consents/international-standing-order-consents
  • GETGet International Standing Order Consents/international-standing-order-consents/:ConsentId
  • POSTCreate International Standing Orders/international-standing-orders
  • GETGet International Standing Orders/international-standing-orders/:InternationalStandingOrderPaymentId

API details

Base URL
https://openbanking.org.uk
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
OAuth 2.0 (client credentials flow) with 1 scope
Operations
41 operations on 40 pathsGET 26POST 15
Main resources
File Payments 7Payment Details 7Domestic Payments 5International Payments 5International Scheduled Payments 5Domestic Scheduled Payments 4Domestic Standing Orders 4International Standing Orders 4
Description format
OpenAPI 3.0.0, API version 3.1.7
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Payment Initiation API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Payment Initiation API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create Domestic Payment Consents” (POST /domestic-payment-consents), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Payment Initiation API?

Swagger for Payment Initiation API Specification It is listed under Finance & banking and has 41 endpoints.

Who publishes the Payment Initiation API?

It is listed from Open Banking's public API description (an OpenAPI document), not published by Open Banking on Swastik Codes. Anyone who controls openbanking.org.uk can claim the profile by adding a DNS TXT record.

What is the base URL of the Payment Initiation API?

Requests go to https://openbanking.org.uk. Endpoint paths are added to this base URL.

How do I authenticate with the Payment Initiation API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; OAuth 2.0 (client credentials flow) with 1 scope.

How many endpoints does the Payment Initiation API have?

41 operations on 40 paths (26 GET, 15 POST). The largest groups are File Payments, Payment Details, Domestic Payments, International Payments.

Is forking the Payment Initiation API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.