Skip to main content

Create Transaction PIN API

Overview​

Create a new transaction PIN for a user to enable secure transaction operations.

API Details​

Endpoint​

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

Request Body​

{
    "transaction_pin": "0000",
    "user_id": "b52aef3999ea4545a868a772377699a3"
}

Request Parameters​

  • transaction_pin (String, required): The transaction PIN to be set for the user
    • Example: "0000"
  • user_id (String, required): The unique identifier of the user
    • Example: "b52aef3999ea4545a868a772377699a3"

Headers​

authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJiNTJhZWYzOTk5ZWE0NTQ1YTg2OGE3NzIzNzc2OTlhMyIsInJvbGVzIjpbIlJPTEVfTUVSQ0hBTlQiXSwiZXhwIjoxNzU3MjI3MjA1fQ.shraUdMTOm27muCvBsPnZz8d0E5HeTuwxtHBxjksNm0
companyid: 59388167894b4d10a04fe5da3b8a2104
requestid: be08f79e-7eac-40e1-acbe-00f6ae7b8f7b

Response​

{
    "success": 1,
    "error": [],
    "data": {
        "message": "AUTH_TRANSACTION_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 transaction PIN was set successfully

Example Usage​

curl --location 'https://api.gafapay.com:8443/gafapay/v3/auth/transaction_pin' \
--header 'authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJiNTJhZWYzOTk5ZWE0NTQ1YTg2OGE3NzIzNzc2OTlhMyIsInJvbGVzIjpbIlJPTEVfTUVSQ0hBTlQiXSwiZXhwIjoxNzU3MjI3MjA1fQ.shraUdMTOm27muCvBsPnZz8d0E5HeTuwxtHBxjksNm0' \
--header 'companyid: 59388167894b4d10a04fe5da3b8a2104' \
--header 'requestid: be08f79e-7eac-40e1-acbe-00f6ae7b8f7b' \
--header 'Content-Type: application/json' \
--data '{
    "transaction_pin": "0000",
    "user_id": "b52aef3999ea4545a868a772377699a3"
}'

Notes​

  • The transaction PIN is used for authorizing financial transactions
  • The PIN should be a secure 4-6 digit combination
  • Users must have proper authorization to set transaction PINs
  • The transaction PIN is separate from the login PIN and serves different security purposes