API docs by Redocly

Issuer Bank Integration APIs - Card & Cardholder Information (2025.4.0)

Download OpenAPI specification:Download

Operations exposed by the Issuer Bank for amiko to integrate with. For additional guidance around this integration API, see the relevant section in the Amiko documentation.

Card Identifier

Returns the cardId associated with a PAN

To request a safe identifier matched to a PAN. See the Amiko documentation for additional requirements on this endpoint

header Parameters
tracing-id
required
string

Tracing ID that can be used to track interactions.

auth_header
string

This is going to be where we send the API key. The header will consist of a custom api key or standardised JWT auth.

Request Body schema: application/json
required
pan
required
string <[0-9]{13,19}>

Primary Account Number of the card

Responses

Request samples

Content type
application/json
{
  • "pan": "string"
}

Response samples

Content type
application/json
{
  • "cardId": "string"
}

Returns the PAN associated with a cardId

To resolve a cardId into a PAN, used for scheme-facing operations.

path Parameters
cardId
required
string
header Parameters
tracing-id
required
string

Tracing ID that can be used to track interactions.

auth_header
string

This is going to be where we send the API key. The header will consist of a custom api key or standardised JWT auth.

Responses

Response samples

Content type
application/json
{
  • "pan": "string"
}

Returns the cardholderID associated with a cardId

To retrieve the identifier of the holder of the card

path Parameters
cardId
required
string
header Parameters
tracing-id
required
string

Tracing ID that can be used to track interactions.

auth_header
string

This is going to be where we send the API key. The header will consist of a custom api key or standardised JWT auth.

Responses

Response samples

Content type
application/json
{
  • "cardholderId": "string"
}

Cardholder Information (Conditional)

Returns the information if and how the cardholder can be reached

To retrieve if the cardholder can be reached via a digital channel (Dialgoue Engine) and optionally type of that channel

path Parameters
cardholderId
required
string
header Parameters
tracing-id
required
string

Tracing ID that can be used to track interactions.

auth_header
string

This is going to be where we send the API key. The header will consist of a custom api key or standardised JWT auth.

Responses

Response samples

Content type
application/json
{
  • "contactable": true,
  • "channel": [
    ]
}

Card Information (Optional)

Returns additional optional card attributes

To retrieve additional attributes related to the card currency, the issuer and cardholder-facing brand

path Parameters
cardId
required
string
header Parameters
tracing-id
required
string

Tracing ID that can be used to track interactions.

auth_header
string

This is going to be where we send the API key. The header will consist of a custom api key or standardised JWT auth.

Responses

Response samples

Content type
application/json
{
  • "issuerId": "string",
  • "issuerName": "string",
  • "brandId": "string",
  • "brandName": "string",
  • "currencyCode": "string"
}

Returns the expiry month and year for a cardId

Returns the expiry month and year for a cardId

path Parameters
cardId
required
string
header Parameters
tracing-id
required
string

Tracing ID that can be used to track interactions.

auth_header
string

This is going to be where we send the API key. The header will consist of a custom api key or standardised JWT auth.

Responses

Response samples

Content type
application/json
{
  • "expiryMonth": "string",
  • "expiryYear": "string"
}

Returns the current status for a cardId

Information on whether the card is active, suspended (temporarily) or blocked (permanently). In the case of a blocked card, also the information on the block reason.

path Parameters
cardId
required
string
header Parameters
tracing-id
required
string

Tracing ID that can be used to track interactions.

auth_header
string

This is going to be where we send the API key. The header will consist of a custom api key or standardised JWT auth.

Responses

Response samples

Content type
application/json
{
  • "status": "active",
  • "blockReason": "lost_stolen",
  • "fraudType": "first_party_fraud"
}

Cardholder Information (Optional)

Returns additional optional cardholder attributes

To retrieve the cardholder name and generic additional attributes of the cardholder. The returned values will not be stored by Amiko and are only requested on demand to be displayed on the agent UI.

path Parameters
cardholderId
required
string
header Parameters
tracing-id
required
string

Tracing ID that can be used to track interactions.

auth_header
string

This is going to be where we send the API key. The header will consist of a custom api key or standardised JWT auth.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "languageCode": "string",
  • "attributes": [
    ]
}

Utility

Returns the health status for this API

The specification is based on the IETF draft linked below. Its content consists of a single mandatory root field (“status”) and several optional fields. Health Check Response Format for HTTP APIs: https://inadarei.github.io/rfc-healthcheck/

header Parameters
auth_header
string

This is going to be where we send the API key. The header will consist of a custom api key or standardised JWT auth.

Responses

Response samples

Content type
application/json
{
  • "status": "fail"
}