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 Card - Order API

Card Order Api Controller

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

Tagged areas include Card - Order. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 4 paths, and defines 45 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.

4 operations 4 paths 45 schemas 2 GET2 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 Card - Order API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (basic) using the application flow.

Paths & Operations 4

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

Card - Order 4

Card Order Api Controller

GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders/{orderReference}
Retrieve card order by external reference
retrieveOrderByCardIssuerExtRef 8 params → 400401403404500502200
POST
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders/{orderReference}/releasedeprecated
This API is deprecated. The Release orders for a card API must be used to release all orders related to a card.
releaseCardOrderByCardIssuerExtRef 7 params → 400401403404500502200
GET
/issuers/{issuerId}/cards/{cardReference}/orders/{orderReference}
Retrieve card order
retrieveOrder 8 params → 400401403404500502200
POST
/issuers/{issuerId}/cards/{cardReference}/orders/{orderReference}/releasedeprecated
This API is deprecated. The Release orders for a card API must be used to release all orders related to a card.
releaseCardOrder 7 params → 400401403404500502200

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are CardContract (58 properties), Card (53 properties), Order (35 properties), CardBlockingInformation (25 properties). Each schema is shown below with its type and property counts.

CardContract
object
58 properties
CustomerIdentifier
object
Identification of the updated customer either by Issuer customer external reference or by customer reference
2 properties
CardIdentifier
object
Identification of the card either by Issuer card external reference or by card reference
2 properties
MailAddress
object
15 properties 1 required
OrderIdentifier
object
Order reference calculated by our system
1 property
NotFoundErrorApiResponse
object
1 property 1 required
BadGatewayErrorApiResponse
object
1 property 1 required
InternalServerErrorErrorApiResponse
object
1 property 1 required
InternalServerErrorResponseMetadata
object
4 properties 4 required
CardBlockingInformation
object
25 properties 1 required
ProductExtensionIdentifier
object
1 property
UnauthorizedErrorApiResponse
object
1 property 1 required
ProductIdentifier
object
2 properties
Links
object
2 properties 1 required
CardContractIdentifier
object
Identification of the card contract either by Issuer card contract external reference or by card contract reference
2 properties
MultiCardInfo
object
3 properties
UnauthorizedResponseMetadata
object
4 properties 4 required
ReleaseOrderResponse
object
3 properties
EncryptedPan
object
2 properties
PinInheritanceExternalCardIdentifier
object
1 property
ApiResponseEntityOrder
object
Issuer response entity
2 properties 1 required
NotFoundResponseMetadata
object
4 properties 4 required
ResponseMetadata
object
6 properties 4 required
AccountIdentifier
object
2 properties
AccountRelation
object
2 properties 2 required
OrderStatusHistory
object
3 properties
MultiCard
object
6 properties
Order
object
35 properties
PinInheritanceCardIdentifier
object
2 properties
CardContractModel
object
2 properties
ForbiddenErrorApiResponse
object
1 property 1 required
ContactCenterIdentifier
object
1 property
ContactCenter
object
6 properties
AuthorizationDataValidation
object
The issuer can update cardholder data used by the Front Office for verification (AVS/ANI).
6 properties
BadRequestResponseMetadata
object
4 properties 4 required
CardStatusHistory
object
6 properties
Card
object
53 properties 1 required
EmailAddress
object
1 property 1 required
BadGatewayResponseMetadata
object
4 properties 4 required
PhoneNumber
object
3 properties 1 required
FeeCondition
object
3 properties
ApiResponseEntityReleaseOrderResponse
object
Issuer response entity
2 properties 1 required
ContractIdentifier
object
Identification of thecorporate contract either by Issuer contract external reference or by contract reference
2 properties
BadRequestErrorApiResponse
object
1 property 1 required
ForbiddenResponseMetadata
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wordline-card-order-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