Worldline Account - Statement API
Account Statement Api Controller
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 Account - Statement API
contact: {}
host: sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/card-issuing
basePath: /api/v2
schemes:
- https
tags:
- name: Account - Statement
description: Account Statement Api Controller
paths:
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements:
get:
tags:
- Account - Statement
summary: Retrieve statements list for the account by external reference
operationId: listStatementsByAccountIssuerExtRef
description: "The API is used to get the list of statements generated for an account and optionally a requested period.\nIt is also possible to get reprint information of a statement.\nThe input parameters are:\n- the involved account: it can be provided by using the account reference or the issuer external account reference,\n- the search period (start date / end date),\n- the embed field \"reprint-history\" if needed.\n\nThe API returns:\n•\tin the consumer cards context, the list of statements of the paying account\n•\tin the commercial cards context, the list of statements of the employee account whether it is paid by another account or not. \n\nIn response, the list of statement is provided with the financial information of each statement such as:\nprevious cycle balance (start balance), end cycle balance, due amount, total of payments, ..."
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: issuerAccountExternalReference
in: path
description: Issuer Account External Reference
required: true
type: string
- name: periodStartDateTime
in: query
description: 'Period start date of cycle closure to include (format : yyyy-MM-ddTHH:mm:ssZ)'
required: false
type: string
- name: periodEndDateTime
in: query
description: 'Period end date of cycle closure to include (format : yyyy-MM-ddTHH:mm:ssZ)'
required: false
type: string
- name: includeOriginalAccount
in: query
description: 'Parameter to indicate if data related to the original account should be returned : case of a product change or a card reallocation (only for corporate cards).Default value is false.'
required: false
type: boolean
default: false
- name: embed
in: query
description: Embedded Fields
required: false
type: array
items:
type: string
enum:
- reprintHistory
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/ApiResponseEntityListStatement'
security:
- basic: []
deprecated: false
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/last:
get:
tags:
- Account - Statement
summary: Retrieve last statement for the account by external reference
operationId: retrieveLastStatementByAccountIssuerExtRef
description: "The API is used to get the financial information of the last statement generated for an account such as:\nprevious cycle balance (start balance), end cycle balance, due amount, total of payments, ...\nIt is also possible to get reprint information of the statement.\nThe input parameters are:\n- the involved account: it can be provided by using the account reference or the issuer external account reference,\n- the embed field \"reprint-history\" if needed.\n\nThe API returns:\n•\tin the consumer cards context, the statement of the paying account\n•\tin the commercial cards context, the statement of the employee account whether it is paid by another account or not."
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: issuerAccountExternalReference
in: path
description: Issuer Account External Reference
required: true
type: string
- name: embed
in: query
description: Embedded Fields
required: false
type: array
items:
type: string
enum:
- reprintHistory
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/ApiResponseEntityStatement'
security:
- basic: []
deprecated: false
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/last/operations:
get:
tags:
- Account - Statement
summary: List operations for last account statement by external reference
description: 'The API is used to get the list of operations of the last statement generated for an account.
The input account can be provided by using:
- the account reference
- or the issuer external account reference.'
operationId: listLastStatementOperationsByAccountIssuerExtRef
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: issuerAccountExternalReference
in: path
description: Issuer Account 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/ApiResponseEntityListOperation'
security:
- basic: []
deprecated: false
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/last/reprint:
post:
tags:
- Account - Statement
summary: Reprint last statement by external reference
description: 'The API is used to request the reprint of the last statement for an account.
The input account can be provided by using:
- the account reference
- or the issuer external account reference.
As a result, the statement data is extracted again and pushed to the output management module'
operationId: reprintLastStatementByAccountIssuerExtRef
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: issuerAccountExternalReference
in: path
description: Issuer Account 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/ApiResponseEntityReprintStatementResponse'
security:
- basic: []
deprecated: false
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/next:
get:
tags:
- Account - Statement
summary: Retrieve next statement for the account by external reference
description: "The API is used to get the financial information based on the last statement generated for an account such as:\ncurrent cycle balance, cycle closure date, payment due date, next cycle closure date (end cycle balance, due amount, total of payments are not yet known).\nThe input parameters are:\n- the issuerId\n- the involved account: it can be provided by using the account reference or the issuer external account reference,\n\nThe API returns:\n•\tin the consumer cards context, the statement of the paying account\n•\tin the commercial cards context, the statement of the employee account whether it is paid by another account or not."
operationId: retrieveNextStatementByAccountIssuerExtRef
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: issuerAccountExternalReference
in: path
description: Issuer Account External Reference
required: true
type: string
- name: embed
in: query
description: Embedded Fields
required: false
type: array
items:
type: string
enum:
- reprintHistory
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/ApiResponseEntityStatement'
security:
- basic: []
deprecated: false
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/next/operations:
get:
tags:
- Account - Statement
summary: List operations for next account statement by external reference
description: "The API is used to get the list of operations generated for an account since the last cycle closure date. \nThose operations will be part of the next statement.\nThe input account can be provided by using:\n- the account reference\n- or the issuer external account reference."
operationId: listNextStatementOperationsByAccountIssuerExtRef
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: issuerAccountExternalReference
in: path
description: Issuer Account 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/ApiResponseEntityListOperation'
security:
- basic: []
deprecated: false
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/{cycleClosureDate}:
get:
tags:
- Account - Statement
summary: Retrieve one statement from the list by external reference
description: "The API is used to get the financial information for an account statement such as: previous cycle balance (start balance), end cycle balance, due amount, total of payments, ...\nThe input account can be provided by using:\n•\tthe account reference\n•\tor the issuer external account reference.\nThe statement involved by the request has to be provided by giving the cycle closure date.\n\nThe API returns:\n•\tin the consumer cards context, the statement of the paying account\n•\tin the commercial cards context, the statement of the employee account whether it is paid by another account or not."
operationId: retrieveStatementByAccountIssuerExtRef
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: issuerAccountExternalReference
in: path
description: Issuer Account External Reference
required: true
type: string
- name: cycleClosureDate
in: path
description: 'Cycle Closure Date (format : yyyy-MM-ddTHH:mm:ssZ)
HH:mm:ss should be filled with 23:59:59'
required: true
type: string
- name: embed
in: query
description: Embedded Fields
required: false
type: array
items:
type: string
enum:
- reprintHistory
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/ApiResponseEntityStatement'
security:
- basic: []
deprecated: false
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/{cycleClosureDate}/operations:
get:
tags:
- Account - Statement
summary: List operations for an account statement by external reference
description: "The API is used to get the list of operations posted to an account included in a statement.\nThe input account can be provided by using:\n•\tthe account reference\n•\tor the issuer external account reference.\nThe statement involved by the request has to be provided by giving the cycle closure date.\nIt is also possible to exclude sub-operations generated during the payment (manual or automatic) / reimbursement apportionment on accounts."
operationId: listStatementOperationsByAccountIssuerExtRef
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: issuerAccountExternalReference
in: path
description: Issuer Account External Reference
required: true
type: string
- name: cycleClosureDate
in: path
description: 'Cycle Closure Date (format : yyyy-MM-ddTHH:mm:ssZ)
HH:mm:ss should be filled with 23:59:59'
required: true
type: string
- name: excludeOperationKinds
in: query
description: 'Parameter to filter out sub-operations generated during the payment (manual or automatic)/reimbursement apportionment on accounts Available value : SUBPAYOP (apportionment operation)'
required: false
type: array
items:
type: string
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/ApiResponseEntityListOperation'
security:
- basic: []
deprecated: false
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/{cycleClosureDate}/reprint:
post:
tags:
- Account - Statement
summary: Reprint a statement by external reference
description: 'The API is used to request the reprint of a statement for an account.
The input account can be provided by using:
- the account reference
- or the issuer external account reference.
The statement involved by the request has to be provided by giving the cycle closure date
As a result, the statement data is extracted again and pushed to the output management module.'
operationId: reprintStatementByAccountIssuerExtRef
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: issuerAccountExternalReference
in: path
description: Issuer Account External Reference
required: true
type: string
- name: cycleClosureDate
in: path
description: 'Cycle Closure Date (format : yyyy-MM-ddTHH:mm:ssZ)
HH:mm:ss should be filled with 23:59:59'
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/ApiResponseEntityReprintStatementResponse'
security:
- basic: []
deprecated: false
/issuers/{issuerId}/accounts/{accountReference}/statements:
get:
tags:
- Account - Statement
summary: Retrieve statements list for the account
operationId: listStatements
description: "The API is used to get the list of statements generated for an account and optionally a requested period.\nIt is also possible to get reprint information of a statement.\nThe input parameters are:\n- the involved account: it can be provided by using the account reference or the issuer external account reference,\n- the search period (start date / end date),\n- the embed field \"reprint-history\" if needed.\n\nThe API returns:\n•\tin the consumer cards context, the list of statements of the paying account\n•\tin the commercial cards context, the list of statements of the employee account whether it is paid by another account or not. \n\nIn response, the list of statement is provided with the financial information of each statement such as:\nprevious cycle balance (start balance), end cycle balance, due amount, total of payments, ..."
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: accountReference
in: path
description: Account Reference
required: true
type: string
- name: periodStartDateTime
in: query
description: 'Period start date of cycle closure to include (format : yyyy-MM-ddTHH:mm:ssZ)'
required: false
type: string
- name: periodEndDateTime
in: query
description: 'Period end date of cycle closure to include (format : yyyy-MM-ddTHH:mm:ssZ)'
required: false
type: string
- name: includeOriginalAccount
in: query
description: 'Parameter to indicate if data related to the original account should be returned : case of a product change or a card reallocation (only for corporate cards).Default value is false.'
required: false
type: boolean
default: false
- name: embed
in: query
description: Embedded Fields
required: false
type: array
items:
type: string
enum:
- reprintHistory
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/ApiResponseEntityListStatement'
security:
- basic: []
deprecated: false
/issuers/{issuerId}/accounts/{accountReference}/statements/last:
get:
tags:
- Account - Statement
summary: Retrieve last statement for the account
operationId: retrieveLastStatement
description: "The API is used to get the financial information of the last statement generated for an account such as:\nprevious cycle balance (start balance), end cycle balance, due amount, total of payments, ...\nIt is also possible to get reprint information of the statement.\nThe input parameters are:\n- the involved account: it can be provided by using the account reference or the issuer external account reference,\n- the embed field \"reprint-history\" if needed.\n\nThe API returns:\n•\tin the consumer cards context, the statement of the paying account\n•\tin the commercial cards context, the statement of the employee account whether it is paid by another account or not."
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: accountReference
in: path
description: Account Reference
required: true
type: string
- name: embed
in: query
description: Embedded Fields
required: false
type: array
items:
type: string
enum:
- reprintHistory
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':
# --- truncated at 32 KB (113 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/wordline/refs/heads/main/openapi/wordline-account-statement-api-openapi.yml