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 Transaction API
contact: {}
host: sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/card-issuing
basePath: /api/v2
schemes:
- https
tags:
- name: Transaction
description: Transaction API Controller
paths:
/issuers/{issuerId}/transactions/{transactionId}:
get:
tags:
- Transaction
summary: Retrieve transaction details
operationId: retrieveTransactionDetailsByTransactionId
description: "The API allows the transaction details to be retrieved. \nThe main input fields are:\n•\tThe issuer ID\n•\tThe transaction for which the detail is requested: It is provided by using the transaction Id. \n\nIt is also possible to request some additional data relative to addendum (to retrieve lodging information, car rental information, air itinerary information) by using the embedded fields.\n\nIn return, the interface provides the generic information (mainly master data) relevant to the transaction."
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: transactionId
in: path
description: Unique id of specific transaction
required: true
type: string
- name: embed
in: query
description: 'Available values for embed : addendum (to retrieve lodgingInformation, carRentalInformation, airItineraryInformation) '
required: false
type: array
items:
type: string
enum:
- addendum
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/ApiResponseEntityTransactionDetails'
security:
- basic: []
deprecated: false
/issuers/{issuerId}/transactions/{transactionId}/dispute:
post:
x-wl-idempotent: true
tags:
- Transaction
summary: Create a dispute from a transaction
operationId: createDisputeFromTransaction
description: "The API allows an issuer to create a dispute folder in the system for a given operation. This API enables the issuer to initiate the dispute from its application.\nSeveral actions can be performed :\n- Dispute only \n- Dispute + refund/redebit (full or partial)\n- Dispute + write-off (full or partial)\n- Dispute + fraud declaration\n- Dispute + event creation\n- Dispute + attach documents \n- Dispute + combination of above options\n\nMain data in input are :\n- the external operation reference which can be retrieved using a search operation in the system, for example using the API retrieves list of operations for an account.\n- in option, several fields in the case additional actions have to be done besides the dispute folder creation (e.g operation(s) posting, event(s) creation, add document(s)).\n\nIn response, the created dispute folder identifier is provided back systematically; then depending on the additional requests, the response includes also the posting, event creation and documents add response.\n\nIdempotency 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: 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: transactionId
in: path
description: Transaction Id
required: true
type: string
- in: body
name: body
required: false
schema:
$ref: '#/definitions/CreateDisputeRequest'
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/ApiResponseEntityCreateDisputeResponse'
security:
- basic: []
deprecated: false
get:
tags:
- Transaction
summary: Get the dispute information of the transaction
operationId: getDisputeFolderInfoByTransactionId
description: 'The API returns the dispute folder information if the transaction identified by its transaction Identifier is disputed. If so, it provides access to the full dispute content, including:
- General dispute folder details such as the dispute reason and status
- Cardholder information including card status and billing amount
- The issuer accounting balance
- Transaction details including the reconciliation amount, transaction type, and merchant information
The response may also be enriched (when embed fields are specified in the input) with additional data related to added events, performed postings, attached documents, and messages exchanged with the scheme, representing the dispute cycle history.
If the transaction is not disputed, a 404 response code is returned along with a status message indicating that no Dispute Folder has been found.'
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: transactionId
in: path
description: Transaction Id
required: true
type: string
- name: embed
in: query
description: Embedded Fields
required: false
type: array
items:
type: string
enum:
- events
- postings
- documents
- messages
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/ApiResponseEntityDispute'
security:
- basic: []
deprecated: false
/acquiring/transaction/v2.0/acquirers/{acquirerId}/transactions/{transactionId}:
get:
tags:
- Transaction
summary: Retrieve a transaction (deprecated, please use v2.1 call)
description: 'This operation uses the unique transactionId to retrieve the transaction data
'
operationId: getTransaction
parameters:
- name: acquirerId
in: path
description: Unique identification of the acquirer, determined by equensWorldline
required: true
schema:
type: string
- name: transactionId
in: path
description: 'Unique identification of the transaction
examples TDS16172008721825920, TDS16172008721825921
'
required: true
schema:
type: string
responses:
200:
description: Successful
content:
application/json:
schema:
$ref: '#/components/schemas/Transaction'
example:
transactionIdentification:
transactionId: TDS16172008721825920
actionId: 432956ee-6974-42d2-bfdb-878997f21653
acquirerReferenceNumber: '11223344662288134679854'
merchantReference: trx reference by merchant
merchantTransactionReference: DEPRECATED. Not available in v2.1. Please use merchantReference
pspReference: string
retrievalReferenceNumber: string
stan: 12752
contractIdentification:
acquirerId: '315000001'
pspId: string
holdingId: 200
merchantId: '1001'
contractId: '10011'
cardAcceptorId: '1001'
siteId: 100111
terminalId: W01AB01
approvalCode: AB90EF
brand: MAES
cardAcceptorNameLocation: Purchase Merchant/ CC \ARNHEM \NLD
channel: 1
contactlessIndicator: 1
creditDebitIndicator: D
forwardingInstitutionId: '671734512'
matStatus: '1'
merchantCategoryCode: 7000
paymentFacilitatorId: '10000000000'
paymentInfo:
- merchantPaymentId: SO-000000017036619028
merchantPaymentAggregationLevelCode: '02'
paymentType: '03'
paymentDate: '2024-02-21T00:00:00+01:00'
paymentCrossReferenceURI: acquiring/payment/v2.0/payments/acquirers/XXX/payment/XXX?paymentDate=YYYY-MM-DD
paymentProductTypeCode: '2'
posEntryMode: 79x
pricePlanTarifId: tarifId
processingDateTimeScheme: '2024-03-21T15:52:01+01:00'
region: Netherlands Maestro
regionCode: '31'
subMerchantId: '734188'
terminalBatchReference: '0000000216'
terminalProtocol: '02'
transactionDateTime: '2024-03-21T15:52:01+01:00'
transactionDescription: ''
transactionFeePricePlanTypeCode: '01'
transactionLevel: Contract
transactionStatus: TFEE
transactionType: Purchase Presentment
transactionTypeCode: '904'
truncatedPan: '6731230000000123'
vatLabel: ''
result3ds: ''
version3ds: ''
cavv: string
xid: string
ucaf: string
mitCause: Unscheduled
initiatorType: Cardholder
captureSequenceNumber: 2
captureSequenceCount: 3
schemeMerchantId: string
schemeTransactionId: string
paymentInitiationChannel: '0'
transactionAmount:
amount: '3.00'
currency: EUR
transactionVatAmount:
amount: '3.00'
currency: EUR
merchantTransactionFeeAmount:
amount: '3.00'
currency: EUR
merchantTransactionFeeVatAmount:
amount: '3.00'
currency: EUR
netAmount:
amount: '3.00'
currency: EUR
schemeMarkupAmount:
amount: '3.00'
currency: EUR
interchangeFeeAmount:
amount: '3.00'
currency: EUR
cashBackAmount:
amount: '3.00'
currency: EUR
acquirerMarkupAmount:
amount: '3.00'
currency: EUR
merchantTransactionAmount:
amount: '3.00'
currency: EUR
400:
description: Invalid input provided
content: {}
401:
description: Unauthorized
content: {}
403:
description: Forbidden
content: {}
404:
description: Resource not found
content: {}
500:
description: Unexpected error or Internal error
content: {}
502:
description: Backend service problem
content: {}
/acquiring/transaction/v2.1/acquirers/{acquirerId}/transactions/{transactionId}:
get:
tags:
- Transaction
summary: Retrieve a transaction
description: 'This operation uses the unique transactionId to retrieve the transaction data. A list will be returned.
'
operationId: getTransactionById
parameters:
- name: acquirerId
in: path
description: Unique identification of the acquirer, determined by equensWorldline
required: true
schema:
type: string
- name: transactionId
in: path
description: 'Unique identification of the transaction
examples TDS16172008721825920, TDS16172008721825921
'
required: true
schema:
type: string
responses:
200:
description: Successful
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Transaction'
examples:
POS:
value:
- transactionIdentification:
transactionId: TDS16172008721825920
actionId: 432956ee-6974-42d2-bfdb-878997f21653
acquirerReferenceNumber: '11223344662288134679854'
merchantReference: trx reference by merchant
merchantTransactionReference: DEPRECATED. Not available in v2.1. Please use merchantReference
pspReference: string
retrievalReferenceNumber: string
stan: 12752
contractIdentification:
acquirerId: '315000001'
pspId: string
holdingId: 200
merchantId: '1001'
contractId: '10011'
cardAcceptorId: '1001'
siteId: 100111
terminalId: W01AB01
approvalCode: AB90EF
brand: MAES
cardAcceptorNameLocation: Purchase Merchant/ CC \ARNHEM \NLD
channel: 1
contactlessIndicator: 1
creditDebitIndicator: D
forwardingInstitutionId: '671734512'
matStatus: '1'
merchantCategoryCode: 7000
paymentFacilitatorId: '10000000000'
paymentInfo:
- merchantPaymentId: SO-000000017036619028
merchantPaymentAggregationLevelCode: '02'
paymentType: '03'
paymentDate: '2024-02-14T00:00:00+01:00'
paymentCrossReferenceURI: acquiring/payment/v2.0/payments/acquirers/XXX/payment/XXX?paymentDate=YYYY-MM-DD
paymentProductTypeCode: '2'
posEntryMode: 79x
pricePlanTarifId: tarifId
processingDateTimeScheme: '2024-02-14T12:20:56+01:00'
region: Netherlands Maestro
regionCode: '31'
subMerchantId: '734188'
terminalBatchReference: '0000000216'
terminalProtocol: '02'
transactionDateTime: '2024-02-14T12:20:56+01:00'
transactionDescription: ''
transactionFeePricePlanTypeCode: '01'
transactionLevel: Contract
transactionStatus: TFEE
transactionType: Purchase Presentment
transactionTypeCode: '904'
truncatedPan: '6731230000000123'
vatLabel: ''
result3ds: ''
version3ds: ''
cavv: string
xid: string
ucaf: string
mitCause: Unscheduled
initiatorType: Cardholder
captureSequenceNumber: 2
captureSequenceCount: 3
schemeMerchantId: string
schemeTransactionId: string
paymentInitiationChannel: '0'
transactionAmount:
amount: '3.00'
currency: EUR
transactionVatAmount:
amount: '3.00'
currency: EUR
merchantTransactionFeeAmount:
amount: '3.00'
currency: EUR
merchantTransactionFeeVatAmount:
amount: '3.00'
currency: EUR
netAmount:
amount: '3.00'
currency: EUR
schemeMarkupAmount:
amount: '3.00'
currency: EUR
interchangeFeeAmount:
amount: '3.00'
currency: EUR
cashBackAmount:
amount: '3.00'
currency: EUR
acquirerMarkupAmount:
amount: '3.00'
currency: EUR
merchantTransactionAmount:
amount: '3.00'
currency: EUR
CNP:
value:
- transactionIdentification:
transactionId: ACQ_EU2-20230926085528-000000000000106006
actionId: 4bcccd2c-b364-4b4d-b64d-c266914e70ba
acquirerReferenceNumber: '11223344662288134679854'
merchantReference: trx reference by merchant
merchantTransactionReference: DEPRECATED. Not available in v2.1. Please use merchantReference
pspReference: string
retrievalReferenceNumber: string
stan: 12752
contractIdentification:
acquirerId: '315000001'
pspId: PSP11112222
holdingId: 200
merchantId: '1001'
contractId: '10011'
cardAcceptorId: '90100110'
siteId: 100111
terminalId: W01AB01
approvalCode: AB90EF
brand: MAST
cardAcceptorNameLocation: Event Payment Solutions 1 Rotterdam
channel: 2
contactlessIndicator: null
creditDebitIndicator: D
forwardingInstitutionId: '671734512'
matStatus: ''
merchantCategoryCode: 7999
paymentFacilitatorId: '10000000000'
paymentInfo:
- merchantPaymentId: SO-000000017036619028
merchantPaymentAggregationLevelCode: '02'
paymentType: '03'
paymentDate: '2024-02-14T00:00:00+01:00'
paymentCrossReferenceURI: acquiring/payment/v2.0/payments/acquirers/XXX/payment/XXX?paymentDate=YYYY-MM-DD
paymentProductTypeCode: '2'
posEntryMode: ''
pricePlanTarifId: tarifId
processingDateTimeScheme: '2024-02-14T12:20:56+01:00'
region: Netherlands Maestro
regionCode: '31'
subMerchantId: '734188'
terminalBatchReference: ''
terminalProtocol: ''
transactionDateTime: '2024-03-21T15:52:01+01:00'
transactionDescription: ''
transactionFeePricePlanTypeCode: '01'
transactionLevel: Contract
transactionStatus: TFEE
transactionType: Purchase Presentment
transactionTypeCode: '904'
truncatedPan: '6731230000000123'
vatLabel: ''
result3ds: Full
version3ds: V2
cavv: string
xid: string
ucaf: string
mitCause: Unscheduled
initiatorType: Cardholder
captureSequenceNumber: 2
captureSequenceCount: 3
schemeMerchantId: string
schemeTransactionId: string
paymentInitiationChannel: ''
transactionAmount:
amount: '3.00'
currency: EUR
transactionVatAmount:
amount: '3.00'
currency: EUR
merchantTransactionFeeAmount:
amount: '3.00'
currency: EUR
merchantTransactionFeeVatAmount:
amount: '3.00'
currency: EUR
netAmount:
amount: '3.00'
currency: EUR
schemeMarkupAmount:
amount: '3.00'
currency: EUR
interchangeFeeAmount:
amount: '3.00'
currency: EUR
acquirerMarkupAmount:
amount: '3.00'
currency: EUR
merchantTransactionAmount:
amount: '3.00'
currency: EUR
400:
description: Invalid input provided
content: {}
401:
description: Unauthorized
content: {}
403:
description: Forbidden
content: {}
404:
description: Resource not found
content: {}
500:
description: Unexpected error or Internal error
content: {}
502:
description: Backend service problem
content: {}
/acquiring/transaction/v2.0/acquirers/{acquirerId}/transactions:
get:
tags:
- Transaction
summary: Retrieve transactions on search criteria
description: "This operation uses query parameters to retrieve the associated transaction(s) data. \nFor example, with a MC 2nd Chargeback the unique AcquirerRefNo retrieves the unique transactionId’s and associated transaction data of all the different stages in the dispute life cycle.\nIf there is a previous and/or next page the http response header will have a link (url) to this data. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link#pagination_through_links.\nNote, startDateTime and endDateTime must be present AND at least one of these query parameters: acquirerRefNo, merchantReference, actionId, pspReference\n"
operationId: getTransactionBySearchCriteria
parameters:
- name: acquirerId
in: path
description: Unique identification of the acquirer, determined by equensWorldline
required: true
schema:
type: string
- name: acquirerRefNo
in: query
description: 'Data supplied by an acquirer to assist in identifying a transaction, e.g. for researching retrievals and chargebacks.
(Note: acquirerRefNo = acquirerReferenceNumber)
'
schema:
type: string
- name: merchantReference
in: query
description: 'This is a reference that the merchant can add to an authorization request towards the terminal by entering it via the keyboard of the merchant.
'
schema:
type: string
- name: merchantTransactionRefNo
in: query
description: '***DEPRECATED*** (please use merchantReference)
This is a reference that the merchant can add to an authorization request towards the terminal by entering it via the keyboard of the merchant.
'
schema:
type: string
- name: actionId
in: query
description: 'Action ID (example 432956ee-6974-42d2-bfdb-878997f21653)
'
schema:
type: string
- name: pspReference
in: query
description: 'Additional information provided by the concentrator to return on his statement
'
schema:
type: string
- name: startDateTime
in: query
description: 'Start DateTime the transaction was created (yyyy-mm-dd hh:mm:ss) (greater or equals to this value)
Note, startDateTime and endDateTime must be present AND at least one of these query parameters: acquirerRefNo, merchantReference, actionId, pspReference
'
required: true
schema:
type: string
format: date-time
- name: endDateTime
in: query
description: 'End DateTime the transaction was created (yyyy-mm-dd hh:mm:ss) (until this value, so not incuded)
Note, startDateTime and endDateTime must be present AND at least one of these query parameters: acquirerRefNo, merchantReference, actionId, pspReference
'
required: true
schema:
type: string
format: date-time
- name: transactionAmountFrom
in: query
description: Transaction amount (whole units), amount should be greater than or equal to this value
schema:
type: integer
format: int32
- name: transactionAmountTo
in: query
description: Transaction amount (whole units), amount should be less than this value
schema:
type: integer
format: int32
- name: transactionAmountCurrency
in: query
description: Transaction amount currency, according to ISO 4217. Required if search amount is available. Example EUR
schema:
type: string
- name: sortField
in: query
description: Sort field
schema:
type: string
enum:
- TransactionId
- TransactionDateTime
- TransactionType
- Brand
- TruncatedPan
- name: sortOrder
in: query
description: Sort order
schema:
type: string
enum:
- Ascending
- Descending
- name: pageSize
in: query
description: Page size (max 300)
schema:
type: string
- name: pageNumber
in: query
description: Page number
schema:
type: string
responses:
200:
description: Successful
headers:
Link:
description: Link header for pagination. Only available if there is a next and/or prev page.
schema:
type: string
example: </acquiring/transaction/v2.0/acquirers/abc/transactions&pageNumber=3>; rel="next", </acquiring/transaction/v2.0/acquirers/abc/transactions&pageNumber=1>; rel="prev"
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Transaction'
example:
- transactionIdentification:
transactionId: TDS16172008721825920
actionId: 432956ee-6974-42d2-bfdb-878997f21653
acquirerReferenceNumber: '11223344662288134679854'
merchantReference: trx reference by merchant
merchantTransactionReference: DEPRECATED. Not available in v2.1. Please use merchantReference
pspReference: string
retrievalReferenceNumber: string
stan: 12752
contractIdentification:
acquirerId: '315000001'
pspId: string
holdingId: 200
merchantId: '1001'
contractId: '10011'
cardAcceptorId: '1001'
siteId: 100111
terminalId: W01AB01
approvalCode: AB90EF
brand: MAES
cardAcceptorNameLocation: Purchase Merchant/ CC \ARNHEM \NLD
channel: 1
contactlessIndicator: 1
creditDebitIndicator: D
forwardingInstitutionId: '671734512'
matStatus: '1'
merchantCategoryCode: 7000
paymentFacilitatorId: '10000000000'
paymentInfo:
- merchantPaymentId: SO-000000017036619028
merchantPaymentAggregationLevelCode: '02'
paymentType: '03'
paymentDate: '2024-02-21T00:00:00+01:00'
paymentCrossReferenceURI: acquiring/payment/v2.0/payments/acquirers/XXX/payment/XXX?paymentDate=YYYY-MM-DD
paymentProductTypeCode: '2'
posEntryMode: 79x
pricePlanTarifId: tarifId
processingDateTimeScheme: '2024-03-21T15:52:01+01:00'
region: Netherlands Maestro
regionCode: '31'
subMerchantId: '734188'
terminalBatchReference: '0000000216'
terminalProtocol: '02'
transactionDat
# --- truncated at 32 KB (172 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/wordline/refs/heads/main/openapi/wordline-transaction-api-openapi.yml