Worldline Account - Authorization API
Account Authorization Controller
Account Authorization Controller
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 - Authorization API
contact: {}
host: sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/card-issuing
basePath: /api/v2
schemes:
- https
tags:
- name: Account - Authorization
description: Account Authorization Controller
paths:
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-business-cases:
get:
tags:
- Account - Authorization
summary: Get business cases by external account reference
operationId: getMultipleBusinessCasesByExtAcctRef
produces:
- application/json
parameters:
- name: WL-Correlation-ID
in: header
required: false
type: string
- name: WL-Username
in: header
required: false
type: string
- name: WL-Peer-ID
in: header
required: false
type: string
- name: endTime
in: query
description: endTime
required: true
type: string
format: date-time
- name: issuerAccountExternalReference
in: path
description: issuerAccountExternalReference
required: true
type: string
- name: issuerId
in: path
description: issuerId
required: true
type: string
- name: startTime
in: query
description: startTime
required: true
type: string
format: date-time
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityGetBusinessCases'
'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}/authorization-business-cases/search:
post:
tags:
- Account - Authorization
summary: Enquire business cases for request
operationId: enquireBusinessCases
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: businessCasesEnquiryRequest
description: businessCasesEnquiryRequest
required: true
schema:
$ref: '#/definitions/BusinessCasesEnquiryRequest'
- name: issuerId
in: path
description: issuerId
required: true
type: string
- name: requestorReference
in: query
description: Requestor Reference
required: false
type: string
- name: userReference
in: query
description: User Reference
required: false
type: string
- name: WL-Correlation-ID
in: header
description: WL-Correlation-ID
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityGetBusinessCases'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestErrorApiResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/UnauthorizedResponseMetadata'
'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: []
? /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-business-cases/{businessCaseId}
: get:
tags:
- Account - Authorization
summary: Get business case by external account reference
description: This operation enables to retrieve the details of an authorization identified by its business case Id.
operationId: getSingleBusinessCaseByExtAcctRef
produces:
- application/json
parameters:
- name: WL-Correlation-ID
in: header
required: false
type: string
- name: WL-Username
in: header
required: false
type: string
- name: WL-Peer-ID
in: header
required: false
type: string
- name: businessCaseId
in: path
description: businessCaseId
required: true
type: string
- name: endTime
in: query
description: 'example: 2012-12-31T22:00:00.000
End of time period (excluded) for which transactions have to be provided.'
required: true
type: string
format: date-time
- name: issuerAccountExternalReference
in: path
description: issuerAccountExternalReference
required: true
type: string
- name: issuerId
in: path
description: issuerId
required: true
type: string
- name: startTime
in: query
description: 'example: 2012-12-31T22:00:00.000
Start of time period (included) for which transactions have to be provided.'
required: true
type: string
format: date-time
- name: filter
in: query
description: Filtered Fields
required: false
type: array
items:
type: string
collectionFormat: multi
allowEmptyValue: false
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityGetBusinessCase'
'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}/accounts/external-accounts/{issuerAccountExternalReference}/authorizations:
get:
tags:
- Account - Authorization
summary: Get authorizations by external account reference
operationId: getMultipleAuthorizationsByExtAcctRef
description: 'This operation enables to retrieve a list of authorizations associated to an account for a given period.
In response, for each authorization, the main properties of the authorization are provided such as the type of operation, the amount, the result code, the acceptance context.'
produces:
- application/json
parameters:
- name: WL-Correlation-ID
in: header
required: false
type: string
- name: WL-Username
in: header
required: false
type: string
- name: WL-Peer-ID
in: header
required: false
type: string
- name: endTime
in: query
description: 'Example: 2012-12-31T22:00:00.000
End of time period (excluded) for which transactions have to be provided.'
required: true
type: string
format: date-time
- name: issuerAccountExternalReference
in: path
description: issuerAccountExternalReference
required: true
type: string
- name: issuerId
in: path
description: issuerId
required: true
type: string
- name: startTime
in: query
description: 'Example: 2012-12-31T22:00:00.000
Start of time period (included) for which transactions have to be provided.'
required: true
type: string
format: date-time
- name: filter
in: query
description: Filtered Fields
required: false
type: array
items:
type: string
collectionFormat: multi
allowEmptyValue: false
- name: page
in: query
description: Page
required: false
type: integer
default: 0
format: int32
allowEmptyValue: false
- name: offset
in: query
description: 'Offset, maximum: 100'
required: false
type: integer
default: 100
format: int32
allowEmptyValue: false
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityGetAuthorizations'
'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}/accounts/external-accounts/{issuerAccountExternalReference}/authorizations/{authorizationId}:
get:
tags:
- Account - Authorization
summary: Get authorization by external account reference
description: This operation enables to retrieve the details of an authorization identified by its transaction Id.
operationId: getSingleAuthorizationByExtAcctRef
produces:
- application/json
parameters:
- name: WL-Correlation-ID
in: header
required: false
type: string
- name: WL-Username
in: header
required: false
type: string
- name: WL-Peer-ID
in: header
required: false
type: string
- name: authorizationId
in: path
description: authorizationId
required: true
type: string
- name: endTime
in: query
description: 'Example: 2012-12-31T22:00:00.000
End of time period (excluded) for which transactions have to be provided.'
required: true
type: string
format: date-time
- name: issuerAccountExternalReference
in: path
description: issuerAccountExternalReference
required: true
type: string
- name: issuerId
in: path
description: Not used, will be removed
required: true
type: string
- name: startTime
in: query
description: 'Example: 2012-12-31T22:00:00.000
Start of time period (included) for which transactions have to be provided.'
required: true
type: string
format: date-time
- name: filter
in: query
description: Filtered Fields
required: false
type: array
items:
type: string
collectionFormat: multi
allowEmptyValue: false
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityGetAuthorization'
'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}/accounts/{accountReference}/authorization-business-cases:
get:
tags:
- Account - Authorization
summary: Get business cases
operationId: getMultipleBusinessCases
produces:
- application/json
parameters:
- name: WL-Correlation-ID
in: header
required: false
type: string
- name: WL-Username
in: header
required: false
type: string
- name: WL-Peer-ID
in: header
required: false
type: string
- name: accountReference
in: path
description: accountReference
required: true
type: string
- name: endTime
in: query
description: 'example: 2012-12-31T22:00:00.000
End of time period (excluded) for which transactions have to be provided.'
required: true
type: string
format: date-time
- name: issuerId
in: path
description: issuerId
required: true
type: string
- name: startTime
in: query
description: 'example: 2012-12-31T22:00:00.000
Start of time period (included) for which transactions have to be provided.'
required: true
type: string
format: date-time
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityGetBusinessCases'
'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}/accounts/{accountReference}/authorization-business-cases/{businessCaseId}:
get:
tags:
- Account - Authorization
summary: Get business case
description: This operation enables to retrieve the details of an authorization identified by its business case Id.
operationId: getSingleBusinessCase
produces:
- application/json
parameters:
- name: WL-Correlation-ID
in: header
required: false
type: string
- name: WL-Username
in: header
required: false
type: string
- name: WL-Peer-ID
in: header
required: false
type: string
- name: accountReference
in: path
description: accountReference
required: true
type: string
- name: businessCaseId
in: path
description: businessCaseId
required: true
type: string
- name: endTime
in: query
description: endTime
required: true
type: string
format: date-time
- name: issuerId
in: path
description: issuerId
required: true
type: string
- name: startTime
in: query
description: startTime
required: true
type: string
format: date-time
- name: filter
in: query
description: Filtered Fields
required: false
type: array
items:
type: string
collectionFormat: multi
allowEmptyValue: false
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityGetBusinessCase'
'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}/accounts/{accountReference}/authorizations:
get:
tags:
- Account - Authorization
summary: Get authorizations
operationId: getMultipleAuthorizations
description: 'This operation enables to retrieve a list of authorizations associated to an account for a given period.
In response, for each authorization, the main properties of the authorization are provided such as the type of operation, the amount, the result code, the acceptance context.'
produces:
- application/json
parameters:
- name: WL-Correlation-ID
in: header
required: false
type: string
- name: WL-Username
in: header
required: false
type: string
- name: WL-Peer-ID
in: header
required: false
type: string
- name: accountReference
in: path
description: accountReference
required: true
type: string
- name: endTime
in: query
description: 'Example: 2012-12-31T22:00:00.000
End of time period (excluded) for which transactions have to be provided.'
required: true
type: string
format: date-time
- name: issuerId
in: path
description: issuerId
required: true
type: string
- name: startTime
in: query
description: 'Example: 2012-12-31T22:00:00.000
Start of time period (included) for which transactions have to be provided.'
required: true
type: string
format: date-time
- name: filter
in: query
description: Filtered Fields
required: false
type: array
items:
type: string
collectionFormat: multi
allowEmptyValue: false
- name: page
in: query
description: Page
required: false
type: integer
default: 0
format: int32
allowEmptyValue: false
- name: offset
in: query
description: 'Offset, maximum: 100'
required: false
type: integer
default: 100
format: int32
allowEmptyValue: false
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityGetAuthorizations'
'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}/accounts/{accountReference}/authorizations/{authorizationId}:
get:
tags:
- Account - Authorization
summary: Get authorization
operationId: getSingleAuthorization
produces:
- application/json
parameters:
- name: WL-Correlation-ID
in: header
required: false
type: string
- name: accountReference
in: path
description: accountReference
required: true
type: string
- name: authorizationId
in: path
description: authorizationId
required: true
type: string
x-example: Length should be 18
- name: endTime
in: query
description: endTime
required: true
type: string
format: date-time
- name: issuerId
in: path
description: issuerId
required: true
type: string
- name: startTime
in: query
description: startTime
required: true
type: string
format: date-time
- name: filter
in: query
description: Filtered Fields
required: false
type: array
items:
type: string
collectionFormat: multi
allowEmptyValue: false
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityGetAuthorization'
'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}/accounts/{accountReference}/reserves:
get:
tags:
- Account - Authorization
summary: Get reservations
operationId: getReservations
produces:
- application/json
parameters:
- name: accountReference
in: path
description: accountReference
required: true
type: string
- name: issuerId
in: path
description: issuerId
required: true
type: string
- name: WL-Correlation-ID
in: header
description: WL-Correlation-ID
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityGetReserves'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestErrorApiResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/UnauthorizedResponseMetadata'
'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: []
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/reserves:
get:
tags:
- Account - Authorization
summary: Get reservations by external account reference
operationId: getReservationsByExtAcctRef
produces:
- application/json
parameters:
- name: issuerAccountExternalReference
in: path
description: issuerAccountExternalReference
required: true
type: string
- name: issuerId
in: path
description: issuerId
required: true
type: string
- name: WL-Correlation-ID
in: header
description: WL-Correlation-ID
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityGetReserves'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestErrorApiResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/UnauthorizedResponseMetadata'
'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: []
definitions:
ApiResponseEntityGetAuthorization:
type: object
required:
- responseMetadata
properties:
data:
description: Response data
allOf:
- $ref: '#/definitions/GetAuthorizationResponse'
responseMetadata:
description: Response metadata
allOf:
- $ref: '#/definitions/ResponseMetadata'
title: ApiResponseEntityGetAuthorization
description: Issuer response entity
ApiResponseEntityGetAuthorizations:
type: object
required:
- responseMetadata
properties:
data:
type: array
items:
$ref: '#/definitions/Authorization'
responseMetadata:
description: Response metadata
allOf:
- $ref: '#/definitions/ResponseMetadata'
title: ApiResponseEntityGetAuthorizations
description: Issuer response entity
NotFoundErrorApiResponse:
type: object
required:
- responseMetadata
properties:
responseMetadata:
allOf:
- $ref: '#/definitions/NotFoundResponseMetadata'
title: NotFoundErrorApiResponse
ApiResponseEntityGetBusinessCase:
type: object
required:
- responseMetadata
properties:
data:
description: Response data
allOf:
- $ref: '#/definitions/GetBusinessCaseResponse'
responseMetadata:
description: Response metadata
allOf:
- $ref: '#/definitions/ResponseMetadata'
title: ApiResponseEntityGetBusinessCase
description: Issuer response entity
BadGatewayErrorApiResponse:
type: object
required:
- responseMetadata
properties:
responseMetadata:
allOf:
- $ref: '#/definitions/BadGatewayResponseMetadata'
title: BadGatewayErrorApiResponse
InternalServerErrorErrorApiResponse:
type: object
required:
- responseMetadata
properties:
responseMetadata:
allOf:
- $ref: '#/definitions/InternalServerErrorResponseMetadata'
title: InternalServerErrorErrorApiResponse
InternalServerErrorResponseMetadata:
type: object
required:
- correlationId
- responseDateTime
- statusCode
- statusMessage
properties:
correlationId:
type: string
description: Correlation Identifier
responseDateTime:
type: string
example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ
description: Timestamp when response date was generated
statusCode:
type: integer
format: int32
example: 500
description: HTTP status code
statusMessage:
type: string
example: Internal server error
description: Executed REST API status message
title: InternalServerErrorResponseMetadata
UnauthorizedErrorApiResponse:
type: object
required:
- responseMetadata
properties:
responseMetadata:
allOf:
- $ref: '#/definitions/UnauthorizedResponseMetadata'
title: UnauthorizedResponseMetadata
Links:
type: object
required:
- self
properties:
self:
type: string
example: /x/{x}?x=x
description: Service method URL
next:
type: string
example: /x/{x}?page[offset]=2
description: URL pagination query parameter next page
title: Links
VelocityLimitIdentifier:
type: object
properties:
velocityLimitReference:
type: string
description: 'minLength: 1
maxLength: 60
Identifies the velocity check.'
title: VelocityLimitIdentifier
UnauthorizedResponseMetadata:
type: object
required:
- correlationId
- responseDateTime
- statusCode
- statusMessage
properties:
correlationId:
type: string
description: Correlation Identifier
responseDateTime:
type: string
example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ
description: Timestamp when response date was generated
statusCode:
type: integer
format: int32
example: 401
description: HTTP status code
statusMessage:
type: string
example: Unauthorized
description: Executed REST API status message
title: UnauthorizedResponseMetadata
Authorization:
type: object
properties:
accountIdentifier:
$ref: '#/definitions/AccountIdentifier'
approvalCode:
type: string
description: 'maxLength: 10
Code computed at time of authorization and returned to requestor in case of an approval.'
authorizationBusinessCaseIdentifier:
$ref: '#/definitions/AuthorizationBusinessCaseIdentifier'
authorizationIdentifier:
$ref: '#/definitions/AuthorizationIdentifier'
businessCaseType:
type: string
description: 'examples: List [ "FinancialRequest", "FinancialVerification", "AccountVerification", "BalanceEnquiry", "StatementEnquiry", "PinChange", "PinUnblock", "PickUp", "CardReturn", "Reconciliation", "ReserveUpdate", "ReserveExpiry", "CardFileOperation", "TokenLifeCycleEvent", "Other", "Unknown" ]
This value is the same for all transactions belonging to the same business case. '
cardAcceptorCity:
type: string
description: 'maxLength: 60
City the acceptor is resident (e.g. Frankfurt).'
cardAcceptorCountry:
type: string
description: "minLength: 3\nmaxLength: 3\nISO 3166 numeric country code of the acceptor. \nExample: 076 = Bra
# --- truncated at 32 KB (81 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/wordline/refs/heads/main/openapi/wordline-account-authorization-api-openapi.yml