Worldline Account - Future Update API
Account Future Updates Api Controller
Account Future Updates Api Controller
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/wordline-account-future-update-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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 - Future Update API
contact: {}
host: sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/card-issuing
basePath: /api/v2
schemes:
- https
tags:
- name: Account - Future Update
description: Account Future Updates Api Controller
paths:
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates:
get:
tags:
- Account - Future Update
summary: Retrieve list of future changes of the account by external reference
description: 'The API is used to get the account updates that have to be applied at a schedule date.
The main input fields requested by the API are:
- The issuer ID
- The account involved by the change: It can be provided by using the account reference or the issuer external account reference
In response, a list of updates with the schedule date is provided.
It is also possible to request the account updates planned in the past and already processed.'
operationId: listAccountFutureUpdatesByIssuerExtRef
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: all
in: query
description: Retrieve also updates already processed
required: false
type: boolean
default: false
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/ApiResponseEntityListAccountFutureUpdate'
security:
- basic: []
deprecated: false
post:
x-wl-idempotent: true
tags:
- Account - Future Update
summary: Schedule new account parameters update in future by external reference
description: 'The API is used to enter the account updates that should be applied on a schedule date.
The main input fields requested by the API are:
- The issuer ID
- The account involved by the change: It can be provided by using the account reference or the issuer external account reference
- The plan date
- The updates
Idempotency 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.'
operationId: createAccountFutureUpdateByIssuerExtRef
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
- in: body
name: body
required: true
schema:
$ref: '#/definitions/CreateAccountFutureUpdateRequest'
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/ApiResponseEntityCreateAccountFutureUpdateResponse'
security:
- basic: []
deprecated: false
? /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{futureChangeReference}
: get:
tags:
- Account - Future Update
summary: Retrieve future changes for the account by external reference
description: 'The API allows to get the account updates that have to be applied at a schedule date.
The main input fields requested by the API are:
- The issuer ID
- The account involved by the change: It can be provided by using the account reference or the issuer external account reference
- The future change reference (unique per account)'
operationId: retrieveAccountFutureUpdateByIssuerExtRefAndFutureRef
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: futureChangeReference
in: path
description: future change 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/ApiResponseEntityAccountFutureUpdate'
security:
- basic: []
deprecated: false
patch:
tags:
- Account - Future Update
summary: Update future changes of the account by external reference
description: 'The API is used to modify the account updates that should be applied on a schedule date (not yet reached).
The main input fields requested by the API are:
- The issuer ID
- The account involved by the change: It can be provided by using the account reference or the issuer external account reference
- The future change reference (unique per account)
- The updates
- The reason of the future update modification'
operationId: modifyAccountFutureUpdateByExtRef
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: issuerAccountExternalReference
required: true
type: string
- name: futureChangeReference
in: path
description: Future Change Reference
required: true
type: string
- in: body
name: body
required: true
schema:
$ref: '#/definitions/ModifyAccountFutureUpdateRequest'
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/ApiResponseEntityModifyAccountFutureUpdateResponse'
security:
- basic: []
deprecated: false
/issuers/{issuerId}/accounts/{accountReference}/account-future-updates:
get:
tags:
- Account - Future Update
summary: Retrieve list of future changes of the account
description: 'The API is used to get the account updates that have to be applied at a schedule date.
The main input fields requested by the API are:
- The issuer ID
- The account involved by the change: It can be provided by using the account reference or the issuer external account reference
In response, a list of updates with the schedule date is provided.
It is also possible to request the account updates planned in the past and already processed.'
operationId: listAccountFutureUpdates
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: all
in: query
description: Retrieve also updates already processed
required: false
type: boolean
default: false
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/ApiResponseEntityListAccountFutureUpdate'
security:
- basic: []
deprecated: false
post:
x-wl-idempotent: true
tags:
- Account - Future Update
summary: Schedule new account parameters update in future
description: 'The API is used to enter the account updates that should be applied on a schedule date.
The main input fields requested by the API are:
- The issuer ID
- The account involved by the change: It can be provided by using the account reference or the issuer external account reference
- The plan date
- The updates
Idempotency 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.'
operationId: createAccountFutureUpdate
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: accountReference
in: path
description: Account Reference
required: true
type: string
- in: body
name: body
required: true
schema:
$ref: '#/definitions/CreateAccountFutureUpdateRequest'
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/ApiResponseEntityCreateAccountFutureUpdateResponse'
security:
- basic: []
deprecated: false
/issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{futureChangeReference}:
get:
tags:
- Account - Future Update
summary: Retrieve future changes for the account
description: 'The API allows to get the account updates that have to be applied at a schedule date.
The main input fields requested by the API are:
- The issuer ID
- The account involved by the change: It can be provided by using the account reference or the issuer external account reference
- The future change reference (unique per account)'
operationId: retrieveAccountFutureUpdateByFutureRef
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: futureChangeReference
in: path
description: future change 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/ApiResponseEntityAccountFutureUpdate'
security:
- basic: []
deprecated: false
patch:
tags:
- Account - Future Update
summary: Update future changes of the account
description: 'The API is used to modify the account updates that should be applied on a schedule date (not yet reached).
The main input fields requested by the API are:
- The issuer ID
- The account involved by the change: It can be provided by using the account reference or the issuer external account reference
- The future change reference (unique per account)
- The updates
- The reason of the future update modification'
operationId: modifyAccountFutureUpdate
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: accountReference
in: path
description: Account Reference
required: true
type: string
- name: futureChangeReference
in: path
description: Future Change Reference
required: true
type: string
- in: body
name: body
required: true
schema:
$ref: '#/definitions/ModifyAccountFutureUpdateRequest'
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/ApiResponseEntityModifyAccountFutureUpdateResponse'
security:
- basic: []
deprecated: false
/issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{futureChangeReference}/cancel:
post:
tags:
- Account - Future Update
summary: Cancel future changes of the account
description: 'The API is used to cancel the account updates that should be applied on a schedule date (not yet reached).
The main input fields requested by the API are:
- The issuer ID
- The account involved by the change: It can be provided by using the account reference or the issuer external account reference
- The future change reference (unique per account)
- The reason of the future update cancellation'
operationId: cancelAccountFutureUpdate
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: accountReference
in: path
description: Account Reference
required: true
type: string
- name: futureChangeReference
in: path
description: Future Change Reference
required: true
type: string
- in: body
name: body
required: true
schema:
$ref: '#/definitions/CancelAccountFutureUpdateRequest'
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/ApiResponseEntityCancelAccountFutureUpdateResponse'
security:
- basic: []
deprecated: false
? /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{futureChangeReference}/cancel
: post:
tags:
- Account - Future Update
summary: Cancel future changes of the account by external reference
description: 'The API is used to cancel the account updates that should be applied on a schedule date (not yet reached).
The main input fields requested by the API are:
- The issuer ID
- The account involved by the change: It can be provided by using the account reference or the issuer external account reference
- The future change reference (unique per account)
- The reason of the future update cancellation '
operationId: cancelAccountFutureUpdateByExtRef
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: issuerAccountExternalReference
required: true
type: string
- name: futureChangeReference
in: path
description: Future Change Reference
required: true
type: string
- in: body
name: body
required: true
schema:
$ref: '#/definitions/CancelAccountFutureUpdateRequest'
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/ApiResponseEntityCancelAccountFutureUpdateResponse'
security:
- basic: []
deprecated: false
definitions:
ApiResponseEntityModifyAccountFutureUpdateResponse:
x-wl-api-response: true
type: object
required:
- responseMetadata
properties:
responseMetadata:
description: Response metadata
allOf:
- $ref: '#/definitions/ResponseMetadata'
data:
description: Response data
allOf:
- $ref: '#/definitions/ModifyAccountFutureUpdateResponse'
description: Issuer response entity
title: ApiResponseEntityModifyAccountFutureUpdateResponse
ModifyAccountFutureUpdateRequest:
type: object
properties:
futureChangeDate:
description: Refer to AccountFutureUpdate.futureChangeDate
type: string
format: date-time
iban:
description: 'Refer to Account.iban
Has to be provided as part of future update mandate input, except if the SEPA mandate UMR is provided (comes from another system).'
type: string
updateReason:
description: Refer to AccountFutureUpdate.updateReason
type: string
ibanOwnerName:
description: 'Refer to Account.ibanOwnerName
Has to be provided as part of future update mandate input, except if the SEPA mandate UMR is provided (comes from another system).'
type: string
bic:
description: Refer to Account.bic
type: string
amountDueFixedAmount:
description: Refer to Account.amountDueFixedAmount
allOf:
- $ref: '#/definitions/Amount'
amountDueMinAmount:
description: Refer to Account.amountDueMinAmount
allOf:
- $ref: '#/definitions/Amount'
greaterOrLesserAmountDue:
description: Refer to Account.greaterOrLesserAmountDue
type: string
amountDuePercentage:
description: Refer to Account.amountDuePercentage
type: string
directDebitFixedAmount:
description: Refer to Account.directDebitFixedAmount
allOf:
- $ref: '#/definitions/Amount'
directDebitPercentage:
description: Refer to Account.directDebitPercentage
type: string
selectedModels:
type: array
description: Select the required model from the list.
items:
$ref: '#/definitions/AccountModel'
sepaIndicator:
type: boolean
description: Refer to AccountFutureUpdate.sepaIndicator
secondIban:
type: string
description: Refer to Account.secondIban
paymentMode:
type: string
description: Refer to Account.paymentMode
sepaMandateUmr:
description: 'Refer to Account.sepaMandateUmr
The unique reference to identify the SEPA mandate can be provided to our system if mandate is created explicitly by another system.'
type: string
debtorPhoneNumber:
description: Refer to AccountFutureUpdate.debtorPhoneNumber
type: string
debtorEmail:
description: Refer to AccountFutureUpdate.debtorEmail
type: string
debtorPostalAddress:
description: Refer to AccountFutureUpdate.debtorPostalAddress
allOf:
- $ref: '#/definitions/SepaMandateMailAddress'
mandateContractId:
description: Refer to AccountFutureUpdate.mandateContractId
type: string
mandateNatureType:
description: Refer to AccountFutureUpdate.mandateNatureType
type: string
mandateSignDate:
description: 'Refer to AccountFutureUpdate.mandateSignDate
Has to be provided as part of future update mandate input, except if the SEPA mandate UMR is provided (comes from another system).'
type: string
format: date-time
mandateSignCity:
description: Refer to AccountFutureUpdate.mandateSignCity
type: string
title: ModifyAccountFutureUpdateRequest
AccountFutureUpdateIdentifier:
type: object
properties:
futureChangeReference:
type: string
description: A reference of an account future update (unique per account) that may be used to carry out research, find information, etc.
title: AccountFutureUpdateIdentifier
NotFoundErrorApiResponse:
type: object
required:
- responseMetadata
properties:
responseMetadata:
allOf:
- $ref: '#/definitions/NotFoundResponseMetadata'
title: NotFoundErrorApiResponse
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 whe
# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/wordline/refs/heads/main/openapi/wordline-account-future-update-api-openapi.yml