Skip to main content

Get Cash Transfer Request API

Overview​

Retrieve details of a specific cash transfer request using the cash transfer request ID.

API Details​

Endpoint​

GET https://api.gafapay.com:8443/gafapay/v3/transaction/cash_transfer_request/{cash_transfer_request_id}

Path Parameters​

  • cash_transfer_request_id (string, required): The unique identifier of the cash transfer request
    • Example: 8d917bd67d94d5b97d84b46209ec2b3

Headers​

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

Response​

{
    "success": 1,
    "error": [],
    "data": {
        "cash_transfer_request": {
            "is_active": true,
            "created_by": "fb8f09210e0f46b7b4262d77f5b6c273",
            "created_date": 1756923571,
            "updated_by": null,
            "updated_date": 1756924031,
            "id": "8d917bd67d94d5b97d84b46209ec2b3",
            "from_user_type": null,
            "from_user_detail": {
                "dial_code": "+221",
                "first_name": "Suresh",
                "last_name": "Raina",
                "phone_number": "968784529",
                "user_id": "",
                "user_type": ""
            },
            "to_user_type": null,
            "to_user_detail": {
                "dial_code": "+221",
                "first_name": "test",
                "last_name": "user",
                "phone_number": "967468480",
                "user_id": "",
                "user_type": 0
            },
            "amount": 100.0,
            "currency_id": "1f1519903ed240578f071aa45cb479f2",
            "reference_number": "5531074821",
            "expiry_date": null,
            "request_status": 1,
            "from_agent_id": "fb8f09210e0f46b7b4262d77f5b6c273",
            "to_agent_id": null,
            "sender_txn_id": "9ce964d02d3a48ada60ee28b8d61c7d3",
            "receiver_txn_id": "",
            "requested_by_user_type": null,
            "requested_by_user_id": null
        }
    }
}

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
    • cash_transfer_request (object): Cash transfer request details

Cash Transfer Request Object Fields​

  • is_active (boolean): Whether the request is currently active
  • created_by (string): ID of the user who created the request
  • created_date (integer): Unix timestamp when the request was created
  • updated_by (string, nullable): ID of the user who last updated the request
  • updated_date (integer, nullable): Unix timestamp when the request was last updated
  • id (string): Unique identifier of the cash transfer request
  • from_user_type (integer, nullable): Type of the sender user
  • from_user_detail (object): Details of the sender user
    • dial_code (string): Country dial code
    • first_name (string): Sender's first name
    • last_name (string): Sender's last name
    • phone_number (string): Sender's phone number
    • user_id (string): Sender's user ID
    • user_type (string): Sender's user type
  • to_user_type (integer, nullable): Type of the recipient user
  • to_user_detail (object): Details of the recipient user
    • dial_code (string): Country dial code
    • first_name (string): Recipient's first name
    • last_name (string): Recipient's last name
    • phone_number (string): Recipient's phone number
    • user_id (string): Recipient's user ID
    • user_type (integer): Recipient's user type
  • amount (number): Amount to be transferred
  • currency_id (string): Currency identifier for the transaction
  • reference_number (string): Reference number for the request
  • expiry_date (integer, nullable): Unix timestamp when the request expires
  • request_status (integer): Current status of the request
    • 1 = Pending
    • 2 = Accepted
    • 3 = Rejected
    • 4 = Expired
  • from_agent_id (string): Agent ID of the sender
  • to_agent_id (string, nullable): Agent ID of the recipient
  • sender_txn_id (string): Unique transaction ID from sender
  • receiver_txn_id (string): Unique transaction ID from receiver
  • requested_by_user_type (integer, nullable): Type of user who made the request
  • requested_by_user_id (string, nullable): ID of user who made the request

Example Usage​

curl --location 'https://api.gafapay.com:8443/gafapay/v3/transaction/cash_transfer_request/8d917bd67d94d5b97d84b46209ec2b3' \
--header 'companyid: 59388167894b4d10a04fe5da3b8a2104' \
--header 'requestid: be08f79e-7eac-40e1-acbe-00f6ae7b8f7b' \
--header 'authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJmYjhmMDkyMTBlMGY0NmI3YjQyNjJkNzdmNWI2YzI3MyIsInJvbGVzIjpbIlJPTEVfQ1VTVE9NRVIiXSwiZXhwIjoxNzU3MTYwNzEzfQ.b3RU1QWT7N7WQQJ5kHAO2yptdnEO6vr-7GwdCAGUpCA'

Notes​

  • This API retrieves the complete details of a cash transfer request
  • The cash_transfer_request_id should be obtained from the response of the Save Cash Transfer Request API
  • The response includes all user details, transaction information, and current status
  • Timestamps are provided in Unix format (seconds since epoch)
  • The request_status field indicates the current state of the request
  • The reference_number can be used for tracking and customer service purposes
  • Both sender and recipient details are included in the response for verification