Skip to main content

Change Login PIN API

Overview​

Change/update a user's existing login PIN to a new one.

API Details​

Endpoint​

PUT https://api.gafapay.com:8443/gafapay/v3/auth/login_pin

Headers​

authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIyYzYyNjdlMjFlMTY0YjM0YjYzZmE2MjEzYmMyYWE2ZiIsInJvbGVzIjpbIlJPTEVfQ1VTVE9NRVIiXSwiZXhwIjoxNzU3MDk1Mzc3fQ.ZVm0keyOS5xoTYtiepfsiYPzM3EaPpUSzGAgIU8G3ww
companyid: 59388167894b4d10a04fe5da3b8a2104
requestid: b35d332f-131e-44c1-892f-8322e022da74
Content-Type: application/json

Request Body​

{
    "user_id": "2c6267e21e164b34b63fa6213bc2aa6f",
    "login_pin": "1111"
}

Request Body Fields​

  • user_id (string, required): Unique identifier of the user whose PIN is being changed
  • login_pin (string, required): The new PIN code to set

Response​

{
    "success": 1,
    "error": [],
    "data": {
        "message": "AUTH_LOGIN_PIN_SUCCESSFULLY_SET"
    }
}

Response Fields​

  • success (integer): Response status indicator
    • 1 = Success
    • 0 = Failure
  • error (array): Array of error messages (empty on success)
  • data (object): Response data object
    • message (string): Success message indicating PIN was successfully changed

Example Usage​

curl --location --request PUT 'https://api.gafapay.com:8443/gafapay/v3/auth/login_pin' \
--header 'accept: application/json, text/plain, */*' \
--header 'authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIyYzYyNjdlMjFlMTY0YjM0YjYzZmE2MjEzYmMyYWE2ZiIsInJvbGVzIjpbIlJPTEVfQ1VTVE9NRVIiXSwiZXhwIjoxNzU3MDk1Mzc3fQ.ZVm0keyOS5xoTYtiepfsiYPzM3EaPpUSzGAgIU8G3ww' \
--header 'companyid: 59388167894b4d10a04fe5da3b8a2104' \
--header 'requestid: b35d332f-131e-44c1-892f-8322e022da74' \
--header 'Content-Type: application/json' \
--data '{
    "user_id": "2c6267e21e164b34b63fa6213bc2aa6f",
    "login_pin": "1111"
}'