Deposits
Deposits
Top up an account balance.
Modified at Apr 28, 2026, 05:38 AM UTC
Deposits add balance to an account. Use this section when your integration needs payment methods, deposit creation, deposit status, or payment instruction fields for a balance top-up.
The payable amount shown to the payer should come from amounts.total_pay. This value is the final amount returned by the API for the selected provider and deposit amount.
Deposit Status
| Status | Meaning |
|---|---|
| pending | The deposit is waiting for payment. |
| processing | The payment is being checked. |
| succeeded | The deposit is complete. |
| failed | The deposit failed. |
| cancelled | The deposit was cancelled. |
| expired | The payment window expired. |