---
title: "Get pin"
method: POST
path: "/pws/pws_get_pin/"
tags: ["Card"]
---

# Get pin

`POST /pws/pws_get_pin/`

## Request

- Base URL: `https://api.uat.paymentology.com/ppws/api`
- URL: `https://api.uat.paymentology.com/ppws/api/pws/pws_get_pin/`
- Auth: none declared

This web service provides the ability to retrieve a PIN for a card/token. The encrypted pin is returned, or the PIN is sent via SMS to the cardholder.Note: The sending of the PIN via SMS requires that a valid mobile number be included during the card create process

## Request body

- PinModel: This web service allows to get pin for a card/token. Pass public token and api will retrieve back encrypted pin.
  - `api_call_unique_identifier` string, required: Unique number that must be passed at each API request. Identifier to make each API request unique
  - `client_id` integer, required: Unique identifier for the client which Paymentology will provide at outset
  - `delivery_method` integer, required: <p>pin delivery method:</p> <ul> <li class="docBullet"> <p>0==&gt;returns encrypted pin in response</p> </li> <li class="docBullet"> <p>1==&gt; SMS plain pin to card holder (sms will be sent to ch_mobile field of pws_create_card web service, if provided during create card else error message will be returned).</p> </li> </ul> <p>Note : if the mobile number has not been provided at create card stage, then it can be updated using pws_card_holder_edit. mobile number format must be 00 (country code ) phone number or + (country code) phone number</p>
  - `token` integer, required: Public token for the card
  - `user_id` string: User Id of the Customer who triggered the API request.
  - `remarks` string: Remarks for API request

## Response `200`

Successful Response

- GetPinResponse: This model contains response when we call get pin api
  - `header` GetPinHeader
    - `error_id` integer: error id
    - `error_desc` string: error message
  - `body` GetPinBody
    - `epin` string: AES Encrypted PIN BLOCK Format ISO format 2 by CP Key back

## Other responses

- `404`: Webservices does not exist
- `500`: Internal Server error

## Changes

- **2026-11-03** `73c2771493b1`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/paymentology/apis/payapi-docs/changes/pws/pws_get_pin/post.md)

---

[API](https://skmtc.dev/paymentology/apis/payapi-docs.md) - [All operations](https://skmtc.dev/paymentology/apis/payapi-docs/llms.txt) - [OpenAPI document](https://skmtc.dev/paymentology/apis/payapi-docs/revisions/73c2771493b1?raw)