# Open Payments Payment Initiation Service (PIS) API

**Canonical:** https://apis.io/apis/openpayments-io/openpayments-io-payment-initiation-service-pis-api/  
**Provider:** Open Payments — https://apis.io/providers/openpayments-io/  
**Base URL:** https://api.openbankingplatform.com  
**Documentation:** https://docs.openpayments.io/docs/api.md

Open Payments Payment Initiation Service (PIS) API is one of 11 APIs that [Open Payments](https://apis.io/providers/openpayments-io/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Payment Initiation Service (PIS). The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Payment Initiation Service (PIS) offers the following services: * Create and authorize payments * Status information of payments and authorizations * Create and authorize baskets to efficiently sign multiple payments in one authorization * Cancel previously signed payments * Retrieve and create currency exchange (FX) quotes for cross-border transfers

## Operations (21)

| Method | Path | Summary |
|---|---|---|
| POST | `/psd2/paymentinitiation/v1/{payment-service}/{payment-product}` | Create Payment |
| GET | `/psd2/paymentinitiation/v1/{payment-service}/{payment-product}/{paymentId}` | Get Payment |
| DELETE | `/psd2/paymentinitiation/v1/{payment-service}/{payment-product}/{paymentId}` | Cancel Payment |
| GET | `/psd2/paymentinitiation/v1/{payment-service}/{payment-product}/{paymentId}/status` | Get Payment Status |
| POST | `/psd2/paymentinitiation/v1/{payment-service}/{payment-product}/{paymentId}/authorisations` | Create Payment Authorisation |
| GET | `/psd2/paymentinitiation/v1/{payment-service}/{payment-product}/{paymentId}/authorisations` | Get Payment Authorisations |
| GET | `/psd2/paymentinitiation/v1/{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId}` | Get Payment Authorisation SCA Status |
| PUT | `/psd2/paymentinitiation/v1/{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId}` | Start Payment Authorisation |
| POST | `/psd2/paymentinitiation/v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations` | Create Payment Cancellation Authorisation |
| GET | `/psd2/paymentinitiation/v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations` | Get Payment Cancellation Authorisations |
| GET | `/psd2/paymentinitiation/v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations/{cancellationId}` | Get Payment Cancellation Authorisation SCA Status |
| PUT | `/psd2/paymentinitiation/v1/{payment-service}/{payment-product}/{paymentId}/cancellation-authorisations/{cancellationId}` | Start Payment Cancellation Authorisation |
| POST | `/psd2/paymentinitiation/v1/signing-baskets` | Create Signing Basket |
| GET | `/psd2/paymentinitiation/v1/signing-baskets/{basketId}` | Get Signing Basket |
| DELETE | `/psd2/paymentinitiation/v1/signing-baskets/{basketId}` | Delete Signing Basket |
| GET | `/psd2/paymentinitiation/v1/signing-baskets/{basketId}/status` | Get Signing Basket Status |
| POST | `/psd2/paymentinitiation/v1/signing-baskets/{basketId}/authorisations` | Create Signing Basket Authorisation |
| PUT | `/psd2/paymentinitiation/v1/signing-baskets/{basketId}/authorisations/{authorisationId}` | Start Signing Basket Authorisation |
| GET | `/psd2/paymentinitiation/v1/signing-baskets/{basketId}/authorisations/{authorisationId}` | Get Signing Basket Authorisation SCA Status |
| POST | `/psd2/paymentinitiation/v1/fx` | Create FX Quote |
| GET | `/psd2/paymentinitiation/v1/fx/{fxQuoteId}` | Get FX Quote |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/openpayments-io/openapi/openpayments-io-payment-initiation-service-pis-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/openpayments-io/json-schema/openpayments-io-payment-initiation-sepa-direct-debit-json-schema.json
- **JSONSchema** — https://artifacts.apis.io/openpayments-io/json-schema/openpayments-io-get-payout-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/openpayments-io/json-schema/openpayments-io-create-payout-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/openpayments-io/json-schema/openpayments-io-create-payout-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/openpayments-io/json-schema/openpayments-io-confirm-iso-payment-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/openpayments-io/json-schema/openpayments-io-confirm-payout-response-schema.json

## Other Open Payments APIs (10)

- [Open Payments Account Information Service (AIS) API](https://apis.io/apis/openpayments-io/openpayments-io-account-information-service-ais-api/)
- [Open Payments ASPSP Information Service API](https://apis.io/apis/openpayments-io/openpayments-io-aspsp-information-service-api/)
- [Open Payments Bankgiro Lookup API](https://apis.io/apis/openpayments-io/openpayments-io-bankgiro-lookup-api/)
- [Open Payments Consent Service API](https://apis.io/apis/openpayments-io/openpayments-io-consent-service-api/)
- [Open Payments FX Connect API](https://apis.io/apis/openpayments-io/openpayments-io-fx-connect-api/)
- [Open Payments ISO Payments API](https://apis.io/apis/openpayments-io/openpayments-io-iso-payments-api/)
- [Open Payments KYC Service API](https://apis.io/apis/openpayments-io/openpayments-io-kyc-service-api/)
- [Open Payments Payout Service API](https://apis.io/apis/openpayments-io/openpayments-io-payout-service-api/)
- [Open Payments SEPA Direct Debit API](https://apis.io/apis/openpayments-io/openpayments-io-sepa-direct-debit-api/)
- [Open Payments Verification of Payee (VoP) API](https://apis.io/apis/openpayments-io/openpayments-io-verification-of-payee-vop-api/)

## Tags

Payment Initiation Service (PIS)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/openpayments-io/openpayments-io-payment-initiation-service-pis-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/openpayments-io/.
