Endpoints

GET /transactions/history/daily?date=:date
GET /transactions/history/weekly?date=:date
GET /transactions/history/monthly?date=:date

Authentication & headers

These endpoints use the same signed headers as other PayFast APIs.

Header	Type	Required	Description
`merchant-id`	integer (8 chars)	Yes	Your PayFast Merchant ID.
`version`	string	Yes	API version (e.g., `v1`).
`timestamp`	ISO-8601 datetime	Yes	`YYYY-MM-DDTHH:MM:SS[+HH:MM]`.
`signature`	string (MD5 hex)	Yes	MD5 of alphabetised submitted header/body variables + passphrase, lower-case hex.

Note: Some legacy notes list signature as optional; in practice, authenticated calls should always include a valid signature. Keep it consistent across your collection.

Query parameters (shared)

Name	Type	Required	Used by	Description
`date`	string	No*	daily / weekly / monthly	Anchor date for the requested period. If omitted, each endpoint uses the current period.
	`YYYY-MM-DD`		daily / weekly	For the specific day, or the ISO week containing this date.
	`YYYY-MM` or `YYYY-MM-DD`		monthly	For the calendar month containing this date. Many clients accept `YYYY-MM`.
`limit`	integer	No	all	Max rows to return (default `1000`).
`offset`	integer	No	all	Rows to skip; use with `limit` for pagination.

While optional, providing date makes testing deterministic.

Response

Content-Type: text/csv (CSV string contained in a JSON wrapper in some clients)
Columns (typical): Date,Type,Sign,Party,Name,Description,Currency,"Funding Type",Gross,Fee,Net,Balance,"M Payment ID","PF Payment ID","custom str1","custom int1","custom str2","custom int2","custom str3","custom str4","custom str5","custom int3","custom int4","custom int5"

Example:

Date,Type,Sign,Party,Name,Description,Currency,"Funding Type",Gross,Fee,Net,Balance,"M Payment ID","PF Payment ID","custom str1","custom int1","custom str2","custom int2","custom str3","custom str4","custom str5","custom int3","custom int4","custom int5"
"2025-08-13 07:03:38",FUNDS_RECEIVED,CREDIT,"Test User 01","Support Centre purchase, Invoice ID #3715","Support Centre - Invoice #3715",ZAR,WALLET,16.00,-2.30,13.70,,3715,2739098,PF_WHMCS_8.13._2.3.0,,,,,,,,,
"2025-08-13 07:54:47",FUNDS_RECEIVED,CREDIT,"Test User 01","Support Centre purchase, Invoice ID #3715","Support Centre - Invoice #3715",ZAR,WALLET,16.00,-2.30,13.70,,3715,2739160,PF_WHMCS_8.13._2.3.1,,,,,,,,,

Examples

Daily

curl -G "https://api.payfast.co.za/transactions/history/daily" \
  --data-urlencode "date=2025-08-31" \
  --data-urlencode "limit=1000" \
  --data-urlencode "offset=0" \
  -H "merchant-id: 10029252" \
  -H "version: v1" \
  -H "timestamp: 2025-09-01T08:00:00+02:00" \
  -H "signature: <md5-alphabetised-vars-plus-passphrase>"

Weekly

curl -G "https://api.payfast.co.za/transactions/history/weekly" \
  --data-urlencode "date=2025-08-31" \
  --data-urlencode "limit=1000" \
  --data-urlencode "offset=0" \
  -H "merchant-id: 10029252" \
  -H "version: v1" \
  -H "timestamp: 2025-09-01T08:00:00+02:00" \
  -H "signature: <md5-alphabetised-vars-plus-passphrase>"

Monthly

curl -G "https://api.payfast.co.za/transactions/history/monthly" \
  --data-urlencode "date=2025-08" \
  --data-urlencode "limit=1000" \
  --data-urlencode "offset=0" \
  -H "merchant-id: 10029252" \
  -H "version: v1" \
  -H "timestamp: 2025-09-01T08:00:00+02:00" \
  -H "signature: <md5-alphabetised-vars-plus-passphrase>"

Notes & gotchas

Defaults: If date is omitted, each endpoint resolves to today, this ISO week, or this calendar month respectively.
Pagination: Use limit + offset to page through large CSVs.
CSV parsing: Treat the payload as CSV text—don’t assume JSON columns.
Timezones: Timestamps in CSV are typically local to the PayFast system; confirm against your finance reporting zone if you require alignment.
Signature mismatches: Most often caused by (a) not alphabetising vars before hashing, (b) excluding one of the headers from the string to sign, or (c) case/encoding differences. Ensure lower-case hex output.