<[object Object]>
PesaWay Docs

# Pull Transactions

This enables you to get the PesaWay Wallet Balance. You can query for the belance as follows:

Test Endpoint:

https://sandbox.pesaway.com/api/v1/pull-transactions/

There are no parameters expected

# Request Sample

{
  "StartDate": "2024-10-19 11:41:27",
  "EndDate": "2024-10-19 11:42:27",
  "TransType": "Collection",
  "OffsetValue": 0
}

# Response Parameters

Response Parameters Field Type Description
StartDate The start of the period for the transactions in the format of 2024-10-19 11:41:27
EndDate The end of the period for the transactions in the format of 2024-10-19 11:42:27
TransType The type of transactions you would want to pull. Supported Types are 'Collection' and 'Payment'
OffsetValue Starts from 0. The service uses offset as opposed to page numbers. The OFF SET value allows you to specify from which row to start from retrieving data

NB: Maximum transactions that can be retrieved with a single request is 100.

# Response Sample

[
  {
    "Reference": "nZ84WxLx8p1",
    "Receipt": "BP1323OTKQ1",
    "TransactionDate": "2020-08-05T10:13:00Z",
    "Recipient": "72200000 - John Doe",
    "ExternalReference": "UAT2",
    "TransactionType": "Collection",
    "Amount": "876.00"
  },
  {
    "Reference": "nZ84WxLx8p2",
    "Receipt": "BP1323OTKQ2",
    "TransactionDate": "2020-08-05T10:13:00Z",
    "Recipient": "72200000 - John Doe",
    "ExternalReference": "UAT2",
    "TransactionType": "Collection",
    "Amount": "876.00"
  },
  {
    "Reference": "nZ84WxLx8p3",
    "Receipt": "BP1323OTKQ3",
    "TransactionDate": "2020-08-05T10:13:00Z",
    "Recipient": "72200000 - John Doe",
    "ExternalReference": "UAT2",
    "TransactionType": "Collection",
    "Amount": "876.00"
  }
]

# Response Parameters

Response Parameters Field Type Description
Reference PesaWay's internal receipt for the transaction (unique)
Receipt This is the payment's third party receipt e.g. MPESA Receipt
TransactionDate The date stamp for the transaction
Recipient Details on the person the transaction was done with
ExternalReference The merchant's own reference for the transaction.
TransactionType Type of transaction e.g. Collection (income) or Payment (expense).
Amount The amount that was transcted.

← Account Balance →