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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Worldline

Worldline Terminal API

The Terminal API from Worldline — 10 operation(s) for terminal.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 16 operations across 10 paths, and defines 28 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.

16 operations 10 paths 28 schemas 2 DELETE8 GET4 PATCH2 POST

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 Terminal API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (basic) using the application flow.

Paths & Operations 16

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

Terminal 16
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/terminals
Search terminals
getTerminalOverviewList 16 params → 200400401403404500502
POST
/acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}/terminals
Add a terminal (based on Card Acceptor ID)
postSiteTerminalCaid 2 params body → 201400401403404500502
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}/terminals/{terminalId}
Retrieve a terminal (based on Card Acceptor ID)
getSiteTerminalCaid 4 params → 200400401403404500502
DELETE
/acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}/terminals/{terminalId}
Terminate a terminal (based on Card Acceptor ID)
deleteSiteTerminalCaid 3 params → 200400401403404500502
PATCH
/acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}/terminals/{terminalId}
Update a terminal (based on Card Acceptor ID)
patchSiteTerminalCaid 3 params body → 200400401403404500502
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}/terminals/{terminalId}/addresses
Retrieve addresses of a terminal (based on Card Acceptor ID)
getSiteTerminalAddressesCaid 4 params → 200400401403404500502
POST
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/terminals
Add a terminal
postTerminal 3 params body → 201400401403404500502
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/terminals/{terminalId}
Retrieve a terminal
getTerminal 5 params → 200400401403404500502
DELETE
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/terminals/{terminalId}
Delete a terminal
deleteTerminal 4 params → 200400401403404500502
PATCH
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/terminals/{terminalId}
Update a terminal
patchTerminal 4 params body → 200400401403404500502
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/terminals/{terminalId}/addresses
Retrieve the addresses of a terminal
getTerminalAddresses 5 params → 200400401403404500502
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/terminals/{terminalId}/balances
Retrieve the balances of a terminal
getTerminalBalances 5 params → 200400401403404500502
PATCH
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/terminals/{terminalId}/balances
Update the balances of a terminal
patchTerminalBalances 4 params body → 200400401403404500502
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/terminals/{terminalId}/brands
Retrieve the brand parameters of a terminal
getTerminalBrands 5 params → 200400401403404500502
PATCH
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/terminals/{terminalId}/brands
Update the brand parameters of a terminal
patchTerminalBrands 5 params body → 200400401403404500502
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/terminals/{terminalId}/checknumbers/{checkNumber}
Retrieve a terminal check number
getTerminalCheckNumber 3 params → 200400401403404500502

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are AllowedServices (20 properties), AddressDetails (16 properties), Amount (16 properties), BrandParameters (16 properties). Each schema is shown below with its type and property counts.

BrandParameters
object
16 properties
AddressDetails
object
16 properties 3 required
Amount
object
16 properties
Balance
object
10 properties
CardEntryModes
object
5 properties
Operation
object
4 properties
TerminalBrandData
object
2 properties
PostTerminal
object
3 properties
AllowedServices
object
20 properties
TerminalBalancebankAccount
object
5 properties
TerminalAddressData
object
2 properties
PostTerminalContractIdentification
object
1 property
PostTerminalResponse
object
2 properties
BrandData
object
3 properties
TerminalListData
object
9 properties
CorrelationResponse
object
1 property
TerminalCheckNumberResponse
object
2 properties
ErrorData
object
3 properties
TerminalBasic
object
6 properties
TerminalStatus
object
5 properties
ManualEntryProcessingOptions
object
6 properties
ErrorResponse
object
1 property
PostTerminalBasic
object
3 properties
ServiceProviders
object
1 property
TerminalContractIdentification
object
5 properties
TerminalData
object
7 properties
TerminalBalanceData
object
2 properties
RejectedProductTypes
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wordline-terminal-api-openapi.yml Raw ↑

Other APIs Worldline publishes across the network.

Worldline Connect (Global Collect) API
AE Profile APIs.io
Worldline Direct (Global Online Pay) API
AE Profile APIs.io
Worldline Acquiring API
AE Profile APIs.io
Worldline Financial Services Issuing API
AE Profile APIs.io
Worldline Financial Services Acquiring API
AE Profile APIs.io
Worldline Open Banking API
AE Profile APIs.io
Worldline SmartPOS API
AE Profile APIs.io
Worldline Identity and Authentication API
AE Profile APIs.io
Worldline Account - AccountState API
AE Profile APIs.io
Worldline Account API
AE Profile APIs.io
Worldline Account - Authorization API
AE Profile APIs.io
Worldline Account - Authorization Restriction API
AE Profile APIs.io
#Terminal
← Back to W APIs
API Details
ID
wordline:wordline-terminal-api
Base URL
https://api.connect.worldline-solutions.com
Docs
https://docs.connect.worldline-solutions.com/
Provider
Worldline
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network