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

The Holding API from Worldline — 3 operation(s) for holding.

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

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

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

6 operations 3 paths 16 schemas 1 DELETE3 GET1 PATCH1 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 Holding API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (basic) using the application flow.

Paths & Operations 6

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

Holding 6
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/holdings
Search holdings
getHoldingOverviewList 8 params → 200400401403404500502
POST
/acquiring/contract/v2.0/acquirers/{acquirerId}/holdings
Add a holding
PostHolding 1 param body → 201400401403404500502
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/holdings/{holdingId}
Retrieve a holding
getHolding 3 params → 200400401403404500502
DELETE
/acquiring/contract/v2.0/acquirers/{acquirerId}/holdings/{holdingId}
Terminate a holding
deleteHolding 2 params → 200400401403404500502
PATCH
/acquiring/contract/v2.0/acquirers/{acquirerId}/holdings/{holdingId}
Update a holding
patchHolding 2 params body → 200400401403404500502
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/holdings/{holdingId}/addresses
Retrieve the addresses of a holding
getHoldingAddresses 3 params → 200400401403404500502

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are AddressDetails (16 properties), Address (10 properties), MerchantIdentificationResponse (7 properties), HoldingListData (6 properties). Each schema is shown below with its type and property counts.

PostHolding
object
1 property
ErrorResponse
object
1 property
AddressDetails
object
16 properties 3 required
HoldingStatus
object
2 properties
PostHoldingResponse
object
2 properties
MerchantIdentificationResponse
object
7 properties
PostHoldingBasic
object
1 property
HoldingListData
object
6 properties
CorrelationResponse
object
1 property
HoldingContractIdentification
object
2 properties
HoldingData
object
4 properties
HoldingAddressData
object
2 properties
ErrorData
object
3 properties
Address
object
10 properties
Operation
object
4 properties
HoldingBasic
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wordline-holding-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