useRewardsBalance: true to let the sender pay with their rewards balance when sending money to a Fluz account. Fluz takes the sender’s cash first and uses rewards for the rest. If the sender has no cash available, the whole amount comes from rewards.
It works on two operations:
Everything else about the send, such as the destination, auth and idempotency, works as described in Send money.
Rewards can pay only for sends to a Fluz account.
sendMoneyandcreateExternalPayouttake a cash balance only.- To move rewards to the user’s own bank account, use
withdrawCashBalancewithsource: REWARDS_BALANCE. A withdrawal takes one source per request, cash or rewards, not both. - Prepayment / gift card balance can’t fund any send.
useRewardsBalance
useRewardsBalance: Boolean is optional on both inputs.
The recipient always receives the money in a spend account. You can’t send into someone’s rewards balance.
createTransfer
useRewardsBalance: true added.
With a linked funding source
bankCardId, bankAccountId and paypalVaultId still work with a Bearer token, one per request. Fluz deposits from that source into the sender’s spend account first, and useRewardsBalance still applies to the send.
requestAccountTransfer
requestAccountTransfer sends the transfer for approval instead of sending it right away. Pass useRewardsBalance on the request, and it is used when the approver approves.
approveApprovalRequest or declineApprovalRequest, which need MANAGE_APPROVALS. See Request account transfer approval.
Errors
Errors come back in the standard GraphQL format.createTransfer returns null when the send can’t complete.
See
createTransfer and CreateTransferInput in the API reference.