Worldline Account - Authorization Restriction API
Account Authorization Restriction Controller
Account Authorization Restriction 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 Restriction API
contact: {}
host: sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/card-issuing
basePath: /api/v2
schemes:
- https
tags:
- name: Account - Authorization Restriction
description: Account Authorization Restriction Controller
paths:
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-restrictions:
get:
tags:
- Account - Authorization Restriction
summary: List the Authorization Restrictions (by issuer ref.)
description: Operation to get the list of Authorization Restrictions on an Account.
operationId: getMultipleAuthorizationRestrictionsByExtAcctRef
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: issuerAccountExternalReference
in: path
required: true
type: string
- name: issuerId
in: path
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityGetAuthorizationRestrictions'
'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}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides
: get:
tags:
- Account - Authorization Restriction
summary: List the Authorization Restriction Overrides (by issuer ref.)
description: Operation to get the list of overrides on an Authorization Restriction, identified by its authorizationRestrictionReference.
operationId: getMultipleAuthorizationRestrictionOverridesByExtAcctRef
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: all
in: query
required: false
type: boolean
default: false
- name: authorizationRestrictionReference
in: path
required: true
type: string
- name: issuerAccountExternalReference
in: path
required: true
type: string
- name: issuerId
in: path
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityGetAuthorizationRestrictionOverrides'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestErrorApiResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/UnauthorizedErrorApiResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ForbiddenErrorApiResponse'
'404':
description: Not found
schema:
$ref: '#/definitions/NotFoundErrorApiResponse'
'500':
description: Internal server error
schema:
$ref: '#/definitions/InternalServerErrorErrorApiResponse'
'502':
description: Bad gateway
schema:
$ref: '#/definitions/BadGatewayErrorApiResponse'
security:
- basic: []
deprecated: false
post:
tags:
- Account - Authorization Restriction
summary: Create an Authorization Restriction Override (by issuer ref.)
description: Operation to override an Authorization Restriction, identified by its authorizationRestrictionReference.
operationId: createAuthorizationRestrictionOverrideByExtAcctRef
consumes:
- application/json
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: authorizationRestrictionReference
in: path
required: true
type: string
- name: issuerAccountExternalReference
in: path
required: true
type: string
- name: issuerId
in: path
required: true
type: string
- in: body
name: requestBody
required: true
schema:
$ref: '#/definitions/CreateAuthorizationRestrictionOverrideRequest'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityCreateAuthorizationRestrictionOverride'
'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}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}
: get:
tags:
- Account - Authorization Restriction
summary: Retrieve an Authorization Restriction Override (by issuer ref.)
description: Operation to fetch an existing Authorization Restriction Override, identified by its authorizationRestrictionOverrideReference.
operationId: getSingleAuthorizationRestrictionOverrideByExtAcctRef
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: authorizationRestrictionOverrideReference
in: path
required: true
type: string
- name: authorizationRestrictionReference
in: path
required: true
type: string
- name: issuerAccountExternalReference
in: path
required: true
type: string
- name: issuerId
in: path
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityGetAuthorizationRestrictionOverride'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestErrorApiResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/UnauthorizedErrorApiResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ForbiddenErrorApiResponse'
'404':
description: Not found
schema:
$ref: '#/definitions/NotFoundErrorApiResponse'
'500':
description: Internal server error
schema:
$ref: '#/definitions/InternalServerErrorErrorApiResponse'
'502':
description: Bad gateway
schema:
$ref: '#/definitions/BadGatewayErrorApiResponse'
security:
- basic: []
deprecated: false
put:
tags:
- Account - Authorization Restriction
summary: Update an Authorization Restriction Override (by issuer ref.)
description: 'Operation to update an existing Authorization Restriction Override, identified by its authorizationRestrictionOverrideReference.
Only the provided attributes are updated (other ones are not modified).
Optional attributes can be set to null (JSON keyword).'
operationId: modifyAuthorizationRestrictionOverrideByExtAcctRef
consumes:
- application/json
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: authorizationRestrictionOverrideReference
in: path
required: true
type: string
- name: authorizationRestrictionReference
in: path
required: true
type: string
- name: issuerAccountExternalReference
in: path
required: true
type: string
- name: issuerId
in: path
required: true
type: string
- in: body
name: requestBody
required: true
schema:
$ref: '#/definitions/ModifyAuthorizationRestrictionOverrideRequest'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityModifyAuthorizationRestrictionOverride'
'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
delete:
tags:
- Account - Authorization Restriction
summary: Delete an Authorization Restriction Override (by issuer ref.)
description: Operation to delete an existing Authorization Restriction Override, identified by its authorizationRestrictionOverrideReference.
operationId: deleteAuthorizationRestrictionOverrideByExtAcctRef
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: authorizationRestrictionOverrideReference
in: path
required: true
type: string
- name: authorizationRestrictionReference
in: path
required: true
type: string
- name: issuerAccountExternalReference
in: path
required: true
type: string
- name: issuerId
in: path
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityDeleteAuthorizationRestrictionOverride'
'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-restrictions:
get:
tags:
- Account - Authorization Restriction
summary: List the Authorization Restrictions
description: Operation to get the list of Authorization Restrictions on an Account.
operationId: getMultipleAuthorizationRestrictions
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
required: true
type: string
- name: issuerId
in: path
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityGetAuthorizationRestrictions'
'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-restrictions/{authorizationRestrictionReference}:
get:
tags:
- Account - Authorization Restriction
summary: Retrieve an Authorization Restriction
description: Operation to fetch an existing Authorization Restriction, identified by its authorizationRestrictionReference.
operationId: getSingleAuthorizationRestriction
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
required: true
type: string
- name: authorizationRestrictionReference
in: path
required: true
type: string
- name: issuerId
in: path
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityGetAuthorizationRestriction'
'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-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides
: get:
tags:
- Account - Authorization Restriction
summary: List the Authorization Restriction Overrides
description: Operation to get the list of overrides on an Authorization Restriction, identified by its authorizationRestrictionReference.
operationId: getMultipleAuthorizationRestrictionOverrides
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
required: true
type: string
- name: all
in: query
required: false
type: boolean
default: false
- name: authorizationRestrictionReference
in: path
required: true
type: string
- name: issuerId
in: path
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityGetAuthorizationRestrictionOverrides'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestErrorApiResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/UnauthorizedErrorApiResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ForbiddenErrorApiResponse'
'404':
description: Not found
schema:
$ref: '#/definitions/NotFoundErrorApiResponse'
'500':
description: Internal server error
schema:
$ref: '#/definitions/InternalServerErrorErrorApiResponse'
'502':
description: Bad gateway
schema:
$ref: '#/definitions/BadGatewayErrorApiResponse'
security:
- basic: []
deprecated: false
post:
tags:
- Account - Authorization Restriction
summary: Create an Authorization Restriction Override
description: Operation to override an Authorization Restriction, identified by its authorizationRestrictionReference.
operationId: createAuthorizationRestrictionOverride
consumes:
- application/json
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
required: true
type: string
- name: authorizationRestrictionReference
in: path
required: true
type: string
- name: issuerId
in: path
required: true
type: string
- in: body
name: requestBody
required: true
schema:
$ref: '#/definitions/CreateAuthorizationRestrictionOverrideRequest'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityCreateAuthorizationRestrictionOverride'
'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-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}
: get:
tags:
- Account - Authorization Restriction
summary: Retrieve an Authorization Restriction Override
description: Operation to fetch an existing Authorization Restriction Override, identified by its authorizationRestrictionOverrideReference.
operationId: getSingleAuthorizationRestrictionOverride
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
required: true
type: string
- name: authorizationRestrictionOverrideReference
in: path
required: true
type: string
- name: authorizationRestrictionReference
in: path
required: true
type: string
- name: issuerId
in: path
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityGetAuthorizationRestrictionOverride'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestErrorApiResponse'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/UnauthorizedErrorApiResponse'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ForbiddenErrorApiResponse'
'404':
description: Not found
schema:
$ref: '#/definitions/NotFoundErrorApiResponse'
'500':
description: Internal server error
schema:
$ref: '#/definitions/InternalServerErrorErrorApiResponse'
'502':
description: Bad gateway
schema:
$ref: '#/definitions/BadGatewayErrorApiResponse'
security:
- basic: []
deprecated: false
put:
tags:
- Account - Authorization Restriction
summary: Update an Authorization Restriction Override
description: 'Operation to update an existing Authorization Restriction Override, identified by its authorizationRestrictionOverrideReference.
Only the provided attributes are updated (other ones are not modified).
Optional attributes can be set to null (JSON keyword).'
operationId: modifyAuthorizationRestrictionOverride
consumes:
- application/json
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
required: true
type: string
- name: authorizationRestrictionOverrideReference
in: path
required: true
type: string
- name: authorizationRestrictionReference
in: path
required: true
type: string
- name: issuerId
in: path
required: true
type: string
- in: body
name: requestBody
required: true
schema:
$ref: '#/definitions/ModifyAuthorizationRestrictionOverrideRequest'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityModifyAuthorizationRestrictionOverride'
'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
delete:
tags:
- Account - Authorization Restriction
summary: Delete an Authorization Restriction Override
description: Operation to delete an existing Authorization Restriction Override, identified by its authorizationRestrictionOverrideReference.
operationId: deleteAuthorizationRestrictionOverride
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
required: true
type: string
- name: authorizationRestrictionOverrideReference
in: path
required: true
type: string
- name: authorizationRestrictionReference
in: path
required: true
type: string
- name: issuerId
in: path
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntityDeleteAuthorizationRestrictionOverride'
'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-restrictions/search:
post:
tags:
- Account - Authorization Restriction
summary: Search the Authorization Restrictions
description: Operation to search the Authorization Restrictions on an Account, together with active and future Overrides, if any.
operationId: searchAuthorizationRestrictionsByAcctRef
consumes:
- application/json
produces:
- application/json
parameters:
- name: accountReference
in: path
required: true
type: string
- name: issuerId
in: path
required: true
type: string
- in: body
name: requestBody
required: true
schema:
$ref: '#/definitions/SearchAuthorizationRestrictionRequest'
- name: WL-Correlation-ID
in: header
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResponseEntitySearchAuthorizationRestrictionResponse'
'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-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}/history
: get:
tags:
- Account - Authorization Restriction
summary: Get authorization restriction override history by external account reference
operationId: getAuthorizationRestrictionOverrideHistoryByExtAcctRef
produces:
- application/json
parameters:
- name: authorizationRestrictionOverrideReference
in: path
description: authorizationRestrictionOverrideReference
required: true
type: string
- name: authorizationRestrictionReference
in: path
description: authorizationRestrictionReference
required: true
type: string
- 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/ApiResponseEntityGetAuthorizationRestrictionOverrideHistory'
'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:
# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/wordline/refs/heads/main/openapi/wordline-account-authorization-restriction-api-openapi.yml