How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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 3.2.0, at version 2.41.1.

Requests are made against a single base URL, https://sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/card-issuing/api/v2.

38 operations 30 paths 47 schemas 8 DELETE8 GET18 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.41.1
Base URL
https://api.connect.worldline-solutions.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Worldline Customer - Address API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (basic) using the clientCredentials 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
createAddressByCustomerIssuerExtRef 6 params body → 400401403404500502200
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
Retrieve customer address by customer external reference and address external reference
retrieveAddressByIssuerExtRefAndCustomerIssuerExtRef 8 params → 400401403404500502200
PUT
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
Update address by customer external reference and address external reference
modifyAddressByIssuerExtRefAndCustomerIssuerExtRef 7 params body → 400401403404500502200
POST
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/invalidate
Invalidate address by customer external reference and address external reference
invalidateAddressByExtCustomerRefAndExtAddress 6 params → 400401403404500502200
POST
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/invalidate
Invalidate address by customer external reference
invalidateAddressByExtCustomerAndAddress 6 params → 400401403404500502200
POST
/issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/invalidate
Invalidate address by address external reference
invalidateAddressByCustomerAndExtAddress 6 params → 400401403404500502200
POST
/issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/invalidate
Invalidate address
invalidateAddress 6 params → 400401403404500502200
POST
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/activate
Activate address by customer external reference and address external reference
activateAddressByIssuerExtRefAndCustomerIssuerExtRef 7 params → 400401403404500502200
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
createAddressUsageByIssuerExtRefAndCustomerIssuerExtRef 7 params body → 400401403404500502200
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
deleteAddressUsageByIssuerExtRefAndCustomerIssuerExtRef 10 params → 400401403404500502200
POST
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/deactivate
Deactivate address by customer external reference and address external reference
deactivateAddressByIssuerExtRefAndCustomerIssuerExtRef 7 params → 400401403404500502200
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
Retrieve customer address by customer external reference
retrieveAddressByCustomerIssuerExtRef 8 params → 400401403404500502200
PUT
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
Update address by customer external reference
modifyAddressByCustomerIssuerExtRef 7 params body → 400401403404500502200
POST
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/activate
Activate address by customer external reference
activateAddressByCustomerIssuerExtRef 7 params → 400401403404500502200
POST
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-usages
Add an address usage by customer external reference
createAddressUsageByCustomerIssuerExtRef 7 params body → 400401403404500502200
DELETE
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-usages
Remove an address usage by customer external reference
deleteAddressUsageByCustomerIssuerExtRef 10 params → 400401403404500502200
POST
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/deactivate
Deactivate address by customer external reference
deactivateAddressByCustomerIssuerExtRef 7 params → 400401403404500502200
POST
/issuers/{issuerId}/customers/{customerReference}/addresses
Create address for a customer
createAddress 6 params body → 400401403404500502200
GET
/issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Retrieve customer address by address external reference
retrieveAddressByIssuerExtRef 8 params → 400401403404500502200
PUT
/issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Update address by address external reference
modifyAddressByIssuerExtRef 7 params body → 400401403404500502200
POST
/issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Add an address usage by address external reference
createAddressUsageByIssuerExtRef 7 params body → 400401403404500502200
DELETE
/issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Remove an address usage by address external reference
deleteAddressUsageByIssuerExtRef 10 params → 400401403404500502200
POST
/issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/activate
Activate address by address external reference
activateAddressByIssuerExtRef 7 params → 400401403404500502200
POST
/issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/deactivate
Deactivate address by address external reference
deactivateAddressByIssuerExtRef 7 params → 400401403404500502200
GET
/issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}
Retrieve customer address
retrieveAddress 8 params → 400401403404500502200
PUT
/issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}
Update address
modifyAddress 7 params body → 400401403404500502200
POST
/issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/activate
Activate address
activateAddress 7 params → 400401403404500502200
POST
/issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/address-usages
Add an address usage
createAddressUsage 7 params body → 400401403404500502200
DELETE
/issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/address-usages
Remove an address usage
deleteAddressUsage 10 params → 400401403404500502200
POST
/issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/deactivate
Deactivate address
deactivateAddress 7 params → 400401403404500502200
DELETE
/issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/address-versions/{addressVersionReference}
Delete an address for a customer
deleteAddress 7 params → 400401403404500502200
DELETE
/issuers/{issuerId}/customers/{customerReference}/external-addresses/{issuerAddressExternalReference}/address-versions/{addressVersionReference}
Delete an address for a customer by address external reference
deleteAddressByAdrExtRef 7 params → 400401403404500502200
DELETE
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-versions/{addressVersionReference}
Delete an address for a customer by customer external reference
deleteAddressByCusExtRef 7 params → 400401403404500502200
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
deleteAddressByCusExtRefAndAdrExtRef 7 params → 400401403404500502200
GET
/issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/address-versions
Retrieve customer address versions
retrieveAddressVersions 7 params → 400401403404500502200
GET
/issuers/{issuerId}/customers/{customerReference}/external-addresses/{issuerAddressExternalReference}/address-versions
Retrieve customer address versions by address external reference
retrieveAddressVersionsByIssuerExtRef 7 params → 400401403404500502200
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-versions
Retrieve customer address versions by customer external reference
retrieveAddressVersionsByCustomerIssuerExtRef 7 params → 400401403404500502200
GET
/issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/external-addresses/{issuerAddressExternalReference}/address-versions
Retrieve customer address versions by customer external reference and address external reference
retrieveAddressVersionsByIssuerExtRefAndCustomerIssuerExtRef 7 params → 400401403404500502200

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.

InternalServerErrorResponseMetadata
object
4 properties 4 required
Address
object
15 properties 2 required
CreateAddressUsageRequest
object
3 properties 2 required
ResponseMetadata
object
6 properties 4 required
AddressIdentifier
object
2 properties
CreateAddressRequest
object
10 properties 2 required
BadRequestErrorApiResponse
object
1 property 1 required
ApiResponseEntityCreateAddressResponse
object
Issuer response entity
2 properties 1 required
EmailAddress
object
1 property 1 required
NotFoundErrorApiResponse
object
1 property 1 required
DeactivateAddressResponse
object
2 properties
ForbiddenErrorApiResponse
object
1 property 1 required
NotFoundResponseMetadata
object
4 properties 4 required
ActivateAddressResponse
object
2 properties
InvalidAddressResponse
object
2 properties
UnauthorizedErrorApiResponse
object
1 property 1 required
ModifyAddressResponse
object
1 property
ModifyAddressRequest
object
8 properties 2 required
Links
object
2 properties 1 required
ApiResponseEntityModifyAddressResponse
object
Issuer response entity
2 properties 1 required
AddressUsage
object
3 properties 2 required
ForbiddenResponseMetadata
object
4 properties 4 required
ModifyAddressRequestPhoneNumber
object
2 properties 1 required
ModifyAddressRequestMailAddress
object
14 properties 1 required
MailAddress
object
15 properties 1 required
ApiResponseEntityAddress
object
Issuer response entity
2 properties 1 required
ApiResponseEntityDeactivateAddressResponse
object
Issuer response entity
2 properties 1 required
InternalServerErrorErrorApiResponse
object
1 property 1 required
ApiResponseEntityAddressVersions
object
Retrieve address versions response entity
2 properties 1 required
AddressVersionIdentifier
object
1 property
UnauthorizedResponseMetadata
object
4 properties 4 required
DeleteAddressUsageResponse
object
1 property 2 required
DeleteAddressUsageResponseAddressUsage
object
3 properties 2 required
CreateAddressResponse
object
1 property
CreateAddressRequestPhoneNumber
object
2 properties 1 required
ApiResponseEntityDeleteAddressUsageResponse
object
Issuer response entity
2 properties 1 required
PhoneNumber
object
3 properties 1 required
ApiResponseEntityInvalidateAddressResponse
object
Issuer response entity
2 properties 1 required
BadGatewayErrorApiResponse
object
1 property 1 required
DeleteAddressResponse
object
2 properties 2 required
BadRequestResponseMetadata
object
4 properties 4 required
CreateAddressRequestMailAddress
object
14 properties 1 required
ApiResponseEntityActivateAddressResponse
object
Issuer response entity
2 properties 1 required
CreateAddressUsageResponse
object
3 properties 2 required
BadGatewayResponseMetadata
object
4 properties 4 required
ApiResponseEntityCreateAddressUsageResponse
object
Issuer response entity
2 properties 1 required
ApiResponseEntityDeleteAddress
object
Delete address response entity
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wordline-customer-address-api-openapi.yml Raw ↑

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
Where this information came from

This is an independent, third-party profile of Worldline Customer - Address API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.