openbanking.org.uk

Swagger for Payment Initiation API Specification

🔑 oauth2 41 endpoints financial

📄 Docs 📋 OpenAPI spec 🔬 Try in Swagger UI

SDKs by language (8 total)

openbanking-python

pip install openbanking-python

GitHub integration →

openbanking-basiq-sdk

npm install openbanking-basiq-sdk

GitHub integration →

openbanking-node-sdk

npm install openbanking-node-sdk

GitHub integration →

openbanking-ui

npm install openbanking-ui

GitHub integration →

openbanking-uk-extensions

# Maven: see https://github.com/OpenBankingToolkit/openbanking-uk-extensions

GitHub integration →

openbanking-java-sdk

# Maven: see https://github.com/HashApithon/openbanking-java-sdk

GitHub integration →

OpenBanking-UK-Datamodel-Java-SDK

# Maven: see https://github.com/ForgeRock/OpenBanking-UK-Datamodel-Java-SDK

GitHub integration →

openbanking-nodejs-sdk

# See https://github.com/webmaxru/openbanking-nodejs-sdk

GitHub integration →

curl examples

Get File Payments

curl \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  https://openbanking.org.uk/file-payments/{FilePaymentId}

Get File Payment Consents

curl \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  https://openbanking.org.uk/file-payment-consents/{ConsentId}

Get Domestic Payment Consents

curl \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  https://openbanking.org.uk/domestic-payment-consents/{ConsentId}

Endpoints (41 total)

GET

/file-payments/{FilePaymentId}

Get File Payments

GET

/file-payment-consents/{ConsentId}

Get File Payment Consents

GET

/domestic-payment-consents/{ConsentId}

Get Domestic Payment Consents

GET

/domestic-payments/{DomesticPaymentId}

Get Domestic Payments

GET

/file-payment-consents/{ConsentId}/file

Get File Payment Consents

GET

/file-payments/{FilePaymentId}/report-file

Get File Payments

GET

/international-payment-consents/{ConsentId}

Get International Payment Consents

GET

/domestic-standing-order-consents/{ConsentId}

Get Domestic Standing Order Consents

GET

/file-payments/{FilePaymentId}/payment-details

Get Payment Details

GET

/domestic-scheduled-payment-consents/{ConsentId}

Get Domestic Scheduled Payment Consents

GET

/international-payments/{InternationalPaymentId}

Get International Payments

GET

/international-standing-order-consents/{ConsentId}

Get International Standing Order Consents

Related APIs in same category

ato.gov.au billingo.hu brex.io bunq.com codat.io codat.io