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 - CardPinState API

Card Pin State

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

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

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

Paths & Operations 2

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

Card - CardPinState 2

Card Pin State

POST
/issuers/{issuerId}/cards/pin-state
Card Pin State With EnquireCardStates
getCardPinStateByCard 5 params → 200400401403404500502
GET
/issuers/{issuerId}/cards/pin-state/{accountReference}
Card Pin State With EnquireCardStates
getCardPinStateByAcctNbr 5 params → 200400401403404500502

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are CardStateResponse (22 properties), ResponseMetadata (6 properties), UnauthorizedResponseMetadata (4 properties), NotFoundResponseMetadata (4 properties). Each schema is shown below with its type and property counts.

ApiResponseEntityCardPinState
object
Issuer response entity
2 properties 1 required
ApiResponseEntityCardPinStateList
object
Issuer response entity
2 properties 1 required
Links
object
2 properties 1 required
NotFoundResponseMetadata
object
4 properties 4 required
BadRequestResponseMetadata
object
4 properties 4 required
ResponseMetadata
object
6 properties 4 required
BadGatewayResponseMetadata
object
4 properties 4 required
CardStateResponse
object
22 properties
NotFoundErrorApiResponse
object
1 property 1 required
BadGatewayErrorApiResponse
object
1 property 1 required
InternalServerErrorErrorApiResponse
object
1 property 1 required
InternalServerErrorResponseMetadata
object
4 properties 4 required
ForbiddenErrorApiResponse
object
1 property 1 required
RetrieveCardPinStateRequest
object
One of cardNumber, alternativeCardNumber or cardReference is mandatory
3 properties
BadRequestErrorApiResponse
object
1 property 1 required
UnauthorizedResponseMetadata
object
4 properties 4 required
ForbiddenResponseMetadata
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wordline-card-cardpinstate-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