Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Worldline

Worldline Card - Letter API

Card Letter API Controller

Documentation Provider Profile APIs.io OpenAPI GitHub

Worldline Card - Letter API is one of 79 APIs that Worldline publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Card - Letter. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 12 operations across 10 paths, and defines 34 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.

12 operations 10 paths 34 schemas 2 DELETE6 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 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 Card - Letter API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (basic) using the application flow.

Paths & Operations 12

Across 10 paths, the API surfaces 12 operations — 2 DELETE, 6 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Card - Letter 12

Card Letter API Controller

GET
/issuers/{issuerId}/cards/{cardReference}/letters/{letterId}
Retrieve letter for the card (beta)
retrieveLetterCardRef 6 params → 400401403404500502200
DELETE
/issuers/{issuerId}/cards/{cardReference}/letters/{letterId}
Delete a letter for a card (beta)
deleteLetterCardRef 6 params → 400401403404500502200
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/letters/{letterId}
Retrieve letter for a card by external reference (beta)
retrieveLetterCardExtRef 6 params → 400401403404500502200
DELETE
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/letters/{letterId}
Delete a letter for a card by external reference (beta)
deleteLetterCardExtRef 6 params → 400401403404500502200
POST
/issuers/{issuerId}/cards/{cardReference}/letters/{letterId}/validate
Validate a letter for a card (beta)
validateLetterCardRef 6 params → 400401403404500502200
POST
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/letters/{letterId}/validate
Validate a letter for a card by external reference (beta)
validateLetterCardExtRef 6 params → 400401403404500502200
POST
/issuers/{issuerId}/cards/{cardReference}/generate-letter
Generate letter for a card (beta)
generateLetterCardRef 6 params → 400401403404500502200
POST
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/generate-letter
Generate letter for a card by external reference (beta)
generateLetterCardExtRef 6 params → 400401403404500502200
GET
/issuers/{issuerId}/cards/{cardReference}/prefilled-letter-templates/{letterTemplateReference}
Get parameters for the defined letter templates (beta)
prefillLetterTemplatesCardRef 6 params → 400401403404500502200
GET
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/prefilled-letter-templates/{letterTemplateReference}
Get parameters for the defined letter templates by external reference(beta)
prefillLetterTemplatesCardExtRef 6 params → 400401403404500502200
GET
/issuers/{issuerId}/cards/letter-templates
List of available letter templates for cards (beta)
letterTemplateList 5 params → 400401403404500502200
GET
/issuers/{issuerId}/cards/letter-templates/{letterTemplateReference}
Retrieve a specific letter template (beta)
retrieveLetterTemplate 6 params → 400401403404500502200

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are LetterTemplateParameter (12 properties), Letter (10 properties), PrefilledLetterTemplate (9 properties), LetterTemplate (8 properties). Each schema is shown below with its type and property counts.

GenerateCardLetterRequest
object
3 properties 1 required
LetterTemplate
object
8 properties
LetterTemplateParameter
object
12 properties
LetterTemplateParameterValue
object
3 properties
ApiResponseEntityPrefilledLetterTemplatesResponse
object
Prefilled Letter Template Response
2 properties 1 required
NotFoundErrorApiResponse
object
1 property 1 required
GenerateCardLetterResponse
object
3 properties 3 required
BadGatewayErrorApiResponse
object
1 property 1 required
InternalServerErrorErrorApiResponse
object
1 property 1 required
InternalServerErrorResponseMetadata
object
4 properties 4 required
LetterTemplateValueItem
object
1 property
UnauthorizedErrorApiResponse
object
1 property 1 required
Links
object
2 properties 1 required
ApiResponseEntityGenerateCardLetterResponse
object
Generate Card Letter Response
2 properties 1 required
UnauthorizedResponseMetadata
object
4 properties 4 required
NotFoundResponseMetadata
object
4 properties 4 required
ResponseMetadata
object
6 properties 4 required
ValidateCardLetterResponse
object
2 properties 2 required
ApiResponseEntityValidateCardLetterResponse
object
Validate Card Letter Response
2 properties 1 required
ForbiddenErrorApiResponse
object
1 property 1 required
ApiResponseEntityRetrieveLetterTemplate
object
Retrieve Letter Template response entity
2 properties 1 required
LetterIdentifier
object
1 property
DeleteCardLetterResponse
object
1 property 1 required
Letter
object
10 properties
ApiResponseEntityDeleteCardLetterResponse
object
Delete Card Letter response entity
2 properties 1 required
LetterTemplateSubParameterValue
object
2 properties
BadRequestResponseMetadata
object
4 properties 4 required
ApiResponseEntityRetrieveLetterTemplates
object
Retrieve Letter Templates response entity
2 properties 1 required
LetterTemplateIdentifier
object
1 property
ApiResponseEntityRetrieveLetter
object
Retrieve Card Letter response entity
2 properties 1 required
BadGatewayResponseMetadata
object
4 properties 4 required
PrefilledLetterTemplate
object
9 properties 1 required
BadRequestErrorApiResponse
object
1 property 1 required
ForbiddenResponseMetadata
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wordline-card-letter-api-openapi.yml Raw ↑

Other APIs Worldline publishes across the network.

Worldline Connect (Global Collect) API
AE Profile APIs.io
Worldline Direct (Global Online Pay) API
AE Profile APIs.io
Worldline Acquiring API
AE Profile APIs.io
Worldline Financial Services Issuing API
AE Profile APIs.io
Worldline Financial Services Acquiring API
AE Profile APIs.io
Worldline Open Banking API
AE Profile APIs.io
Worldline SmartPOS API
AE Profile APIs.io
Worldline Identity and Authentication API
AE Profile APIs.io
Worldline Account - AccountState API
AE Profile APIs.io
Worldline Account API
AE Profile APIs.io
Worldline Account - Authorization API
AE Profile APIs.io
Worldline Account - Authorization Restriction API
AE Profile APIs.io
#Card - Letter
← Back to W APIs
API Details
ID
wordline:wordline-card-letter-api
Base URL
https://api.connect.worldline-solutions.com
Docs
https://docs.connect.worldline-solutions.com/
Provider
Worldline
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network