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 Company API
contact: {}
host: sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/card-issuing
basePath: /api/v2
schemes:
- https
tags:
- name: Company
description: Company Api Controller
paths:
/issuers/{issuerId}/companies/{customerReference}:
get:
tags:
- Company
summary: Retrieve company's information
operationId: retrieveCompanyByCustomerRef
description: 'The "retrieve company''s information" API allows the user to get company information.
Information to be provided in input:
- The issuer ID
- The customer reference or the issuer customer reference (as company)
In addition to the company information, it is also possible to request the list of addresses and contacts of the company.'
produces:
- application/json
parameters:
- name: WL-Correlation-ID
in: header
required: false
type: string
- name: WL-Origin
in: header
required: false
type: string
- name: WL-Username
in: header
required: false
type: string
- name: filter
in: query
description: Filtered Fields
required: false
type: array
items:
type: string
collectionFormat: multi
- name: issuerId
in: path
description: issuerId
required: true
type: string
- name: customerReference
in: path
description: customerReference
required: true
type: string
- name: embed
in: query
description: Embedded Fields
required: false
type: array
items:
type: string
enum:
- addressIdentifiers
- addresses
- contactIdentifiers
- contacts
collectionFormat: multi
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityCompany'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestErrorApiResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/UnauthorizedErrorApiResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ForbiddenErrorApiResponse'
'404':
description: Not found
schema:
$ref: '#/definitions/NotFoundErrorApiResponse'
'500':
description: Internal server error
schema:
$ref: '#/definitions/InternalServerErrorErrorApiResponse'
'502':
description: Bad gateway
schema:
$ref: '#/definitions/BadGatewayErrorApiResponse'
security:
- basic: []
deprecated: false
put:
tags:
- Company
summary: Update company
operationId: updateCompany
description: 'The "update company" API allows the user to update the attributes of a customer (as company).
To identify the company, it is needed to provide:
- The issuer ID
- The customer reference or the issuer customer reference (as company) for which updates are required
The customer reference can be retrieved by using the "Retrieve list of company''s information" API.
All the attributes must be given in input even if they remain unchanged. For that, It can be needed to use the "retrieve company''s information" API to get all the current attributes.'
consumes:
- application/json
produces:
- application/json
parameters:
- name: WL-Correlation-ID
in: header
required: false
type: string
- name: WL-Origin
in: header
required: false
type: string
- name: WL-Username
in: header
required: false
type: string
- name: filter
in: query
description: Filtered Fields
required: false
type: array
items:
type: string
collectionFormat: multi
- name: issuerId
in: path
description: Issuer ID
required: true
type: string
- name: customerReference
in: path
description: Customer Reference
required: true
type: string
- in: body
name: body
required: false
schema:
$ref: '#/definitions/ModifyCompanyRequest'
responses:
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestErrorApiResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/UnauthorizedErrorApiResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ForbiddenErrorApiResponse'
'404':
description: Not found
schema:
$ref: '#/definitions/NotFoundErrorApiResponse'
'500':
description: Internal server error
schema:
$ref: '#/definitions/InternalServerErrorErrorApiResponse'
'502':
description: Bad gateway
schema:
$ref: '#/definitions/BadGatewayErrorApiResponse'
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityModifyCompanyResponse'
security:
- basic: []
deprecated: false
patch:
tags:
- Company
summary: Update company partially
operationId: updateCompanyPartially
description: 'The "update company partially" API allows the user to update the attributes of a customer (as company).
To identify the company, it is needed to provide:
- The issuer ID
- The customer reference or the issuer customer reference (as company) for which updates are required
The customer reference can be retrieved by using the "Retrieve list of company''s information" API.
With this API, only attributes that need to be updated must be given in input.'
consumes:
- application/json
produces:
- application/json
parameters:
- name: WL-Correlation-ID
in: header
required: false
type: string
- name: WL-Origin
in: header
required: false
type: string
- name: WL-Username
in: header
required: false
type: string
- name: filter
in: query
description: Filtered Fields
required: false
type: array
items:
type: string
collectionFormat: multi
- name: issuerId
in: path
description: Issuer ID
required: true
type: string
- name: customerReference
in: path
description: Customer Reference
required: true
type: string
- in: body
name: body
required: false
schema:
$ref: '#/definitions/ModifyCompanyRequest'
responses:
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestErrorApiResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/UnauthorizedErrorApiResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ForbiddenErrorApiResponse'
'404':
description: Not found
schema:
$ref: '#/definitions/NotFoundErrorApiResponse'
'500':
description: Internal server error
schema:
$ref: '#/definitions/InternalServerErrorErrorApiResponse'
'502':
description: Bad gateway
schema:
$ref: '#/definitions/BadGatewayErrorApiResponse'
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityModifyCompanyResponse'
security:
- basic: []
deprecated: false
/issuers/{issuerId}/companies/{customerReference}/company-history:
get:
tags:
- Company
summary: Retrieve list of historic updates of a company (beta)
operationId: listCompanyHistory
description: "The API allows the company update history of a company to be retrieved. \nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe customer for which information is requested : It can be provided by using the customer reference or the issuer customer external reference (as company). \nA start date and an end date can be provided in order to limit the search of the history. \nIn response, the interface provides a list of changes with the effective date of the update."
produces:
- application/json
parameters:
- name: WL-Correlation-ID
in: header
required: false
type: string
- name: WL-Origin
in: header
required: false
type: string
- name: WL-Username
in: header
required: false
type: string
- name: filter
in: query
description: Filtered Fields
required: false
type: array
items:
type: string
collectionFormat: multi
- name: issuerId
in: path
description: issuerId
required: true
type: string
- name: customerReference
in: path
description: customerReference
required: true
type: string
- name: periodStartDateTime
in: query
required: false
type: string
description: 'Format : yyyy-MM-ddTHH:mm:ssZ'
- name: periodEndDateTime
in: query
required: false
type: string
description: 'Format : yyyy-MM-ddTHH:mm:ssZ'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityCompanyHistory'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestErrorApiResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/UnauthorizedErrorApiResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ForbiddenErrorApiResponse'
'404':
description: Not found
schema:
$ref: '#/definitions/NotFoundErrorApiResponse'
'500':
description: Internal server error
schema:
$ref: '#/definitions/InternalServerErrorErrorApiResponse'
'502':
description: Bad gateway
schema:
$ref: '#/definitions/BadGatewayErrorApiResponse'
security:
- basic: []
deprecated: false
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}:
get:
tags:
- Company
summary: Retrieve company information by external reference
operationId: retrieveCompanyByIssuerExtRef
description: 'The "retrieve company''s information" API allows the user to get company information.
Information to be provided in input:
- The issuer ID
- The customer reference or the issuer customer reference (as company)
In addition to the company information, it is also possible to request the list of addresses and contacts of the company.'
produces:
- application/json
parameters:
- name: WL-Correlation-ID
in: header
required: false
type: string
- name: WL-Origin
in: header
required: false
type: string
- name: WL-Username
in: header
required: false
type: string
- name: filter
in: query
description: Filtered Fields
required: false
type: array
items:
type: string
collectionFormat: multi
- name: issuerId
in: path
description: issuerId
required: true
type: string
- name: issuerCustomerExternalReference
in: path
description: issuerCustomerExternalReference
required: true
type: string
- name: embed
in: query
description: Embedded Fields
required: false
type: array
items:
type: string
enum:
- addressIdentifiers
- addresses
- contactIdentifiers
- contacts
collectionFormat: multi
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityCompany'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestErrorApiResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/UnauthorizedErrorApiResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ForbiddenErrorApiResponse'
'404':
description: Not found
schema:
$ref: '#/definitions/NotFoundErrorApiResponse'
'500':
description: Internal server error
schema:
$ref: '#/definitions/InternalServerErrorErrorApiResponse'
'502':
description: Bad gateway
schema:
$ref: '#/definitions/BadGatewayErrorApiResponse'
security:
- basic: []
deprecated: false
put:
tags:
- Company
summary: Update Company by external reference
operationId: updateCompanyByIssuerExtRef
description: 'The "update company" API allows the user to update the attributes of a customer (as company).
To identify the company, it is needed to provide:
- The issuer ID
- The customer reference or the issuer customer reference (as company) for which updates are required
The customer reference can be retrieved by using the "Retrieve list of company''s information" API.
All the attributes must be given in input even if they remain unchanged. For that, It can be needed to use the "retrieve company''s information" API to get all the current attributes.'
consumes:
- application/json
produces:
- application/json
parameters:
- name: WL-Correlation-ID
in: header
required: false
type: string
- name: WL-Origin
in: header
required: false
type: string
- name: WL-Username
in: header
required: false
type: string
- name: filter
in: query
description: Filtered Fields
required: false
type: array
items:
type: string
collectionFormat: multi
- name: issuerId
in: path
description: Issuer ID
required: true
type: string
- name: issuerCustomerExternalReference
in: path
description: Issuer Customer External Reference
required: true
type: string
- in: body
name: body
required: false
schema:
$ref: '#/definitions/ModifyCompanyRequest'
responses:
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestErrorApiResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/UnauthorizedErrorApiResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ForbiddenErrorApiResponse'
'404':
description: Not found
schema:
$ref: '#/definitions/NotFoundErrorApiResponse'
'500':
description: Internal server error
schema:
$ref: '#/definitions/InternalServerErrorErrorApiResponse'
'502':
description: Bad gateway
schema:
$ref: '#/definitions/BadGatewayErrorApiResponse'
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityModifyCompanyResponse'
security:
- basic: []
deprecated: false
patch:
tags:
- Company
summary: Update Company partially by external reference
operationId: updateCompanyPartiallyByIssuerExtRef
description: 'The "update company partially" API allows the user to update the attributes of a customer (as company).
To identify the company, it is needed to provide:
- The issuer ID
- The customer reference or the issuer customer reference (as company) for which updates are required
The customer reference can be retrieved by using the "Retrieve list of company''s information" API.
With this API, only attributes that need to be updated must be given in input.'
consumes:
- application/json
produces:
- application/json
parameters:
- name: WL-Correlation-ID
in: header
required: false
type: string
- name: WL-Origin
in: header
required: false
type: string
- name: WL-Username
in: header
required: false
type: string
- name: filter
in: query
description: Filtered Fields
required: false
type: array
items:
type: string
collectionFormat: multi
- name: issuerId
in: path
description: Issuer ID
required: true
type: string
- name: issuerCustomerExternalReference
in: path
description: Issuer Customer External Reference
required: true
type: string
- in: body
name: body
required: false
schema:
$ref: '#/definitions/ModifyCompanyRequest'
responses:
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestErrorApiResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/UnauthorizedErrorApiResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ForbiddenErrorApiResponse'
'404':
description: Not found
schema:
$ref: '#/definitions/NotFoundErrorApiResponse'
'500':
description: Internal server error
schema:
$ref: '#/definitions/InternalServerErrorErrorApiResponse'
'502':
description: Bad gateway
schema:
$ref: '#/definitions/BadGatewayErrorApiResponse'
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityModifyCompanyResponse'
security:
- basic: []
deprecated: false
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/company-history:
get:
tags:
- Company
summary: Retrieve list of historic updates of a company by customer external reference (beta)
operationId: listCompanyHistoryByIssuerExtRef
description: "The API allows the company update history of a company to be retrieved. \nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe customer for which information is requested : It can be provided by using the customer reference or the issuer customer external reference (as company). \nA start date and an end date can be provided in order to limit the search of the history. \nIn response, the interface provides a list of changes with the effective date of the update."
produces:
- application/json
parameters:
- name: WL-Correlation-ID
in: header
required: false
type: string
- name: WL-Origin
in: header
required: false
type: string
- name: WL-Username
in: header
required: false
type: string
- name: filter
in: query
description: Filtered Fields
required: false
type: array
items:
type: string
collectionFormat: multi
- name: issuerId
in: path
description: issuerId
required: true
type: string
- name: issuerCustomerExternalReference
in: path
description: issuerCustomerExternalReference
required: true
type: string
- name: periodStartDateTime
in: query
required: false
type: string
description: 'Format : yyyy-MM-ddTHH:mm:ssZ'
- name: periodEndDateTime
in: query
required: false
type: string
description: 'Format : yyyy-MM-ddTHH:mm:ssZ'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityCompanyHistory'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestErrorApiResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/UnauthorizedErrorApiResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ForbiddenErrorApiResponse'
'404':
description: Not found
schema:
$ref: '#/definitions/NotFoundErrorApiResponse'
'500':
description: Internal server error
schema:
$ref: '#/definitions/InternalServerErrorErrorApiResponse'
'502':
description: Bad gateway
schema:
$ref: '#/definitions/BadGatewayErrorApiResponse'
security:
- basic: []
deprecated: false
/issuers/{issuerId}/companies:
get:
tags:
- Company
summary: Retrieve list of company's information
operationId: listCompanies
description: 'The "Retrieve list of company''s information" API enables to get a list of customers based on multiple criteria such as corporateName, nationalFiscalNumber, address town name, address postal code.
All companies whose corporate name includes the ''corporate name'' parameter are returned (e.g. ''zon'' => ''amazon'' + ''zon craft'', ...)'
produces:
- application/json
parameters:
- name: WL-Correlation-ID
in: header
required: false
type: string
- name: WL-Origin
in: header
required: false
type: string
- name: WL-Username
in: header
required: false
type: string
- name: filter
in: query
description: Filtered Fields
required: false
type: array
items:
type: string
collectionFormat: multi
- name: issuerId
in: path
description: issuerId
required: true
type: string
- name: corporateName
in: query
description: Name of the company
required: true
type: string
- name: nationalFiscalIdentifier
in: query
description: national fiscal identifier of the company
required: false
type: string
- name: postalAddress.postCode
in: query
description: Post code of the company's address
required: false
type: string
- name: postalAddress.townName
in: query
description: Town name of the company's address
required: false
type: string
- name: buildingNumber
in: query
description: Building number of the company
required: false
type: string
- name: streetName
in: query
description: Street name of the company
required: false
type: string
- name: page
in: query
description: '0'
required: false
type: integer
default: 0
format: int32
- name: offset
in: query
description: '100'
required: false
type: integer
default: 100
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityListCompany'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestErrorApiResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/UnauthorizedErrorApiResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ForbiddenErrorApiResponse'
'404':
description: Not found
schema:
$ref: '#/definitions/NotFoundErrorApiResponse'
'500':
description: Internal server error
schema:
$ref: '#/definitions/InternalServerErrorErrorApiResponse'
'502':
description: Bad gateway
schema:
$ref: '#/definitions/BadGatewayErrorApiResponse'
security:
- basic: []
deprecated: false
post:
x-wl-idempotent: true
x-wl-lra-operation: true
x-wl-lra-interface: true
tags:
- Company
summary: Create company
operationId: createCompany
description: 'The API creates a company if all the mandatory fields are provided (see company''s resource).
By default, the company is considered ''ACTIVE'' if the Status field is not provided.
The default address of the company must be also configured.
The API returns a customer reference (as company).
The response can also be enriched (if specified as embedded fields in input) with additional data such as company information, address identifiers linked to the company, addresses of the company, contacts of the company.
Idempotency is managed by the API; that is, if the request with the same WL-Correlation-ID is sent multiple times, it will be executed only once.The response will be retrieved directly from our system.'
consumes:
- application/json
produces:
- application/json
parameters:
- name: WL-Correlation-ID
in: header
required: false
type: string
- name: WL-Origin
in: header
required: false
type: string
- name: WL-Username
in: header
required: false
type: string
- name: embed
in: query
description: Embedded Fields
required: false
type: array
items:
type: string
enum:
- company
- company.addressIdentifiers
- company.addresses
- company.contacts
collectionFormat: multi
- name: issuerId
in: path
description: issuerId
required: true
type: string
- in: body
name: requestBody
description: requestBody
required: true
schema:
$ref: '#/definitions/CreateCompanyRequest'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityCreateCompanyResponse'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestErrorApiResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/UnauthorizedErrorApiResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ForbiddenErrorApiResponse'
'404':
description: Not found
schema:
$ref: '#/definitions/NotFoundErrorApiResponse'
'500':
description: Internal server error
schema:
$ref: '#/definitions/InternalServerErrorErrorApiResponse'
'502':
description: Bad gateway
schema:
$ref: '#/definitions/BadGatewayErrorApiResponse'
security:
- basic: []
deprecated: false
/issuers/{issuerId}/companies/{customerReference}/addresses:
get:
tags:
- Company
summary: Retrieve company's Address information list
operationId: retrieveCompanyAddressByCustomerRef
description: "This API enables all the addresses associated with a given customer (as company), identified by customer reference or issuer customer reference to be retrieved. \nTo identify the company, it is needed to provide:\n- The issuer ID\n- The customer reference or the issuer customer reference (as company)\nThe address could be either a permanent address or a temporary address.\nSeveral address types are managed. Each address can be used for a specific usage (card delivery, statement delivery, contract letter,...).\nAddress usage is associated to a service (card service, account service, dispute service, ..) configured in our system.\nThe API can retrieve only the addresses linked to a specific usage: in this case, all the mandatory 'AddressUsage' attributes must be provided (e.g. serviceCode, AddressUsage).\nIf the showHistory indicator is set to Y then the full history of the addresses and the future addresses are returned. If this indicator is empty (default behavior) or equals to N, then only the last active addresses are returned.\nAddress identifiers, Address attributes and Address usages are displayed in the response."
produces:
- application/json
parameters:
- name: WL-Correlation-ID
in: header
required: false
type: string
- name: WL-Origin
in: header
required: false
type: string
- name: WL-Username
in: header
required: false
type: string
- name: issuerId
in: path
description: issuerId
required: true
type: string
- name: customerReference
in: path
description: customerReference
required: true
type: string
- name: filter
in: query
description: Filtered Fields
required: false
type: array
items:
type: string
collectionFormat: multi
- name: serviceCode
in: query
description: 'The Service for which the address usage is defined : CARD_SERVICE, ACCOUNT_SERVICE. Conditional (must be used with addressUsageName)'
required: false
type: string
- name: entityReference
in: query
description: 'This corresponds to the application domain of the address. It can be eg a card contract reference, card account reference. It is an optional field.
It enables to have the same usage address for the same customer applied to different addresses (one cardholder with 2 card contracts: card delivery address usage is assigned to main postal address for contract A and card delivery address usage is also assigned to office postal address for contract B.'
required: false
type: string
- name: addressUsageName
in: query
description: The business process for which the address usage is defined such as CARD_DELIVERY, PIN_MAILER_DELIVERY, STATEMENT_DELIVERY.
required: false
type: string
- name: showHistory
in: query
description: 'If the showHistory indicator is set to ''true'' then the full history of the addresses are returned. If this indicator is empty (default behavior) or equals to ''false'', then only the last active addresses are returned. '
required: false
default: false
type: boolean
- name: embed
in: query
description: Embedded Fields
required: false
type: array
items:
type: string
enum:
- addressUsages
collectionFormat: multi
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityListAddress'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestErrorApiResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/UnauthorizedErrorApiResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ForbiddenErrorApiResponse'
'404':
description: Not found
schema:
$re
# --- truncated at 32 KB (98 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/wordline/refs/heads/main/openapi/wordline-company-api-openapi.yml