Skip to content
OpenParablePublic APIs

Payment Initiation API API

by openbanking.org.uk

OAuthHTTPSFinance
Open documentation ↗

Overview

Swagger for Payment Initiation API Specification

Payment Initiation API is a finance API from openbanking.org.uk. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 41 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Finance
Base URL
https://openbanking.org.uk
Version
3.1.7
Endpoints
41
OpenAPI
Specification ↗
Spec updated
2021-03-07

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://openbanking.org.uk/domestic-payment-consents/CONSENTID" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://openbanking.org.uk/domestic-payment-consents/CONSENTID", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://openbanking.org.uk/domestic-payment-consents/CONSENTID",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
POST/domestic-payment-consentsCreate Domestic Payment Consents
GET/domestic-payment-consents/{ConsentId}Get Domestic Payment Consents
GET/domestic-payment-consents/{ConsentId}/funds-confirmationGet Domestic Payment Consents Funds Confirmation
POST/domestic-paymentsCreate Domestic Payments
GET/domestic-payments/{DomesticPaymentId}Get Domestic Payments
GET/domestic-payments/{DomesticPaymentId}/payment-detailsGet Payment Details
POST/domestic-scheduled-payment-consentsCreate Domestic Scheduled Payment Consents
GET/domestic-scheduled-payment-consents/{ConsentId}Get Domestic Scheduled Payment Consents
POST/domestic-scheduled-paymentsCreate Domestic Scheduled Payments
GET/domestic-scheduled-payments/{DomesticScheduledPaymentId}Get Domestic Scheduled Payments
GET/domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-detailsGet Payment Details
POST/domestic-standing-order-consentsCreate Domestic Standing Order Consents
GET/domestic-standing-order-consents/{ConsentId}Get Domestic Standing Order Consents
POST/domestic-standing-ordersCreate Domestic Standing Orders
GET/domestic-standing-orders/{DomesticStandingOrderId}Get Domestic Standing Orders
GET/domestic-standing-orders/{DomesticStandingOrderId}/payment-detailsGet Payment Details
POST/file-payment-consentsCreate File Payment Consents
GET/file-payment-consents/{ConsentId}Get File Payment Consents
GET/file-payment-consents/{ConsentId}/fileGet File Payment Consents
POST/file-payment-consents/{ConsentId}/fileCreate File Payment Consents
POST/file-paymentsCreate File Payments
GET/file-payments/{FilePaymentId}Get File Payments
GET/file-payments/{FilePaymentId}/payment-detailsGet Payment Details
GET/file-payments/{FilePaymentId}/report-fileGet File Payments
POST/international-payment-consentsCreate International Payment Consents
GET/international-payment-consents/{ConsentId}Get International Payment Consents
GET/international-payment-consents/{ConsentId}/funds-confirmationGet International Payment Consents Funds Confirmation
POST/international-paymentsCreate International Payments
GET/international-payments/{InternationalPaymentId}Get International Payments
GET/international-payments/{InternationalPaymentId}/payment-detailsGet Payment Details
POST/international-scheduled-payment-consentsCreate International Scheduled Payment Consents
GET/international-scheduled-payment-consents/{ConsentId}Get International Scheduled Payment Consents
GET/international-scheduled-payment-consents/{ConsentId}/funds-confirmationGet International Scheduled Payment Consents Funds Confirmation
POST/international-scheduled-paymentsCreate International Scheduled Payments
GET/international-scheduled-payments/{InternationalScheduledPaymentId}Get International Scheduled Payments
GET/international-scheduled-payments/{InternationalScheduledPaymentId}/payment-detailsGet Payment Details
POST/international-standing-order-consentsCreate International Standing Order Consents
GET/international-standing-order-consents/{ConsentId}Get International Standing Order Consents
POST/international-standing-ordersCreate International Standing Orders
GET/international-standing-orders/{InternationalStandingOrderPaymentId}Get International Standing Orders
GET/international-standing-orders/{InternationalStandingOrderPaymentId}/payment-detailsGet Payment Details

Questions

Does the Payment Initiation API API need an API key?

Yes. The Payment Initiation API API uses OAuth authentication; the documentation explains how to get credentials.

Does the Payment Initiation API API support HTTPS?

Yes, the Payment Initiation API API is served over HTTPS.

How many endpoints does the Payment Initiation API API have?

Its OpenAPI description lists 41 endpoints in version 3.1.7. All of them are shown on this page.

What are alternatives to the Payment Initiation API API?

Other Finance APIs include Stripe, SEC EDGAR Data, Plaid, Fed Treasury, Razorpay IFSC.

Compare alternatives →

Stripe

Finance

Payment processing, subscriptions, and financial management

API key446 endpoints

SEC EDGAR Data

Finance

API to access annual reports of public US companies

No authCORS

Plaid

Finance

Connect with user's bank accounts and access transaction data

API key198 endpoints

Fed Treasury

Finance

U.S. Department of the Treasury Data

No auth

Razorpay IFSC

Finance

Indian Financial Systems Code (Bank Branch Codes)

No auth

Klarna

Finance

Klarna payment and shopping service

API key

Listed from APIs.guru (CC0).