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

Worldline Payment API

The Payment API from Worldline — 5 operation(s) for payment.

Worldline Payment API is one of 79 APIs that Worldline publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payment. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 5 paths, and defines 4 schemas. It is described by OpenAPI 2.0, at version 2.41.1.

Requests are made against the base URL https://api.connect.worldline-solutions.com.

5 operations 5 paths 4 schemas 5 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2.41.1
Base URL
https://api.connect.worldline-solutions.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Worldline Payment API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (basic) using the application flow.

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 GET. Each is listed below with its method, path, parameters, and response codes.

Payment 5
GET
/acquiring/payment/v2.0/acquirers/{acquirerId}/payments/{paymentId}
Get payment based on payment id
getPayment 3 params → 200400401403404500502
GET
/acquiring/payment/v2.0/acquirers/{acquirerId}/payments
Retrieve payments on search criteria
getPaymentsForSearchCriteria 12 params → 200400401403404500502
GET
/acquiring/payment/v2.0/acquirers/{acquirerId}/holdings/{holdingId}/payments
Retrieve payments on holding level
getPaymentsForHolding 11 params → 200400401403404500502
GET
/acquiring/payment/v2.0/acquirers/{acquirerId}/merchants/{merchantId}/payments
Retrieve payments on merchant level
getPaymentsForMerchant 11 params → 200400401403404500502
GET
/acquiring/payment/v2.0/acquirers/{acquirerId}/contracts/{contractId}/payments
Retrieve payments on contract level
getPaymentsForContract 11 params → 200400401403404500502

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Payment (34 properties), ContractIdentification (4 properties), Amount (2 properties), PaymentIdentification (2 properties). Each schema is shown below with its type and property counts.

Payment
object
34 properties
PaymentIdentification
object
2 properties
Amount
object
2 properties
ContractIdentification
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wordline-payment-api-openapi.yml Raw ↑

Other APIs Worldline publishes across the network.

Worldline Connect (Global Collect) API
Worldline Direct (Global Online Pay) API
Worldline Acquiring API
Worldline Financial Services Issuing API
Worldline Financial Services Acquiring API
Worldline Open Banking API
Worldline SmartPOS API
Worldline Identity and Authentication API
Worldline Account - AccountState API
Worldline Account API
Worldline Account - Authorization API
Worldline Account - Authorization Restriction API