Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Enable Banking Payments API

The Payments API from Enable Banking — 3 operation(s) for payments.

Enable Banking Payments API is one of 4 APIs that Enable Banking publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, a JSON-LD context, pricing, an engineering blog, and 4 JSON Schemas.

This API exposes 4 operations across 3 paths, and defines 43 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0-3030f99c.

Requests are made against 2 base URLs: https://api.enablebanking.com, https://api.tilisy.com.

4 operations 3 paths 43 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0-3030f99c
Base URL
https://api.enablebanking.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Enable Banking Payments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — In order to get access to this API you need to: - Generate a private RSA key and a self-signed certificate; - Upload the certificate to enablebanking.com and g…

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Payments 4
POST
/payments
Create payment
create_payment_payments_post body → 200400401403404408422429
GET
/payments/{payment_id}
Get payment
get_payment_payments__payment_id__get 1 param → 200400401403404408422429
DELETE
/payments/{payment_id}
Delete payment
delete_payment_payments__payment_id__delete 1 param → 200400401403404408422429
GET
/payments/{payment_id}/transactions/{transaction_id}
Get payment transaction
get_payment_transaction_payments__payment_id__transactions__transaction_id__get 2 params → 200400401403404408422429

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are CreditTransferTransactionDetails (14 properties), CreditTransferTransaction (12 properties), CreatePaymentRequest (11 properties), PostalAddress (10 properties). Each schema is shown below with its type and property counts.

PaymentTypeInformation
object
4 properties
PaymentRequestResource
object
9 properties 1 required
GetPaymentResponse
object
8 properties 7 required
EndDate
string
The last applicable day of execution for a given standing order. If not given, the standing order is considered as endless.
GenericIdentification
object
3 properties 2 required
PaymentStatus
string
StatusReasonInformation
object
2 properties 2 required
CreditTransferTransactionDetails
object
Details of the payment instruction executed (to be executed) by the ASPSP
14 properties 2 required
ASPSP
object
2 properties 2 required
AmountType
object
2 properties 2 required
GetPaymentTransactionResponse
object
2 properties 2 required
RequestedExecutionDate
string
Date at which the initiating party requests the clearing agent to process the payment. API: This date can be used in the following cases: - the single requeste…
PaymentRequestResourceDetails
object
9 properties
ServiceLevelCode
string
PostalAddress
object
10 properties
CreatePaymentRequest
object
11 properties 6 required
ErrorResponse
object
4 properties 1 required
ExecutionRule
string
RegulatoryAuthority
object
2 properties 2 required
ChargeBearerCode
string
FinancialInstitutionIdentification
object
3 properties
CreditTransferTransaction
object
Payment instruction to be executed by the ASPSP
12 properties 2 required
RegulatoryReportingDetails
object
3 properties 1 required
FrequencyCode
string
PaymentIdentification
object
2 properties
CreatePaymentResponse
object
4 properties 4 required
SchemeName
string
Beneficiary
object
4 properties 1 required
ClearingSystemMemberIdentification
object
2 properties
PaymentType
string
ContactDetails
object
2 properties
SuccessResponse
object
1 property
PaymentInformationId
string
Reference assigned by a sending party to unambiguously identify the payment information block within the message.
PriorityCode
string
RegulatoryReporting
object
2 properties 1 required
PSUType
string
UnstructuredRemittanceInformation
array
Payment details. For credit transfers may contain free text, reference number or both at the same time (in case Extended Remittance Information is supported).…
PurposeCode
string
AddressType
string
PartyIdentification
object
5 properties
CategoryPurposeCode
string
ErrorCode
string
ReferenceNumber
string
This field specifies the reference assigned by the sender to unambiguously identify the message.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

enable-banking-payments-api-openapi.yml Raw ↑

Other APIs Enable Banking publishes across the network.

Enable Banking Accounts data API
Enable Banking Misc API
Enable Banking User sessions API