Retrieve Encrypted PIN

curl --request POST \
  --url 'https://api.{{tenant}}.ext-uat1-sandbox.mycore.enfuce.com/issuer/v1/pin/view' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pinControlId": "20218aae-b15e-406c-9e9f-23735cd86a48",
  "pubKey": "-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArMRPoM6Za3XDIsomnVObGJsrHHHIRZ5zRsVoU8Unie9QvK9OBf0cCGyXd8XPky7W3m/KDKLGUnfne8vAMOeT1NpBgQnv2lcpIfBMLjSUKT5gIcJMY00Asqjvi4YFwRdW9AxSThxtkb7AIsJJiRwbAGFDnt+Ic/gIQS5s1vnuIjaYBTbzYtwnh3WBQ7DJsCVes81onwapGtdiswQD15cNhAI5853/uB/vno3j3tOq3gpm9+qLa6FYGfWZan07k+RMCVF1v6kxa9teCj6V3cysdtPeK9+gQnBjuuSESQL7/s/BgC7QxLqBCabkFyLo+3QO+iKmfeKPX8imV1rUgyjo3QIDAQAB-----END PUBLIC KEY-----"
}
'

import requests

url = "https://api.{{tenant}}.ext-uat1-sandbox.mycore.enfuce.com/issuer/v1/pin/view"

payload = {
    "pinControlId": "20218aae-b15e-406c-9e9f-23735cd86a48",
    "pubKey": "-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArMRPoM6Za3XDIsomnVObGJsrHHHIRZ5zRsVoU8Unie9QvK9OBf0cCGyXd8XPky7W3m/KDKLGUnfne8vAMOeT1NpBgQnv2lcpIfBMLjSUKT5gIcJMY00Asqjvi4YFwRdW9AxSThxtkb7AIsJJiRwbAGFDnt+Ic/gIQS5s1vnuIjaYBTbzYtwnh3WBQ7DJsCVes81onwapGtdiswQD15cNhAI5853/uB/vno3j3tOq3gpm9+qLa6FYGfWZan07k+RMCVF1v6kxa9teCj6V3cysdtPeK9+gQnBjuuSESQL7/s/BgC7QxLqBCabkFyLo+3QO+iKmfeKPX8imV1rUgyjo3QIDAQAB-----END PUBLIC KEY-----"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    pinControlId: '20218aae-b15e-406c-9e9f-23735cd86a48',
    pubKey: '-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArMRPoM6Za3XDIsomnVObGJsrHHHIRZ5zRsVoU8Unie9QvK9OBf0cCGyXd8XPky7W3m/KDKLGUnfne8vAMOeT1NpBgQnv2lcpIfBMLjSUKT5gIcJMY00Asqjvi4YFwRdW9AxSThxtkb7AIsJJiRwbAGFDnt+Ic/gIQS5s1vnuIjaYBTbzYtwnh3WBQ7DJsCVes81onwapGtdiswQD15cNhAI5853/uB/vno3j3tOq3gpm9+qLa6FYGfWZan07k+RMCVF1v6kxa9teCj6V3cysdtPeK9+gQnBjuuSESQL7/s/BgC7QxLqBCabkFyLo+3QO+iKmfeKPX8imV1rUgyjo3QIDAQAB-----END PUBLIC KEY-----'
  })
};

fetch('https://api.{{tenant}}.ext-uat1-sandbox.mycore.enfuce.com/issuer/v1/pin/view', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.{{tenant}}.ext-uat1-sandbox.mycore.enfuce.com/issuer/v1/pin/view",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'pinControlId' => '20218aae-b15e-406c-9e9f-23735cd86a48',
    'pubKey' => '-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArMRPoM6Za3XDIsomnVObGJsrHHHIRZ5zRsVoU8Unie9QvK9OBf0cCGyXd8XPky7W3m/KDKLGUnfne8vAMOeT1NpBgQnv2lcpIfBMLjSUKT5gIcJMY00Asqjvi4YFwRdW9AxSThxtkb7AIsJJiRwbAGFDnt+Ic/gIQS5s1vnuIjaYBTbzYtwnh3WBQ7DJsCVes81onwapGtdiswQD15cNhAI5853/uB/vno3j3tOq3gpm9+qLa6FYGfWZan07k+RMCVF1v6kxa9teCj6V3cysdtPeK9+gQnBjuuSESQL7/s/BgC7QxLqBCabkFyLo+3QO+iKmfeKPX8imV1rUgyjo3QIDAQAB-----END PUBLIC KEY-----'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.{{tenant}}.ext-uat1-sandbox.mycore.enfuce.com/issuer/v1/pin/view"

	payload := strings.NewReader("{\n  \"pinControlId\": \"20218aae-b15e-406c-9e9f-23735cd86a48\",\n  \"pubKey\": \"-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArMRPoM6Za3XDIsomnVObGJsrHHHIRZ5zRsVoU8Unie9QvK9OBf0cCGyXd8XPky7W3m/KDKLGUnfne8vAMOeT1NpBgQnv2lcpIfBMLjSUKT5gIcJMY00Asqjvi4YFwRdW9AxSThxtkb7AIsJJiRwbAGFDnt+Ic/gIQS5s1vnuIjaYBTbzYtwnh3WBQ7DJsCVes81onwapGtdiswQD15cNhAI5853/uB/vno3j3tOq3gpm9+qLa6FYGfWZan07k+RMCVF1v6kxa9teCj6V3cysdtPeK9+gQnBjuuSESQL7/s/BgC7QxLqBCabkFyLo+3QO+iKmfeKPX8imV1rUgyjo3QIDAQAB-----END PUBLIC KEY-----\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.{{tenant}}.ext-uat1-sandbox.mycore.enfuce.com/issuer/v1/pin/view")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"pinControlId\": \"20218aae-b15e-406c-9e9f-23735cd86a48\",\n  \"pubKey\": \"-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArMRPoM6Za3XDIsomnVObGJsrHHHIRZ5zRsVoU8Unie9QvK9OBf0cCGyXd8XPky7W3m/KDKLGUnfne8vAMOeT1NpBgQnv2lcpIfBMLjSUKT5gIcJMY00Asqjvi4YFwRdW9AxSThxtkb7AIsJJiRwbAGFDnt+Ic/gIQS5s1vnuIjaYBTbzYtwnh3WBQ7DJsCVes81onwapGtdiswQD15cNhAI5853/uB/vno3j3tOq3gpm9+qLa6FYGfWZan07k+RMCVF1v6kxa9teCj6V3cysdtPeK9+gQnBjuuSESQL7/s/BgC7QxLqBCabkFyLo+3QO+iKmfeKPX8imV1rUgyjo3QIDAQAB-----END PUBLIC KEY-----\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.{{tenant}}.ext-uat1-sandbox.mycore.enfuce.com/issuer/v1/pin/view")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"pinControlId\": \"20218aae-b15e-406c-9e9f-23735cd86a48\",\n  \"pubKey\": \"-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArMRPoM6Za3XDIsomnVObGJsrHHHIRZ5zRsVoU8Unie9QvK9OBf0cCGyXd8XPky7W3m/KDKLGUnfne8vAMOeT1NpBgQnv2lcpIfBMLjSUKT5gIcJMY00Asqjvi4YFwRdW9AxSThxtkb7AIsJJiRwbAGFDnt+Ic/gIQS5s1vnuIjaYBTbzYtwnh3WBQ7DJsCVes81onwapGtdiswQD15cNhAI5853/uB/vno3j3tOq3gpm9+qLa6FYGfWZan07k+RMCVF1v6kxa9teCj6V3cysdtPeK9+gQnBjuuSESQL7/s/BgC7QxLqBCabkFyLo+3QO+iKmfeKPX8imV1rUgyjo3QIDAQAB-----END PUBLIC KEY-----\"\n}"

response = http.request(request)
puts response.read_body

{
  "pinBlock": "9358E39632CAAAC2",
  "tzpk": "A59DA3A12AF8254034B2167EEF1773B0E5B230C558C5C6CE1BA4D65C43B2C20E24FE41C51BEF799087D55B4EB3E9DA0C8845CF76EF569D3C3F6D5A818F7F18EF634231E102A88830ABAF983BF2FB9C35DDDAAC47DB004EEF80E14B9D9E5CAE30CCF42596F4BD8B524EFCA6F538C13AFC7D1D22C9A31B58F166D85787119AC5A60EA23FCDE274787EC72403CFC313B27B53E4B9E4E414589DE5FD71EBBAC84A792B9B2A3A32335C221D3440F40DA6D9755FE7A15C47174C3595C1EDC685E86740C06FF9B76451E85E8C8934E24563D0D24B4C8E449B72E768A8706895AB574D023D9E9CBBBDC22206E25612FBC7CC5A9DEA7863992CE9C8399BAD4AC2BDFA2404"
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "JSON parse error: Unexpected character...",
  "instance": "/v1/cards",
  "id": "5cc541cb-f456-4331-b537-d2380fca0400",
  "timestamp": "2026-02-24T12:34:56Z"
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "Access Denied",
  "instance": "/v1/cards",
  "id": "5cc541cb-f456-4331-b537-d2380fca0403",
  "timestamp": "2026-02-24T12:34:56Z"
}

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "Entity not found - Program with id: 2ec117b7-454e-4cc5-8b89-dea5485aab2b",
  "instance": "/v1/cards",
  "id": "5cc541cb-f456-4331-b537-d2380fca0404",
  "timestamp": "2026-02-24T12:34:56Z"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Unexpected error occurred.",
  "instance": "/v1/cards",
  "id": "5cc541cb-f456-4331-b537-d2380fca0500",
  "timestamp": "2026-02-24T12:34:56Z"
}

POST

view

Retrieve Encrypted PIN

curl --request POST \
  --url 'https://api.{{tenant}}.ext-uat1-sandbox.mycore.enfuce.com/issuer/v1/pin/view' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pinControlId": "20218aae-b15e-406c-9e9f-23735cd86a48",
  "pubKey": "-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArMRPoM6Za3XDIsomnVObGJsrHHHIRZ5zRsVoU8Unie9QvK9OBf0cCGyXd8XPky7W3m/KDKLGUnfne8vAMOeT1NpBgQnv2lcpIfBMLjSUKT5gIcJMY00Asqjvi4YFwRdW9AxSThxtkb7AIsJJiRwbAGFDnt+Ic/gIQS5s1vnuIjaYBTbzYtwnh3WBQ7DJsCVes81onwapGtdiswQD15cNhAI5853/uB/vno3j3tOq3gpm9+qLa6FYGfWZan07k+RMCVF1v6kxa9teCj6V3cysdtPeK9+gQnBjuuSESQL7/s/BgC7QxLqBCabkFyLo+3QO+iKmfeKPX8imV1rUgyjo3QIDAQAB-----END PUBLIC KEY-----"
}
'

import requests

url = "https://api.{{tenant}}.ext-uat1-sandbox.mycore.enfuce.com/issuer/v1/pin/view"

payload = {
    "pinControlId": "20218aae-b15e-406c-9e9f-23735cd86a48",
    "pubKey": "-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArMRPoM6Za3XDIsomnVObGJsrHHHIRZ5zRsVoU8Unie9QvK9OBf0cCGyXd8XPky7W3m/KDKLGUnfne8vAMOeT1NpBgQnv2lcpIfBMLjSUKT5gIcJMY00Asqjvi4YFwRdW9AxSThxtkb7AIsJJiRwbAGFDnt+Ic/gIQS5s1vnuIjaYBTbzYtwnh3WBQ7DJsCVes81onwapGtdiswQD15cNhAI5853/uB/vno3j3tOq3gpm9+qLa6FYGfWZan07k+RMCVF1v6kxa9teCj6V3cysdtPeK9+gQnBjuuSESQL7/s/BgC7QxLqBCabkFyLo+3QO+iKmfeKPX8imV1rUgyjo3QIDAQAB-----END PUBLIC KEY-----"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    pinControlId: '20218aae-b15e-406c-9e9f-23735cd86a48',
    pubKey: '-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArMRPoM6Za3XDIsomnVObGJsrHHHIRZ5zRsVoU8Unie9QvK9OBf0cCGyXd8XPky7W3m/KDKLGUnfne8vAMOeT1NpBgQnv2lcpIfBMLjSUKT5gIcJMY00Asqjvi4YFwRdW9AxSThxtkb7AIsJJiRwbAGFDnt+Ic/gIQS5s1vnuIjaYBTbzYtwnh3WBQ7DJsCVes81onwapGtdiswQD15cNhAI5853/uB/vno3j3tOq3gpm9+qLa6FYGfWZan07k+RMCVF1v6kxa9teCj6V3cysdtPeK9+gQnBjuuSESQL7/s/BgC7QxLqBCabkFyLo+3QO+iKmfeKPX8imV1rUgyjo3QIDAQAB-----END PUBLIC KEY-----'
  })
};

fetch('https://api.{{tenant}}.ext-uat1-sandbox.mycore.enfuce.com/issuer/v1/pin/view', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.{{tenant}}.ext-uat1-sandbox.mycore.enfuce.com/issuer/v1/pin/view",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'pinControlId' => '20218aae-b15e-406c-9e9f-23735cd86a48',
    'pubKey' => '-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArMRPoM6Za3XDIsomnVObGJsrHHHIRZ5zRsVoU8Unie9QvK9OBf0cCGyXd8XPky7W3m/KDKLGUnfne8vAMOeT1NpBgQnv2lcpIfBMLjSUKT5gIcJMY00Asqjvi4YFwRdW9AxSThxtkb7AIsJJiRwbAGFDnt+Ic/gIQS5s1vnuIjaYBTbzYtwnh3WBQ7DJsCVes81onwapGtdiswQD15cNhAI5853/uB/vno3j3tOq3gpm9+qLa6FYGfWZan07k+RMCVF1v6kxa9teCj6V3cysdtPeK9+gQnBjuuSESQL7/s/BgC7QxLqBCabkFyLo+3QO+iKmfeKPX8imV1rUgyjo3QIDAQAB-----END PUBLIC KEY-----'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.{{tenant}}.ext-uat1-sandbox.mycore.enfuce.com/issuer/v1/pin/view"

	payload := strings.NewReader("{\n  \"pinControlId\": \"20218aae-b15e-406c-9e9f-23735cd86a48\",\n  \"pubKey\": \"-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArMRPoM6Za3XDIsomnVObGJsrHHHIRZ5zRsVoU8Unie9QvK9OBf0cCGyXd8XPky7W3m/KDKLGUnfne8vAMOeT1NpBgQnv2lcpIfBMLjSUKT5gIcJMY00Asqjvi4YFwRdW9AxSThxtkb7AIsJJiRwbAGFDnt+Ic/gIQS5s1vnuIjaYBTbzYtwnh3WBQ7DJsCVes81onwapGtdiswQD15cNhAI5853/uB/vno3j3tOq3gpm9+qLa6FYGfWZan07k+RMCVF1v6kxa9teCj6V3cysdtPeK9+gQnBjuuSESQL7/s/BgC7QxLqBCabkFyLo+3QO+iKmfeKPX8imV1rUgyjo3QIDAQAB-----END PUBLIC KEY-----\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.{{tenant}}.ext-uat1-sandbox.mycore.enfuce.com/issuer/v1/pin/view")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"pinControlId\": \"20218aae-b15e-406c-9e9f-23735cd86a48\",\n  \"pubKey\": \"-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArMRPoM6Za3XDIsomnVObGJsrHHHIRZ5zRsVoU8Unie9QvK9OBf0cCGyXd8XPky7W3m/KDKLGUnfne8vAMOeT1NpBgQnv2lcpIfBMLjSUKT5gIcJMY00Asqjvi4YFwRdW9AxSThxtkb7AIsJJiRwbAGFDnt+Ic/gIQS5s1vnuIjaYBTbzYtwnh3WBQ7DJsCVes81onwapGtdiswQD15cNhAI5853/uB/vno3j3tOq3gpm9+qLa6FYGfWZan07k+RMCVF1v6kxa9teCj6V3cysdtPeK9+gQnBjuuSESQL7/s/BgC7QxLqBCabkFyLo+3QO+iKmfeKPX8imV1rUgyjo3QIDAQAB-----END PUBLIC KEY-----\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.{{tenant}}.ext-uat1-sandbox.mycore.enfuce.com/issuer/v1/pin/view")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"pinControlId\": \"20218aae-b15e-406c-9e9f-23735cd86a48\",\n  \"pubKey\": \"-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArMRPoM6Za3XDIsomnVObGJsrHHHIRZ5zRsVoU8Unie9QvK9OBf0cCGyXd8XPky7W3m/KDKLGUnfne8vAMOeT1NpBgQnv2lcpIfBMLjSUKT5gIcJMY00Asqjvi4YFwRdW9AxSThxtkb7AIsJJiRwbAGFDnt+Ic/gIQS5s1vnuIjaYBTbzYtwnh3WBQ7DJsCVes81onwapGtdiswQD15cNhAI5853/uB/vno3j3tOq3gpm9+qLa6FYGfWZan07k+RMCVF1v6kxa9teCj6V3cysdtPeK9+gQnBjuuSESQL7/s/BgC7QxLqBCabkFyLo+3QO+iKmfeKPX8imV1rUgyjo3QIDAQAB-----END PUBLIC KEY-----\"\n}"

response = http.request(request)
puts response.read_body

{
  "pinBlock": "9358E39632CAAAC2",
  "tzpk": "A59DA3A12AF8254034B2167EEF1773B0E5B230C558C5C6CE1BA4D65C43B2C20E24FE41C51BEF799087D55B4EB3E9DA0C8845CF76EF569D3C3F6D5A818F7F18EF634231E102A88830ABAF983BF2FB9C35DDDAAC47DB004EEF80E14B9D9E5CAE30CCF42596F4BD8B524EFCA6F538C13AFC7D1D22C9A31B58F166D85787119AC5A60EA23FCDE274787EC72403CFC313B27B53E4B9E4E414589DE5FD71EBBAC84A792B9B2A3A32335C221D3440F40DA6D9755FE7A15C47174C3595C1EDC685E86740C06FF9B76451E85E8C8934E24563D0D24B4C8E449B72E768A8706895AB574D023D9E9CBBBDC22206E25612FBC7CC5A9DEA7863992CE9C8399BAD4AC2BDFA2404"
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "JSON parse error: Unexpected character...",
  "instance": "/v1/cards",
  "id": "5cc541cb-f456-4331-b537-d2380fca0400",
  "timestamp": "2026-02-24T12:34:56Z"
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "Access Denied",
  "instance": "/v1/cards",
  "id": "5cc541cb-f456-4331-b537-d2380fca0403",
  "timestamp": "2026-02-24T12:34:56Z"
}

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "Entity not found - Program with id: 2ec117b7-454e-4cc5-8b89-dea5485aab2b",
  "instance": "/v1/cards",
  "id": "5cc541cb-f456-4331-b537-d2380fca0404",
  "timestamp": "2026-02-24T12:34:56Z"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Unexpected error occurred.",
  "instance": "/v1/cards",
  "id": "5cc541cb-f456-4331-b537-d2380fca0500",
  "timestamp": "2026-02-24T12:34:56Z"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-audit-user

string

Optional audit user header

Body

application/json

Request payload for successful PIN retrieval.

pinControlId

string<uuid>

required

Control ID that was returned in the Request PIN Control Access Token Endpoint.

Example:

"20218aae-b15e-406c-9e9f-23735cd86a48"

pubKey

string

required

RSA 2048 public key in PEM format (X.509 SubjectPublicKeyInfo). The key may contain:

new lines,
the PEM headers ("-----BEGIN PUBLIC KEY-----" and "-----END PUBLIC KEY-----") The key must not contain any spaces.

Example:

"-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArMRPoM6Za3XDIsomnVObGJsrHHHIRZ5zRsVoU8Unie9QvK9OBf0cCGyXd8XPky7W3m/KDKLGUnfne8vAMOeT1NpBgQnv2lcpIfBMLjSUKT5gIcJMY00Asqjvi4YFwRdW9AxSThxtkb7AIsJJiRwbAGFDnt+Ic/gIQS5s1vnuIjaYBTbzYtwnh3WBQ7DJsCVes81onwapGtdiswQD15cNhAI5853/uB/vno3j3tOq3gpm9+qLa6FYGfWZan07k+RMCVF1v6kxa9teCj6V3cysdtPeK9+gQnBjuuSESQL7/s/BgC7QxLqBCabkFyLo+3QO+iKmfeKPX8imV1rUgyjo3QIDAQAB-----END PUBLIC KEY-----"

Response

Successful retrieval of PIN.

pinBlock

string

required

Hex encoded value of the pin block (ISO PIN Block Format 1). It is 3DES (double length key) encrypted with the key from the tzpk field (which is provided in encrypted form).

Example:

"9358E39632CAAAC2"

tzpk

string

required

Terminal Zone PIN Key (TZPK) that decrypts the generated PIN block to retrieve the actual PIN. Hex encoded value, encrypted with the pubKey passed as input. Once decrypted, this is the 3DES key used for decrypting the pin block.

Example:

"A59DA3A12AF8254034B2167EEF1773B0E5B230C558C5C6CE1BA4D65C43B2C20E24FE41C51BEF799087D55B4EB3E9DA0C8845CF76EF569D3C3F6D5A818F7F18EF634231E102A88830ABAF983BF2FB9C35DDDAAC47DB004EEF80E14B9D9E5CAE30CCF42596F4BD8B524EFCA6F538C13AFC7D1D22C9A31B58F166D85787119AC5A60EA23FCDE274787EC72403CFC313B27B53E4B9E4E414589DE5FD71EBBAC84A792B9B2A3A32335C221D3440F40DA6D9755FE7A15C47174C3595C1EDC685E86740C06FF9B76451E85E8C8934E24563D0D24B4C8E449B72E768A8706895AB574D023D9E9CBBBDC22206E25612FBC7CC5A9DEA7863992CE9C8399BAD4AC2BDFA2404"

⌘I

Introduction

Cards API

Cardholders API

PIN API

Wallet API

Transaction Lifecycle

Spend Controls API

Exchange Rates API

Retrieve Encrypted PIN

Authorizations

Headers

Body

Response