PIN

Set PIN

This API allows you to sets the PIN for a card in the system.

Endpoint

GET {{baseUrl}}/issuing/api/:version/card/setpin

Description

Sets the personal identification number (PIN) for a specific card within the system. This API allows the cardholder to securely define the card’s PIN, enabling ATM withdrawals and POS transactions.

Setting a PIN involves two steps:
Setup – Initiates the PIN setup process.
Confirm – Confirms and finalizes the PIN.

The API returns an iframe URL for PIN setup. This URL can be embedded in your web or mobile application to allow the cardholder to securely set their PIN without exposing sensitive information.

🔗 Path Parameters

version string required

API version number. Default value is v1.

📩 Request Headers

x-api-key string required

Shared X-API key

x-product-id string required

Shared Product ID

x-cardholder-id string required

Unique identifier of the cardholder

x-wallet-id string required

Unique identifier of the wallet

x-card-id string required

Unique identifier of the card

x-client-id string

Client identification key

x-request-id string required

Idempotency key for request tracking

Content-Type string required

Must be application/json

Authorization string

Bearer access token

🧩 Examples

Request Example

cURL

curl --location --request GET \
--url '{{baseUrl}}/issuing/api/:version/card/setpin' \
--header 'x-api-key: {{Shared X-API key}}' \
--header 'x-product-id: {{Shared ProductID}}' \
--header 'x-cardholder-id: {{CardholderID}}' \
--header 'x-wallet-id: {{WalletID}}' \
--header 'x-card-id: {{CardID}}' \
--header 'x-client-id: {{ClientID}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}' \

Python

import requests
import json

url = "{{baseUrl}}/issuing/api/:version/card/setpin"

payload = {}
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-cardholder-id': '{{CardholderID}}',
  'x-wallet-id': '{{WalletID}}',
  'x-card-id': '{{CardID}}',
  'x-client-id': '{{ClientID}}',
  'x-request-id': '{{IdempotencyKey}}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{AccessToken}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{baseUrl}}/issuing/api/:version/card/setpin")
  .method("GET", body)
  .addHeader("x-api-key", "{{Shared X-API key}}")
  .addHeader("x-product-id", "{{Shared ProductID}}")
  .addHeader("x-cardholder-id", "{{CardholderID}}")
  .addHeader("x-wallet-id", "{{WalletID}}")
  .addHeader("x-card-id", "{{CardID}}")
  .addHeader("x-client-id", "{{ClientID}}")
  .addHeader("x-request-id", "{{IdempotencyKey}}")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{AccessToken}}")
  .build();
Response response = client.newCall(request).execute();

NodeJs

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/:version/card/setpin',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-cardholder-id': '{{CardholderID}}', 
    'x-wallet-id': '{{WalletID}}', 
    'x-card-id': '{{CardID}}', 
    'x-client-id': '{{ClientID}}', 
    'x-request-id': '{{IdempotencyKey}}', 
    'Content-Type': 'application/json', 
    'Authorization': 'Bearer {{AccessToken}}'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response Example

200: Success

{
  "status": "Success",
  "message": "Set PIN URL fetched successfully.",
  "code": 200,
  "data": [
    {
      "set_pin_url": "URL"
    }
  ]
}

400: Error

{
  "code": 400,
  "message": "Error Message",
  "status": "error"
}

🧪 Try It Out

🔢 Set Card PIN — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-cardholder-id:

x-wallet-id:

x-card-id:

x-client-id:

x-request-id:

Authorization:

💻 Generated cURL Command

❯

Reset PIN

This API is used to reset PIN for a card in the system.

Endpoint

GET {{baseUrl}}/issuing/api/:version/card/resetpin

Description

Resets the personal identification number (PIN)for a specific card within the system. This API allows the cardholder to securely reset their card’s PIN, ensuring continued protection for ATM withdrawals and POS transactions.

Resetting a PIN involves two steps::
Reset – Initiates the PIN reset process.
Confirm – Confirms and finalizes the new PIN.

This API returns an iframe URL for resetting the PIN. This URL, when retrieved in the response, enables you to display it within an iframe in your application (web/mobile).

🔗 Path Parameters

version string required

API version number. Default value is v1.

📩 Request Headers

x-api-key string required

Shared X-API key

x-product-id string required

Shared Product ID

x-cardholder-id string required

Unique identifier of the cardholder

x-wallet-id string required

Unique identifier of the wallet

x-card-id string required

Unique identifier of the card

x-client-id string

Client identification key

x-request-id string required

Idempotency key for request tracking

Content-Type string required

Must be application/json

Authorization string

Bearer access token

🧩 Examples

Request Example

cURL

curl --location --request GET \
--url '{{baseUrl}}/issuing/api/:version/card/resetpin' \
--header 'x-api-key: {{Shared X-API key}}' \
--header 'x-product-id: {{Shared ProductID}}' \
--header 'x-cardholder-id: {{CardholderID}}' \
--header 'x-wallet-id: {{WalletID}}' \
--header 'x-card-id: {{CardID}}' \
--header 'x-client-id: {{ClientID}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}' \

Python

import requests
import json

url = "{{baseUrl}}/issuing/api/:version/card/resetpin"

payload = {}
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-cardholder-id': '{{CardholderID}}',
  'x-wallet-id': '{{WalletID}}',
  'x-card-id': '{{CardID}}',
  'x-client-id': '{{ClientID}}',
  'x-request-id': '{{IdempotencyKey}}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{AccessToken}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{baseUrl}}/issuing/api/:version/card/resetpin")
  .method("GET", body)
  .addHeader("x-api-key", "{{Shared X-API key}}")
  .addHeader("x-product-id", "{{Shared ProductID}}")
  .addHeader("x-cardholder-id", "{{CardholderID}}")
  .addHeader("x-wallet-id", "{{WalletID}}")
  .addHeader("x-card-id", "{{CardID}}")
  .addHeader("x-client-id", "{{ClientID}}")
  .addHeader("x-request-id", "{{IdempotencyKey}}")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{AccessToken}}")
  .build();
Response response = client.newCall(request).execute();

NodeJs

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/:version/card/resetpin',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-cardholder-id': '{{CardholderID}}', 
    'x-wallet-id': '{{WalletID}}', 
    'x-card-id': '{{CardID}}', 
    'x-client-id': '{{ClientID}}', 
    'x-request-id': '{{IdempotencyKey}}', 
    'Content-Type': 'application/json', 
    'Authorization': 'Bearer {{AccessToken}}'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response Example

200: Success

{
  "status": "Success",
  "message": "Reset PIN URL fetched successfully.",
  "code": 200,
  "data": [
    {
      "set_pin_url": "URL"
    }
  ]
}

400: Error

{
  "code": 400,
  "message": "Error Message",
  "status": "error"
}

🧪 Try It Out

🔄 Reset Card PIN — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-cardholder-id:

x-wallet-id:

x-card-id:

x-client-id:

x-request-id:

Authorization:

💻 Generated cURL Command

❯

Change PIN

This API is used to change PIN for a card in the system.

Endpoint

GET {{baseUrl}}/issuing/api/:version/card/changepin

Description

Changes the personal identification number (PIN) for a specific card within the issuing platform. This API allows the cardholder to securely update the existing PIN, ensuring continued protection for ATM withdrawals and POS transactions.

Changing a PIN involves three steps:
Enter current PIN – Provide the existing PIN for verification.
Enter new PIN – Set the new PIN for the card.
Confirm new PIN – Confirms and finalizes the new PIN.

This API returns an iframe URL to change pin. The URL returned in this response will allow you to display it as an Iframe in your application (web/mobile).

🔗 Path Parameters

version string required

API version number. Default value is v1.

📩 Request Headers

x-api-key string required

Shared X-API key

x-product-id string required

Shared Product ID

x-cardholder-id string required

Unique identifier of the cardholder

x-wallet-id string required

Unique identifier of the wallet

x-card-id string required

Unique identifier of the card

x-client-id string

Client identification key

x-request-id string required

Idempotency key for request tracking

Content-Type string required

Must be application/json

Authorization string

Bearer access token

🧩 Examples

Request Example

cURL

curl --location --request GET \
--url '{{baseUrl}}/issuing/api/:version/card/changepin' \
--header 'x-api-key: {{Shared X-API key}}' \
--header 'x-product-id: {{Shared ProductID}}' \
--header 'x-cardholder-id: {{CardholderID}}' \
--header 'x-wallet-id: {{WalletID}}' \
--header 'x-card-id: {{CardID}}' \
--header 'x-client-id: {{ClientID}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}' \

Python

import requests
import json

url = "{{baseUrl}}/issuing/api/:version/card/changepin"

payload = {}
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-cardholder-id': '{{CardholderID}}',
  'x-wallet-id': '{{WalletID}}',
  'x-card-id': '{{CardID}}',
  'x-client-id': '{{ClientID}}',
  'x-request-id': '{{IdempotencyKey}}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{AccessToken}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{baseUrl}}/issuing/api/:version/card/changepin")
  .method("GET", body)
  .addHeader("x-api-key", "{{Shared X-API key}}")
  .addHeader("x-product-id", "{{Shared ProductID}}")
  .addHeader("x-cardholder-id", "{{CardholderID}}")
  .addHeader("x-wallet-id", "{{WalletID}}")
  .addHeader("x-card-id", "{{CardID}}")
  .addHeader("x-client-id", "{{ClientID}}")
  .addHeader("x-request-id", "{{IdempotencyKey}}")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{AccessToken}}")
  .build();
Response response = client.newCall(request).execute();

NodeJs

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/:version/card/changepin',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-cardholder-id': '{{CardholderID}}', 
    'x-wallet-id': '{{WalletID}}', 
    'x-card-id': '{{CardID}}', 
    'x-client-id': '{{ClientID}}', 
    'x-request-id': '{{IdempotencyKey}}', 
    'Content-Type': 'application/json', 
    'Authorization': 'Bearer {{AccessToken}}'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response Example

200: Success

{
  "status": "Success",
  "message": "Change PIN URL fetched successfully.",
  "code": 200,
  "data": [
    {
      "set_pin_url": "URL"
    }
  ]
}

400: Error

{
  "code": 400,
  "message": "Error Message",
  "status": "error"
}

🧪 Try It Out

✏️ Change Card PIN — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-cardholder-id:

x-wallet-id:

x-card-id:

x-client-id:

x-request-id:

Authorization:

💻 Generated cURL Command

❯