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 - Authorization Restriction API

Account Authorization Restriction Controller

Worldline Account - Authorization Restriction 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 - Authorization Restriction. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 16 operations across 10 paths, and defines 35 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.

16 operations 10 paths 35 schemas 2 DELETE9 GET3 POST2 PUT

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 - Authorization Restriction API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (basic) using the application flow.

Paths & Operations 16

Across 10 paths, the API surfaces 16 operations — 2 DELETE, 9 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Account - Authorization Restriction 16

Account Authorization Restriction Controller

GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-restrictions
List the Authorization Restrictions (by issuer ref.)
getMultipleAuthorizationRestrictionsByExtAcctRef 5 params → 200400401403404500502
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides
List the Authorization Restriction Overrides (by issuer ref.)
getMultipleAuthorizationRestrictionOverridesByExtAcctRef 7 params → 200400401403404500502
POST
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides
Create an Authorization Restriction Override (by issuer ref.)
createAuthorizationRestrictionOverrideByExtAcctRef 7 params → 200400401403404500502
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}
Retrieve an Authorization Restriction Override (by issuer ref.)
getSingleAuthorizationRestrictionOverrideByExtAcctRef 7 params → 200400401403404500502
PUT
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}
Update an Authorization Restriction Override (by issuer ref.)
modifyAuthorizationRestrictionOverrideByExtAcctRef 8 params → 200400401403404500502
DELETE
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}
Delete an Authorization Restriction Override (by issuer ref.)
deleteAuthorizationRestrictionOverrideByExtAcctRef 7 params → 200400401403404500502
GET
/issuers/{issuerId}/accounts/{accountReference}/authorization-restrictions
List the Authorization Restrictions
getMultipleAuthorizationRestrictions 5 params → 200400401403404500502
GET
/issuers/{issuerId}/accounts/{accountReference}/authorization-restrictions/{authorizationRestrictionReference}
Retrieve an Authorization Restriction
getSingleAuthorizationRestriction 6 params → 200400401403404500502
GET
/issuers/{issuerId}/accounts/{accountReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides
List the Authorization Restriction Overrides
getMultipleAuthorizationRestrictionOverrides 7 params → 200400401403404500502
POST
/issuers/{issuerId}/accounts/{accountReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides
Create an Authorization Restriction Override
createAuthorizationRestrictionOverride 7 params → 200400401403404500502
GET
/issuers/{issuerId}/accounts/{accountReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}
Retrieve an Authorization Restriction Override
getSingleAuthorizationRestrictionOverride 7 params → 200400401403404500502
PUT
/issuers/{issuerId}/accounts/{accountReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}
Update an Authorization Restriction Override
modifyAuthorizationRestrictionOverride 8 params → 200400401403404500502
DELETE
/issuers/{issuerId}/accounts/{accountReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}
Delete an Authorization Restriction Override
deleteAuthorizationRestrictionOverride 7 params → 200400401403404500502
POST
/issuers/{issuerId}/accounts/{accountReference}/authorization-restrictions/search
Search the Authorization Restrictions
searchAuthorizationRestrictionsByAcctRef 4 params → 200400401403404500502
GET
/issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}/history
Get authorization restriction override history by external account reference
getAuthorizationRestrictionOverrideHistoryByExtAcctRef 5 params → 200400401403404500502
GET
/issuers/{issuerId}/accounts/{accountReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}/history
Get authorization restriction override history
getAuthorizationRestrictionOverrideHistory 5 params → 200400401403404500502

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are GetAuthorizationRestrictionOverrideResponse (10 properties), AuthorizationRestrictionOverride (9 properties), AuthorizationRestrictionWithOverrides (8 properties), GetAuthorizationRestrictionResponse (8 properties). Each schema is shown below with its type and property counts.

ApiResponseEntityGetAuthorizationRestrictionOverrides
object
Response to: List the Authorization Restriction Overrides
2 properties 1 required
GetAuthorizationRestrictionResponse
object
8 properties
CreateAuthorizationRestrictionOverrideRequest
object
5 properties
NotFoundErrorApiResponse
object
1 property 1 required
AuthorizationRestrictionIdentifier
object
1 property
BadGatewayErrorApiResponse
object
1 property 1 required
GetAuthorizationRestrictionOverrideResponse
object
10 properties
InternalServerErrorErrorApiResponse
object
1 property 1 required
ApiResponseEntityModifyAuthorizationRestrictionOverride
object
Response to: Update an Authorization Restriction Override
2 properties 1 required
ApiResponseEntityCreateAuthorizationRestrictionOverride
object
Response to: Create an Authorization Restriction Override
2 properties 1 required
InternalServerErrorResponseMetadata
object
4 properties 4 required
UnauthorizedErrorApiResponse
object
1 property 1 required
Links
object
2 properties 1 required
ApiResponseEntityDeleteAuthorizationRestrictionOverride
object
Response to: Delete an Authorization Restriction Override
2 properties 1 required
ApiResponseEntityGetAuthorizationRestrictions
object
Response to: List the Authorization Restrictions
2 properties 1 required
ApiResponseEntityGetAuthorizationRestrictionOverrideHistory
object
Issuer response entity
2 properties 1 required
UnauthorizedResponseMetadata
object
4 properties 4 required
ApiResponseEntitySearchAuthorizationRestrictionResponse
object
Response to: Search the Authorization Restrictions
2 properties 1 required
ModifyAuthorizationRestrictionOverrideRequest
object
5 properties
NotFoundResponseMetadata
object
4 properties 4 required
ResponseMetadata
object
6 properties 4 required
ForbiddenErrorApiResponse
object
1 property 1 required
AuthorizationRestrictionOverride
object
9 properties
AuthorizationRestrictionWithOverrides
object
8 properties
SearchAuthorizationRestrictionRequest
object
2 properties
AuthorizationRestrictionOverrideHistoryEntry
object
7 properties 1 required
BadRequestResponseMetadata
object
4 properties 4 required
AuthorizationRestrictionOverrideIdentifier
object
1 property
SearchAuthorizationRestrictionResponse
object
1 property
BadGatewayResponseMetadata
object
4 properties 4 required
ApiResponseEntityGetAuthorizationRestriction
object
Response to: Retrieve an Authorization Restriction
2 properties 1 required
ApiResponseEntityGetAuthorizationRestrictionOverride
object
Response to: Retrieve an Authorization Restriction Override
2 properties 1 required
BadRequestErrorApiResponse
object
1 property 1 required
ForbiddenResponseMetadata
object
4 properties 4 required
AuthorizationRestriction
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wordline-account-authorization-restriction-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 - Cvv2 Try Counter API