Worldline Company - Address API
Company Address Api Controller
Worldline Company - Address 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 - Address. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 26 operations across 18 paths, and defines 46 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.
26 operations
18 paths
46 schemas
4 DELETE4 GET14 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Worldline Company - Address API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (basic) using the application flow.
Paths & Operations 26
Across 18 paths, the API surfaces 26 operations — 4 DELETE, 4 GET, 14 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
Company - Address 26
Company Address Api Controller
POST
/issuers/{issuerId}/companies/{customerReference}/addresses
Create address for a company customer
GET
/issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}
Retrieve company's address information by address ref
PUT
/issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}
Update company address
GET
/issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Retrieve company's address information by address external reference
PUT
/issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Update company address by external address reference
POST
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses
Create address for a company by external reference
GET
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
Retrieve address information by company external reference
PUT
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
Update company address by company external reference
GET
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
Retrieve address information by company external reference and address external reference
PUT
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
Update company address by company external reference and address external reference
POST
/issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}/activate
Activate address of a company
POST
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/activate
Activate address of a company by company external reference
POST
/issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/activate
Activate address of a company by address external reference
POST
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/activate
Activate address of a company by company external reference and address external reference
POST
/issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}/deactivate
Deactivate address of a company
POST
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/deactivate
Deactivate address of a company by company external reference
POST
/issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/deactivate
Deactivate address of a company by address external reference
POST
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/deactivate
Deactivate address of a company by company external reference and address external reference
POST
/issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}/address-usages
Create an address usage for a company
DELETE
/issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}/address-usages
Remove an address usage of a company
POST
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-usages
Create an address usage for a company by company external reference
DELETE
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-usages
Remove an address usage of a company by company external reference
POST
/issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Create an address usage for a company by address external reference
DELETE
/issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Remove an address usage of a company by address external reference
POST
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Create an address usage for a company by company external reference and address external reference
DELETE
/issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Remove an address usage of a company by company external reference and address external reference
Schemas 46
The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are Company (21 properties), MailAddress (15 properties), Address (15 properties), ModifyAddressRequestMailAddress (14 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
MailAddress
object
15 properties
1 required
ApiResponseEntityCreateAddressResponse
object
Issuer response entity
2 properties
1 required
CreateAddressRequestPhoneNumber
object
2 properties
1 required
AddressVersionIdentifier
object
1 property
NotFoundErrorApiResponse
object
1 property
1 required
ApiResponseEntityDeleteAddressUsageResponse
object
Issuer response entity
2 properties
1 required
BadGatewayErrorApiResponse
object
1 property
1 required
InternalServerErrorErrorApiResponse
object
1 property
1 required
InternalServerErrorResponseMetadata
object
4 properties
4 required
UnauthorizedErrorApiResponse
object
1 property
1 required
ModifyAddressRequestPhoneNumber
object
2 properties
1 required
CreateAddressResponse
object
1 property
DeleteAddressUsageResponse
object
1 property
2 required
AddressIdentifier
object
2 properties
AddressUsage
object
3 properties
2 required
Links
object
2 properties
1 required
CreateAddressUsageRequest
object
3 properties
2 required
ModifyAddressRequest
object
8 properties
2 required
UnauthorizedResponseMetadata
object
4 properties
4 required
ApiResponseEntityCompany
object
Issuer response entity
2 properties
1 required
Address
object
15 properties
2 required
DeleteAddressUsageResponseAddressUsage
object
3 properties
2 required
ContactIdentifier
object
1 property
NotFoundResponseMetadata
object
4 properties
4 required
ResponseMetadata
object
6 properties
4 required
ApiResponseEntityActivateAddressResponse
object
Issuer response entity
2 properties
1 required
ModifyAddressResponse
object
1 property
CreateAddressRequest
object
10 properties
2 required
ModifyAddressRequestMailAddress
object
14 properties
1 required
ActivateAddressResponse
object
2 properties
ApiResponseEntityCreateAddressUsageResponse
object
Issuer response entity
2 properties
1 required
ForbiddenErrorApiResponse
object
1 property
1 required
DeactivateAddressResponse
object
2 properties
CreateAddressRequestMailAddress
object
14 properties
1 required
CreateAddressUsageResponse
object
3 properties
2 required
ApiResponseEntityDeactivateAddressResponse
object
Issuer response entity
2 properties
1 required
Contact
object
11 properties
BadRequestResponseMetadata
object
4 properties
4 required
ApiResponseEntityModifyAddressResponse
object
Issuer response entity
2 properties
1 required
EmailAddress
object
1 property
1 required
BadGatewayResponseMetadata
object
4 properties
4 required
PhoneNumber
object
3 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 - Address