Skip to main content

Get Payment Request User

Overview​

Retrieve detailed information about a specific payment request user by their unique identifier.

API Details​

Endpoint​

GET https://api.gafapay.com:8443/gafapay/v3/user/payment_request_users/{id}

Path Parameters​

  • id (String, required): The unique identifier of the payment request user to retrieve
    • Format: UUID string
    • Example: 190bc954d98e44c7a26dc5caba7a0cdd

Headers​

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

Response​

{
    "success": 1,
    "error": [],
    "data": {
        "payment_request_users": {
            "amount": 100.0,
            "id": "190bc954d98e44c7a26dc5caba7a0cdd",
            "user_type": 2,
            "user_id": "fb8f09210e0f46b7b4262d77f5b6c273",
            "payment_request_id": "bc47de8f53294a44842a421ad90affbe",
            "payment_status": 1,
            "cancel_reason": null,
            "payer_transaction_id": null,
            "currency_id": "1f1519903ed240578f071aa45cb479f2",
            "user_info": {
                "first_name": "Suresh",
                "last_name": "Raina",
                "dial_code": "+221",
                "phone_number": "968784529",
                "email": "kushalpatel2930@gmail.com",
                "image": null
            },
            "group_info": null,
            "is_active": true,
            "created_date": 1756556059
        }
    }
}

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
    • payment_request_users (object): Payment request user information object

Payment Request User Object Fields​

  • amount (number): Payment amount requested

    • Format: Decimal number
    • Example: 100.0, 50.5, 1000.00

  • id (string): Unique identifier for the payment request user record

    • Format: UUID string
    • Example: "190bc954d98e44c7a26dc5caba7a0cdd"

  • user_type (integer): Type of user

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

  • user_id (string): ID of the user associated with this payment request

    • Format: UUID string
    • Example: "fb8f09210e0f46b7b4262d77f5b6c273"

  • payment_request_id (string): ID of the payment request

    • Format: UUID string
    • Example: "bc47de8f53294a44842a421ad90affbe"

  • payment_status (integer): Current status of the payment

    • 1 = PAYMENT_STATUS_PENDING
    • 2 = PAYMENT_STATUS_COMPLETED
    • 3 = PAYMENT_STATUS_CANCELLED_BY_INITIATOR
    • 4 = PAYMENT_STATUS_CANCELLED_BY_PAYER
    • See Constants for more details

  • cancel_reason (string|null): Reason for cancellation if applicable

    • Format: Text string
    • Example: "User requested cancellation"
    • Can be null if not cancelled

  • payer_transaction_id (string|null): Transaction ID from the payer

    • Format: Transaction identifier string
    • Can be null if payment not completed

  • currency_id (string): ID of the currency used for the payment

    • Format: UUID string
    • Example: "1f1519903ed240578f071aa45cb479f2"

  • user_info (object): User information object

    • first_name (string): User's first name
    • last_name (string): User's last name
    • dial_code (string): Country dial code
    • phone_number (string): Phone number
    • email (string|null): Email address
    • image (string|null): Profile image URL

  • group_info (object|null): Group information if applicable

    • Can be null if not part of a group

  • is_active (boolean): Whether the payment request user record is active

    • true = Active
    • false = Inactive

  • created_date (long): Creation timestamp

    • Format: Unix timestamp
    • Example: 1756556059

Example Usage​

curl --location 'https://api.gafapay.com:8443/gafapay/v3/user/payment_request_users/190bc954d98e44c7a26dc5caba7a0cdd' \
--header 'authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJlNDk0Njg3N2YxODk0NmIyOTlmZGRmMGYyMTMzZGNiYSIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNzU3MDA3NDEyfQ.ph7qKBEzuHxgljV3141L9iOrWmHI4TnyoknBSNoVYYU' \
--header 'companyid: 59388167894b4d10a04fe5da3b8a2104' \
--header 'requestid: be08f79e-7eac-40e1-acbe-00f6ae7b8f7b'

Notes​

  • This API returns a single payment request user object instead of an array
  • The response structure is similar to the "Get All" API but returns one specific record
  • Payment status values can be referenced from the Constants page
  • User type values can be referenced from the Constants page
  • Use this API when you need detailed information about a specific payment request user
  • The ID parameter must be a valid UUID format