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 Card Contract API
contact: {}
host: sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/card-issuing
basePath: /api/v2
schemes:
- https
tags:
- name: Card Contract
description: Card Contract Api Controller
paths:
/issuers/{issuerId}/card-contracts:
get:
tags:
- Card Contract
summary: List card contracts
operationId: listCardContractsByGroupReference
description: 'The API allows the list of card contracts to be retrieved which have the same card contract group reference.
The main input fields are:
- The issuer ID
- The group reference of the card contract for which the detail is requested:
It is also possible to request some additional data by using the embedded fields.
In return, the interface provides the generic information (mainly master data) relevant to the card contract.'
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: cardContractGroupReference
in: query
description: group reference of the Card Contract
required: true
type: string
- name: embed
in: query
description: Embedded Fields
required: false
type: array
items:
type: string
enum:
- cards
- selectedModels
- cardIdentifiers
- relatedAccounts
- cards.orders
- cards.statusHistory
- cards.replacementFor
- cards.renewedFor
collectionFormat: multi
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/ApiResponseEntityListCardContract'
security:
- basic: []
deprecated: false
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}:
get:
tags:
- Card Contract
summary: Retrieve card contract by external reference
operationId: retrieveCardContractByIssuerExtRef
description: "The API allows the card contract details to be retrieved. \nThe main input fields are:\n- The issuer ID\n- The card contract for which the detail is requested: It can be provided by using the card contract reference or the issuer card contract external reference. \n\nIt is also possible to request some additional data by using the embedded fields.\n\nIn return, the interface provides the generic information (mainly master data) relevant to the card contract."
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: issuerCardContractExternalReference
in: path
description: Issuer Card Contract External Reference
required: true
type: string
- name: embed
in: query
description: Embedded Fields
required: false
type: array
items:
type: string
enum:
- selectedModels
- cardIdentifiers
- relatedAccounts
- contactCenters
- cards
- cards.orders
collectionFormat: multi
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/ApiResponseEntityCardContract'
security:
- basic: []
deprecated: false
patch:
tags:
- Card Contract
summary: Update card contract by external reference
operationId: modifyCardContractByIssuerExtRef
description: "The API allows a list of pre-defined parameters (attributes) of a card contract to be updated.\nThe main input fields are:\n- The issuer ID\n- The card contract for which updates are required: It can be provided by using the card contract reference or the issuer card contract external reference. \n- Parameters to be updated\n\nThe card contract parameters can be retrieved using the Retrieve card Contract detail API. \nThe updated parameters should be consistent with the initial product configuration defined in the system (e.g., a change of model is accepted only if the provided model reference is allowed in the product definition).\nA typical update for the card contract is the embossing name."
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: issuerCardContractExternalReference
in: path
description: Issuer Card Contract External Reference
required: true
type: string
- in: body
name: body
required: false
schema:
$ref: '#/definitions/ModifyCardContractRequest'
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/ApiResponseEntityModifyCardContractResponse'
security:
- basic: []
deprecated: false
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cardholder:
get:
tags:
- Card Contract
summary: Retrieve cardholder for a card contract by external reference
operationId: retrieveCardHolderByIssuerExtRef
description: "The API allows the cardholder data linked to the card contract to be retrieved.\nThe main input fields are:\n- The issuer ID\n- The card contract for which the detail is requested: It can be provided by using the card contract reference or the issuer card contract external reference. \n\nIt is also possible to request some additional data by using the embedded fields.\n\nIn return, the interface provides the generic information of the customer."
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: issuerCardContractExternalReference
in: path
description: Issuer Card Contract External Reference
required: true
type: string
- name: embed
in: query
description: Embedded Fields
required: false
type: array
items:
type: string
enum:
- addressIdentifiers
- addresses
collectionFormat: multi
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityCustomer'
'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}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cards:
get:
tags:
- Card Contract
summary: List cards for card contract by external reference
operationId: listCardsForCardContractByIssuerExtRef
description: "The API allows all the cards of a card contract to be retrieved. \nThe main input fields are:\n- The issuer ID\n- The card contract for which the cards list is requested: It can be provided by using the card contract reference or the issuer card contract external reference. \n\nIn return, the interface provides the list of all the cards linked to the card contract. Each card is provided with additional information such as card status, expiry date, embossing line, blocking reason (if in blocked status)."
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: issuerCardContractExternalReference
in: path
description: Issuer Card Contract External Reference
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityListCard'
'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}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/close:
post:
x-wl-lra-operation: true
tags:
- Card Contract
summary: Close card contract by external reference
description: "The API allows a card contract to be closed.\nThe main input fields are:\n•\tThe issuer ID\n•\tThe card contract for which the closure is requested: It can be provided by using the card contract reference or the issuer card contract external reference. \n•\tThe parameters of the closure: reason, delay, date.\n\nA card contract can be either closed immediately or in the future (either at the card expiry date or at another scheduled date)."
operationId: closeCardContractByIssuerExtRef
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: issuerCardContractExternalReference
in: path
description: Issuer Card Contract External Reference
required: true
type: string
- in: body
name: body
required: false
schema:
$ref: '#/definitions/CloseCardContractRequest'
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/ApiResponseEntityCloseCardContractResponse'
security:
- basic: []
deprecated: false
/issuers/{issuerId}/card-contracts/{cardContractReference}/cancel-close:
post:
tags:
- Card Contract
summary: Cancel close card contract
description: 'This API enables to cancel a card contract closing with a scheduled date in the future.
As a result, no closing date is planned anymore for the card contract.'
operationId: cancelCloseCardContract
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: cardContractReference
in: path
description: Card Contract Reference
required: true
type: string
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/ApiResponseEntityCancelCloseCardContractResponse'
security:
- basic: []
deprecated: false
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cancel-close:
post:
tags:
- Card Contract
summary: cancel close card contract by external reference
description: 'This API enables to cancel a card contract closing with a scheduled date in the future.
As a result, no closing date is planned anymore for the card contract.'
operationId: cancelCloseCardContractByIssuerExtRef
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: issuerCardContractExternalReference
in: path
description: Issuer Card Contract External Reference
required: true
type: string
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/ApiResponseEntityCancelCloseCardContractResponse'
security:
- basic: []
deprecated: false
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/contract:
get:
tags:
- Card Contract
summary: Retrieve contract for a card contract by external reference
operationId: retrieveContractForCardContractByIssuerExtRef
description: "The API allows the contract detail of a card contract to be retrieved. \nThe main input fields requested by the API are:\n- The issuer ID\n- The card contract for which the contract information is requested: It can be provided by using the card contract reference or the issuer card contract external reference. \n\nIt is also possible to request some additional data, such as contract customers, accounts, legitimacy documents, by using the embedded fields.\n\nIn return, the interface provides the contract details."
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: issuerCardContractExternalReference
in: path
description: Issuer Card Contract External Reference
required: true
type: string
- name: embed
in: query
description: Embedded Fields
required: false
type: array
items:
type: string
enum:
- advertisementFlags
- deliveryChannel
- legitimacyDocuments
- contractFees
- accountIdentifiers
- accounts
- cardContractIdentifiers
- cardContracts
- dataAnalysisFlags
- contractCustomerIdentifiers
- contractCustomers
- addonSubscriptions
collectionFormat: multi
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityContract'
'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}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/corporate-contract:
get:
tags:
- Card Contract
summary: Retrieve corporate contract for a card contract by external reference
operationId: retrieveCorporateContractForCardContractByIssuerExtRef
description: "The API allows the corporate contract detail of a card contract to be retrieved. \n\nThe main input fields requested by the API are:\n•\tThe issuer ID\n•\tThe card contract for which the corporate contract information is requested: It can be provided by using the card contract reference or the issuer card contract external reference. \n\nIt is also possible to request some additional data, such as list of corporate contract entities (limited to 100), list of all customers (limited to 100), list of all companies (limited to 100), list of corporate employee accounts (limited to 100), root account linked to this corporate contract, by using the embedded fields.\n\nIn return, the interface provides the corporate contract details."
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: issuerCardContractExternalReference
in: path
description: Issuer Card Contract External Reference
required: true
type: string
- name: embed
in: query
description: Embedded Fields
required: false
type: array
items:
type: string
enum:
- corporateContractEntities
- contractCustomers
- contractCompanies
- corporateEmployeeAccounts
- rootAccount
collectionFormat: multi
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityCorporateContract'
'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}/card-contracts/{cardContractReference}:
get:
tags:
- Card Contract
summary: Retrieve card contract
operationId: retrieveCardContract
description: "The API allows the card contract details to be retrieved. \nThe main input fields are:\n- The issuer ID\n- The card contract for which the detail is requested: It can be provided by using the card contract reference or the issuer card contract external reference. \n\nIt is also possible to request some additional data by using the embedded fields.\n\nIn return, the interface provides the generic information (mainly master data) relevant to the card contract."
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: cardContractReference
in: path
description: Card Contract Reference
required: true
type: string
- name: embed
in: query
description: Embedded Fields
required: false
type: array
items:
type: string
enum:
- selectedModels
- cardIdentifiers
- relatedAccounts
- contactCenters
- cards
- cards.orders
collectionFormat: multi
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/ApiResponseEntityCardContract'
security:
- basic: []
deprecated: false
patch:
tags:
- Card Contract
summary: Update card contract
operationId: modifyCardContract
description: "The API allows a list of pre-defined parameters (attributes) of a card contract to be updated.\nThe main input fields are:\n- The issuer ID\n- The card contract for which updates are required: It can be provided by using the card contract reference or the issuer card contract external reference. \n- Parameters to be updated\n\nThe card contract parameters can be retrieved using the Retrieve card Contract detail API. \nThe updated parameters should be consistent with the initial product configuration defined in the system (e.g., a change of model is accepted only if the provided model reference is allowed in the product definition).\nA typical update for the card contract is the embossing name."
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: cardContractReference
in: path
description: Card Contract Reference
required: true
type: string
- in: body
name: body
requ
# --- truncated at 32 KB (224 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/wordline/refs/heads/main/openapi/wordline-card-contract-api-openapi.yml