Get COD wallet summary

Returns the authenticated merchant’s COD Wallet dashboard summary, including the next payment, current COD balance, withdrawn amount, and debit limit.

💡

Authentication

Bearer token authentication is required.

Only summary information belonging to the authenticated merchant is returned.

The token must be obtained using POST /api/auth/login and sent as Authorization: Bearer {token}.

💡

Filtering

Optionally filter the summary by COD wallet creation date using:

?created_at_from=YYYY-MM-DD

?created_at_to=YYYY-MM-DD

Both parameters can be combined to filter the summary by a specific creation date range.

The debit_maximum_allowed value is always calculated from the full COD Wallet and is not affected by the date filters.

📌

Summary Information

The endpoint returns the following dashboard figures:

next_amount → Next payment amount for the merchant.

next_date → Expected date of the next payment.

balance → Current COD Wallet balance.

available_balance → Available COD Wallet balance.

withdrawn → Total amount withdrawn through bank payouts and wallet debits.

cod_total → Total accepted COD collections.

paid_bank → Total amount already paid through bank payouts.

wallet_total → Total amount transferred to the merchant shipping wallet.

in_progress_bank → Amount currently pending through bank payout.

debit_maximum_allowed → Maximum amount that can currently be debited from the COD Wallet.

💡

Amount

All monetary values returned by this endpoint are expressed in SAR.

next_amount, balance, withdrawn, cod_total, paid_bank, wallet_total, in_progress_bank, and debit_maximum_allowed are returned as decimal amounts in SAR.

next_date contains the expected next payment date.

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://app.gotreek.com/api/auth/login

Request

Responses