Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Worldline Account - Future Update API

Account Future Updates Api Controller

Worldline Account - Future Update API is one of 79 APIs that Worldline publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Account - Future Update. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 10 operations across 6 paths, and defines 32 schemas. It is described by OpenAPI 2.0, at version 2.41.1.

Requests are made against the base URL https://api.connect.worldline-solutions.com.

10 operations 6 paths 32 schemas 4 GET2 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2.41.1
Base URL
https://api.connect.worldline-solutions.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Worldline Account - Future Update API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (basic) using the application flow.

Paths & Operations 10

Across 6 paths, the API surfaces 10 operations — 4 GET, 2 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Account - Future Update 10

Account Future Updates Api Controller

GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates
Retrieve list of future changes of the account by external reference
listAccountFutureUpdatesByIssuerExtRef 7 params → 400401403404500502200
POST
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates
Schedule new account parameters update in future by external reference
createAccountFutureUpdateByIssuerExtRef 7 params → 400401403404500502200
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{futureChangeReference}
Retrieve future changes for the account by external reference
retrieveAccountFutureUpdateByIssuerExtRefAndFutureRef 7 params → 400401403404500502200
PATCH
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{futureChangeReference}
Update future changes of the account by external reference
modifyAccountFutureUpdateByExtRef 8 params → 400401403404500502200
GET
/issuers/{issuerId}/accounts/{accountReference}/account-future-updates
Retrieve list of future changes of the account
listAccountFutureUpdates 7 params → 400401403404500502200
POST
/issuers/{issuerId}/accounts/{accountReference}/account-future-updates
Schedule new account parameters update in future
createAccountFutureUpdate 7 params → 400401403404500502200
GET
/issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{futureChangeReference}
Retrieve future changes for the account
retrieveAccountFutureUpdateByFutureRef 7 params → 400401403404500502200
PATCH
/issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{futureChangeReference}
Update future changes of the account
modifyAccountFutureUpdate 8 params → 400401403404500502200
POST
/issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{futureChangeReference}/cancel
Cancel future changes of the account
cancelAccountFutureUpdate 8 params → 400401403404500502200
POST
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{futureChangeReference}/cancel
Cancel future changes of the account by external reference
cancelAccountFutureUpdateByExtRef 8 params → 400401403404500502200

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are AccountFutureUpdate (33 properties), ModifyAccountFutureUpdateRequest (23 properties), CreateAccountFutureUpdateRequest (17 properties), SepaMandateMailAddress (13 properties). Each schema is shown below with its type and property counts.

ApiResponseEntityModifyAccountFutureUpdateResponse
object
Issuer response entity
2 properties 1 required
ModifyAccountFutureUpdateRequest
object
23 properties
AccountFutureUpdateIdentifier
object
1 property
NotFoundErrorApiResponse
object
1 property 1 required
InternalServerErrorResponseMetadata
object
4 properties 4 required
BadGatewayErrorApiResponse
object
1 property 1 required
InternalServerErrorErrorApiResponse
object
1 property 1 required
CancelAccountFutureUpdateResponse
object
3 properties 1 required
UnauthorizedErrorApiResponse
object
1 property 1 required
SepaMandateMailAddress
object
13 properties
Links
object
2 properties 1 required
AccountModel
object
3 properties
UnauthorizedResponseMetadata
object
4 properties 4 required
CreateAccountFutureUpdateResponse
object
4 properties 1 required
NotFoundResponseMetadata
object
4 properties 4 required
ResponseMetadata
object
6 properties 4 required
CancelAccountFutureUpdateRequest
object
1 property 1 required
AccountIdentifier
object
2 properties
CreateAccountFutureUpdateRequest
object
17 properties 1 required
CreateAccountFutureUpdateRequestSepaMandate
object
8 properties
ApiResponseEntityCreateAccountFutureUpdateResponse
object
Issuer response entity
2 properties 1 required
Amount
object
3 properties 3 required
ApiResponseEntityCancelAccountFutureUpdateResponse
object
Issuer response entity
2 properties 1 required
ForbiddenErrorApiResponse
object
1 property 1 required
AccountFutureUpdate
object
33 properties 3 required
ApiResponseEntityListAccountFutureUpdate
object
Issuer response entity
2 properties 1 required
BadRequestResponseMetadata
object
4 properties 4 required
BadGatewayResponseMetadata
object
4 properties 4 required
ApiResponseEntityAccountFutureUpdate
object
Issuer response entity
2 properties 1 required
ModifyAccountFutureUpdateResponse
object
4 properties 4 required
BadRequestErrorApiResponse
object
1 property 1 required
ForbiddenResponseMetadata
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wordline-account-future-update-api-openapi.yml Raw ↑

Other APIs Worldline publishes across the network.

Worldline Connect (Global Collect) API
Worldline Direct (Global Online Pay) API
Worldline Acquiring API
Worldline Financial Services Issuing API
Worldline Financial Services Acquiring API
Worldline Open Banking API
Worldline SmartPOS API
Worldline Identity and Authentication API
Worldline Account - AccountState API
Worldline Account API
Worldline Account - Authorization API
Worldline Account - Authorization Restriction API