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

The Merchant API from Worldline — 4 operation(s) for merchant.

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

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

This API exposes 9 operations across 4 paths, and defines 21 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.

9 operations 4 paths 21 schemas 2 DELETE3 GET2 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 Merchant API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (basic) using the application flow.

Paths & Operations 9

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

Merchant 9
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/merchants
Search merchants
getMerchantOverviewList 14 params → 200400401403404500502
POST
/acquiring/contract/v2.0/acquirers/{acquirerId}/merchants
Add a merchant
PostMerchant 1 param body → 201400401403404500502
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/merchants/{merchantId}
Retrieve a merchant
getMerchant 3 params → 200400401403404500502
DELETE
/acquiring/contract/v2.0/acquirers/{acquirerId}/merchants/{merchantId}
Delete a merchant
deleteMerchant 2 params → 200400401403404500502
PATCH
/acquiring/contract/v2.0/acquirers/{acquirerId}/merchants/{merchantId}
Update a merchant
patchMerchant 2 params body → 200400401403404500502
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/merchants/{merchantId}/addresses
Retrieve the addresses of a merchant
getMerchantAddresses 3 params → 200400401403404500502
POST
/acquiring/contract/v2.0/acquirers/{acquirerId}/merchants/{merchantId}/addresses
Add addresses to a Merchant
postMerchantAddresses 2 params body → 201400401403404500502
PATCH
/acquiring/contract/v2.0/acquirers/{acquirerId}/merchants/{merchantId}/addresses
Update the addresses of a Merchant
patchMerchantAddresses 2 params body → 200400401403404500502
DELETE
/acquiring/contract/v2.0/acquirers/{acquirerId}/merchants/{merchantId}/addresses/{addressType}
Delete an address from a merchant
deleteMerchantAddresses 3 params → 200400401403404500502

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are AddressDetails (16 properties), MerchantBasic (12 properties), Address (10 properties), PostMerchantBasic (9 properties). Each schema is shown below with its type and property counts.

PostMerchantContractIdentification
object
2 properties
MerchantAddressData
object
2 properties
AddressDetails
object
16 properties 3 required
MerchantRefundLimits
object
1 property
MerchantIdentificationResponse
object
7 properties
Address
object
10 properties
MerchantClusters
object
2 properties
Operation
object
4 properties
MerchantListData
object
6 properties
MerchantContractIdentification
object
3 properties
PostMerchantResponse
object
2 properties
ExternalIds
object
4 properties
MerchantStatus
object
2 properties
PostMerchantBasic
object
9 properties
CorrelationResponse
object
1 property
ErrorData
object
3 properties
MerchantData
object
7 properties
PostMerchantAddresses
object
1 property 1 required
ErrorResponse
object
1 property
PostMerchant
object
4 properties
MerchantBasic
object
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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