useRewardsBalance on the GraphQL account-to-account mutations to fund a transfer from the sender’s rewards balance. You can combine rewards with the sender’s resolved spend account in the same request. Prepayment / gift-card balance is not a field on these inputs and cannot fund the transfer.
This page covers the TGS GraphQL surface only:
createTransfer(CreateTransferInput)requestAccountTransfer(RequestAccountTransferInput)
Not
withdrawCashBalance.Withdraw to an external account uses source: CASH_BALANCE | REWARDS_BALANCE and is XOR (one source per request). Account-to-account send uses useRewardsBalance on createTransfer / requestAccountTransfer and can combine rewards with one spend account.Mutations and scopes
useRewardsBalance is optional on both inputs. Omit it or pass false for cash-only — the default, so existing clients do not change behavior.
Input field
useRewardsBalance: Boolean
When true, fund the transfer from the sender’s rewards balance in addition to the spend account TGS already resolves from the access token (or application operator for Basic Auth).
The recipient is still credited on a spend account (
destination.userCashBalanceId, or the automatically resolved cash balance). There is no GraphQL field to send rewards into another account’s rewards balance.
CreateTransferInput / RequestAccountTransferInput still have no usePrepaymentBalance (or equivalent). Do not copy FluzPay purchase flags onto these mutations.
createTransfer
useRewardsBalance: true.
With an external funding source
bankCardId, bankAccountId, and paypalVaultId remain Bearer-token only, at most one per request. They deposit into the sender’s spend account first; useRewardsBalance still applies to the transfer itself.
requestAccountTransfer
MirrorscreateTransfer. Pass useRewardsBalance on the request; it is included in the payload that executes after approveApprovalRequest.
approveApprovalRequest / declineApprovalRequest with MANAGE_APPROVALS. See Request Account Transfer Approval.
Errors
Failures use the standard GraphQL error envelope.createTransfer returns createTransfer: null when the send cannot complete.
See Transfer to Another Fluz Account for the rest of
CreateTransferInput and createTransfer / CreateTransferInput in the API reference.