Export Customer Wallets

POST

https://api.zid.sa/v1/customer-wallets/customers/export/

Queues an export containing all customer wallets that match the specified filters. The export is generated in the background and made available through the store's exports.

🔑Scopes

third_customer_wallet_read - Customer Wallet Read

Note

Customer Wallet APIs are available only for stores using one of the following currencies: SAR, AED, QAR, KWD, BHD, or OMR.
Stores using any other currency receive the message: Customer wallets is only available for GCC countries.

Request

Query Params

Header Params

Responses

🟢204Success

This response does not have a body.

🟠401Unauthorized

🔴500Internal Server error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.zid.sa/v1/customer-wallets/customers/export/?balance_min=100&balance_max=1000&expiring_in_days=30&expiring_before=2026-09-30' \
--header 'Store-Id: 123456' \
--header 'X-manager-Token: {{Access-Token}}'

Response Example

401 - Example 1

{
    "status": "error",
    "message": {
        "type": "error",
        "code": "ERROR_SESSION_MISSING",
        "name": "Sorry",
        "description": "Please login first."
    }
}

Modified at 2026-09-08 09:45:47

Bulk Debit Customer Wallets

Get Customer Wallet Balance

Export Customer Wallets

Note#

Request

Responses

Note