Skip to main content

Withdrawal types

BalanceWithdrawalConfig​

FieldTypeDescription
enabledBoolean!Whether withdrawals are available
minimumAmountFloat!Minimum request amount
methods[BalanceWithdrawalMethod!]!Configured payout methods
feePercentFloat!Percentage fee
exchangeRateFloat!Payout conversion rate

BalanceWithdrawalMethod​

FieldTypeDescription
codeID!Stable payout method code
nameJSON!Localized names
destinationTypeWithdrawalDestinationType!Destination format
placeholderStringDestination field hint
iconString!Safe icon-library class

Method codes are not an enum: administrators can connect custom providers without changing the GraphQL schema.

CreateBalanceWithdrawalInput​

FieldTypeDescription
requestIdID!UUIDv7 used for idempotent creation
amountFloat!Amount debited from the primary balance
methodCodeString!Code from BalanceWithdrawalConfig.methods
destinationString!Destination details
pinStringPIN when the operation is protected by project settings

BalanceWithdrawalResult​

FieldTypeDescription
messageString!Localized result message
requestIdID!Request identifier
statusWithdrawalStatus!Initial status
payoutAmountFloat!Payout after fee and conversion
balanceFloatUpdated primary balance
bonusBalanceFloatCurrent bonus balance

BalanceWithdrawalHistoryConnection​

FieldTypeDescription
items[BalanceWithdrawalHistoryItem!]!Requests on the current page
pageInfoWithdrawalPageInfo!Next-page cursor state

BalanceWithdrawalHistoryItem​

FieldTypeDescription
requestIdID!Request identifier
amountFloat!Debited amount
payoutAmountFloat!Calculated payout
feePercentFloat!Fee captured at creation
exchangeRateFloat!Conversion rate captured at creation
methodCodeString!Payout method code
destinationString!Recipient details
statusWithdrawalStatus!Request status
createdAtDateTime!Creation timestamp
processedAtDateTimeCompletion timestamp

WithdrawalPageInfo​

FieldTypeDescription
endCursorIDCursor of the last item
hasNextPageBoolean!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​

ValueDescription
PENDINGRequest is awaiting processing
PAIDPayout is confirmed
REJECTEDRequest was rejected and the debit was refunded

See withdrawal operations.