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 Site API

The Site API from Worldline — 8 operation(s) for site.

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

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

This API exposes 17 operations across 8 paths, and defines 30 schemas. It is described by OpenAPI 3.2.0, at version 2.0.4.

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

17 operations 8 paths 30 schemas 2 DELETE7 GET6 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 17

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

Site 17
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/sites
Search sites
getSiteOverviewList 18 params → 200400401403404500502
POST
/acquiring/contract/v2.0/acquirers/{acquirerId}/sites
Add a site (based on Card Acceptor ID)
postSiteCaid 1 param body → 201400401403404500502
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}
Retrieve a site (based on Card Acceptor ID)
getSiteCaid 3 params → 200400401403404500502
DELETE
/acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}
Terminate a site (based on Card Acceptor ID)
deleteSiteCaid 2 params → 200400401403404500502
PATCH
/acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}
Update a site (based on Card Acceptor ID)
patchSiteCaid 2 params body → 200400401403404500502
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}/addresses
Retrieve addresses of a site (based on Card Acceptor ID)
getSiteAddressesCaid 3 params → 200400401403404500502
PATCH
/acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}/addresses
Update addresses of a site (based on Card Acceptor ID)
patchSitePatchSiteAddressCaidAddresses 2 params body → 200400401403404500502
POST
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites
Add a site
postSite 2 params body → 201400401403404500502
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}
Retrieve a site
getSite 4 params → 200400401403404500502
DELETE
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}
Delete a site
deleteSite 3 params → 200400401403404500502
PATCH
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}
Update a site
patchSite 3 params body → 200400401403404500502
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/addresses
Retrieve the addresses of a site
getSiteAddresses 4 params → 200400401403404500502
PATCH
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/addresses
Updates the adresses of a site
patchSiteAddresses 3 params body → 200400401403404500502
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/balances
Retrieve the balances of a site
getSiteBalances 4 params → 200400401403404500502
PATCH
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/balances
Update the balances of a site
patchSiteBalances 3 params body → 200400401403404500502
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/brands
Retrieve the brand parameters of a site
getSiteBrands 4 params → 200400401403404500502
PATCH
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/brands
Update the brand parameters of a site
patchSiteBrands 4 params body → 200400401403404500502

Schemas 30

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

Address
object
10 properties
ErrorResponse
object
1 property
SiteContractIdentification
object
4 properties
SiteServiceProviders
object
2 properties
BrandParameters
object
16 properties
Operation
object
4 properties
SiteAddressData
object
2 properties
SiteListData
object
12 properties
ManualEntryProcessingOptions
object
6 properties
AllowedServices
object
20 properties
RefundLimits
object
3 properties
CorrelationResponse
object
1 property
PostSite
object
5 properties
PostSiteBasic
object
6 properties
AddressDetails
object
16 properties 3 required
ServiceProviders
object
1 property
RejectedProductTypes
object
4 properties
PostSiteResponse
object
2 properties
PostSiteContractIdentification
object
3 properties
TerminalBalancebankAccount
object
5 properties
SiteData
object
8 properties
Balance
object
10 properties
BrandData
object
3 properties
CardEntryModes
object
5 properties
SiteBalanceData
object
2 properties
SiteBrandData
object
2 properties
ErrorData
object
3 properties
Status
object
6 properties
SiteBasic
object
9 properties
Amount
object
16 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wordline-site-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 Site 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.