Get All Cash Transfer Requests API

Overview

Retrieve a list of cash transfer requests with optional filtering, pagination, and sorting capabilities.

API Details

Method: GET
URL: https://api.gafapay.com:8443/gafapay/v3/transaction/cash_transfer_request
Content-Type: application/json
companyid: 59388167894b4d10a04fe5da3b8a2104
requestid: be08f79e-7eac-40e1-acbe-00f6ae7b8f7b
Authorization: Token required

Endpoint

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

Query Parameters (Filters)

All parameters are optional and can be combined for advanced filtering:

Pagination Parameters

skip (Integer): Number of records to skip for pagination
- Example: 0, 10, 20
limit (Integer): Maximum number of records to return
- Example: 10, 25, 50

Date Range Parameters

start_date (Long): Start date filter (epoch timestamp)
- Example: 1756920000
end_date (Long): End date filter (epoch timestamp)
- Example: 1756929999

Search and Sorting Parameters

search_keyword (String): Search using keyword across relevant fields
- Example: "Suresh", "test user"
sorting (String): Sorting field in JSON format
- Example: {"created_date": "DESC"}, {"amount": "ASC"}

User Type Parameters

from_user_type (Integer): Source user type filter
- Example: 0, 1, 2
to_user_type (Integer): Target user type filter
- Example: 0, 1, 2
requested_by_user_type (Integer): User type who made the request
- Example: 0, 1, 2

Transaction Parameters

amount (Double): Filter by transaction/request amount
- Example: 100.0, 500.0
currency_id (String): Filter by currency ID
- Example: "1f1519903ed240578f071aa45cb479f2"
reference_number (String): Filter by reference number
- Example: "5531074821"

Status and Activity Parameters

is_active (Boolean): Filter by active status
- Example: true, false
request_status (Integer): Filter by request status
- 1 = Pending
- 2 = Accepted
- 3 = Rejected
- 4 = Expired
expiry_date (Long): Filter by expiry date (epoch timestamp)
- Example: 1756929999

Agent and Transaction Parameters

from_agent_id (String): Filter by sender agent ID
- Example: "fb8f09210e0f46b7b4262d77f5b6c273"
to_agent_id (String): Filter by receiver agent ID
- Example: "fb8f09210e0f46b7b4262d77f5b6c273"
sender_txn_id (String): Filter by sender's transaction ID
- Example: "9ce964d02d3a48ada60ee28b8d61c7d3"
receiver_txn_id (String): Filter by receiver's transaction ID
- Example: "abc123def456"

User ID Parameters

requested_by_user_id (String): Filter by user ID who made the request
- Example: "fb8f09210e0f46b7b4262d77f5b6c273"
id (String): Filter by unique cash transfer request ID
- 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": 1756924332,
                "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
            },
            {
                "is_active": true,
                "created_by": "fb8f09210e0f46b7b4262d77f5b6c273",
                "created_date": 1756923071,
                "updated_by": null,
                "updated_date": 1756924332,
                "id": "7cc15df2d3cf4dd3b16dfd88dde786b5",
                "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": "3271045737",
                "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 (array): Array of cash transfer request objects

Cash Transfer Request Object Fields

Each object in the array contains the same fields as described in the Get Cash Transfer Request API:

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
to_user_type (integer, nullable): Type of the recipient user
to_user_detail (object): Details of the recipient user
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
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

Basic Request (No Filters)

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

Filtered Request (By Sender Transaction ID)

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

Advanced Filtered Request (Multiple Parameters)

curl --location 'https://api.gafapay.com:8443/gafapay/v3/transaction/cash_transfer_request?request_status=1&amount=100.0&skip=0&limit=10&sorting={"created_date":"DESC"}' \
--header 'companyid: 59388167894b4d10a04fe5da3b8a2104' \
--header 'requestid: be08f79e-7eac-40e1-acbe-00f6ae7b8f7b' \
--header 'authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJmYjhmMDkyMTBlMGY0NmI3YjQyNjJkNzdmNWI2YzI3MyIsInJvbGVzIjpbIlJPTEVfQ1VTVE9NRVIiXSwiZXhwIjoxNzU3MTYwNzEzfQ.b3RU1QWT7N7WQQJ5kHAO2yptdnEO6vr-7GwdCAGUpCA'

Notes

This API returns an array of cash transfer requests based on the applied filters
All query parameters are optional and can be combined for advanced filtering
Use skip and limit parameters for pagination
The sorting parameter accepts JSON format: {"field_name": "ASC|DESC"}
Date parameters (start_date, end_date, expiry_date) use Unix timestamps
The search_keyword parameter searches across relevant text fields
Multiple filters can be combined using & separator in the URL
The response structure is the same as individual cash transfer request objects
Use this API for listing, searching, and filtering cash transfer requests

Overview​

API Details​

Endpoint​

Query Parameters (Filters)​

Pagination Parameters​

Date Range Parameters​

Search and Sorting Parameters​

User Type Parameters​

Transaction Parameters​

Status and Activity Parameters​

Agent and Transaction Parameters​

User ID Parameters​

Headers​

Response​

Response Fields​

Cash Transfer Request Object Fields​

Example Usage​

Basic Request (No Filters)​

Filtered Request (By Sender Transaction ID)​

Advanced Filtered Request (Multiple Parameters)​

Notes​