Loading…
Represents a payment transaction, including its type, amount, status, and associations.
| Field | Type | Description | Example |
|---|---|---|---|
| id | int | Unique identifier for the payment | 123 |
| user_id | int | ID of the user who made the payment | 123 |
| type | string | Type of payment (see below) | "deposit" |
| amount | number | Amount of the payment, in Tooman | 100.0 |
| description | string | Description of the payment. A verified deposit has the gateway reference code appended to it | "Top-up\nReference code: 4837261509" |
| payable_type | string | Type of the payable resource (e.g., App\Models\Gym) | "App\Models\Gym" |
| payable_id | int | ID of the payable resource | 456 |
| meta | object | Additional metadata (see below) | { ... } |
| is_done | bool | Whether the payment is completed. On a withdrawal this means the bank transfer happened, and has no effect on the balance | true |
| rejected_at | string|null | When a withdrawal was refused by an operator; null otherwise. A rejected withdrawal stops holding its amount out of the balance | "2025-01-01 00:00:00" |
| created_at | string | Creation timestamp (ISO 8601 format) | "2025-01-01 00:00:00" |
| user | object | Full user object (see User Resource) | { ... } |
| user_balance | number | Current spendable balance of the payment's user, identical to GET /payments/balance: verified deposits + income − done purchases and commissions − every withdrawal that is not rejected. A pending withdrawal does reduce it, including this record's own amount. Present only on withdrawal-type records and only for viewers with payments.view_all; absent otherwise. | 1150.0 |
The type field can be one of the following:
depositincomepurchasewithdrawalcommissionstore_purchasestore_purchase is Premium bought through an app store's in-app billing. It is the one type that
never affects the balance: the store collected the money and settles with us out of band, so it
never entered the wallet and must not be debited from it. Treat it as a completed purchase when
rendering payment history, and ignore it when reconciling a balance. See
Store billing.
Free-form, and only populated for payment types that have something to record. Deposits carry the gateway fee breakdown from the moment they are created, and gain the gateway's own figures once verified (see the gateway fee):
| Field | Type | Description |
|---|---|---|
| amount | number | Tooman credited — the same figure as the payment's amount |
| gateway_fee | number | Tooman the user paid on top of amount |
| payable_amount | number | Tooman the user was charged at the gateway |
| track_id | string | Gateway track ID (after verification) |
| ref_number | string | Gateway reference code (after verification; may be null) |
| card_number | string | Masked card number (after verification; may be null) |
| paid_at | string | Payment timestamp reported by the gateway (after verification) |
| charged_rial | int | Amount in Rial as the gateway reports it (after verification) |
{
"amount": 700000,
"gateway_fee": 7786,
"payable_amount": 707786,
"track_id": "123456789",
"ref_number": "4837261509",
"card_number": "1234-****-****-5678",
"paid_at": "2026-01-01T00:00:00.000Z",
"charged_rial": 7077860
}
A store_purchase carries the channel that settled it and the SKU that was bought, plus the VAT
breakdown when a rate is in force:
| Field | Type | Description |
|---|---|---|
| channel | string | The distribution channel, e.g. bazaar |
| product_id | string | The store SKU that was purchased |
{
"channel": "bazaar",
"product_id": "premium_plus_1m"
}
{
"id": 123,
"user_id": 123,
"user": {
"id": 123,
"username": "jdoe",
"first_name": "John",
"last_name": "Doe",
"created_at": "2025-01-01 00:00:00"
},
"type": "deposit",
"amount": 100.0,
"description": "Subscription fee",
"payable_type": "App\\Models\\Gym",
"payable_id": 456,
"meta": {},
"is_done": true,
"rejected_at": null,
"created_at": "2025-01-01 00:00:00"
}
payments.view_allA pending withdrawal as an admin sees it in the list: user_balance is the user's live spendable
balance, which already has this withdrawal's 50 held out of it — the hold is placed when the
withdrawal is requested and released only if it is rejected.
{
"id": 124,
"user_id": 123,
"user": {
"id": 123,
"username": "jdoe",
"first_name": "John",
"last_name": "Doe",
"created_at": "2025-01-01 00:00:00"
},
"type": "withdrawal",
"amount": 50.0,
"description": null,
"payable_type": null,
"payable_id": null,
"meta": null,
"is_done": false,
"created_at": "2025-01-02 00:00:00",
"user_balance": 1150.0
}