Worldline Company API
Company Api Controller
Worldline Company 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. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 18 operations across 11 paths, and defines 50 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.
18 operations
11 paths
50 schemas
2 DELETE7 GET2 PATCH3 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Worldline Company API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (basic) using the application flow.
Paths & Operations 18
Across 11 paths, the API surfaces 18 operations — 2 DELETE, 7 GET, 2 PATCH, 3 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
Company 18
Company Api Controller
GET
/issuers/{issuerId}/companies/{customerReference}
Retrieve company's information
PUT
/issuers/{issuerId}/companies/{customerReference}
Update company
PATCH
/issuers/{issuerId}/companies/{customerReference}
Update company partially
GET
/issuers/{issuerId}/companies/{customerReference}/company-history
Retrieve list of historic updates of a company (beta)
GET
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}
Retrieve company information by external reference
PUT
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}
Update Company by external reference
PATCH
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}
Update Company partially by external reference
GET
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/company-history
Retrieve list of historic updates of a company by customer external reference (beta)
GET
/issuers/{issuerId}/companies
Retrieve list of company's information
POST
/issuers/{issuerId}/companies
Create company
GET
/issuers/{issuerId}/companies/{customerReference}/addresses
Retrieve company's Address information list
GET
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses
Retrieve company's Address information list by external reference
POST
/issuers/{issuerId}/companies/{customerReference}/contacts
Create Contact
POST
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/contacts
Create Contact by external reference
PUT
/issuers/{issuerId}/companies/{customerReference}/contacts/{contactReference}
Modify Contact
DELETE
/issuers/{issuerId}/companies/{customerReference}/contacts/{contactReference}
Remove Contact by customer reference and contact reference
PUT
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/contacts/{contactReference}
Modify Contact by external reference
DELETE
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/contacts/{contactReference}
Remove Contact by external reference
Schemas 50
The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are Company (21 properties), CreateCompanyRequest (17 properties), CompanyHistory (16 properties), Address (15 properties). Each schema is shown below with its type and property counts.
ModifyCompanyRequestContact
object
8 properties
CustomerIdentifier
object
Identification of the updated customer either by Issuer customer external reference or by customer reference
2 properties
MailAddress
object
15 properties
1 required
DeleteContactResponse
object
1 property
ApiResponseEntityCreateContactResponse
object
Create contact response entity
2 properties
1 required
CreateAddressRequestPhoneNumber
object
2 properties
1 required
AddressVersionIdentifier
object
1 property
ModifyContactResponse
object
1 property
CreateCompanyResponse
object
2 properties
1 required
BadGatewayErrorApiResponse
object
1 property
1 required
InternalServerErrorErrorApiResponse
object
1 property
1 required
InternalServerErrorResponseMetadata
object
4 properties
4 required
NotFoundErrorApiResponse
object
1 property
1 required
ApiResponseEntityModifyCompanyResponse
object
Issuer response entity
2 properties
1 required
UnauthorizedErrorApiResponse
object
1 property
1 required
ApiResponseEntityCompanyHistory
object
Issuer response entity
2 properties
1 required
AddressIdentifier
object
2 properties
AddressUsage
object
3 properties
2 required
Links
object
2 properties
1 required
ApiResponseEntityListCompany
object
Issuer response entity
2 properties
1 required
ApiResponseEntityListAddress
object
Issuer response entity
2 properties
1 required
CompanyHistory
object
16 properties
UnauthorizedResponseMetadata
object
4 properties
4 required
ApiResponseEntityCompany
object
Issuer response entity
2 properties
1 required
Address
object
15 properties
2 required
ContactIdentifier
object
1 property
ApiResponseEntityRemoveContactResponse
object
Remove contact response entity
2 properties
1 required
ModifyCompanyRequest
object
15 properties
NotFoundResponseMetadata
object
4 properties
4 required
ResponseMetadata
object
6 properties
4 required
CreateConsumerContractRequestAddress
object
7 properties
2 required
ModifyCompanyResponse
object
1 property
1 required
CreateConsumerContractRequestAddressUsage
object
5 properties
2 required
ModifyAddressRequestMailAddress
object
14 properties
1 required
CreateCompanyRequest
object
17 properties
4 required
ForbiddenErrorApiResponse
object
1 property
1 required
ModifyContactRequest
object
9 properties
CreateContactRequest
object
9 properties
CreateAddressRequestMailAddress
object
14 properties
1 required
Contact
object
11 properties
BadRequestResponseMetadata
object
4 properties
4 required
EmailAddress
object
1 property
1 required
PhoneNumber
object
3 properties
1 required
BadGatewayResponseMetadata
object
4 properties
4 required
CreateContactResponse
object
1 property
ApiResponseEntityCreateCompanyResponse
object
Issuer response entity
2 properties
1 required
ApiResponseEntityModifyContactResponse
object
Modify contact response entity
2 properties
1 required
BadRequestErrorApiResponse
object
1 property
1 required
ForbiddenResponseMetadata
object
4 properties
4 required
Company
object
21 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
#Company