Request a wallet statement

POST

/customers/v1/wallet-statements

Request generation of a monthly wallet statement (CSV). The period must be a completed calendar month. Generation is asynchronous and idempotent per wallet and period; the returned job can be polled until it is COMPLETED.

Request

Header Params

Body Params application/json

Example

{
    "wallet_id": "d9a8fbfc-848f-43a2-9168-911ed3a04a48",
    "period": "2026-05",
    "idempotency_key": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/customers/v1/wallet-statements' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data '{
    "wallet_id": "d9a8fbfc-848f-43a2-9168-911ed3a04a48",
    "period": "2026-05",
    "idempotency_key": "string"
}'

Responses

🟢201Created

application/json

Wallet statement generation job created.

Bodyapplication/json

Example

{
    "id": "7f4cf3e1-2f6a-4d24-9c1b-1f6f9a1f2b35",
    "entity_type": "report",
    "entity_id": "47d152eb-2076-4b0c-a87a-bce74e43f4f2",
    "type": "WALLET_STATEMENT",
    "status": "PENDING",
    "payload": {
        "wallet_id": "47d152eb-2076-4b0c-a87a-bce74e43f4f2",
        "period": "2026-05",
        "period_from": "2026-04-30T14:00:00.000Z",
        "period_to": "2026-05-31T13:59:59.999Z"
    },
    "result": null,
    "error_reason": null,
    "progress": 0,
    "owner": "ExampleClient",
    "idempotency_key": "wallet-statement-47d152eb-2076-4b0c-a87a-bce74e43f4f2-2026-05",
    "created_at": "2026-06-01T00:05:12.000Z",
    "updated_at": "2026-06-01T00:06:03.000Z"
}

Modified at 2026-06-17 12:01:16

Delete a webhook

List wallet statements