Set PIN

POST

https://api.freedompay.kz/v5/card-api/card/set_pin

The PIN setup method is designed to set or change the Personal Identification Number (PIN) on a payment card. This process is essential for ensuring security when performing card transactions, such as cash withdrawals from ATMs and payments at retail locations.
The PIN can be provided in the request in the pin parameter, encrypted using a public key generated by Freedom Processing.
If the pin parameter is not provided in the request, the PIN will be automatically generated by

Request

Body Params application/json

card_id

string

required

Identifier of the card in Freedom Processing.

string

optional

Encrypted PIN code. The AES 256 algorithm is used for encryption. If this parameter is not provided, the PIN code will be generated by Freedom Processing.

Example

{
  "card_id": "string",
  "pin": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.freedompay.kz/v5/card-api/card/set_pin' \
--header 'Content-Type: application/json' \
--data-raw '{
    "card_id": "string",
    "pin": "string"
}'

Responses

🟢200Success

application/json

Body

status

string

required

Status of the request. Possible values:

ok: Request completed successfully.

error: Request completed with an error.

request_status

string

required

Execution status of the request. Refer to the documentation.

string

required

Date and time of the request (format: RFC 3339, YYYY-MM-DDThh:mm:ss+hh:mm).

Example

{
  "status": "string",
  "request_status": "string",
  "dt": "string"
}

Unblock card

Reset PIN counter