Worldline Site API
The Site API from Worldline — 8 operation(s) for site.
OpenAPI Specification
swagger: '2.0'
info:
description: 'The current set of APIs will be available in Q2 2026 on Worldline Global Issuing Platforms.
Additional APIs are under construction and planned to be available in 2026.'
version: 2.41.1
title: Worldline Card Issuing Account - AccountState Site API
contact: {}
host: sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/card-issuing
basePath: /api/v2
schemes:
- https
tags:
- name: Site
paths:
/acquiring/contract/v2.0/acquirers/{acquirerId}/sites:
get:
tags:
- Site
summary: Search sites
description: 'This operation retrieves a list of sites. Terminated sites are excluded.
'
operationId: getSiteOverviewList
parameters:
- name: acquirerId
in: path
description: Unique identification of the acquirer, determined by equensWorldline
required: true
schema:
type: string
- name: iban
in: query
description: 'International Bank Account Number for merchant payments
'
schema:
type: string
- name: holdingId
in: query
description: 'Unique identification of the holding, determined by equensWorldline
'
schema:
type: integer
format: int32
- name: merchantId
in: query
description: 'Unique identification of the merchant, determined by the acquirer
'
schema:
type: string
- name: contractId
in: query
description: 'Unique identification of the contract, determined by the acquirer
'
schema:
type: string
- name: postalCode
in: query
description: 'Postal code of site address
'
schema:
type: string
- name: houseNumber
in: query
description: 'House number of site address. Note, Postal code must be given as well
'
schema:
type: integer
format: int32
- name: siteId
in: query
description: 'Unique identification of the site within the contract
'
schema:
type: integer
format: int32
- name: cardAcceptorId
in: query
description: 'Unique identification of the site in accordance with payment scheme rules. Some Dutch acquirers have a waiver not to fill this field. In that case it contains the merchant ID
'
schema:
type: string
- name: terminalId
in: query
description: 'Identification of the terminal. Within the Dutch model a terminal ID uniquely identifies one specific physical device. Within other terminal models the terminal ID is only considered unique within the context of its own site (card acceptor ID)
'
schema:
type: string
- name: merchantName
in: query
description: 'Name of the merchant
'
schema:
type: string
- name: contractName
in: query
description: 'Optional name for this specific contract
'
schema:
type: string
- name: siteName
in: query
description: 'Name of the site
'
schema:
type: string
- name: sortField
in: query
description: 'Sort field
'
schema:
type: string
enum:
- siteId
- siteName
- name: sortOrder
in: query
description: 'Sort order
'
schema:
type: string
enum:
- Ascending
- Descending
- name: pageSize
in: query
description: Page size (Max page size is 300)
schema:
type: string
- name: pageNumber
in: query
description: Page number
schema:
type: string
- name: includeTerminated
in: header
description: Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included).
schema:
type: boolean
responses:
200:
description: Successful
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SiteListData'
example:
- contractIdentification:
acquirerId: '315000001'
holdingId: 200
merchantId: '1001'
contractId: '10011'
cardAcceptorId: '90100110'
siteId: 100110
siteName: EPS*Home Festival
channel: 2
commencementDate: 2022-12-09
status: Active
address:
streetName: Tynjestrjitte
houseNumber: 1
postalCode: 8763ML
city: Parrega
countryCode: 528
contactPersonName: H. Cook
email: H.Cook@homefestival.nl
siteDetailsURI: acquiring/contract/v2.0/acquirers/315000001/contracts/10011/sites/100110
- contractIdentification:
acquirerId: '315000001'
holdingId: 200
merchantId: '1001'
contractId: '10011'
cardAcceptorId: '1001'
siteId: 100111
siteName: EPS*Metal Festival
channel: 1
commencementDate: 2022-12-09
status: Active
address:
streetName: Nieuwstraat
houseNumber: 12
postalCode: 3267AR
city: Goudswaard
countryCode: 528
contactPersonName: M. Cohen
email: M.Cohen@metalfestival.nl
siteDetailsURI: acquiring/contract/v2.0/acquirers/315000001/contracts/10011/sites/100111
- contractIdentification:
acquirerId: '315000001'
holdingId: 300
merchantId: '2001'
contractId: '20011'
cardAcceptorId: '90200110'
siteId: 200110
siteName: GreatGroceries.com
channel: 2
commencementDate: 2022-12-09
status: Active
address:
streetName: Laakweg
houseNumber: 126
postalCode: 2521SC
city: Den Haag
countryCode: 528
contactPersonName: H. Gunes
email: H.Gunes@GreatGroceries.com
siteDetailsURI: acquiring/contract/v2.0/acquirers/315000001/contracts/20011/sites/200110
- contractIdentification:
acquirerId: '315000001'
holdingId: 300
merchantId: '2001'
contractId: '20011'
cardAcceptorId: '2001'
siteId: 200111
siteName: GG Nijmegen
channel: 1
commencementDate: 2022-12-09
status: Active
address:
streetName: Lange Hezelstraat
houseNumber: 14
postalCode: 6511CJ
city: Nijmegen
countryCode: 528
contactPersonName: J. Gonzalez
email: J.Gonzalez@GreatGroceries.com
siteDetailsURI: acquiring/contract/v2.0/acquirers/315000001/contracts/20011/sites/200111
400:
description: Invalid input provided
content: {}
401:
description: Unauthorized
content: {}
403:
description: Forbidden
content: {}
404:
description: Resource not found
content: {}
500:
description: Unexpected error
content: {}
502:
description: Backend service problem
content: {}
post:
tags:
- Site
summary: Add a site (based on Card Acceptor ID)
operationId: postSiteCaid
parameters:
- name: acquirerId
in: path
description: Unique identification of the acquirer, determined by equensWorldline
required: true
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/PostSite'
application/json:
schema:
$ref: '#/components/schemas/PostSite'
text/json:
schema:
$ref: '#/components/schemas/PostSite'
application/*+json:
schema:
$ref: '#/components/schemas/PostSite'
required: true
responses:
201:
description: Change is processed with correlation id
content:
application/json:
schema:
$ref: '#/components/schemas/PostSiteResponse'
400:
description: Invalid input provided
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
401:
description: Unauthorized
content: {}
403:
description: Forbidden
content: {}
404:
description: Resource not found
content: {}
500:
description: Unexpected error
content: {}
502:
description: Backend service problem
content: {}
/acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}:
get:
tags:
- Site
summary: Retrieve a site (based on Card Acceptor ID)
operationId: getSiteCaid
parameters:
- name: acquirerId
in: path
description: Unique identification of the acquirer, determined by equensWorldline
required: true
schema:
type: string
- name: cardAcceptorId
in: path
description: Unique identification of the card acceptor, determined by equensWorldline
required: true
schema:
type: string
- name: includeTerminated
in: header
description: Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included).
schema:
type: boolean
responses:
200:
description: Successful
content:
application/json:
schema:
$ref: '#/components/schemas/SiteData'
example:
contractIdentification:
acquirerId: '315000001'
contractId: '10011'
siteId: 100111
cardAcceptorId: '1001'
basic:
acquirerName: Worldline Sandbox Bank
contractName: Music Festivals
siteName: EPS*Metal Festival
channel: 1
terminalDomainId: 1
subMerchantId: 111
merchantCategoryCode: '7999'
transactionReference: false
refundLimits:
maximumRefundAmount: '56.00'
maximumDailyRefundAmount: '200000.00'
maximumDailyNumberOfRefunds: 3000
status:
status: Active
commencementDate: 2022-12-09
addressDetailsURI: acquiring/contract/v2.0/acquirers/315000001/contracts/10011/sites/100111/addresses
balanceDataURI: acquiring/contract/v2.0/acquirers/315000001/contracts/10011/sites/100111/balances
brandDataURI: acquiring/contract/v2.0/acquirers/315000001/contracts/10011/sites/100111/brands
400:
description: Invalid input provided
content: {}
401:
description: Unauthorized
content: {}
403:
description: Forbidden
content: {}
404:
description: Resource not found
content: {}
500:
description: Unexpected error
content: {}
502:
description: Backend service problem
content: {}
delete:
tags:
- Site
summary: Terminate a site (based on Card Acceptor ID)
operationId: deleteSiteCaid
parameters:
- name: acquirerId
in: path
description: Unique identification of the acquirer, determined by equensWorldline
required: true
schema:
type: string
- name: cardAcceptorId
in: path
description: Unique identification of the card acceptor, determined by equensWorldline
required: true
schema:
type: string
responses:
200:
description: Change is processed with correlation id
content:
application/json:
schema:
$ref: '#/components/schemas/CorrelationResponse'
400:
description: Invalid input provided
content: {}
401:
description: Unauthorized
content: {}
403:
description: Forbidden
content: {}
404:
description: Resource not found
content: {}
500:
description: Unexpected error
content: {}
502:
description: Backend service problem
content: {}
patch:
tags:
- Site
summary: Update a site (based on Card Acceptor ID)
description: "Fields that can be used: **/basic/siteName, /basic/subMerchantId**\r\nOperations that can be used: **replace, remove**\r\nSample request: \r\n\r\n [\r\n {\r\n \"value\": \"MySite\",\r\n \"path\": \"/basic/siteName\",\r\n \"op\": \"replace\" \r\n }, \r\n {\r\n \"value\": \"123456\",\r\n \"path\": \"/basic/subMerchantId\",\r\n \"op\": \"replace\" \r\n }\r\n ]"
operationId: patchSiteCaid
parameters:
- name: acquirerId
in: path
description: Unique identification of the acquirer, determined by equensWorldline
required: true
schema:
type: string
- name: cardAcceptorId
in: path
description: Unique identification of the card acceptor, determined by equensWorldline
required: true
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: '#/components/schemas/Operation'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Operation'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/Operation'
application/*+json:
schema:
type: array
items:
$ref: '#/components/schemas/Operation'
required: false
responses:
200:
description: Change is processed with correlation id
content:
application/json:
schema:
$ref: '#/components/schemas/CorrelationResponse'
400:
description: Invalid input provided
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
401:
description: Unauthorized
content: {}
403:
description: Forbidden
content: {}
404:
description: Resource not found
content: {}
500:
description: Unexpected error
content: {}
502:
description: Backend service problem
content: {}
/acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}/addresses:
get:
tags:
- Site
summary: Retrieve addresses of a site (based on Card Acceptor ID)
operationId: getSiteAddressesCaid
parameters:
- name: acquirerId
in: path
description: Unique identification of the acquirer, determined by equensWorldline
required: true
schema:
type: string
- name: cardAcceptorId
in: path
description: Unique identification of the card acceptor, determined by equensWorldline
required: true
schema:
type: string
- name: includeTerminated
in: header
description: Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included).
schema:
type: boolean
responses:
200:
description: Successful
content:
application/json:
schema:
$ref: '#/components/schemas/SiteAddressData'
example:
contractIdentification:
acquirerId: '315000001'
contractId: '10011'
siteId: 100111
cardAcceptorId: '1001'
addresses:
- addressType: Location
streetName: Nieuwstraat
houseNumber: 12
postalCode: 3267AR
city: Goudswaard
countryCode: 528
contactPersonName: M. Cohen
email: M.Cohen@metalfestival.nl
communicationLanguage: eng
communicationPreference: 3
400:
description: Invalid input provided
content: {}
401:
description: Unauthorized
content: {}
403:
description: Forbidden
content: {}
404:
description: Resource not found
content: {}
500:
description: Unexpected error
content: {}
502:
description: Backend service problem
content: {}
patch:
tags:
- Site
summary: Update addresses of a site (based on Card Acceptor ID)
description: "Fields that can be used: **/addresses/0/streetName, /addresses/0/houseNumber**\r\nOperations that can be used: **replace, remove**\r\nSample request: \r\n\r\n [\r\n {\r\n \"value\": \"Mainstreet\",\r\n \"path\": \"/addresses/0/streetName\",\r\n \"op\": \"replace\" \r\n }, \r\n {\r\n \"value\": 12,\r\n \"path\": \"/addresses/0/houseNumber\",\r\n \"op\": \"replace\" \r\n }\r\n ]"
operationId: patchSitePatchSiteAddressCaidAddresses
parameters:
- name: acquirerId
in: path
description: Unique identification of the acquirer, determined by equensWorldline
required: true
schema:
type: string
- name: cardAcceptorId
in: path
description: Unique identification of the card acceptor, determined by equensWorldline
required: true
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: '#/components/schemas/Operation'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Operation'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/Operation'
application/*+json:
schema:
type: array
items:
$ref: '#/components/schemas/Operation'
required: false
responses:
200:
description: Change is processed with correlation id
content:
application/json:
schema:
$ref: '#/components/schemas/CorrelationResponse'
400:
description: Invalid input provided
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
401:
description: Unauthorized
content: {}
403:
description: Forbidden
content: {}
404:
description: Resource not found
content: {}
500:
description: Unexpected error
content: {}
502:
description: Backend service problem
content: {}
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites:
post:
tags:
- Site
summary: Add a site
operationId: postSite
parameters:
- name: acquirerId
in: path
description: Unique identification of the acquirer, determined by equensWorldline
required: true
schema:
type: string
- name: contractId
in: path
description: 'Unique identification of the contract, determined by the acquirer
'
required: true
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/PostSite'
application/json:
schema:
$ref: '#/components/schemas/PostSite'
text/json:
schema:
$ref: '#/components/schemas/PostSite'
application/*+json:
schema:
$ref: '#/components/schemas/PostSite'
required: true
responses:
201:
description: Change is processed with correlation id
content:
application/json:
schema:
$ref: '#/components/schemas/PostSiteResponse'
400:
description: Invalid input provided
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
401:
description: Unauthorized
content: {}
403:
description: Forbidden
content: {}
404:
description: Resource not found
content: {}
500:
description: Unexpected error
content: {}
502:
description: Backend service problem
content: {}
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}:
get:
tags:
- Site
summary: Retrieve a site
description: 'This operation retrieves a site.
'
operationId: getSite
parameters:
- name: acquirerId
in: path
description: Unique identification of the acquirer, determined by equensWorldline
required: true
schema:
type: string
- name: contractId
in: path
description: 'Unique identification of the contract, determined by the acquirer
'
required: true
schema:
type: string
- name: siteId
in: path
description: Unique identification of the site within the contract
required: true
schema:
type: integer
format: int32
- name: includeTerminated
in: header
description: Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included).
schema:
type: boolean
responses:
200:
description: Successful
content:
application/json:
schema:
$ref: '#/components/schemas/SiteData'
examples:
POS:
value:
contractIdentification:
acquirerId: '315000001'
contractId: '10011'
siteId: 100111
cardAcceptorId: '1001'
basic:
acquirerName: Worldline Sandbox Bank
contractName: Music Festivals
siteName: EPS*Metal Festival
channel: 1
terminalDomainId: 1
subMerchantId: 111
merchantCategoryCode: '7999'
transactionReference: false
refundLimits:
maximumRefundAmount: '56.00'
maximumDailyRefundAmount: '200000.00'
maximumDailyNumberOfRefunds: 3000
status:
status: Active
commencementDate: 2022-12-09
addressDetailsURI: acquiring/contract/v2.0/acquirers/315000001/contracts/10011/sites/100111/addresses
balanceDataURI: acquiring/contract/v2.0/acquirers/315000001/contracts/10011/sites/100111/balances
brandDataURI: acquiring/contract/v2.0/acquirers/315000001/contracts/10011/sites/100111/brands
E-commerce:
value:
contractIdentification:
acquirerId: '315000001'
contractId: '10011'
siteId: 100110
cardAcceptorId: '90100110'
basic:
acquirerName: Worldline Sandbox Bank
contractName: Music Festivals
siteName: EPS*Home Festival
channel: 2
subMerchantId: 111
merchantCategoryCode: '7999'
status:
status: Active
commencementDate: 2022-12-09
addressDetailsURI: acquiring/contract/v2.0/acquirers/315000001/contracts/10011/sites/100110/addresses
balanceDataURI: acquiring/contract/v2.0/acquirers/315000001/contracts/10011/sites/100110/balances
brandDataURI: acquiring/contract/v2.0/acquirers/315000001/contracts/10011/sites/100110/brands
400:
description: Invalid input provided
content: {}
401:
description: Unauthorized
content: {}
403:
description: Forbidden
content: {}
404:
description: Resource not found
content: {}
500:
description: Unexpected error
content: {}
502:
description: Backend service problem
content: {}
delete:
tags:
- Site
summary: Delete a site
operationId: deleteSite
parameters:
- name: acquirerId
in: path
description: Unique identification of the acquirer, determined by equensWorldline
required: true
schema:
type: string
- name: contractId
in: path
description: 'Unique identification of the contract, determined by the acquirer
'
required: true
schema:
type: string
- name: siteId
in: path
description: Unique identification of the site within the contract
required: true
schema:
type: integer
format: int32
responses:
200:
description: Change is processed with correlation id
content:
application/json:
schema:
$ref: '#/components/schemas/CorrelationResponse'
400:
description: Invalid input provided
content: {}
401:
description: Unauthorized
content: {}
403:
description: Forbidden
content: {}
404:
description: Resource not found
content: {}
500:
description: Unexpected error
content: {}
502:
description: Backend service problem
content: {}
patch:
tags:
- Site
summary: Update a site
description: "Based on a GET Site call a PATCH Site call can be generated to change one or more fields. Whether it is allowed to change a field (and which values are allowed) is determined by the business logic of the contract management solution.\r\nSample request: \r\n\r\n [\r\n {\r\n \"value\": \"MySite\",\r\n \"path\": \"/basic/siteName\",\r\n \"op\": \"replace\" \r\n }, \r\n {\r\n \"value\": \"123456\",\r\n \"path\": \"/basic/subMerchantId\",\r\n \"op\": \"replace\" \r\n }\r\n ]"
operationId: patchSite
parameters:
- name: acquirerId
in: path
description: Unique identification of the acquirer, determined by equensWorldline
required: true
schema:
type: string
- name: contractId
in: path
description: 'Unique identification of the contract, determined by the acquirer
'
required: true
schema:
type: string
- name: siteId
in: path
description: Unique identification of the site within the contract
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: '#/components/schemas/Operation'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Operation'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/Operation'
application/*+json:
schema:
type: array
items:
$ref: '#/components/schemas/Operation'
required: false
responses:
200:
description: Change is processed with correlation id
content:
application/json:
schema:
$ref: '#/components/schemas/CorrelationResponse'
400:
description: Invalid input provided
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
401:
description: Unauthorized
content: {}
403:
description: Forbidden
content: {}
404:
description: Resource not found
content: {}
500:
description: Unexpected error
content: {}
502:
description: Backend service problem
content: {}
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/addresses:
get:
tags:
- Site
summary: Retrieve the addresses of a site
description: 'This operation retrieves addresses of a site.
'
operationId: getSiteAddresses
parameters:
- name: acquirerId
in: path
description: Unique identification of the acquirer, determined by equensWorldline
required: true
schema:
type: string
- name: contractId
in: path
description: 'Unique identification of the contract, determined by the acquirer
'
required: true
schema:
type: string
- name: siteId
in: path
description: Unique identification of the site within the contract
required: true
schema:
type: integer
format: int32
- name: includeTerminated
in: header
description: Indicates whether terminated items should be included in the response of the GET call. Default value is 'false' (no terminated items included).
schema:
type: boolean
responses:
200:
description: Successful
content:
application/json:
schema:
$ref: '#/components/schemas/SiteAddressData'
example:
contractIdentification:
acquirerId: '315000001'
contractId: '10011'
siteId: 100111
cardAcceptorId: '1001'
addresses:
# --- truncated at 32 KB (94 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/wordline/refs/heads/main/openapi/wordline-site-api-openapi.yml