Get Card PIN

Returns the card PIN encrypted under a client-provided AES session key. The caller RSA-OAEP encrypts a one-time AES-256 session key with the PCI public key and passes it as encryptedKey; the EIP-712 signature over a prior view-pin challenge is passed via the x-eip712-signature / x-eip712-nonce headers. Fetched from partner-api over HTTP.

GET /pci/cards/{cardId}/pin

Get Card PIN

JavaScript

const options = {
  method: 'GET',
  headers: {
    'x-eip712-signature': '<x-eip712-signature>',
    'x-eip712-nonce': '<x-eip712-nonce>',
    Authorization: 'Bearer <token>'
  }
};

fetch('https://api.example.com/pci/cards/{cardId}/pin', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request GET \
  --url https://api.example.com/pci/cards/{cardId}/pin \
  --header 'Authorization: Bearer <token>' \
  --header 'x-eip712-nonce: <x-eip712-nonce>' \
  --header 'x-eip712-signature: <x-eip712-signature>'

import requests

url = "https://api.example.com/pci/cards/{cardId}/pin"

headers = {
    "x-eip712-signature": "<x-eip712-signature>",
    "x-eip712-nonce": "<x-eip712-nonce>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

package main

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

func main() {

	url := "https://api.example.com/pci/cards/{cardId}/pin"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-eip712-signature", "<x-eip712-signature>")
	req.Header.Add("x-eip712-nonce", "<x-eip712-nonce>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/pci/cards/{cardId}/pin")
  .header("x-eip712-signature", "<x-eip712-signature>")
  .header("x-eip712-nonce", "<x-eip712-nonce>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/pci/cards/{cardId}/pin")

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

request = Net::HTTP::Get.new(url)
request["x-eip712-signature"] = '<x-eip712-signature>'
request["x-eip712-nonce"] = '<x-eip712-nonce>'
request["Authorization"] = 'Bearer <token>'

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

200

{
  "encryptedPin": "<string>",
  "iv": "<string>"
}

{
  "success": false,
  "error": "<string>"
}

{
  "success": false,
  "error": "<string>"
}

{
  "success": false,
  "error": "<string>"
}

Headers

x-eip712-signature · string · required

EIP-712 signature over the view-pin challenge.

x-eip712-nonce · string · required

Nonce of the challenge that was signed.

Path Parameters

cardId · string<uuid> · required

Query Parameters

encryptedKey · string · required

Base64-encoded RSA-OAEP encrypted AES-256 session key.

Response

200

application/json

The request has succeeded.

encryptedPin · string · required

AES-GCM encrypted PIN (PIN Block 2 format), Base64-encoded.

iv · string · required

Base64-encoded AES-GCM initialization vector.