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

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.
6. userCashBalanceId - If CASH_BALANCEis selected, you can specify the cash balance (spend account) to deposit your funds
7. memo* - If you want to attach a note to this transaction, provide a free-text memo here. Max 255 characters.
8. transactionCategory - If you want to categorize this transaction, provide a category name. Categories are created automatically on first use and reused if the same name is passed again.
9. attachmentId - If you want to attach a file to this transaction, provide the ID returned by the upload endpoint. See Add Expense Details. 📘 See Add Expense Details for full details on uploading attachments and working with memos and categories.

​

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",
  "userCashBalanceId": "0347ade-2b69-55e6-4db0-5b5daddf45d22"
}

​

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

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