Debit COD wallet

Creates a debit request from the merchant’s COD Wallet, either as a bank payout or as a credit to the merchant shipping wallet.

💡

Authentication

Bearer token authentication is required.
The request must be made by an authenticated merchant with the required organisation permissions.
The token must be obtained using POST /api/auth/login and sent as Authorization: Bearer {token}.

💡

Debit Request

Send the debit amount and debit type in the request body.

amount: Debit amount in SAR, not cents.

type: Debit destination:
** bank → creates a bank payout request with status in_progress.
** wallet → credits the merchant shipping wallet, with the amount calculated net of 15% VAT and status paid immediately.

The requested amount must be greater than 0.

The amount cannot exceed debit_maximum_allowed returned by the COD Wallet summary endpoint.

📌

Request

Use POST /api/cod-wallets with a JSON body:

{"amount":115,"type":"wallet"}

For a bank payout:

{"amount":500,"type":"bank"}

The request returns the created COD wallet debit record in the data field.

💡

Amount & Maximum Limit

Debit amount is expressed in SAR.

Unlike the COD wallet list, the debit amount is not expressed in cents.

The maximum allowed debit amount is available through debit_maximum_allowed from GET /api/cod-wallets/summary.

If the requested amount exceeds the maximum allowed amount, the API returns a validation error.

Request

Authorization

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

Body Params application/jsonRequired

Examples

Request

Responses