How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Worldline Terminal API

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

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 3.2.0, at version 2.0.4.

Requests are made against a single base URL, /MerchantApiContract/api.

16 operations 10 paths 28 schemas 2 DELETE8 GET4 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.4
Base URL
https://api.connect.worldline-solutions.com
License
proprietary Worldline Financial Services
Resource Areas
1

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), BrandParameters (16 properties), Amount (16 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
1 property
TerminalCheckNumberResponse
object
2 properties
BrandParameters
object
16 properties
PostTerminal
object
3 properties
Operation
object
4 properties
TerminalContractIdentification
object
5 properties
ManualEntryProcessingOptions
object
6 properties
TerminalData
object
7 properties
AllowedServices
object
20 properties
PostTerminalBasic
object
3 properties
CorrelationResponse
object
1 property
TerminalBrandData
object
2 properties
TerminalAddressData
object
2 properties
TerminalBalanceData
object
2 properties
AddressDetails
object
16 properties 3 required
ServiceProviders
object
1 property
RejectedProductTypes
object
4 properties
TerminalBalancebankAccount
object
5 properties
Balance
object
10 properties
BrandData
object
3 properties
CardEntryModes
object
5 properties
TerminalStatus
object
5 properties
PostTerminalContractIdentification
object
1 property
PostTerminalResponse
object
2 properties
ErrorData
object
3 properties
TerminalListData
object
9 properties
TerminalBasic
object
6 properties
Amount
object
16 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
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
Where this information came from

This is an independent, third-party profile of Worldline Terminal API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.