Worldline Corporate Contract API
Corporate Contract API Controller
Worldline Corporate 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 Corporate Contract. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 43 operations across 35 paths, and defines 191 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
35 paths
191 schemas
10 GET10 PATCH23 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Worldline Corporate Contract API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (basic) using the application flow.
Paths & Operations 43
Across 35 paths, the API surfaces 43 operations — 10 GET, 10 PATCH, 23 POST. Each is listed below with its method, path, parameters, and response codes.
Corporate Contract 43
Corporate Contract API Controller
GET
/issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}
Retrieve corporate employee Accounts
PATCH
/issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}
Update Corporate employee account
GET
/issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Retrieve corporate employee accounts by account external reference
PATCH
/issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Update Corporate employee account by account external reference
GET
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Retrieve corporate employee Accounts by contract external reference and account external reference
PATCH
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Update Corporate employee account by contract external reference and account external reference
GET
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}
Retrieve corporate employee Accounts by contract external reference
PATCH
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}
Update Corporate employee account by contract external reference
GET
/issuers/{issuerId}/corporate-contracts/{contractReference}
Retrieve corporate contract
PATCH
/issuers/{issuerId}/corporate-contracts/{contractReference}
Modify Corporate contract
GET
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}
Retrieve corporate contract by external reference
PATCH
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}
Modify Corporate contract by external reference
POST
/issuers/{issuerId}/corporate-contracts/{contractReference}/close
Close Corporate contract
POST
/issuers/{issuerId}/corporate-contracts/{contractReference}/add-corporate-contract-entity
Add an entity to a Corporate contract
PATCH
/issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-contract-entity/{companyEntityExternalReference}deprecated
Modify an entity of a Corporate contract - deprecated
PATCH
/issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-contract-entities/{companyEntityExternalReference}
Modify an entity of a Corporate contract
PATCH
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-contract-entity/{companyEntityExternalReference}deprecated
modify an entity of a Corporate contract by external reference - deprecated
PATCH
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-contract-entities/{companyEntityExternalReference}
modify an entity of a Corporate contract by external reference
POST
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-corporate-contract-entity
Add an entity to a Corporate contract by external reference
POST
/issuers/{issuerId}/corporate-contracts/{contractReference}/add-corporate-employee-cards-accounts
Add an employee and its card(s) and account(s) to a Corporate contract
POST
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-corporate-employee-cards-accounts
Add an employee and its card(s) and account(s) to a Corporate contract by external reference
POST
/issuers/{issuerId}/corporate-contracts/{contractReference}/add-virtual-cards-accounts-service
Add Corporate VCA Service cards and accounts to a corporate contract
POST
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-virtual-cards-accounts-service
Add Corporate VCA Service cards and accounts to a corporate contract by issuer contract external reference
POST
/issuers/{issuerId}/corporate-contracts/create-corporate-contract
Create a Corporate contract
POST
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/close
Close Corporate contract by external reference
POST
/issuers/{issuerId}/corporate-contracts/{contractReference}/refund-fee-on-demand
Refund fee by contract reference for corporate contract
GET
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions
List add-on services subscriptions for a corporate contract by external reference
POST
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions
Subscribe to add-on for a corporate contract by external reference
GET
/issuers/{issuerId}/corporate-contracts/{contractReference}/addon-subscriptions
List add-on services subscriptions for a corporate contract
POST
/issuers/{issuerId}/corporate-contracts/{contractReference}/addon-subscriptions
Subscribe to add-on for a corporate contract
POST
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions/unsubscribe
Unsubscribe add-on for a corporate contract by external reference
POST
/issuers/{issuerId}/corporate-contracts/{contractReference}/addon-subscriptions/unsubscribe
Unsubscribe add-on for a corporate contract
POST
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/refund-fee-on-demand
Refund Fee By Issuer Contract External Reference For Corporate Contract
POST
/issuers/{issuerId}/corporate-contracts/{contractReference}/change-paying-account
Change paying account structure for a corporate contract
POST
/issuers/{issuerId}/corporate-contracts/{contractReference}/cancel-change-paying-account
Cancel scheduled change of paying account type
POST
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/cancel-change-paying-account
Cancel scheduled change of paying account type by external reference
POST
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/change-paying-account
Change paying account structure for a corporate contract by external reference
GET
/issuers/{issuerId}/corporate-contracts/{contractReference}/contract-owner
Retrieve contract owner for a corporate contract (beta)
GET
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/contract-owner
Retrieve contract owner for a corporate contract by external reference (beta)
POST
/issuers/{issuerId}/corporate-contracts/{contractReference}/card-contracts/{cardContractReference}/reallocate
Reallocate employee
POST
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/card-contracts/{cardContractReference}/reallocate
Reallocate employee by issuer contract external reference
POST
/issuers/{issuerId}/corporate-contracts/{contractReference}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/reallocate
Reallocate employee by issuer card contract external reference
POST
/issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/reallocate
Reallocate employee by issuer contract external reference and issuer card contract external reference
Schemas 191
The contract defines 191 schemas that model the data the API accepts and returns. The most detailed are Account (103 properties), CardContract (58 properties), Card (53 properties), ContractMember (44 properties). Each schema is shown below with its type and property counts.
CreateCorporateContractRequestContract
object
The issuer must provide data related to the contract.
18 properties
3 required
CreateCorporateContractRequestHierarchyOutgoingCreditTransferFeature
object
The issuer can enable or not each different Outgoing Credit Transfer (OCT) options if this latter is enabled and if can be overriden within the reimbursement m…
8 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
ApiResponseEntityAddCorporateEmployeeCardsAndAccountsResponse
object
Issuer response entity
2 properties
1 required
ReallocateEmployeeResponseOriginalAccount
object
4 properties
4 required
CreateCorporateContractResponse
object
3 properties
1 required
CorporateContractFee
object
Specify the corporate contract Fee
ContractMember
object
44 properties
CreateCorporateContractRequestAddCorporateVcaServiceCardsAndAccounts
object
5 properties
2 required
ApiResponseEntityRefundFeeOnDemandResponse
object
Refund Fee On Demand response entity
2 properties
1 required
CloseCorporateContractResponse
object
2 properties
2 required
CreateCorporateContractResponseCard
object
8 properties
Customer
object
43 properties
2 required
ProductIdentifier
object
2 properties
CreateAddOnSubscriptionRequestAddOnParameter
object
2 properties
2 required
AccountStatusHistory
object
3 properties
InsurancePackageIdentifier
object
Unique identifier of the insurance contract package
1 property
ApiResponseEntityCreateAddOnSubscriptionResponse
object
Issuer response entity
2 properties
1 required
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
CreateCorporateContractResponseCorporateContractEntity
object
6 properties
4 required
PinInheritanceExternalCardIdentifier
object
1 property
CreateCorporateContractResponseCardContract
object
4 properties
ContactIdentifier
object
1 property
CreateCorporateContractResponseCorporateEmployeeCardsAndAccounts
object
3 properties
1 required
ApiResponseEntityAddCorporateVcaServiceCardsAndAccountsResponse
object
Issuer response entity
2 properties
1 required
ApiResponseEntityCorporateEmployeeAccountResponse
object
Issuer response entity
2 properties
1 required
Order
object
35 properties
ForbiddenErrorApiResponse
object
1 property
1 required
ApiResponseEntityCreateCorporateContractResponse
object
Issuer response entity
2 properties
1 required
AddCorporateEmployeeCardsAndAccountsResponseContract
object
3 properties
2 required
CreateCorporateContractResponseContact
object
4 properties
1 required
RemoveAddOnSubscriptionResponse
object
4 properties
2 required
CreateCorporateContractRequestCorporateContractRootEntity
object
The issuer must define the first level of the company organization (corresponding to the root entity).
4 properties
2 required
CreateCorporateContractResponseCorporateContractRootEntity
object
2 properties
2 required
AddCorporateContractEntityResponseContract
object
2 properties
2 required
CreateAddOnSubscriptionResponse
object
4 properties
2 required
ApiResponseEntityCloseCorporateContractResponse
object
Issuer response entity
2 properties
1 required
CreateCorporateContractRequestCorporateEmployeeCard
object
1 property
Card
object
53 properties
1 required
ChangePayingAccountResponseCorporateContract
object
3 properties
FeeCondition
object
3 properties
ReallocateEmployeeResponse
object
2 properties
2 required
CreateCorporateContractRequestVcaServiceCardContract
object
Data related to each VCA service virtual card contract needs to be provided
10 properties
CreateCorporateContractRequestContact
object
8 properties
FeePostingEntityIdentifier
object
3 properties
AddCorporateEmployeeCardsAndAccountsResponseCorporateContractEntity
object
4 properties
2 required
AddCorporateEmployeeCardsAndAccountsResponse
object
2 properties
1 required
MailAddress
object
15 properties
1 required
CreateCorporateContractRequestCorporateVcaServiceCard
object
1 property
CreateCorporateContractRequestCorporateContractLevel
object
2 properties
2 required
AccountOutgoingCreditTransferFeature
object
Specify OctFeature (periodicOct, periodicOctType, periodicOctMaxThreshold, etc.)
9 properties
BadGatewayErrorApiResponse
object
1 property
1 required
InternalServerErrorErrorApiResponse
object
1 property
1 required
InternalServerErrorResponseMetadata
object
4 properties
4 required
NotFoundErrorApiResponse
object
1 property
1 required
CorporateContractLevel
object
Specify the level in the company organization
2 properties
ProductExtensionIdentifier
object
1 property
CorporateEmployeeAccount
object
Specify the corporate employee account
17 properties
CreateCorporateContractRequestAddCorporateEmployeeCardsAndAccounts
object
5 properties
3 required
AddressUsage
object
3 properties
2 required
CreateCorporateContractResponseCorporateEmployeeCard
object
1 property
CreateCorporateContractRequestCorporateEmployeeAccount
object
9 properties
ReallocateEmployeeResponseChangedAccount
object
4 properties
4 required
CreateCorporateContractRequestCorporateContractEntityAccount
object
1 property
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
CreateCorporateContractResponseAccount
object
5 properties
3 required
AccountIdentifier
object
2 properties
CreateCorporateContractRequestSepaMandate
object
The issuer must provide SEPA mandate if payment processing channel is SEPA (SEPA indicator is true) and payment mode is AUTOPAYMENT
13 properties
1 required
CreateCorporateContractRequestAddOnSubscription
object
4 properties
ReallocateEmployeeRequest
object
2 properties
1 required
ModifyCorporateContractRequest
object
12 properties
ApiResponseEntityListAddonSubscription
object
Issuer response entity
2 properties
1 required
CloseCorporateContractResponseAccount
object
1 property
EmailAddress
object
1 property
1 required
InsuranceContract
object
10 properties
CreateCorporateContractRequestCorporateContractFee
object
7 properties
AddCorporateContractEntityRequest
object
3 properties
1 required
CardContract
object
58 properties
AddCorporateVcaServiceCardsAndAccountsRequest
object
2 properties
1 required
ModifyCorporateEmployeeAccountResponse
object
1 property
ApiResponseEntityContractMember
object
Issuer response entity
2 properties
1 required
CreateCorporateContractRequestAccount
object
32 properties
ExternalVelocityLimitIdentifier
object
1 property
AddressVersionIdentifier
object
1 property
OrderIdentifier
object
Order reference calculated by our system
1 property
ReallocateEmployeeResponseChangedCardContract
object
3 properties
3 required
ExternalRestrictionIdentifier
object
1 property
UnauthorizedErrorApiResponse
object
1 property
1 required
CreateCorporateContractResponseCustomer
object
5 properties
4 required
ChangePayingAccountResponse
object
1 property
CreateCorporateContractResponseCompany
object
4 properties
2 required
CreateCorporateContractResponseCorporateContractEntityAccount
object
1 property
CorporateContract
object
31 properties
ModifyCorporateContractEntityResponse
object
2 properties
2 required
ApiResponseEntityRemoveAddOnSubscriptionResponse
object
Issuer response entity
2 properties
1 required
CreateCorporateContractResponseOrder
object
3 properties
CardContractIdentifier
object
Identification of the card contract either by Issuer card contract external reference or by card contract reference
2 properties
Account
object
103 properties
12 required
ModifyCorporateEmployeeAccountRequestCorporateContractFee
object
8 properties
ModifyCorporateContractEntityRequest
object
2 properties
CreateCorporateContractResponseCorporateEmployeeAccount
object
2 properties
1 required
InsuranceEvent
object
3 properties
CreateAddOnSubscriptionRequest
object
7 properties
2 required
HierarchyOperationStatus
object
4 properties
ApiResponseEntityAddCorporateContractEntityResponse
object
Issuer response entity
2 properties
1 required
MultiCard
object
6 properties
AdvertisementFlags
object
Specify possible channels used to provide advertisements
6 properties
RemoveAddOnSubscriptionRequest
object
5 properties
2 required
PinInheritanceCardIdentifier
object
2 properties
HierarchyOperationStatusHistory
object
6 properties
Amount
object
3 properties
3 required
CardContractModel
object
2 properties
ChangePayingAccountRequest
object
1 property
1 required
ModifyCorporateEmployeeAccountRequestCorporateEmployeeAccount
object
8 properties
CreateCorporateContractRequestCard
object
Card related data to be provided for the creation of the card.
11 properties
ChangePayingAccountResponseAccountFutureUpdate
object
4 properties
ContactCenterIdentifier
object
1 property
ApiResponseEntityCorporateContract
object
Issuer response entity
2 properties
1 required
AuthorizationDataValidation
object
The issuer can update cardholder data used by the Front Office for verification (AVS/ANI).
6 properties
ContactCenter
object
6 properties
Contact
object
11 properties
AddOnServiceParameter
object
4 properties
BadRequestResponseMetadata
object
4 properties
4 required
CardStatusHistory
object
6 properties
CreateCorporateContractResponseCorporateContractLevel
object
2 properties
2 required
AddCorporateVcaServiceCardsAndAccountsResponse
object
2 properties
1 required
CreateCorporateContractResponseAddress
object
3 properties
3 required
CreateCorporateContractRequestCustomer
object
35 properties
3 required
PhoneNumber
object
3 properties
1 required
CreateCorporateContractResponseContract
object
13 properties
7 required
CreateCorporateContractRequestCardOrder
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…
4 properties
ExternalVelocityLimit
object
7 properties
1 required
ContractIdentifier
object
Identification of thecorporate contract either by Issuer contract external reference or by contract reference
2 properties
BadGatewayResponseMetadata
object
4 properties
4 required
ForbiddenResponseMetadata
object
4 properties
4 required
Company
object
21 properties
Vulnerability
object
2 properties
1 required
CreateCorporateContractRequestAddCorporateContractEntity
object
7 properties
5 required
CreateAddressRequestPhoneNumber
object
2 properties
1 required
ReallocateEmployeeResponseOriginalCorporateEmployeeAccount
object
2 properties
2 required
ModifyCorporateContractResponse
object
1 property
1 required
AddCorporateContractEntityResponse
object
3 properties
ReallocateEmployeeResponseChangedCorporateEmployeeAccount
object
3 properties
3 required
CardBlockingInformation
object
25 properties
1 required
CreateCorporateContractRequest
object
6 properties
1 required
CreateCorporateContractRequestAddress
object
8 properties
2 required
InsuranceContractIdentifier
object
The insurance package which is linked to this contract
1 property
SepaMandateMailAddress
object
13 properties
AddressIdentifier
object
2 properties
LoyaltyPoint
object
2 properties
Links
object
2 properties
1 required
ApiResponseEntityReallocateEmployeeResponse
object
Reallocate Employee response entity
2 properties
1 required
CreateCorporateContractRequestVcaServiceCard
object
Card related data to be provided for the creation of the card.
3 properties
ApiResponseEntityChangePayingAccountResponse
object
Issuer response entity
2 properties
1 required
CreateCorporateContractRequestAccountHierarchy
object
The issuer must provide at least data related to the root account when creating the corporate contract.
5 properties
CreateCorporateContractRequestPinMailerOrder
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…
3 properties
ApiResponseEntityModifyCorporateContractResponse
object
Issuer response entity
2 properties
1 required
CancelChangePayingAccountResponse
object
1 property
CloseCorporateContractResponseCorporateContract
object
3 properties
3 required
ApiResponseEntityModifyCorporateContractEntityResponse
object
Issuer response entity
2 properties
1 required
UnauthorizedResponseMetadata
object
4 properties
4 required
ChangePayingAccountResponseAccount
object
4 properties
Address
object
15 properties
2 required
CreateCorporateContractRequestCardContract
object
Data related to each card contract and card have to be provided. If there is no card at creation time then no data to be provided.
19 properties
CreateCorporateContractRequestAddOnParameter
object
2 properties
RefundFeeOnDemandResponse
object
3 properties
RefundFeeOnDemandRequest
object
2 properties
2 required
NotFoundResponseMetadata
object
4 properties
4 required
ResponseMetadata
object
6 properties
4 required
CloseCorporateContractRequest
object
5 properties
2 required
AddCorporateEmployeeCardsAndAccountsRequest
object
2 properties
1 required
AccountRelation
object
2 properties
2 required
OrderStatusHistory
object
3 properties
CreateCorporateContractRequestAddressUsage
object
5 properties
2 required
CreateCorporateContractRequestCompany
object
17 properties
3 required
CorporateContractEntity
object
Specify the corporate contract entity
8 properties
CreateAddressRequestMailAddress
object
14 properties
1 required
ApiResponseEntityModifyCorporateEmployeeAccountResponse
object
Issuer response entity
2 properties
1 required
ContractFee
object
6 properties
InsuranceContractPackage
object
2 properties
BadRequestErrorApiResponse
object
1 property
1 required
ModifyCorporateEmployeeAccountRequest
object
2 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
#Corporate Contract