Worldline Contract API
Contract Api Controller
Worldline Contract API is one of 79 APIs that Worldline publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 3 JSON Schema definitions.
Tagged areas include Contract. The published artifact set on APIs.io includes an OpenAPI specification and 3 JSON Schemas.
This API exposes 75 operations across 61 paths, and defines 298 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 2 base URLs: https://sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/card-issuing/api/v2, /MerchantApiContract/api.
75 operations
61 paths
298 schemas
3 DELETE20 GET11 PATCH39 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Worldline Contract API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (basic) using the clientCredentials flow.
Paths & Operations 75
Across 61 paths, the API surfaces 75 operations — 3 DELETE, 20 GET, 11 PATCH, 39 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Contract 75
Contract Api Controller
POST
/issuers/{issuerId}/contracts/brand-advicedeprecated
Get a brand selection advice (beta)
POST
/issuers/{issuerId}/contracts/advise-product-extension
Advice a product extension (beta)
GET
/issuers/{issuerId}/contracts/brand-advice-config/{issuerProductExternalReference}deprecated
Retrieve brand advice algorithm configuration by issuer product external…
PATCH
/issuers/{issuerId}/contracts/brand-advice-config/{issuerProductExternalReference}deprecated
Update brand advice algorithm configuration by issuer product external…
POST
/issuers/{issuerId}/contracts/create-consumer-contract
Create consumer contract
POST
/issuers/{issuerId}/contracts/{contractReference}/sign
Sign Contract
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/sign
Sign Contract by external reference
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
Retrieve contract by external reference
PATCH
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
Update contract by external reference
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/accounts
List accounts for contract by external reference
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions
Retrieve the list of add-on services by external reference
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions
Subscribe to add-on by external reference
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions/unsubscribe
Unsubscribe add-on by external reference
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/add-cards-accounts
Add cards and accounts to a contract by external reference
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/card-contracts
List card contracts for contract by external reference
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/close
Close contract by external reference
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/update-all-customers-addresses
Update addresses of all customers linked to the contract by external reference
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/suspend
Suspend contract by external reference
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-close
Cancel contract Closing by external reference
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-suspend
Cancel contract Suspension by external reference
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-fees
List contract fees for a contract (Membership fee and Account setup fee models)…
PATCH
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-fees/{accountReference}
Update contract fees for an account (Membership fee and Account setup fee…
PATCH
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-fees/external-accounts/{issuerAccountExternalReference}
Update contract fees for an account (Membership fee and Account setup fee…
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-owner
Retrieve contract owner for a contract by external reference
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/legitimacy-documents
List legitimacy documents for a contract by external reference
PUT
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/legitimacy-documents/external-customers/{issuerCustomerExternalReference}
Update legitimacy document of a contract customer by contract external…
POST
/issuers/{issuerId}/contracts/search
Retrieve contracts by criteria
GET
/issuers/{issuerId}/contracts/{contractReference}
Retrieve contract
PATCH
/issuers/{issuerId}/contracts/{contractReference}
Update contract
GET
/issuers/{issuerId}/contracts/{contractReference}/accounts
List accounts for contract
POST
/issuers/{issuerId}/contracts/{contractReference}/add-cards-accounts
Add cards and accounts to a contract
GET
/issuers/{issuerId}/contracts/{contractReference}/addon-subscriptions
Retrieve the list of add-on services
POST
/issuers/{issuerId}/contracts/{contractReference}/addon-subscriptions
Subscribe to add-on
POST
/issuers/{issuerId}/contracts/{contractReference}/addon-subscriptions/unsubscribe
Unsubscribe add-on
GET
/issuers/{issuerId}/contracts/{contractReference}/card-contracts
List card contracts for contract
POST
/issuers/{issuerId}/contracts/{contractReference}/close
Close contract
POST
/issuers/{issuerId}/contracts/{contractReference}/update-all-customers-addresses
Update addresses of all customers linked to the contract
POST
/issuers/{issuerId}/contracts/{contractReference}/suspend
Suspend contract
POST
/issuers/{issuerId}/contracts/{contractReference}/cancel-close
Cancel contract closing
POST
/issuers/{issuerId}/contracts/{contractReference}/cancel-suspend
Cancel contract suspension
GET
/issuers/{issuerId}/contracts/{contractReference}/contract-fees
List contract fees for a contract (Membership fee and Account setup fee models)
PATCH
/issuers/{issuerId}/contracts/{contractReference}/contract-fees/{accountReference}
Update contract fees for an account (Membership fee and Account setup fee…
PATCH
/issuers/{issuerId}/contracts/{contractReference}/contract-fees/external-accounts/{issuerAccountExternalReference}
Update contract fees for an account (Membership fee and Account setup fee…
GET
/issuers/{issuerId}/contracts/{contractReference}/contract-owner
Retrieve contract owner for a contract
GET
/issuers/{issuerId}/contracts/{contractReference}/legitimacy-documents
List legitimacy documents for a contract
PUT
/issuers/{issuerId}/contracts/{contractReference}/legitimacy-documents/{customerReference}
Update legitimacy document of a contract customer
POST
/issuers/{issuerId}/contracts/{contractReference}/switch-principal-card
Switch between principal and supplementary cards
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/switch-principal-card
Switch between principal and supplementary cards by external reference
POST
/issuers/{issuerId}/contracts/{contractReference}/change-product
Change the existing product for another one
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/change-product
Change the existing product for another one by external reference
POST
/issuers/{issuerId}/contracts/{contractReference}/cancel-product-change
Cancel a pending ProductChange
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-product-change
Cancel a pending ProductChange by external reference
POST
/issuers/{issuerId}/contracts/{contractReference}/force-product-change
Force a pending ProductChange
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/force-product-change
Force a pending ProductChange by external reference
POST
/issuers/{issuerId}/contracts/{contractReference}/refund-fee-on-demand
Refund fee by contract reference
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/refund-fee-on-demand
Refund fee by issuer contract external reference
POST
/issuers/{issuerId}/contracts/{contractReference}/replace-customer
Replace a customer within a consumer contract
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/replace-customer
Replace a customer within a consumer contract by external reference
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts
Search contracts
POST
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts
Add a contract
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}
Retrieve a contract
DELETE
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}
Delete a contract
PATCH
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}
Update a contract
POST
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/currencies
Add currencies to a contract
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/addresses
Retrieve the addresses of a contract
POST
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/addresses
Add addresses to a contract
PATCH
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/addresses
Update the addresses of a contract
DELETE
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/addresses/{addressType}
Delete an address from a contract
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/balances
Retrieve the balances of a contract
POST
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/balances
Add balances to a contract
PATCH
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/balances
Update the balances of a contract
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/brands
Retrieve the brand parameters of a contract
POST
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/brands
Add brands to a contract
PATCH
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/brands
Update the brand parameters of a contract
DELETE
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/brands/{label}
Delete a brand from a contract
Schemas 298
The contract defines 298 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.
AdviceProductExtensionResponse
object
2 properties
2 required
ChangeProductResponse
object
3 properties
CreateAddOnSubscriptionResponse
object
4 properties
2 required
AccountStatusHistory
object
3 properties
CloseContractResponseCard
object
6 properties
1 required
Order
object
35 properties
CancelContractSuspensionResponse
object
1 property
CreateConsumerContractRequestCard
object
Card related data to be provided for the creation of the first card.
18 properties
InsuranceEvent
object
3 properties
CancelProductChangeResponseOriginalAccount
object
3 properties
Links
object
2 properties
1 required
CancelProductChangeResponseChangedContract
object
6 properties
CreateConsumerContractResponseCard
object
9 properties
1 required
CreateConsumerContractRequestAddress
object
7 properties
2 required
LegitimacyDocument
object
Legitimacy document information
6 properties
NotFoundResponseMetadata
object
4 properties
4 required
SwitchPrincipalCardRequest
object
2 properties
1 required
BrandAdviceRequest
object
3 properties
ContractFee
object
6 properties
ContractIdentifier
object
Identification of thecorporate contract either by Issuer contract external reference or by contract reference
2 properties
UnauthorizedResponseMetadata
object
4 properties
4 required
CreateConsumerContractRequestCustomer
object
The issuer has to provide customers which don't already exist in our system. Each new customer is identified by a correlation id. For example: - If a contract…
39 properties
4 required
BrandAdviceConfigPercentage
object
2 properties
ModifyAddressRequestMailAddress
object
14 properties
1 required
AddOnServiceParameter
object
4 properties
ExternalVelocityLimitIdentifier
object
1 property
BadRequestResponseMetadata
object
4 properties
4 required
ModifyContractFeeResponse
object
1 property
1 required
SignContractResponse
object
1 property
BadGatewayResponseMetadata
object
4 properties
4 required
AccountIdentifier
object
2 properties
CreateConsumerContractRequestAddCardsAccounts
object
With the contract creation request it is possible to provide data for one additional card only (it can be e.g. a single card, a twin card), not configured in t…
3 properties
3 required
ContractModel
object
Model containing predefined configuration for fee generation applicable on a contract
2 properties
ChangeProductRequest
object
7 properties
2 required
AdvertisementFlags
object
Specify possible channels used to provide advertisements
6 properties
AuthorizationDataValidation
object
The issuer can update cardholder data used by the Front Office for verification (AVS/ANI).
6 properties
CreateConsumerContractRequestLegitimacyDocument
object
7 properties
5 required
PinInheritanceExternalCardIdentifier
object
1 property
ApiResponseEntityCloseContractResponse
object
Issuer response entity
2 properties
1 required
CreateConsumerContractRequestAddOnSubscription
object
4 properties
2 required
CloseContractResponseAccount
object
3 properties
ModifyContractCustomersAddressesResponse
object
2 properties
2 required
AccountHierarchyModel
object
2 properties
ModifyContractCustomersAddressesRequestAddress
object
8 properties
2 required
CustomerAttributes
object
6 properties
ModifyContractRequest
object
12 properties
ReplaceCustomerInConsumerContractResponseCardContract
object
2 properties
ApiResponseEntityForceProductChangeResponse
object
Issuer response entity
2 properties
1 required
ApiResponseEntityModifyBrandAdviceConfigResponse
object
Issuer response entity
2 properties
1 required
AccountModel
object
3 properties
ModifyContractCustomersAddressesRequest
object
1 property
1 required
Contract
object
Consumer contract entity
39 properties
ModifyBrandAdviceConfigResponse
object
1 property
OriginalAccount
object
3 properties
CloseContractResponseCardContract
object
3 properties
CreateAddressRequestPhoneNumber
object
2 properties
1 required
ContactCenter
object
6 properties
ReplaceCustomerInContractRequestAddress
object
8 properties
2 required
ModifyContractFeeRequest
object
5 properties
ForbiddenErrorApiResponse
object
1 property
1 required
ApiResponseEntitySwitchPrincipalCardResponse
object
Issuer response entity
2 properties
1 required
ApiResponseEntityAdviceProductExtensionResponse
object
Issuer response entity
2 properties
1 required
BadRequestErrorApiResponse
object
1 property
1 required
SuspendContractResponseCard
object
6 properties
1 required
ApiResponseEntityListCardContract
object
Issuer response entity
2 properties
1 required
ApiResponseEntityCustomer
object
Issuer response entity
2 properties
1 required
BadGatewayErrorApiResponse
object
1 property
1 required
ExternalRestrictionIdentifier
object
1 property
ChangedCardContract
object
8 properties
PhoneNumber
object
3 properties
1 required
AddCardsAccountsResponse
object
5 properties
2 required
SignContractResponseCard
object
6 properties
6 required
ApiResponseEntityCreateAddOnSubscriptionResponse
object
Issuer response entity
2 properties
1 required
ApiResponseEntitySuspendContractResponse
object
Issuer response entity
2 properties
1 required
ApiResponseEntityRemoveAddOnSubscriptionResponse
object
Issuer response entity
2 properties
1 required
CreateAddOnSubscriptionRequest
object
7 properties
2 required
ModifyLegitimacyDocumentRequest
object
5 properties
SwitchPrincipalCardResponseContract
object
3 properties
BrandAdviceConfig
object
3 properties
CreateConsumerContractResponseCardContract
object
Information for each card contract if any
12 properties
2 required
ApiResponseEntityRefundFeeOnDemandResponse
object
Refund Fee On Demand response entity
2 properties
1 required
OriginalContract
object
Only if a product change is triggered by card replacement. Represents the original contract data before product change has occured
7 properties
CustomerIdentifier
object
Identification of the updated customer either by Issuer customer external reference or by customer reference
2 properties
AccountRelation
object
2 properties
2 required
ApiResponseEntityAddCardsAccountsResponse
object
Issuer response entity
2 properties
1 required
FeeCondition
object
3 properties
CreateConsumerContractResponse
object
2 properties
2 required
OrderStatusHistory
object
3 properties
OriginalCardContract
object
5 properties
ReplaceCustomerInConsumerContractResponseAccount
object
4 properties
CreateConsumerContractRequestContractFee
object
5 properties
CreateConsumerContractRequestAccount
object
32 properties
1 required
ApiResponseEntityBrandAdvice
object
Brand advice response
2 properties
1 required
CancelProductChangeResponseOriginalCardContract
object
2 properties
ApiResponseEntityListContractFee
object
Issuer response entity
2 properties
1 required
CancelContractClosingResponse
object
1 property
CreateConsumerContractRequestSepaMandate
object
11 properties
InsuranceContract
object
10 properties
MultiCardInfo
object
3 properties
CancelProductChangeResponse
object
4 properties
ExternalAuthorizationsRestrictionIdentifier
object
1 property
CreateConsumerContractRequestContact
object
9 properties
ReplaceCustomerInConsumerContractResponse
object
1 property
InsuranceContractPackage
object
2 properties
MultiCard
object
6 properties
CreateConsumerContractResponseCustomer
object
Information related to all persons associated to the contract (contract holder, account owner, card holder)
6 properties
4 required
ChangedAccount
object
6 properties
ChangeProductResponseOrder
object
3 properties
ApiResponseEntityBrandAdviceConfig
object
Issuer response entity
2 properties
1 required
HierarchyOutgoingCreditTransferFeature
object
Specify OctFeature (periodicOct, periodicOctType, periodicOctMaxThreshold, etc.)
9 properties
SepaMandateMailAddress
object
13 properties
AddressVersionIdentifier
object
1 property
RemoveAddOnSubscriptionResponse
object
4 properties
2 required
ForbiddenResponseMetadata
object
4 properties
4 required
EmailAddress
object
1 property
1 required
AddressUsage
object
3 properties
2 required
HierarchyOperationStatus
object
4 properties
CycleInformation
object
Dates related to the closure calendar for the open closure cycle
10 properties
CloseContractResponseContract
object
5 properties
ModifyContractCustomersAddressesResponseCustomer
object
2 properties
CreateConsumerContractResponseAddress
object
3 properties
ApiResponseEntityListContract
object
Issuer response entity
2 properties
1 required
ForceProductChangeResponse
object
3 properties
InternalServerErrorResponseMetadata
object
4 properties
4 required
CardChange
object
2 properties
CreateConsumerContractRequestPinMailerOrder
object
The issuer can provide data related to a PIN mailer order if it is configured as required in the PIN production model. If not provided and required then the de…
5 properties
ModifyAddressRequestPhoneNumber
object
2 properties
1 required
EncryptedPan
object
2 properties
ProductChangeInformation
object
Only if a product change is triggered by card replacement. Represents product change information
11 properties
CreateAddOnSubscriptionRequestAddOnParameter
object
2 properties
2 required
ApiResponseEntityModifyLegitimacyDocumentResponse
object
Issuer response entity
2 properties
1 required
MailAddress
object
15 properties
1 required
CardContract
object
58 properties
CancelProductChangeRequest
object
1 property
CreateConsumerContractRequestCardOrder
object
The issuer can provide data related to the card order if physical card is requested. If not provided and required then the default sending mode is retrieved fr…
8 properties
UnauthorizedErrorApiResponse
object
1 property
1 required
ChangedCard
object
8 properties
CreateConsumerContractRequestAddOnParameter
object
2 properties
2 required
CreateConsumerContractRequestAddressUsage
object
5 properties
2 required
CreateConsumerContractResponseOrder
object
Information of each order (card order, PIN mailer order) if any
3 properties
1 required
ContactIdentifier
object
1 property
CreateConsumerContractResponseAccount
object
5 properties
5 required
AddressIdentifier
object
2 properties
SuspendContractRequest
object
3 properties
1 required
SignContractRequest
object
1 property
SuspendContractResponseContract
object
5 properties
ProductExtensionIdentifier
object
1 property
ApiResponseEntityModifyContractCustomersAddressesResponse
object
Issuer response entity
2 properties
1 required
ModifyLegitimacyDocumentResponse
object
5 properties
ApiResponseEntityCreateConsumerContractResponse
object
Issuer response entity
2 properties
1 required
OriginalCard
object
5 properties
ProductIdentifier
object
2 properties
CreateConsumerContractRequestContract
object
The issuer must provide data related to the contract.
22 properties
2 required
ApiResponseEntityChangeProductResponse
object
Issuer response entity
2 properties
1 required
CardStatusHistory
object
6 properties
ReplaceCustomerInContractRequest
object
2 properties
2 required
SuspendContractResponseCardContract
object
7 properties
ModifyContractCustomersAddressesResponseAddress
object
4 properties
CreateConsumerContractRequestTanMailerOrder
object
The issuer can provide data related to a TAN mailer order if it is configured as required in the TAN production model. If not provided and required then the de…
4 properties
PinInheritanceCardIdentifier
object
2 properties
CreateConsumerContractResponseContact
object
4 properties
LoyaltyPoint
object
2 properties
ApiResponseEntityListAddonSubscription
object
Issuer response entity
2 properties
1 required
ModifyBrandAdviceConfigProfile
object
2 properties
CardBlockingInformation
object
25 properties
1 required
ExternalRestriction
object
5 properties
1 required
ApiResponseEntityListLegitimacyDocuments
object
Issuer response entity
2 properties
1 required
ApiResponseEntityCancelContractSuspensionResponse
object
Issuer response entity
2 properties
1 required
InternalServerErrorErrorApiResponse
object
1 property
1 required
CardContractIdentifier
object
Identification of the card contract either by Issuer card contract external reference or by card contract reference
2 properties
ContactCenterIdentifier
object
1 property
SignContractResponseCardContract
object
Information for each card contract if any
3 properties
3 required
SwitchPrincipalCardResponse
object
1 property
AdviceProductExtensionRequest
object
1 property
1 required
SwitchPrincipalCardResponseCardContract
object
2 properties
Card
object
53 properties
1 required
CreateConsumerContractRequestCardContract
object
Data related to each card contract and card have to be provided. If there is no card at contract creation time then no data to be provided.
27 properties
1 required
ModifyBrandAdviceConfigRequest
object
3 properties
ExternalAuthorizationsRestriction
object
5 properties
1 required
AccountOutgoingCreditTransferFeature
object
Specify OctFeature (periodicOct, periodicOctType, periodicOctMaxThreshold, etc.)
9 properties
Account
object
103 properties
12 required
CreateConsumerContractRequestAccountHierarchy
object
The issuer must provide at least data related to the root account and other accounts if any when creating the contract.
6 properties
1 required
CancelProductChangeResponseOriginalContract
object
5 properties
Vulnerability
object
2 properties
1 required
RefundFeeOnDemandRequest
object
2 properties
2 required
SearchContractRequest
object
15 properties
ReplaceCustomerInConsumerContractResponseContract
object
4 properties
ApiResponseEntityCancelContractClosingResponse
object
Issuer response entity
2 properties
1 required
ModifyContractResponse
object
1 property
1 required
SuspendContractResponse
object
1 property
AddOnSubscription
object
6 properties
ApiResponseEntityContract
object
Issuer response entity
2 properties
1 required
BrandAdviceResponse
object
3 properties
ApiResponseEntityModifyContractResponse
object
Issuer response entity
2 properties
1 required
CreateConsumerContractResponseContract
object
10 properties
6 required
CloseContractRequest
object
5 properties
2 required
CancelProductChangeResponseChangedAccount
object
3 properties
AddCardsAccountsRequest
object
7 properties
1 required
Address
object
15 properties
2 required
NotFoundErrorApiResponse
object
1 property
1 required
ApiResponseEntityCancelProductChangeResponse
object
Issuer response entity
2 properties
1 required
RemoveAddOnSubscriptionRequest
object
5 properties
2 required
SuspendContractResponseAccount
object
3 properties
Amount
object
3 properties
3 required
ApiResponseEntityListAccount
object
Issuer response entity
2 properties
1 required
ReplaceCustomerInContractRequestCustomer
object
35 properties
3 required
CardIdentifier
object
Identification of the card either by Issuer card external reference or by card reference
2 properties
DataAnalysisFlags
object
Specify which data analysis flags are enabled (person, paymentTransaction, exchangeThirdParties, etc.)
3 properties
CreateAddressRequestMailAddress
object
14 properties
1 required
BrandAdviceConfigProfile
object
5 properties
SignContractResponseAccount
object
3 properties
3 required
InsurancePackageIdentifier
object
Unique identifier of the insurance contract package
1 property
ApiResponseEntityReplaceCustomerInConsumerContractResponse
object
Issuer response entity
2 properties
1 required
HierarchyOperationStatusHistory
object
6 properties
BrandAdviceConfigResponse
object
1 property
ChangedContract
object
Only if a product change is triggered by card replacement. Represents the new contract data after product change has occured
9 properties
ResponseMetadata
object
6 properties
4 required
DeliveryChannel
object
Specify the channel for letter delivery used for this contract
3 properties
ForceProductChangeRequest
object
2 properties
1 required
CreateConsumerContractRequest
object
3 properties
1 required
InsuranceContractIdentifier
object
The insurance package which is linked to this contract
1 property
SignContractResponseContract
object
4 properties
3 required
AddCardsAccountsRequestAccountHierarchy
object
The issuer provides data related to each account to be created.
2 properties
1 required
CardContractSourceInheritance
object
4 properties
CreateConsumerContractRequestEncryptedPin
object
The issuer can provide an encrypted PIN if it is allowed by the product configuration (self-selected PIN before production received from the issuer). If the fi…
7 properties
4 required
Contact
object
11 properties
CancelProductChangeResponseChangedCardContract
object
2 properties
RefundFeeOnDemandResponse
object
3 properties
Customer
object
43 properties
2 required
ExternalVelocityLimit
object
7 properties
1 required
ReplaceCustomerInContractRequestTargetCustomer
object
2 properties
ApiResponseEntitySignContractResponse
object
Issuer response entity
2 properties
1 required
CloseContractResponse
object
1 property
OrderIdentifier
object
Order reference calculated by our system
1 property
CardContractModel
object
2 properties
BrandData
object
3 properties
AddressDetails
object
16 properties
3 required
ErrorData
object
3 properties
Financial
object
3 properties
Transaction2PaymentCurrency
object
2 properties
PostDcc
object
2 properties
PostContractAddresses
object
1 property
1 required
ContractResponse
object
3 properties
PostContract
object
7 properties
2 required
EditContractAddressesResponse
object
4 properties
AddressType
object
1 property
CorrelationResponse
object
1 property
PostContractContractIdentification
object
2 properties
1 required
ContractContractIdentification
object
3 properties
PostContractCurrencyData
object
1 property
ContractCurrencyTransaction2Payment
object
2 properties
TransactionFeePricePlan
object
3 properties
ManualEntryProcessingOptions
object
6 properties
CardEntryModes
object
5 properties
PostContractBrandsResponse
object
4 properties
PostContractResponse
object
3 properties
Status
object
6 properties
ContractData
object
11 properties
ContractBalanceData
object
2 properties
PostContractStatus
object
2 properties
PostCurrencyData
object
1 property
ContractCurrencyBalance
object
2 properties
ErrorResponse
object
1 property
ExternalIds
object
4 properties
CurrencyCombination
object
2 properties
MerchantIdentificationResponse
object
7 properties
ContractAddressData
object
2 properties
EditContractBalancesResponse
object
4 properties
ContractServiceProvider
object
2 properties
PostContractCurrency
object
2 properties
Balance
object
10 properties
PostBankAccount
object
5 properties
Address_2
object
10 properties
ContractSubentitiesMissingResponse
object
3 properties
Amount_2
object
16 properties
Operation
object
4 properties
PostContractBalances
object
1 property
1 required
Dcc
object
4 properties
ContractCurrencyBankAccount
object
4 properties
PostRefundLimits
object
3 properties
PostContractBasic
object
5 properties
1 required
RejectedProductTypes
object
4 properties
PostContractCurrenciesResponse
object
4 properties
CurrencyData
object
3 properties
BalanceNumber
object
1 property
ContractBrandData
object
2 properties
BrandParameters
object
16 properties
TerminalBalancebankAccount
object
5 properties
PostFinancial
object
1 property
ContractListData
object
10 properties
PostContractBalance
object
10 properties
PostServiceProvider
object
1 property
BrandLabel
object
1 property
ContractBasic
object
8 properties
RefundLimits
object
3 properties
AllowedServices
object
20 properties
PostContractBrands
object
1 property
1 required
ContractStatusResponse
object
6 properties
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
#Contract
Where this information came from
This is an independent, third-party profile of Worldline Contract API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.