Worldline Customer - Address API
Customer Address Api Controller
Worldline Customer - 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 Customer - Address. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 38 operations across 30 paths, and defines 47 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.
38 operations
30 paths
47 schemas
8 DELETE8 GET18 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Worldline Customer - Address API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (basic) using the application flow.
Paths & Operations 38
Across 30 paths, the API surfaces 38 operations — 8 DELETE, 8 GET, 18 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
Customer - Address 38
Customer Address Api Controller
POST
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses
Create address for a customer by external reference
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
Retrieve customer address by customer external reference and address external reference
PUT
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
Update address by customer external reference and address external reference
POST
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/invalidate
Invalidate address by customer external reference and address external reference
POST
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/invalidate
Invalidate address by customer external reference
POST
/issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/invalidate
Invalidate address by address external reference
POST
/issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/invalidate
Invalidate address
POST
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/activate
Activate address by customer external reference and address external reference
POST
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Add an address usage by customer external reference and address external reference
DELETE
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Remove an address usage by customer external reference and address external reference
POST
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/deactivate
Deactivate address by customer external reference and address external reference
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
Retrieve customer address by customer external reference
PUT
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
Update address by customer external reference
POST
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/activate
Activate address by customer external reference
POST
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-usages
Add an address usage by customer external reference
DELETE
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-usages
Remove an address usage by customer external reference
POST
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/deactivate
Deactivate address by customer external reference
POST
/issuers/{issuerId}/customers/{customerReference}/addresses
Create address for a customer
GET
/issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Retrieve customer address by address external reference
PUT
/issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Update address by address external reference
POST
/issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Add an address usage by address external reference
DELETE
/issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Remove an address usage by address external reference
POST
/issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/activate
Activate address by address external reference
POST
/issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/deactivate
Deactivate address by address external reference
GET
/issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}
Retrieve customer address
PUT
/issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}
Update address
POST
/issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/activate
Activate address
POST
/issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/address-usages
Add an address usage
DELETE
/issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/address-usages
Remove an address usage
POST
/issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/deactivate
Deactivate address
DELETE
/issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/address-versions/{addressVersionReference}
Delete an address for a customer
DELETE
/issuers/{issuerId}/customers/{customerReference}/external-addresses/{issuerAddressExternalReference}/address-versions/{addressVersionReference}
Delete an address for a customer by address external reference
DELETE
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-versions/{addressVersionReference}
Delete an address for a customer by customer external reference
DELETE
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/external-addresses/{issuerAddressExternalReference}/address-versions/{addressVersionReference}
Delete an address for a customer by customer external reference and address external reference
GET
/issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/address-versions
Retrieve customer address versions
GET
/issuers/{issuerId}/customers/{customerReference}/external-addresses/{issuerAddressExternalReference}/address-versions
Retrieve customer address versions by address external reference
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-versions
Retrieve customer address versions by customer external reference
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/external-addresses/{issuerAddressExternalReference}/address-versions
Retrieve customer address versions by customer external reference and address external reference
Schemas 47
The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are MailAddress (15 properties), Address (15 properties), ModifyAddressRequestMailAddress (14 properties), CreateAddressRequestMailAddress (14 properties). Each schema is shown below with its type and property counts.
MailAddress
object
15 properties
1 required
ApiResponseEntityCreateAddressResponse
object
Issuer response entity
2 properties
1 required
CreateAddressRequestPhoneNumber
object
2 properties
1 required
ApiResponseEntityDeleteAddress
object
Delete address response entity
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
ApiResponseEntityAddress
object
Issuer response entity
2 properties
1 required
UnauthorizedErrorApiResponse
object
1 property
1 required
ModifyAddressRequestPhoneNumber
object
2 properties
1 required
CreateAddressResponse
object
1 property
AddressIdentifier
object
2 properties
AddressUsage
object
3 properties
2 required
ApiResponseEntityInvalidateAddressResponse
object
Issuer response entity
2 properties
1 required
Links
object
2 properties
1 required
DeleteAddressUsageResponse
object
1 property
2 required
CreateAddressUsageRequest
object
3 properties
2 required
ModifyAddressRequest
object
8 properties
2 required
InvalidAddressResponse
object
2 properties
UnauthorizedResponseMetadata
object
4 properties
4 required
Address
object
15 properties
2 required
DeleteAddressUsageResponseAddressUsage
object
3 properties
2 required
ApiResponseEntityActivateAddressResponse
object
Issuer response entity
2 properties
1 required
ResponseMetadata
object
6 properties
4 required
NotFoundResponseMetadata
object
4 properties
4 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
ApiResponseEntityAddressVersions
object
Retrieve address versions response entity
2 properties
1 required
CreateAddressRequestMailAddress
object
14 properties
1 required
CreateAddressUsageResponse
object
3 properties
2 required
ApiResponseEntityDeactivateAddressResponse
object
Issuer response entity
2 properties
1 required
ApiResponseEntityModifyAddressResponse
object
Issuer response entity
2 properties
1 required
BadRequestResponseMetadata
object
4 properties
4 required
EmailAddress
object
1 property
1 required
PhoneNumber
object
3 properties
1 required
BadGatewayResponseMetadata
object
4 properties
4 required
BadRequestErrorApiResponse
object
1 property
1 required
DeleteAddressResponse
object
2 properties
2 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 - Address