Skip to main content

Remind Payment Request User API

Overview​

Send a reminder notification to a specific user about their pending payment request.

API Details​

Endpoint​

POST https://api.gafapay.com:8443/gafapay/v3/user/remind_payment_request_user

Headers​

authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJmYjhmMDkyMTBlMGY0NmI3YjQyNjJkNzdmNWI2YzI3MyIsInJvbGVzIjpbIlJPTEVfQ1VTVE9NRVIiXSwiZXhwIjoxNzU3MTYwNzEzfQ.b3RU1QWT7N7WQQJ5kHAO2yptdnEO6vr-7GwdCAGUpCA
companyid: 59388167894b4d10a04fe5da3b8a2104
requestid: be08f79e-7eac-40e1-acbe-00f6ae7b8f7b
Content-Type: application/json

Request Body​

{
    "user_id": "12e10ed1837b4e5b9fad542cf59a555d",
    "user_type": 2,
    "payment_request_id": "66d827aac12e41a4947af3735d6dce15"
}

Request Body Fields​

Required Fields​

  • user_id (string, required): ID of the user to send the reminder to

    • Format: UUID string
    • Example: "12e10ed1837b4e5b9fad542cf59a555d"

  • user_type (integer, required): Type of user

    • 2 = Customer
    • 3 = Merchant
    • 5 = Agent
    • See Constants for more details

  • payment_request_id (string, required): ID of the payment request to remind about

    • Format: UUID string
    • Example: "66d827aac12e41a4947af3735d6dce15"

Response​

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

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 the reminder was sent successfully

Example Usage​

curl --location 'https://api.gafapay.com:8443/gafapay/v3/user/remind_payment_request_user' \
--header 'authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJmYjhmMDkyMTBlMGY0NmI3YjQyNjJkNzdmNWI2YzI3MyIsInJvbGVzIjpbIlJPTEVfQ1VTVE9NRVIiXSwiZXhwIjoxNzU3MTYwNzEzfQ.b3RU1QWT7N7WQQJ5kHAO2yptdnEO6vr-7GwdCAGUpCA' \
--header 'companyid: 59388167894b4d10a04fe5da3b8a2104' \
--header 'requestid: be08f79e-7eac-40e1-acbe-00f6ae7b8f7b' \
--header 'Content-Type: application/json' \
--data '{
    "user_id": "12e10ed1837b4e5b9fad542cf59a555d",
    "user_type": 2,
    "payment_request_id": "66d827aac12e41a4947af3735d6dce15"
}'

Notes​

  • This API sends a reminder notification to the specified user
  • User type values can be referenced from the Constants page
  • Use this API when users need to be reminded about pending payments
  • The API will validate that the user is actually part of the payment request before sending