Worldline Card Contract API
Card Contract Api Controller
Worldline Card Contract 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 Contract. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 17 operations across 15 paths, and defines 102 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.
17 operations
15 paths
102 schemas
11 GET2 PATCH4 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Worldline Card Contract API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (basic) using the application flow.
Paths & Operations 17
Across 15 paths, the API surfaces 17 operations — 11 GET, 2 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.
Card Contract 17
Card Contract Api Controller
GET
/issuers/{issuerId}/card-contracts
List card contracts
GET
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}
Retrieve card contract by external reference
PATCH
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}
Update card contract by external reference
GET
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cardholder
Retrieve cardholder for a card contract by external reference
GET
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cards
List cards for card contract by external reference
POST
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/close
Close card contract by external reference
POST
/issuers/{issuerId}/card-contracts/{cardContractReference}/cancel-close
Cancel close card contract
POST
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cancel-close
cancel close card contract by external reference
GET
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/contract
Retrieve contract for a card contract by external reference
GET
/issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/corporate-contract
Retrieve corporate contract for a card contract by external reference
GET
/issuers/{issuerId}/card-contracts/{cardContractReference}
Retrieve card contract
PATCH
/issuers/{issuerId}/card-contracts/{cardContractReference}
Update card contract
GET
/issuers/{issuerId}/card-contracts/{cardContractReference}/cardholder
Retrieve cardholder for a card contract
GET
/issuers/{issuerId}/card-contracts/{cardContractReference}/cards
List cards for card contract
POST
/issuers/{issuerId}/card-contracts/{cardContractReference}/close
Close card contract
GET
/issuers/{issuerId}/card-contracts/{cardContractReference}/contract
Retrieve contract for a card contract
GET
/issuers/{issuerId}/card-contracts/{cardContractReference}/corporate-contract
Retrieve corporate contract for a card contract
Schemas 102
The contract defines 102 schemas that model the data the API accepts and returns. The most detailed are Account (103 properties), CardContract (58 properties), Card (53 properties), Customer (43 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
ApiResponseEntityCancelCloseCardContractResponse
object
Issuer response entity
2 properties
1 required
CorporateContractFee
object
Specify the corporate contract Fee
Customer
object
43 properties
2 required
ProductIdentifier
object
2 properties
AccountStatusHistory
object
3 properties
ApiResponseEntityCustomer
object
Issuer response entity
2 properties
1 required
InsurancePackageIdentifier
object
Unique identifier of the insurance contract package
1 property
CycleInformation
object
Dates related to the closure calendar for the open closure cycle
10 properties
ContractModel
object
Model containing predefined configuration for fee generation applicable on a contract
2 properties
EncryptedPan
object
2 properties
PinInheritanceExternalCardIdentifier
object
1 property
ContactIdentifier
object
1 property
ApiResponseEntityListCard
object
Issuer response entity
2 properties
1 required
DataAnalysisFlags
object
Specify which data analysis flags are enabled (person, paymentTransaction, exchangeThirdParties, etc.)
3 properties
Order
object
35 properties
ForbiddenErrorApiResponse
object
1 property
1 required
Card
object
53 properties
1 required
FeeCondition
object
3 properties
ModifyCardContractResponse
object
1 property
ApiResponseEntityCloseCardContractResponse
object
Issuer response entity
2 properties
1 required
FeePostingEntityIdentifier
object
3 properties
MailAddress
object
15 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
AccountOutgoingCreditTransferFeature
object
Specify OctFeature (periodicOct, periodicOctType, periodicOctMaxThreshold, etc.)
9 properties
CorporateContractLevel
object
Specify the level in the company organization
2 properties
ProductExtensionIdentifier
object
1 property
CorporateEmployeeAccount
object
Specify the corporate employee account
17 properties
AddressUsage
object
3 properties
2 required
ApiResponseEntityListCardContract
object
Issuer response entity
2 properties
1 required
MultiCardInfo
object
3 properties
AccountModel
object
3 properties
AccountHierarchyModel
object
2 properties
ExternalRestriction
object
5 properties
1 required
HierarchyOutgoingCreditTransferFeature
object
Specify OctFeature (periodicOct, periodicOctType, periodicOctMaxThreshold, etc.)
9 properties
AddOnSubscription
object
6 properties
DeliveryChannel
object
Specify the channel for letter delivery used for this contract
3 properties
AccountIdentifier
object
2 properties
CloseCardContractRequest
object
4 properties
2 required
ApiResponseEntityModifyCardContractResponse
object
Issuer response entity
2 properties
1 required
ApiResponseEntityContract
object
Issuer response entity
2 properties
1 required
EmailAddress
object
1 property
1 required
InsuranceContract
object
10 properties
CardContract
object
58 properties
ExternalVelocityLimitIdentifier
object
1 property
AddressVersionIdentifier
object
1 property
OrderIdentifier
object
Order reference calculated by our system
1 property
CancelCloseCardContractResponse
object
1 property
ExternalRestrictionIdentifier
object
1 property
UnauthorizedErrorApiResponse
object
1 property
1 required
CloseCardContractResponse
object
3 properties
CorporateContract
object
31 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
ApiResponseEntityCardContract
object
Issuer response entity
2 properties
1 required
Account
object
103 properties
12 required
InsuranceEvent
object
3 properties
HierarchyOperationStatus
object
4 properties
MultiCard
object
6 properties
AdvertisementFlags
object
Specify possible channels used to provide advertisements
6 properties
PinInheritanceCardIdentifier
object
2 properties
CardContractModel
object
2 properties
Amount
object
3 properties
3 required
HierarchyOperationStatusHistory
object
6 properties
Contract
object
Consumer contract entity
39 properties
ContactCenterIdentifier
object
1 property
ApiResponseEntityCorporateContract
object
Issuer response entity
2 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
Contact
object
11 properties
AddOnServiceParameter
object
4 properties
BadRequestResponseMetadata
object
4 properties
4 required
CardStatusHistory
object
6 properties
PhoneNumber
object
3 properties
1 required
BadGatewayResponseMetadata
object
4 properties
4 required
ExternalVelocityLimit
object
7 properties
1 required
ContractIdentifier
object
Identification of thecorporate contract either by Issuer contract external reference or by contract reference
2 properties
ForbiddenResponseMetadata
object
4 properties
4 required
Company
object
21 properties
Vulnerability
object
2 properties
1 required
CardBlockingInformation
object
25 properties
1 required
ModifyCardContractRequest
object
25 properties
InsuranceContractIdentifier
object
The insurance package which is linked to this contract
1 property
AddressIdentifier
object
2 properties
LoyaltyPoint
object
2 properties
Links
object
2 properties
1 required
UnauthorizedResponseMetadata
object
4 properties
4 required
Address
object
15 properties
2 required
NotFoundResponseMetadata
object
4 properties
4 required
ResponseMetadata
object
6 properties
4 required
AccountRelation
object
2 properties
2 required
OrderStatusHistory
object
3 properties
CorporateContractEntity
object
Specify the corporate contract entity
8 properties
LegitimacyDocument
object
Legitimacy document information
6 properties
ContractFee
object
6 properties
InsuranceContractPackage
object
2 properties
CardChange
object
2 properties
BadRequestErrorApiResponse
object
1 property
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 Contract