Worldline Customer API
Customer Api Controller
Worldline Customer API is one of 79 APIs that Worldline publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Customer. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 18 operations across 11 paths, and defines 51 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
51 schemas
2 DELETE7 GET2 PATCH3 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Worldline Customer 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.
Customer 18
Customer Api Controller
GET
/issuers/{issuerId}/customers
Retrieve list of customer's information
POST
/issuers/{issuerId}/customers
Create a Customer (beta)
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}
Retrieve customer by external reference
PUT
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}
Update customer by external reference
PATCH
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}
Update customer partially by external reference
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/customer-history
Retrieve list of historic updates of a customer by customer external reference (beta)
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses
List addresses for a customer by external reference
GET
/issuers/{issuerId}/customers/{customerReference}
Retrieve customer
PUT
/issuers/{issuerId}/customers/{customerReference}
Update customer
PATCH
/issuers/{issuerId}/customers/{customerReference}
Update customer partially
GET
/issuers/{issuerId}/customers/{customerReference}/customer-history
Retrieve list of historic updates of a customer (beta)
GET
/issuers/{issuerId}/customers/{customerReference}/addresses
List addresses for a customer
POST
/issuers/{issuerId}/customers/{customerReference}/contacts
Create Contact for a customer (beta)
POST
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contacts
Create Contact for a customer by external reference (beta)
PUT
/issuers/{issuerId}/customers/{customerReference}/contacts/{contactReference}
Modify Contact for a customer (beta)
DELETE
/issuers/{issuerId}/customers/{customerReference}/contacts/{contactReference}
Remove Contact for a customer (beta)
PUT
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contacts/{contactReference}
Modify Contact for a customer by external reference (beta)
DELETE
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contacts/{contactReference}
Remove Contact for a customer by external reference (beta)
Schemas 51
The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are Customer (43 properties), CustomerHistory (38 properties), CreateCustomerRequest (36 properties), ModifyCustomerRequest (36 properties). Each schema is shown below with its type and property counts.
Vulnerability
object
2 properties
1 required
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
NotFoundErrorApiResponse
object
1 property
1 required
ModifyCustomerRequest
object
36 properties
BadGatewayErrorApiResponse
object
1 property
1 required
InternalServerErrorErrorApiResponse
object
1 property
1 required
InternalServerErrorResponseMetadata
object
4 properties
4 required
UnauthorizedErrorApiResponse
object
1 property
1 required
AddressIdentifier
object
2 properties
Customer
object
43 properties
2 required
AddressUsage
object
3 properties
2 required
Links
object
2 properties
1 required
CustomerHistory
object
38 properties
2 required
ApiResponseEntityCustomer
object
Issuer response entity
2 properties
1 required
ApiResponseEntityListAddress
object
Issuer response entity
2 properties
1 required
UnauthorizedResponseMetadata
object
4 properties
4 required
Address
object
15 properties
2 required
ContactIdentifier
object
1 property
ApiResponseEntityRemoveContactResponse
object
Remove contact response entity
2 properties
1 required
NotFoundResponseMetadata
object
4 properties
4 required
ResponseMetadata
object
6 properties
4 required
ApiResponseEntityModifyCustomerResponse
object
Issuer response entity
2 properties
1 required
ModifyCustomerRequestContact
object
8 properties
ApiResponseEntityCustomerHistory
object
Issuer response entity
2 properties
1 required
ModifyAddressRequestMailAddress
object
14 properties
1 required
ApiResponseEntityListCustomer
object
Issuer response entity
2 properties
1 required
CreateCustomerRequestAddress
object
7 properties
2 required
CreateCustomerResponse
object
2 properties
1 required
ForbiddenErrorApiResponse
object
1 property
1 required
ModifyContactRequest
object
9 properties
CreateContactRequest
object
9 properties
CreateCustomerRequestAddressUsage
object
5 properties
2 required
CreateAddressRequestMailAddress
object
14 properties
1 required
Contact
object
11 properties
BadRequestResponseMetadata
object
4 properties
4 required
CreateCustomerRequest
object
36 properties
3 required
EmailAddress
object
1 property
1 required
PhoneNumber
object
3 properties
1 required
ModifyCustomerResponse
object
1 property
1 required
BadGatewayResponseMetadata
object
4 properties
4 required
CreateContactResponse
object
1 property
ApiResponseEntityModifyContactResponse
object
Modify contact response entity
2 properties
1 required
BadRequestErrorApiResponse
object
1 property
1 required
ApiResponseEntityCreateCustomerResponse
object
Create Customer response entity
2 properties
1 required
ForbiddenResponseMetadata
object
4 properties
4 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
#Customer