Check statement status

curl --request GET \
  --url https://api.sandbox.pawapay.io/v2/statements/{statementId} \
  --header 'Authorization: Bearer <token>'

{
  "status": "FOUND",
  "data": {
    "statementId": "8917c345-4791-4285-a416-62f24b6982db",
    "status": "COMPLETED",
    "wallet": {
      "currency": "ZMW",
      "country": "ZMB",
      "provider": "MTN_MOMO_ZMB"
    },
    "created": "2020-10-19T08:17:01Z",
    "startDate": "2025-05-10T10:00:00",
    "endDate": "2025-05-11T10:00:00",
    "fileSIze": 1234567,
    "downloadUrl": "https://pawapay.io/downloadUrl",
    "downloadUrlExpiresAt": "2020-10-20T08:17:01Z",
    "completedAt": "2020-10-19T08:17:01Z"
  }
}

GET

statements

{statementId}

Check statement status

curl --request GET \
  --url https://api.sandbox.pawapay.io/v2/statements/{statementId} \
  --header 'Authorization: Bearer <token>'

{
  "status": "FOUND",
  "data": {
    "statementId": "8917c345-4791-4285-a416-62f24b6982db",
    "status": "COMPLETED",
    "wallet": {
      "currency": "ZMW",
      "country": "ZMB",
      "provider": "MTN_MOMO_ZMB"
    },
    "created": "2020-10-19T08:17:01Z",
    "startDate": "2025-05-10T10:00:00",
    "endDate": "2025-05-11T10:00:00",
    "fileSIze": 1234567,
    "downloadUrl": "https://pawapay.io/downloadUrl",
    "downloadUrlExpiresAt": "2020-10-20T08:17:01Z",
    "completedAt": "2020-10-19T08:17:01Z"
  }
}

Get the current status of the statement based on its statementId

Authorizations

Authorization

string

header

required

See Authentication.

Response

Request has been processed by pawaPay

status

enum<string>

required

The result of this operation.

FOUND - The statement was found in pawaPay.
NOT_FOUND - The statement was not found in pawaPay.

Available options:

FOUND,

NOT_FOUND

data

object

Show child attributes

data.statementId

string<uuid>

required

The unique ID for this statement as specified by pawaPay.

Required string length: 36

Example:

"f4401bd2-1568-4140-bf2d-eb77d2b2b639"

data.status

enum<string>

required

Possible statement statuses:

PROCESSING - The statement is in processing status.
COMPLETED - The statement has been completed. See downloadUrl to download the file.
FAILED - The statement has been failed. See failureReason for details.

Available options:

PROCESSING,

COMPLETED,

FAILED

data.wallet

object

required

Specifies which wallet to generate a statement for.

You can check which wallets you have from the wallet balances endpoint.

Show child attributes

data.wallet.country

string

required

Country code for the wallet you are generating a statement for.

You can check which wallets you have from the wallet balances endpoint.

Format is ISO 3166-1 alpha-3, three character country code in upper case. Read more from Wikipedia.

Required string length: 3

Example:

"ZMB"

data.wallet.currency

string

required

ISO currency code for the wallet you are generating a statement for.

You can check which wallets you have from the wallet balances endpoint.

Format must be the ISO 4217 three character currency code in upper case. Read more from Wikipedia.

Example:

"ZMW"

data.wallet.provider

string

If you have provider specific wallets, it indicates which provider specific wallet to generate the statement for in this country.

You can check which wallets you have from the wallet balances endpoint.

Example:

"MTN_MOMO_ZMB"

data.created

string<date-time>

required

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:

"2020-02-21T17:32:29Z"

data.startDate

string<date-time>

required

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

Example:

"2025-05-10T10:00:00"

data.endDate

string<date-time>

required

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

Example:

"2025-05-01T10:00:00"

data.fileSize

number

The file size in bytes of the generated statement.

Example:

1048576

data.downloadUrl

string<uri>

The URL from which to download the generated statement.

Please note! The URL is valid until downloadUrlExpiresAt.

data.downloadUrlExpiresAt

string<date-time>

The download URL expiration time. After this time, the statement cannot be downloaded any more and a new statement should be generated.

Example:

"2025-05-01T10:00:00"

data.completedAt

string<date-time>

The date and time when the statement was generated.

Example:

"2025-05-01T10:00:00"

data.failedAt

string<date-time>

The data and time when the statement generation failed.

Example:

"2025-05-01T10:00:00"

data.failureReason

object

Show child attributes

data.failureReason.failureCode

enum<string>

required

Possible statement failure codes:

UNKNOWN_ERROR - Unable to process request due to an unknown problem.

Available options:

UNKNOWN_ERROR

Example:

"UNKNOWN_ERROR"

data.failureReason.failureMessage

string

Description of the reason for this failure

Example:

"Unable to process request due to an unknown problem."

Statements Statement callback

⌘I

Deposits

Payouts

Refunds

Remittances

Payment page

Finances

Toolkit

Check statement status

Authorizations

Response