Login | Sign Up
- FA
- EN
Creates a deposit request for the authenticated user to add funds to their account.
| Permission | Description |
|---|---|
payments.view_own | Access the payment system |
payments.deposit | Deposit money into own account |
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| amount | decimal | Yes | Amount to credit, in Tooman. Minimum 1 | 700000 |
| description | string | No | Description for the deposit (max 2000 characters) | "Top-up" |
amount is what the user's balance is credited with. The gateway's fee is charged on top of
it, so the figure the user actually pays is payable_amount — see
the gateway fee.
{
"amount": 700000,
"description": "Top-up"
}
Returns a payment gateway link for the user to complete the deposit process, along with the
amounts involved. All amounts are in Tooman, and amount + gateway_fee == payable_amount.
| Field | Type | Description |
|---|---|---|
| link | string | Gateway URL to redirect the user to |
| amount | number | Amount the user's balance will be credited with |
| gateway_fee | number | Gateway fee the user pays on top of amount |
| payable_amount | number | Total the user is charged at the gateway |
{
"link": "https://gateway.zibal.ir/start/123456789",
"amount": 700000,
"gateway_fee": 7786,
"payable_amount": 707786
}
| Status | Description | Reference |
|---|---|---|
| 500 | Payment service provider error ({ "message": "Payment service provider error.", "error": "..." }) | N/A |
| 422 | Validation error | Validation error |
| 401 | Unauthorized | Authentication error |
