Sign in

v1

latestOpenAPI 3.0.02026-07-2627149175.2 KB
finances

Statements

post/v2/statements

Request body

callbackUrlstring required

The URL where PawaPay will POST a callback with the downloadUrl when the statement has been generated.

startDatestring date-time required

The start date of the statement date range. Format defined by 'date-time' in RFC3339 section 5.6 from IETF

endDatestring date-time required

The end date of the statement date range. Format defined by 'date-time' in RFC3339 section 5.6 from IETF

compressedboolean

If true, the statement will be compressed using gzip and returned with a .csv.gz extension. If false or not provided, the statement will be returned as a CSV file with a .csv extension.

Example request

{
  "wallet": {
    "country": "ZMB",
    "currency": "ZMW",
    "provider": "MTN_MOMO_ZMB"
  },
  "callbackUrl": "https://merchant.com/statementCallbacks",
  "startDate": "2025-05-10T10:00:00",
  "endDate": "2025-05-11T10:00:00"
}

Response

Request has been accepted for processing by PawaPay

statementIdstring uuid

The unique ID for this statement as specified by PawaPay.

status'ACCEPTED' | 'REJECTED' required

The initiation status of the statement:

  • ACCEPTED - The statement has been accepted by PawaPay for generation.
  • REJECTED - The statement request has been rejected by PawaPay. See failureReason for details.
createdstring date-time

The timestamp of when the statement was created in the PawaPay platform. Format defined by 'date-time' in RFC3339 section 5.6 from IETF

Example response

{
  "statementId": "f4401bd2-1568-4140-bf2d-eb77d2b2b639",
  "created": "2020-02-21T17:32:29Z",
  "failureReason": {
    "failureCode": "WALLET_NOT_FOUND",
    "failureMessage": "Wallet does not exist."
  }
}