GET
/
rc
/
rest
/
agent
/
tranlist
curl --request GET \
  --url https://sandbox.readycashng.com:8447/rc/rest/agent/tranlist \
  --header 'Authorization: Bearer <token>'
{
    "data": [
        {
            "debit": true,
            "sender": null,
            "recipient": null,
            "terminal": null,
            "tranId": 92673,
            "tranType": "200.22.0000",
            "description": "Cash IN",
            "shortDescription": "Cash IN",
            "longDescription": "Cash IN for 8441000028",
            "date": 1661193929000,
            "amount": 2000.00,
            "reciept": {
                "amount": 2E+3,
                "date": 1661193929000,
                "reference": "645416",
                "recipient": "8441000028"
            },
            "balance": 45494.39,
            "balance2": 1800.00,
            "logoId": null,
            "externalRef": null,
            "sessionId": null,
            "timestamp": null,
            "captureDate": null,
            "narration": null
        },
        {
            "debit": false,
            "sender": null,
            "recipient": null,
            "terminal": null,
            "tranId": 92672,
            "tranType": "200.21.0001",
            "description": "POS Cashback",
            "shortDescription": "POS Cashback Deposit",
            "longDescription": "Money deposited using terminal P051000039949  ",
            "date": 1661109414000,
            "amount": 4975.00,
            "reciept": {
                "amount": 4975,
                "date": 1661109414000,
                "reference": "522746"
            },
            "balance": 47494.39,
            "balance2": null,
            "logoId": null,
            "externalRef": null,
            "sessionId": null,
            "timestamp": null,
            "captureDate": null,
            "narration": "MPOSV2-AGENT POS CASHBACK - 0000100047-286-005265653552"
        },
        {
            "debit": false,
            "sender": null,
            "recipient": null,
            "terminal": null,
            "tranId": 92671,
            "tranType": "200.21.0001",
            "description": "POS Cashback",
            "shortDescription": "POS Cashback Deposit",
            "longDescription": "Money deposited using terminal P051000039949  ",
            "date": 1661108816000,
            "amount": 4975.00,
            "reciept": {
                "amount": 4975,
                "date": 1661108816000,
                "reference": "117797"
            },
            "balance": 42519.39,
            "balance2": null,
            "logoId": null,
            "externalRef": null,
            "sessionId": null,
            "timestamp": null,
            "captureDate": null,
            "narration": "MPOSV2-AGENT POS CASHBACK - 0000100047-286-005265653552"
        }
    ],
    "total": 7,
    "success": true,
    "page": 1
}

The API introduces the idea of a Base Wallet, this is an account tied to the integrating partner, this account is impacted by a credit transaction when a charge is done against any of the wallets created by the partner and a debit transaction is entered when a fund is done. This endpoint allows the integrating partner pull a transaction list/statement for the base wallet

​
Request Parameters

start_date
number
required

UTC date/time stamp in milliseconds for the start date of the query

end_date
number
required

UTC date/time stamp in milliseconds for the end date of the query

pageSize
number
default: "20"

The page size of the records to return, default is 20, max is 100

page
number
default: "1"

The current page of the records to return, default is 1, max is total records/pageSize this is a ‘1’ index parameter

wrap
boolean
default: "true"required

This parameter must be set to true to ensure response is wrapped in pagination format, if not set the response is returned flat, fit only for infinite loading

​
Response

total
int

Total number of records retrieved by the query

success
boolean

if the call for the query was successful

page
int

The current page being returned

data
array
Transfer To Bank AccountCreate Customer Wallet