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

Worldline Card - Pin API

Card Pin Api Controller

Worldline Card - Pin 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 - Pin. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 6 paths, and defines 26 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.

6 operations 6 paths 26 schemas 6 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 - Pin API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (basic) using the application flow.

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 6 POST. Each is listed below with its method, path, parameters, and response codes.

Card - Pin 6

Card Pin Api Controller

POST
/issuers/{issuerId}/cards/{cardReference}/display-pin
Display PIN for a card
displayPin 5 params → 400401403404500502200
POST
/issuers/{issuerId}/cards/{cardReference}/pin
Set a PIN for a card
setPin 5 params → 400401403404500502200
POST
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/display-pin
Display PIN for a card by external reference
displayPinByIssuerExtRef 5 params → 400401403404500502200
POST
/issuers/{issuerId}/cards/display-pin
Display PIN for a card by PAN + PSN and/or expiry date
displayPinByPan 3 params → 400404500200
POST
/issuers/{issuerId}/cards/pin
Set a PIN for a card by PAN + PSN and/or expiry date
setPinByPan 3 params → 400404500200
POST
/issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/pin
Set a PIN for a card by external reference
setPinByIssuerExtRef 5 params → 400401403404500502200

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are SetPinByPanRequest (8 properties), GetPinByPanRequest (8 properties), PinAttribute (6 properties), EncryptedPanData (6 properties). Each schema is shown below with its type and property counts.

CardIdentifier
object
Identification of the card either by Issuer card external reference or by card reference
2 properties
SetPinRequest
object
3 properties 1 required
NotFoundErrorApiResponse
object
1 property 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
ApiResponseEntitySetPinResponse
object
Issuer response entity
2 properties 1 required
Links
object
2 properties 1 required
GetPinRequest
object
encryptedSessionKey is the encrypted session key to be used for encrypting the PIN in the reply
2 properties
GetPinResponse
object
2 properties 1 required
SetPinByPanRequest
object
8 properties 1 required
UnauthorizedResponseMetadata
object
4 properties 4 required
EncryptedData
object
3 properties 3 required
GetPinByPanRequest
object
encryptedSessionKey is the encrypted session key to be used for encrypting the PIN in the reply
8 properties
NotFoundResponseMetadata
object
4 properties 4 required
ResponseMetadata
object
6 properties 4 required
EncryptedPanData
object
6 properties 3 required
ApiResponseEntityGetPinResponse
object
Issuer response entity
2 properties 1 required
ForbiddenErrorApiResponse
object
1 property 1 required
BadRequestResponseMetadata
object
4 properties 4 required
SetPinResponse
object
pinAttribute is just an echo of the input PIN
1 property
BadGatewayResponseMetadata
object
4 properties 4 required
PinAttribute
object
6 properties 3 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-pin-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