BalanceWithdrawalConfig
| Field | Type | Description |
|---|
enabled | Boolean! | Whether withdrawals are available |
minimumAmount | Float! | Minimum request amount |
methods | [BalanceWithdrawalMethod!]! | Configured payout methods |
feePercent | Float! | Percentage fee |
exchangeRate | Float! | Payout conversion rate |
BalanceWithdrawalMethod
| Field | Type | Description |
|---|
code | ID! | Stable payout method code |
name | JSON! | Localized names |
destinationType | WithdrawalDestinationType! | Destination format |
placeholder | String | Destination field hint |
icon | String! | Safe icon-library class |
Method codes are not an enum: administrators can connect custom providers without changing the GraphQL schema.
| Field | Type | Description |
|---|
requestId | ID! | UUIDv7 used for idempotent creation |
amount | Float! | Amount debited from the primary balance |
methodCode | String! | Code from BalanceWithdrawalConfig.methods |
destination | String! | Destination details |
pin | String | PIN when the operation is protected by project settings |
BalanceWithdrawalResult
| Field | Type | Description |
|---|
message | String! | Localized result message |
requestId | ID! | Request identifier |
status | WithdrawalStatus! | Initial status |
payoutAmount | Float! | Payout after fee and conversion |
balance | Float | Updated primary balance |
bonusBalance | Float | Current bonus balance |
BalanceWithdrawalHistoryConnection
| Field | Type | Description |
|---|
items | [BalanceWithdrawalHistoryItem!]! | Requests on the current page |
pageInfo | WithdrawalPageInfo! | Next-page cursor state |
BalanceWithdrawalHistoryItem
| Field | Type | Description |
|---|
requestId | ID! | Request identifier |
amount | Float! | Debited amount |
payoutAmount | Float! | Calculated payout |
feePercent | Float! | Fee captured at creation |
exchangeRate | Float! | Conversion rate captured at creation |
methodCode | String! | Payout method code |
destination | String! | Recipient details |
status | WithdrawalStatus! | Request status |
createdAt | DateTime! | Creation timestamp |
processedAt | DateTime | Completion timestamp |
WithdrawalPageInfo
| Field | Type | Description |
|---|
endCursor | ID | Cursor of the last item |
hasNextPage | Boolean! | Whether another page exists |
WithdrawalDestinationType
EMAIL, WALLET, CARD, PHONE, TEXT.
The type determines the destination format and the appropriate form control. It is not tied to a specific payout provider.
WithdrawalStatus
| Value | Description |
|---|
PENDING | Request is awaiting processing |
PAID | Payout is confirmed |
REJECTED | Request was rejected and the debit was refunded |
See withdrawal operations.