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 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 2.0, at version 2.41.1.

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

17 operations 8 paths 30 schemas 2 DELETE7 GET6 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 Site API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (basic) using the application flow.

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), AddressDetails (16 properties), BrandParameters (16 properties), Amount (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
CardEntryModes
object
5 properties
Balance
object
10 properties
Address
object
10 properties
PostSiteResponse
object
2 properties
RefundLimits
object
3 properties
PostSite
object
5 properties
Operation
object
4 properties
SiteData
object
8 properties
AllowedServices
object
20 properties
SiteBalanceData
object
2 properties
TerminalBalancebankAccount
object
5 properties
SiteContractIdentification
object
4 properties
SiteServiceProviders
object
2 properties
SiteBasic
object
9 properties
SiteBrandData
object
2 properties
SiteListData
object
12 properties
BrandData
object
3 properties
SiteAddressData
object
2 properties
CorrelationResponse
object
1 property
ErrorData
object
3 properties
PostSiteContractIdentification
object
3 properties
ManualEntryProcessingOptions
object
6 properties
ErrorResponse
object
1 property
ServiceProviders
object
1 property
Status
object
6 properties
RejectedProductTypes
object
4 properties
PostSiteBasic
object
6 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