Worldline Card API
Card Api Controller
Worldline Card 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. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 43 operations across 41 paths, and defines 135 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.
43 operations
41 paths
135 schemas
12 GET2 PATCH29 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Worldline Card API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (basic) using the application flow.
Paths & Operations 43
Across 41 paths, the API surfaces 43 operations — 12 GET, 2 PATCH, 29 POST. Each is listed below with its method, path, parameters, and response codes.
Card 43
Card Api Controller
POST
/issuers/{issuerId}/cards/block-all
Block all cards with same PAN or same PAN Reference
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}
Retrieve card by external reference
POST
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/activate
Activate a card by external reference
POST
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/block
Block a card by external reference
POST
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/block-and-replace
Block and replace a card by external reference
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/card-contract
Retrieve card contract for a card by external reference
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/card-events
Retrieve card event list (e.g. PIN change information) by external reference
POST
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/deactivate
Deactivate a card by external reference
POST
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/new-tan
Create new TAN by external reference
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders
List orders for a card by external reference
POST
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/remind-pin
Remind pin for a card by external reference
POST
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/reorder-pin
Reorder new PIN for the card by external reference
POST
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/replace
Replace a card by external reference
POST
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/unblock
Unblock a card by external reference
POST
/issuers/{issuerId}/cards/search
Retrieve card by cardNumber and sequenceNumber and expiryDate
POST
/issuers/{issuerId}/cards/unblock-all
Unblock all cards with same PAN or same PAN Reference
GET
/issuers/{issuerId}/cards/{cardReference}
Retrieve card
POST
/issuers/{issuerId}/cards/{cardReference}/activate
Activate a card
POST
/issuers/{issuerId}/cards/{cardReference}/block
Block a card
POST
/issuers/{issuerId}/cards/{cardReference}/block-and-replace
Block and replace a card
GET
/issuers/{issuerId}/cards/{cardReference}/card-contract
Retrieve card contract for a card
GET
/issuers/{issuerId}/cards/{cardReference}/card-events
Retrieve card event list (e.g. PIN change information)
POST
/issuers/{issuerId}/cards/{cardReference}/deactivate
Deactivate a card
POST
/issuers/{issuerId}/cards/declare-counterfeit-card
Declare counterfeit card
GET
/issuers/{issuerId}/cards/{cardReference}/orders
List orders for a card
POST
/issuers/{issuerId}/cards/{cardReference}/release-orders
Release card orders for a card (beta)
POST
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/release-orders
Release card orders for a card by external reference (beta)
POST
/issuers/{issuerId}/cards/{cardReference}/remind-pin
Remind pin for a card
POST
/issuers/{issuerId}/cards/{cardReference}/reorder-pin
Reorder new PIN for the card
POST
/issuers/{issuerId}/cards/{cardReference}/replace
Replace a card
POST
/issuers/{issuerId}/cards/{cardReference}/unblock
Unblock a card
GET
/issuers/{issuerId}/cards/{cardReference}/blocking-information
Retrieve blocking information for a card
PATCH
/issuers/{issuerId}/cards/{cardReference}/blocking-information
Update blocking information for a card
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/blocking-information
Retrieve blocking information for a card by external reference
PATCH
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/blocking-information
Update blocking information for a card by external reference
POST
/issuers/{issuerId}/cards/update-all-blocking-information
Update blocking information for all cards with same PAN or same PAN Reference
POST
/issuers/{issuerId}/cards/{cardReference}/advise-product-extension
Advice a product extension for a card (beta)
POST
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/advise-product-extension
Advice a product extension for a card by external reference (beta)
GET
/issuers/{issuerId}/cards/{cardReference}/disputes
List DisputeFolders for a card
POST
/issuers/{issuerId}/cards/{cardReference}/new-tan
Create new TAN
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/disputes
List DisputeFolders for a card by external reference
POST
/issuers/{issuerId}/cards/{cardReference}/create-emergency-card
Create Emergency Card
POST
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/create-emergency-card
Create Emergency Card by external reference
Schemas 135
The contract defines 135 schemas that model the data the API accepts and returns. The most detailed are CardContract (58 properties), Card (53 properties), ModifyCustomerRequest (36 properties), Order (35 properties). Each schema is shown below with its type and property counts.
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
ModifyCustomerRequest
object
36 properties
DisputeMessage
object
8 properties
ProductIdentifier
object
2 properties
DeactivateCardResponse
object
4 properties
ReleasedOrder
object
5 properties
4 required
CardEvent
object
8 properties
ApiResponseEntityRemindPINResponse
object
Issuer response entity
2 properties
1 required
ApiResponseEntityUnblockAllCardsResponse
object
Issuer response entity
2 properties
1 required
DisputePosting
object
7 properties
EncryptedPan
object
2 properties
ModifyAllCardsBlockingInformationResponse
object
Issuer response entity
2 properties
2 required
PinInheritanceExternalCardIdentifier
object
1 property
ApiResponseEntityUnblockCardResponse
object
Issuer response entity
2 properties
1 required
ApiResponseEntityDeclareCounterfeitCardResponse
object
Issuer response entity
2 properties
1 required
ExternalAuthorizationsRestrictionIdentifier
object
1 property
ApiResponseEntityListCard
object
Issuer response entity
2 properties
1 required
ReplaceCardRequestCardOrder
object
Card Order for the new card.Empty if no card order needed for the card
11 properties
ApiResponseEntityAdviceProductExtensionCardResponse
object
Issuer response entity
2 properties
1 required
BlockAllCardsResponse
object
1 property
1 required
ApiResponseEntityModifyCardBlockingInformationResponse
object
2 properties
1 required
ModifyCustomerRequestContact
object
8 properties
ApiResponseEntityListDispute
object
Issuer response entity
2 properties
1 required
Order
object
35 properties
ChangedContract
object
Only if a product change is triggered by card replacement. Represents the new contract data after product change has occured
9 properties
DeactivateCardRequest
object
1 property
1 required
ForbiddenErrorApiResponse
object
1 property
1 required
BlockAndReplaceCardRequest
object
3 properties
2 required
DisputeEvent
object
4 properties
ReplaceCardResponse
object
8 properties
Card
object
53 properties
1 required
FeeCondition
object
3 properties
CreateTanResponse
object
3 properties
MailAddress
object
15 properties
1 required
ApiResponseEntityListOrder
object
Issuer response entity
2 properties
1 required
NotFoundErrorApiResponse
object
1 property
1 required
BadGatewayErrorApiResponse
object
1 property
1 required
InternalServerErrorErrorApiResponse
object
1 property
1 required
InternalServerErrorResponseMetadata
object
4 properties
4 required
UnblockCardResponse
object
4 properties
ProductExtensionIdentifier
object
1 property
UnblockAllCardsResponseCard
object
4 properties
4 required
OriginalCardContract
object
5 properties
SearchCardRequest
object
4 properties
ReorderPINRequest
object
10 properties
1 required
OriginalCard
object
5 properties
MultiCardInfo
object
3 properties
AccountIdentifier
object
2 properties
DeclareCounterfeitCardRequest
object
6 properties
1 required
ReplaceCardRequestEncryptedPIN
object
7 properties
4 required
ApiResponseEntityActivateCardResponse
object
Issuer response entity
2 properties
1 required
ApiResponseEntityListCardEvent
object
Issuer response entity
2 properties
1 required
EmailAddress
object
1 property
1 required
UnblockAllCardsResponse
object
1 property
1 required
ChangedCardContract
object
8 properties
BlockAllCardsResponseCard
object
5 properties
4 required
CreateTanRequest
object
5 properties
2 required
CardContract
object
58 properties
BlockCardResponse
object
6 properties
ActivateCardResponse
object
4 properties
BlockAndReplaceCardResponse
object
2 properties
2 required
OrderIdentifier
object
Order reference calculated by our system
1 property
UnauthorizedErrorApiResponse
object
1 property
1 required
ApiResponseEntityBlockCardResponse
object
Issuer response entity
2 properties
1 required
ExternalAuthorizationsRestriction
object
5 properties
1 required
ModifyAllCardsBlockingInformationRequest
object
13 properties
ProductChangeInformation
object
Only if a product change is triggered by card replacement. Represents product change information
11 properties
CardContractIdentifier
object
Identification of the card contract either by Issuer card contract external reference or by card contract reference
2 properties
UnblockCardRequest
object
3 properties
Dispute
object
33 properties
ApiResponseEntityBlockAllCardsResponse
object
Issuer response entity
2 properties
1 required
ApiResponseEntityCardContract
object
Issuer response entity
2 properties
1 required
UnblockAllCardsRequest
object
5 properties
OriginalContract
object
Only if a product change is triggered by card replacement. Represents the original contract data before product change has occured
7 properties
ReplaceCardRequestCardContractCard
object
18 properties
ReleaseOrdersResponse
object
1 property
ApiResponseEntityCardBlockingInformation
object
2 properties
2 required
BlockCardRequest
object
25 properties
MultiCard
object
6 properties
PinInheritanceCardIdentifier
object
2 properties
CardContractModel
object
2 properties
Amount
object
3 properties
3 required
ApiResponseEntityBlockAndReplaceCardResponse
object
Issuer response entity
2 properties
1 required
CreateEmergencyCardResponse
object
12 properties
2 required
DisputeDocument
object
5 properties
ContactCenterIdentifier
object
1 property
ReplaceCardRequest
object
5 properties
1 required
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
ChangedCard
object
8 properties
PhoneNumber
object
3 properties
1 required
BadGatewayResponseMetadata
object
4 properties
4 required
RemindPINRequest
object
10 properties
1 required
ContractIdentifier
object
Identification of thecorporate contract either by Issuer contract external reference or by contract reference
2 properties
ChangedAccount
object
6 properties
ForbiddenResponseMetadata
object
4 properties
4 required
Vulnerability
object
2 properties
1 required
ModifyCardBlockingInformationResponse
object
1 property
2 required
ApiResponseEntityDeactivateCardResponse
object
Issuer response entity
2 properties
1 required
RemindPINResponse
object
3 properties
CreateAddressRequestPhoneNumber
object
2 properties
1 required
CardBlockingInformation
object
25 properties
1 required
ReplaceCardRequestCardContract
object
8 properties
ChangeProductResponseOrder
object
3 properties
ReplaceCardResponseOrder
object
3 properties
AdviceProductExtensionCardResponse
object
3 properties
1 required
Links
object
2 properties
1 required
ReorderPINResponse
object
3 properties
DisputeFolderIdentifier
object
2 properties
1 required
ActivateCardRequest
object
1 property
1 required
ReplaceCardResponseCard
object
Card Information Mandatory for card replacement process Not filled in case of product change, triggered by card replacement (originalContract and changedContra…
12 properties
4 required
OriginalAccount
object
3 properties
UnauthorizedResponseMetadata
object
4 properties
4 required
ApiResponseEntityReplaceCardResponse
object
Issuer response entity
2 properties
1 required
ApiResponseEntityReorderPINResponse
object
Issuer response entity
2 properties
1 required
ReplaceCardRequestPinMailerOrder
object
Pin Mailer Order for the new card.Empty if no PIN mailer order needed
11 properties
NotFoundResponseMetadata
object
4 properties
4 required
ResponseMetadata
object
6 properties
4 required
AccountRelation
object
2 properties
2 required
OrderStatusHistory
object
3 properties
ApiResponseEntityCreateTanResponse
object
Issuer response entity
2 properties
1 required
ModifyAddressRequestMailAddress
object
14 properties
1 required
PinChangeInformation
object
5 properties
BlockAllCardsRequest
object
27 properties
CreateAddressRequestMailAddress
object
14 properties
1 required
ApiResponseEntityReleaseOrdersResponse
object
Issuer response entity
2 properties
1 required
DeclareCounterfeitCardResponse
object
1 property
1 required
ApiResponseEntityCard
object
Issuer response entity
2 properties
1 required
CardChange
object
2 properties
ModifyCardBlockingInformationRequest
object
11 properties
BadRequestErrorApiResponse
object
1 property
1 required
ApiResponseEntityCreateEmergencyCardResponse
object
Issuer response entity
2 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Worldline 12
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
#Card