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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Worldline

Worldline Contract API

Contract Api Controller

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 75 operations across 61 paths, and defines 63 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.

75 operations 61 paths 63 schemas 3 DELETE20 GET11 PATCH39 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 Contract API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (basic) using the application 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)
getBrandAdvice 5 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/advise-product-extension
Advice a product extension (beta)
adviceProductExtension 5 params → 400401403404500502200
GET
/issuers/{issuerId}/contracts/brand-advice-config/{issuerProductExternalReference}deprecated
Retrieve brand advice algorithm configuration by issuer product external reference (beta)
retrieveBrandAdviceConfigByIssuerProductExtRef 5 params → 400401403404500502200
PATCH
/issuers/{issuerId}/contracts/brand-advice-config/{issuerProductExternalReference}deprecated
Update brand advice algorithm configuration by issuer product external reference (beta)
modifyBrandAdviceConfigByIssuerProductExtRef 6 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/create-consumer-contract
Create consumer contract
createConsumerContract 6 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/{contractReference}/sign
Sign Contract
signContract 7 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/sign
Sign Contract by external reference
signExternalContract 7 params → 400401403404500502200
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
Retrieve contract by external reference
retrieveContractByIssuerExtRef 9 params → 400401403404500502200
PATCH
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
Update contract by external reference
modifyContractByIssuerExtRef 7 params → 400401403404500502200
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/accounts
List accounts for contract by external reference
listAccountsForContractByIssuerExtRef 7 params → 400401403404500502200
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions
Retrieve the list of add-on services by external reference
listAddonsSubscriptionsForContractByIssuerExtRef 6 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions
Subscribe to add-on by external reference
createAddOnSubscriptionByIssuerExtRef 7 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions/unsubscribe
Unsubscribe add-on by external reference
removeAddOnSubscriptionByIssuerExtRef 7 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/add-cards-accounts
Add cards and accounts to a contract by external reference
addCardsAccountsByIssuerExtRef 8 params → 400401403404500502200
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/card-contracts
List card contracts for contract by external reference
listCardContractsForContractByIssuerExtRef 6 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/close
Close contract by external reference
closeContractByIssuerExtRef 7 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/update-all-customers-addresses
Update addresses of all customers linked to the contract by external reference
updateAllCustomersAddressesByIssuerExtRef 7 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/suspend
Suspend contract by external reference
suspendContractByIssuerExtRef 7 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-close
Cancel contract Closing by external reference
cancelContractClosingByIssuerExtRef 6 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-suspend
Cancel contract Suspension by external reference
cancelContractSuspensionByIssuerExtRef 6 params → 400401403404500502200
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-fees
List contract fees for a contract (Membership fee and Account setup fee models) by external reference
listContractFeesByIssuerExtRef 6 params → 400401403404500502200
PATCH
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-fees/{accountReference}
Update contract fees for an account (Membership fee and Account setup fee models) by contract external reference
modifyContractFeeByContractIssExtRef 8 params → 400401403404500502200
PATCH
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-fees/external-accounts/{issuerAccountExternalReference}
Update contract fees for an account (Membership fee and Account setup fee models) by contract external reference and account external reference
modifyContractFeeByContractAndAccountIssExtRef 8 params → 400401403404500502200
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-owner
Retrieve contract owner for a contract by external reference
retrieveContractOwnerByIssuerExtRef 7 params → 400401403404500502200
GET
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/legitimacy-documents
List legitimacy documents for a contract by external reference
listLegitimacyDocumentsByIssuerExtRef 6 params → 400401403404500502200
PUT
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/legitimacy-documents/external-customers/{issuerCustomerExternalReference}
Update legitimacy document of a contract customer by contract external reference and customer external reference
modifyLegitimacyDocumentByIssuerExtRef 8 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/search
Retrieve contracts by criteria
searchContract 9 params → 400401403404500502200
GET
/issuers/{issuerId}/contracts/{contractReference}
Retrieve contract
retrieveContract 9 params → 400401403404500502200
PATCH
/issuers/{issuerId}/contracts/{contractReference}
Update contract
modifyContract 7 params → 400401403404500502200
GET
/issuers/{issuerId}/contracts/{contractReference}/accounts
List accounts for contract
listAccountsForContract 7 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/{contractReference}/add-cards-accounts
Add cards and accounts to a contract
addCardsAccounts 8 params → 400401403404500502200
GET
/issuers/{issuerId}/contracts/{contractReference}/addon-subscriptions
Retrieve the list of add-on services
listAddonsSubscriptionsForContract 6 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/{contractReference}/addon-subscriptions
Subscribe to add-on
createAddOnSubscription 7 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/{contractReference}/addon-subscriptions/unsubscribe
Unsubscribe add-on
removeAddOnSubscription 7 params → 400401403404500502200
GET
/issuers/{issuerId}/contracts/{contractReference}/card-contracts
List card contracts for contract
listCardContractsForContract 6 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/{contractReference}/close
Close contract
closeContract 7 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/{contractReference}/update-all-customers-addresses
Update addresses of all customers linked to the contract
updateAllCustomersAddresses 7 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/{contractReference}/suspend
Suspend contract
suspendContract 7 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/{contractReference}/cancel-close
Cancel contract closing
cancelContractClosing 6 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/{contractReference}/cancel-suspend
Cancel contract suspension
cancelContractSuspension 6 params → 400401403404500502200
GET
/issuers/{issuerId}/contracts/{contractReference}/contract-fees
List contract fees for a contract (Membership fee and Account setup fee models)
listContractFees 6 params → 400401403404500502200
PATCH
/issuers/{issuerId}/contracts/{contractReference}/contract-fees/{accountReference}
Update contract fees for an account (Membership fee and Account setup fee models)
modifyContractFee 8 params → 400401403404500502200
PATCH
/issuers/{issuerId}/contracts/{contractReference}/contract-fees/external-accounts/{issuerAccountExternalReference}
Update contract fees for an account (Membership fee and Account setup fee models) by account external reference
modifyContractFeeByAccountIssExtRef 8 params → 400401403404500502200
GET
/issuers/{issuerId}/contracts/{contractReference}/contract-owner
Retrieve contract owner for a contract
retrieveContractOwner 7 params → 400401403404500502200
GET
/issuers/{issuerId}/contracts/{contractReference}/legitimacy-documents
List legitimacy documents for a contract
listLegitimacyDocuments 6 params → 400401403404500502200
PUT
/issuers/{issuerId}/contracts/{contractReference}/legitimacy-documents/{customerReference}
Update legitimacy document of a contract customer
modifyLegitimacyDocument 8 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/{contractReference}/switch-principal-card
Switch between principal and supplementary cards
switchPrincipalCard 7 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/switch-principal-card
Switch between principal and supplementary cards by external reference
switchPrincipalCardByIssuerExtRef 7 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/{contractReference}/change-product
Change the existing product for another one
changeProduct 7 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/change-product
Change the existing product for another one by external reference
changeProductByIssuerExtRef 7 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/{contractReference}/cancel-product-change
Cancel a pending ProductChange
cancelProductChange 7 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-product-change
Cancel a pending ProductChange by external reference
cancelProductChangeByIssuerExtRef 7 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/{contractReference}/force-product-change
Force a pending ProductChange
forceProductChange 7 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/force-product-change
Force a pending ProductChange by external reference
forceProductChangeByIssuerExtRef 7 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/{contractReference}/refund-fee-on-demand
Refund fee by contract reference
refundFeeByContractReference 7 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/refund-fee-on-demand
Refund fee by issuer contract external reference
refundFeeByIssuerContractExternalReference 7 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/{contractReference}/replace-customer
Replace a customer within a consumer contract
replaceCustomerByContractReference 7 params → 400401403404500502200
POST
/issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/replace-customer
Replace a customer within a consumer contract by external reference
replaceCustomerByIssuerContractExternalReference 7 params → 400401403404500502200
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts
Search contracts
getContractOverviewList 16 params → 200400401403404500502
POST
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts
Add a contract
postContract 1 param body → 201400401403404500502
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}
Retrieve a contract
getContract 3 params → 200400401403404500502
DELETE
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}
Delete a contract
deleteContract 2 params → 200400401403404500502
PATCH
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}
Update a contract
PatchContract 2 params body → 200400401403404500502
POST
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/currencies
Add currencies to a contract
postContractCurrencies 2 params body → 201400401403404500502
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/addresses
Retrieve the addresses of a contract
getContractAddresses 3 params → 200400401403404500502
POST
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/addresses
Add addresses to a contract
postContractAddresses 2 params body → 201400401403404500502
PATCH
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/addresses
Update the addresses of a contract
patchContractAddresses 2 params body → 200400401403404500502
DELETE
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/addresses/{addressType}
Delete an address from a contract
deleteContractAddresses 3 params → 200400401403404500502
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/balances
Retrieve the balances of a contract
getContractBalances 3 params → 200400401403404500502
POST
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/balances
Add balances to a contract
postContractBalances 2 params body → 201400401403404500502
PATCH
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/balances
Update the balances of a contract
patchContractBalances 2 params body → 200400401403404500502
GET
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/brands
Retrieve the brand parameters of a contract
getContractBrands 3 params → 200400401403404500502
POST
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/brands
Add brands to a contract
postContractBrands 2 params body → 201400403404500
PATCH
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/brands
Update the brand parameters of a contract
patchContractBrands 3 params body → 200400403404500
DELETE
/acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/brands/{label}
Delete a brand from a contract
deleteContractBrand 3 params → 200400403404500

Schemas 63

The contract defines 63 schemas that model the data the API accepts and returns. The most detailed are AllowedServices (20 properties), Amount (16 properties), AddressDetails (16 properties), BrandParameters (16 properties). Each schema is shown below with its type and property counts.

BrandParameters
object
16 properties
AddressDetails
object
16 properties 3 required
PostContractStatus
object
2 properties
Financial
object
3 properties
ContractBalanceData
object
2 properties
PostContract
object
7 properties 2 required
ContractBasic
object
8 properties
PostContractResponse
object
3 properties
ContractResponse
object
3 properties
BalanceNumber
object
1 property
ContractStatusResponse
object
6 properties
ErrorData
object
3 properties
ContractData
object
11 properties
ErrorResponse
object
1 property
ContractBrandData
object
2 properties
ContractListData
object
10 properties
MerchantIdentificationResponse
object
7 properties
Balance
object
10 properties
ContractCurrencyTransaction2Payment
object
2 properties
Dcc
object
4 properties
Operation
object
4 properties
PostContractBasic
object
5 properties 1 required
PostContractCurrency
object
2 properties
PostContractBrands
object
1 property 1 required
ContractCurrencyBalance
object
2 properties
PostContractCurrenciesResponse
object
4 properties
PostContractCurrencyData
object
1 property
PostContractBrandsResponse
object
4 properties
PostContractContractIdentification
object
2 properties 1 required
PostBankAccount
object
5 properties
PostContractBalance
object
10 properties
ContractServiceProvider
object
2 properties
ContractAddressData
object
2 properties
RejectedProductTypes
object
4 properties
CurrencyData
object
3 properties
PostDcc
object
2 properties
PostRefundLimits
object
3 properties
PostContractBalances
object
1 property 1 required
Amount
object
16 properties
PostCurrencyData
object
1 property
Transaction2PaymentCurrency
object
2 properties
Address
object
10 properties
CurrencyCombination
object
2 properties
AddressType
object
1 property
EditContractBalancesResponse
object
4 properties
PostServiceProvider
object
1 property
TerminalBalancebankAccount
object
5 properties
ContractSubentitiesMissingResponse
object
3 properties
PostFinancial
object
1 property
EditContractAddressesResponse
object
4 properties
TransactionFeePricePlan
object
3 properties
ContractContractIdentification
object
3 properties
PostContractAddresses
object
1 property 1 required
CardEntryModes
object
5 properties
RefundLimits
object
3 properties
AllowedServices
object
20 properties
ExternalIds
object
4 properties
CorrelationResponse
object
1 property
BrandData
object
3 properties
ManualEntryProcessingOptions
object
6 properties
BrandLabel
object
1 property
ContractCurrencyBankAccount
object
4 properties
Status
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wordline-contract-api-openapi.yml Raw ↑

Other APIs Worldline publishes across the network.

Worldline Connect (Global Collect) API
AE Profile APIs.io
Worldline Direct (Global Online Pay) API
AE Profile APIs.io
Worldline Acquiring API
AE Profile APIs.io
Worldline Financial Services Issuing API
AE Profile APIs.io
Worldline Financial Services Acquiring API
AE Profile APIs.io
Worldline Open Banking API
AE Profile APIs.io
Worldline SmartPOS API
AE Profile APIs.io
Worldline Identity and Authentication API
AE Profile APIs.io
Worldline Account - AccountState API
AE Profile APIs.io
Worldline Account API
AE Profile APIs.io
Worldline Account - Authorization API
AE Profile APIs.io
Worldline Account - Authorization Restriction API
AE Profile APIs.io
#Contract
← Back to W APIs
API Details
ID
wordline:wordline-contract-api
Base URL
https://api.connect.worldline-solutions.com
Docs
https://docs.connect.worldline-solutions.com/
Provider
Worldline
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network