Fluz Overview
API ReferenceFluz
Start typing to search…

Deposit Funds

depositCashBalance

When you're ready to move money into your Fluz account, you can deposit funds into the following three balances:

  1. Cash balance- A regular cash balance deposit.
  2. Gift card balance- A non-withdrawable deposit for gift card balance.
  3. Reserve balance - A deposit held in reserve balance.

Make a Deposit

To deposit funds into one of your Fluz balances, use the depositCashBalance mutation. This mutation accepts an input object type of DepositCashBalanceInput, which allows you to specify the following details:

  1. Amount: Required - The amount you wish to deposit.
  2. idempotencyKey: Required - A unique client-generated UUID to ensure a request is processed only once.
  3. Funding Source: The payment method from which the deposit will be made (e.g., bank account, credit or debit card, PayPal). In order to get your funding source's ID, use the getWallet query.
    1. bankAccountId - If you want to pay with a bank account, define the bank account ID in the depositCashBalance mutation.
    2. bankCardId - If you want to pay with a bank card, define the bank card ID in the depositCashBalance mutation.
    3. paypalVaultID - If you want to pay with a PayPal account, define the PayPal account ID in the depositCashBalance mutation.
  4. Deposit Destination: The balance where you want to deposit your funds. The available options for this are defined in the CashBalanceDepositType enumerator:
    1. CASH_BALANCE
    2. GIFT_CARD_BALANCE
    3. RESERVE_BALANCE
  5. Merchant Category Code: Only applies for GIFT_CARD_BALANCE. A four-digit number that classifies a business by the type of products or services it offers. Use getMccList to retrieve a list of valid MCCs.

Sample Request

mutation depositCashBalance($input: DepositCashBalanceInput!) {
  depositCashBalance(input: $input) {
    cashBalanceDeposits {
      ...CashBalanceDepositFragment
    }
    balances {
      ...UserBalancesFragment
    }
  }
}

DepositCashBalanceInput

{
  "idempotencyKey": "0284be6f-1a69-44f7-9da0-5b5edaf45d19",
  "amount": 987.65,
  "depositType": "GIFT_CARD_BALANCE",
  "merchantCategoryCode": 1234,
  "bankAccountId": "0284be6f-1a69-44f7-9da0-5b5edaf45d19",
  "bankCardId": "0284be6f-1a69-44f7-9da0-5b5edaf45d19",
  "paypalVaultId": "0284be6f-1a69-44f7-9da0-5b5edaf45d19"
}

Sample Response

{
  "data": {
    "depositCashBalance": {
      "cashBalanceDeposits": [
        {
          "cashBalanceDepositId": "5f5c5b5f-4c4b-4e4e-9e9e-4f4f4f4f4f4f",
          "depositDisplayId": "102370",
          "depositAmount": "100.00",
          "depositFee": "2.00",
          "bankAccountId": "b2c3d4e5-f6a7-890b-c12d-34ef5678gh90",
          "transactionDate": "2024-08-21T10:30:00Z",
          "clearedDate": "2024-08-22T12:00:00Z",
          "status": "COMPLETED",
          "expectedClearedDate": "2024-08-22T12:00:00Z",
          "cashBalanceDepositType": "CASH_BALANCE",
          "cashBalanceSettlements": [
            {
              "cashBalanceSettlementId": "255f8245-02c7-4817-901e-15fe265f6968",
              "cashBalanceDepositId": "255f8245-02c7-4817-901e-15fe265f6968",
              "availabilityType": "INSTANT",
              "status": "AVAILABLE"
            }
          ]
        }
      ],
      "balances": {
        "cashBalance": {
          "availableBalance": "25.00",
          "totalBalance": "25.00",
          "pendingBalance": "25.00",
          "lifetimeBalance": "25.00",
        },
        "rewardBalance": {
          "availableBalance": "25.00",
          "totalBalance": "25.00",
          "lifetimeBalance": "25.00",
        },
        "giftCardCashBalance": {
          "availableBalance": "25.00",
          "totalBalance": "25.00",
          "pendingBalance": "25.00",
          "lifetimeBalance": "25.00",
        }
      }
    }
  }
}

Deposit Response

Once you initiate a deposit with the depositCashBalance mutation, you will get a response providing details about the deposit.

Field NameTypeDescription
cashBalanceDeposits[CashBalanceDeposit]List of cash balance deposits made as part of the mutation.
balancesUserBalancesThe current balances for the user, including cash balance, rewards balance, and Fluz prepayment balance.

The CashBalanceDeposit object will contain important information about the deposit you initiated.

Field NameTypeDescription
cashBalanceDepositIdUUID!Unique identifier for the cash balance deposit.
depositDisplayIdString!Display identifier for the deposit, intended for user-facing purposes.
depositAmountString!The amount of the deposit.
depositFeeStringFee associated with the deposit, if applicable.
bankCardIdUUIDIdentifier of the bank card used for the deposit.
bankAccountIdUUIDIdentifier of the bank account used for the deposit.
paypalVaultIdUUIDIdentifier of the PayPal vault used for the deposit.
transactionDateDateTime!Date and time when the transaction was made.
clearedDateDateTimeDate and time when the deposit cleared, if applicable.
statusCashBalanceDepositStatus!Current status of the deposit.
expectedClearedDateDateTime!Expected date and time for the deposit to clear.
cashBalanceDepositTypeCashBalanceDepositType!Type of the cash balance deposit, including CASH_BALANCE,GIFT_CARD_PREPAYMENT,RESERVE_BALANCE.
cashBalanceSettlements[CashBalanceSettlement]Settlement time details for the deposit, including status and type.

📘

Please note

Deposits may settle instantly or within 2-5 business days. To learn how settlement times are calculated, read this article.

Updated 3 months ago