Worldline Company - Related API
Company Related Api Controller
Worldline Company - Related API is one of 79 APIs that Worldline publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Company - Related. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 2 operations across 2 paths, and defines 82 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.
2 operations
2 paths
82 schemas
2 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Worldline Company - Related API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (basic) using the application flow.
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.
Company - Related 2
Company Related Api Controller
GET
/issuers/{issuerId}/companies/{customerReference}/corporate-contracts
List corporate contracts for a company
GET
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts
List corporate contracts for a company by external reference
Schemas 82
The contract defines 82 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
CorporateContractFee
object
Specify the corporate contract Fee
Customer
object
43 properties
2 required
ProductIdentifier
object
2 properties
AccountStatusHistory
object
3 properties
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
Order
object
35 properties
ForbiddenErrorApiResponse
object
1 property
1 required
Card
object
53 properties
1 required
FeeCondition
object
3 properties
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
ApiResponseEntityListCorporateContracts
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
DeliveryChannel
object
Specify the channel for letter delivery used for this contract
3 properties
AccountIdentifier
object
2 properties
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
ExternalRestrictionIdentifier
object
1 property
UnauthorizedErrorApiResponse
object
1 property
1 required
CorporateContract
object
31 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
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
HierarchyOperationStatusHistory
object
6 properties
Amount
object
3 properties
3 required
CardContractModel
object
2 properties
ContactCenterIdentifier
object
1 property
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
BadRequestResponseMetadata
object
4 properties
4 required
CardStatusHistory
object
6 properties
BadGatewayResponseMetadata
object
4 properties
4 required
PhoneNumber
object
3 properties
1 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
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
ContractFee
object
6 properties
InsuranceContractPackage
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
#Company - Related