Skip to main content

Create Login PIN API

Overview​

Create a login PIN for user authentication.

API Details​

Constants​

  • User Types:
    • 2 = Customer
    • 3 = Merchant
    • 5 = Agent

Endpoint​

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

Headers​

companyId: 59388167894b4d10a04fe5da3b8a2104
request_id: b35d332f-131e-44c1-892f-8322e022da74
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIyYzYyNjdlMjFlMTY0YjM0YjYzZmE2MjEzYmMyYWE2ZiIsInJvbGVzIjpbIlJPTEVfQ1VTVE9NRVIiXSwiZXhwIjoxNzU3MDk4MTQ3fQ.v1N4tm8m0kJK8E-bGRVz3D7KCu19z7-WDkbZE8qshDQ

Request Body​

{
    "login_pin": "1234"
}

Request Body Fields​

  • login_pin (string, required): The PIN code to be set for user authentication
    • Must be a 4-digit numeric code
    • Example: "1234", "5678", "9999"

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 set successfully

Example Usage​

curl --location 'https://api.gafapay.com:8443/gafapay/v3/auth/login_pin' \
--header 'companyId: 59388167894b4d10a04fe5da3b8a2104' \
--header 'request_id: b35d332f-131e-44c1-892f-8322e022da74' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIyYzYyNjdlMjFlMTY0YjM0YjYzZmE2MjEzYmMyYWE2ZiIsInJvbGVzIjpbIlJPTEVfQ1VTVE9NRVIiXSwiZXhwIjoxNzU3MDk4MTQ3fQ.v1N4tm8m0kJK8E-bGRVz3D7KCu19z7-WDkbZE8qshDQ' \
--data '{
    "login_pin": "1234"
}'