Authorization

API Key

  • Used for securing application management endpoints.
  • Find your API Key in the Developer console. It will also be included automatically when you open the Explorer.
  • Authorization: Basic <API_KEY>

User Access Token

  • Used for securing user operations.
  • Generated from generateAccessToken mutation. Read more about the operations in Explorer.
  • Authorization: Bearer <TOKEN>

Queries

getAccountsByUserId

Description

Get all the accounts information for the User using 'Basic '.

Response

Returns [Account]

Arguments
Name Description
userId - UUID!

Example

Query
query getAccountsByUserId($userId: UUID!) {
  getAccountsByUserId(userId: $userId) {
    accountId
    type
    accountName
    seats {
      ...SeatFragment
    }
    user {
      ...UserFragment
    }
    business {
      ...BusinessFragment
    }
  }
}
Variables
{
  "userId": "1ce811c2-f17b-4800-bbd2-c9362839899d"
}
Response
{
  "data": {
    "getAccountsByUserId": [
      {
        "accountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
        "type": "CONSUMER",
        "accountName": "xyz789",
        "seats": [Seat],
        "user": User,
        "business": Business
      }
    ]
  }
}
Queries

getApplicationScopes

Description

Get the allowed scopes of the application using 'Basic '.

Response

Returns [ScopeType]

Example

Query
query getApplicationScopes {
  getApplicationScopes
}
Response
{"data": {"getApplicationScopes": ["LIST_PAYMENT"]}}
Queries

getApplicationUsers

Description

Get the users who have granted scopes to the application using 'Basic '.

Response

Returns [ApplicationUser]

Arguments
Name Description
paginate - OffsetInput

Example

Query
query getApplicationUsers($paginate: OffsetInput) {
  getApplicationUsers(paginate: $paginate) {
    userId
    scopes
    accounts {
      ...AccountFragment
    }
  }
}
Variables
{"paginate": OffsetInput}
Response
{
  "data": {
    "getApplicationUsers": [
      {
        "userId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
        "scopes": ["LIST_PAYMENT"],
        "accounts": [Account]
      }
    ]
  }
}
Queries

getGiftCards

Description

Retrieves the user's gift cards. Requires LIST_PURCHASES scope.

Response

Returns [GiftCard]

Arguments
Name Description
status - [GiftCardStatus]
paginate - OffsetInput

Example

Query
query getGiftCards(
  $status: [GiftCardStatus],
  $paginate: OffsetInput
) {
  getGiftCards(
    status: $status,
    paginate: $paginate
  ) {
    giftCardId
    purchaserUserId
    endDate
    status
    createdAt
    merchant {
      ...MerchantFragment
    }
  }
}
Variables
{"status": ["ACTIVE"], "paginate": OffsetInput}
Response
{
  "data": {
    "getGiftCards": [
      {
        "giftCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
        "purchaserUserId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
        "endDate": "2007-12-03T10:15:30Z",
        "status": "ACTIVE",
        "createdAt": "2007-12-03T10:15:30Z",
        "merchant": Merchant
      }
    ]
  }
}
Queries

getMccList

Description

Query for listing merchant category codes. Requires MAKE_DEPOSIT scope.

Response

Returns [MerchantCategoryCode]

Arguments
Name Description
paginate - OffsetInput

Example

Query
query getMccList($paginate: OffsetInput) {
  getMccList(paginate: $paginate) {
    code
    displayDescription
    description
  }
}
Variables
{"paginate": OffsetInput}
Response
{
  "data": {
    "getMccList": [
      {
        "code": "abc123",
        "displayDescription": "xyz789",
        "description": "abc123"
      }
    ]
  }
}
Queries

getMerchants

Description

Get the active merchant catalog. Requires LIST_OFFERS scope.

Response

Returns [Merchant]!

Arguments
Name Description
name - String
paginate - OffsetInput
offerTypes - OfferTypesInput
filterBy - FilterByInput Apply fine-grained filters to the offers. Example: { deliveryFormat: URL } will only return merchants that have gift card offers with the URL delivery format.

Example

Query
query getMerchants(
  $name: String,
  $paginate: OffsetInput,
  $offerTypes: OfferTypesInput,
  $filterBy: FilterByInput
) {
  getMerchants(
    name: $name,
    paginate: $paginate,
    offerTypes: $offerTypes,
    filterBy: $filterBy
  ) {
    merchantId
    name
    slug
    offers {
      ...OfferFragment
    }
  }
}
Variables
{
  "name": "abc123",
  "paginate": OffsetInput,
  "offerTypes": OfferTypesInput,
  "filterBy": FilterByInput
}
Response
{
  "data": {
    "getMerchants": [
      {
        "merchantId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
        "name": "xyz789",
        "slug": "xyz789",
        "offers": [Offer]
      }
    ]
  }
}
Queries

getOfferQuote

Description

Get the best offer for merchant based on matching arguments. Requires LIST_OFFERS scope. This requires Fluz to confirm the inventory, response time varies by vendors.

Response

Returns an Offer

Arguments
Name Description
input - GetOfferQuoteInput!

Example

Query
query getOfferQuote($input: GetOfferQuoteInput!) {
  getOfferQuote(input: $input) {
    offeringMerchantId
    offerId
    type
    deliveryFormat
    hasStockInfo
    offerRates {
      ...OfferRateFragment
    }
    denominationsType
    stockInfo {
      ... on StockInfoFixedType {
        ...StockInfoFixedTypeFragment
      }
      ... on StockInfoVariableType {
        ...StockInfoVariableTypeFragment
      }
    }
    cloDetails {
      ...CloDetailsFragment
    }
  }
}
Variables
{"input": GetOfferQuoteInput}
Response
{
  "data": {
    "getOfferQuote": {
      "offeringMerchantId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "offerId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "type": "GIFT_CARD_OFFER",
      "deliveryFormat": "URL",
      "hasStockInfo": true,
      "offerRates": [OfferRate],
      "denominationsType": "VARIABLE",
      "stockInfo": [StockInfoFixedType],
      "cloDetails": CloDetails
    }
  }
}
Queries

getReferralUrl

Description

Get the referral url for a merchant.

Response

Returns a String

Arguments
Name Description
merchant - MerchantInput

Example

Query
query getReferralUrl($merchant: MerchantInput) {
  getReferralUrl(merchant: $merchant)
}
Variables
{"merchant": MerchantInput}
Response
{"data": {"getReferralUrl": "abc123"}}
Queries

getTransactions

Description

Retrieves paginated transaction history for the authenticated user's account. Supports comprehensive filtering and pagination. Requires LIST_PAYMENT and LIST_PURCHASES scope.

Response

Returns a TransactionConnection!

Arguments
Name Description
filter - TransactionFilterInput
paginate - OffsetInput

Example

Query
query getTransactions(
  $filter: TransactionFilterInput,
  $paginate: OffsetInput
) {
  getTransactions(
    filter: $filter,
    paginate: $paginate
  ) {
    transactions {
      ...TransactionFragment
    }
    totalCount
    hasNextPage
  }
}
Variables
{
  "filter": TransactionFilterInput,
  "paginate": OffsetInput
}
Response
{
  "data": {
    "getTransactions": {
      "transactions": [Transaction],
      "totalCount": 123,
      "hasNextPage": true
    }
  }
}
Queries

getUserAddresses

Description

getUserAddresses returns the user's addresses.

Response

Returns [UserAddress]

Arguments
Name Description
paginate - OffsetInput

Example

Query
query getUserAddresses($paginate: OffsetInput) {
  getUserAddresses(paginate: $paginate) {
    userAddressId
    streetAddressLine1
    streetAddressLine2
    country
    city
    state
    postalCode
  }
}
Variables
{"paginate": OffsetInput}
Response
{
  "data": {
    "getUserAddresses": [
      {
        "userAddressId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
        "streetAddressLine1": "xyz789",
        "streetAddressLine2": "xyz789",
        "country": "xyz789",
        "city": "xyz789",
        "state": "abc123",
        "postalCode": "abc123"
      }
    ]
  }
}
Queries

getUserPurchases

Description

Retrieves the user's purchase history. Requires LIST_PURCHASES scope.

Response

Returns [UserPurchase]

Arguments
Name Description
filter - UserPurchaseFilterInput
paginate - OffsetInput

Example

Query
query getUserPurchases(
  $filter: UserPurchaseFilterInput,
  $paginate: OffsetInput
) {
  getUserPurchases(
    filter: $filter,
    paginate: $paginate
  ) {
    purchaseId
    purchaseDisplayId
    purchaseBankCardId
    bankAccountId
    purchaseAmount
    fluzpayAmount
    seatRewardValue
    paypalVaultId
    createdAt
    giftCard {
      ...GiftCardFragment
    }
    virtualCard {
      ...VirtualCardFragment
    }
    accountId
    purchaserUserId
  }
}
Variables
{
  "filter": UserPurchaseFilterInput,
  "paginate": OffsetInput
}
Response
{
  "data": {
    "getUserPurchases": [
      {
        "purchaseId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
        "purchaseDisplayId": "abc123",
        "purchaseBankCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
        "bankAccountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
        "purchaseAmount": 123.45,
        "fluzpayAmount": 987.65,
        "seatRewardValue": 123.45,
        "paypalVaultId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
        "createdAt": "2007-12-03T10:15:30Z",
        "giftCard": GiftCard,
        "virtualCard": VirtualCard,
        "accountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
        "purchaserUserId": "1ce811c2-f17b-4800-bbd2-c9362839899d"
      }
    ]
  }
}
Queries

getVirtualCardBalance

Description

Get balance for multiple virtual cards. Requires PCI_COMPLIANCE and REVEAL_VIRTUALCARD scope.

Response

Returns [VirtualCardBalance!]!

Arguments
Name Description
input - GetVirtualCardBalanceInput!

Example

Query
query getVirtualCardBalance($input: GetVirtualCardBalanceInput!) {
  getVirtualCardBalance(input: $input) {
    virtualCardId
    spentAmount
    remainingBalance
    spendLimit
    spendLimitDuration
  }
}
Variables
{"input": GetVirtualCardBalanceInput}
Response
{
  "data": {
    "getVirtualCardBalance": [
      {
        "virtualCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
        "spentAmount": 123.45,
        "remainingBalance": 123.45,
        "spendLimit": 987.65,
        "spendLimitDuration": "DAILY"
      }
    ]
  }
}
Queries

getVirtualCardBulkOrderStatus

Description

Checks bulk virtual card order status. Requires PCI_COMPLIANCE and REVEAL_VIRTUALCARD scope.

Response

Returns a VirtualCardBulkOrder

Arguments
Name Description
input - GetVirtualCardBulkOrderStatusInput!

Example

Query
query getVirtualCardBulkOrderStatus($input: GetVirtualCardBulkOrderStatusInput!) {
  getVirtualCardBulkOrderStatus(input: $input) {
    orderId
    orderStatus
    virtualCards {
      ...VirtualCardDetailsFragment
    }
    totalCards
    successfulCardCreations
    failedCardCreations
  }
}
Variables
{"input": GetVirtualCardBulkOrderStatusInput}
Response
{
  "data": {
    "getVirtualCardBulkOrderStatus": {
      "orderId": "abc123",
      "orderStatus": "PENDING",
      "virtualCards": [VirtualCardDetails],
      "totalCards": 123,
      "successfulCardCreations": 987,
      "failedCardCreations": 123
    }
  }
}
Queries

getVirtualCardOffers

Description

Get virtual card offers. Requires CREATE_VIRTUALCARD scope.

Response

Returns [VirtualCardOffer]

Arguments
Name Description
input - GetVirtualCardOffersInput

Example

Query
query getVirtualCardOffers($input: GetVirtualCardOffersInput) {
  getVirtualCardOffers(input: $input) {
    offerId
    programName
    bin
    bankName
    programLimits {
      ...ProgramLimitsFragment
    }
    rewardValue
  }
}
Variables
{"input": GetVirtualCardOffersInput}
Response
{
  "data": {
    "getVirtualCardOffers": [
      {
        "offerId": "xyz789",
        "programName": "abc123",
        "bin": "xyz789",
        "bankName": "abc123",
        "programLimits": ProgramLimits,
        "rewardValue": "xyz789"
      }
    ]
  }
}
Queries

getVirtualCardTransactions

Description

Get transactions for multiple virtual cards with filters. Requires PCI_COMPLIANCE and REVEAL_VIRTUALCARD scope.

Response

Returns [VirtualCardTransactions!]!

Arguments
Name Description
input - GetVirtualCardTransactionsInput!

Example

Query
query getVirtualCardTransactions($input: GetVirtualCardTransactionsInput!) {
  getVirtualCardTransactions(input: $input) {
    virtualCardId
    transactions {
      ...VirtualCardTransactionFragment
    }
  }
}
Variables
{"input": GetVirtualCardTransactionsInput}
Response
{
  "data": {
    "getVirtualCardTransactions": [
      {
        "virtualCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
        "transactions": [VirtualCardTransaction]
      }
    ]
  }
}
Queries

getWallet

Description

getWallet returns the user's wallet balance and payment methods.

Response

Returns a GetWalletResponse

Example

Query
query getWallet {
  getWallet {
    bankCards {
      ...BankCardFragment
    }
    bankAccounts {
      ...BankAccountFragment
    }
    paypalAccounts {
      ...PaypalFragment
    }
    blockedPaymentTypes
    balances {
      ...UserBalancesFragment
    }
  }
}
Response
{
  "data": {
    "getWallet": {
      "bankCards": [BankCard],
      "bankAccounts": [BankAccount],
      "paypalAccounts": [Paypal],
      "blockedPaymentTypes": ["BANK_CARD"],
      "balances": UserBalances
    }
  }
}

Mutations

addBankCard

Description

addBankCard adds a bank card to the user's wallet. Requires PCI_COMPLIANCE from the developer and MANAGE_PAYMENT scope. PERSONAL/Private applications are exempt from PCI_COMPLIANCE requirement.

Response

Returns a BankCard

Arguments
Name Description
input - AddBankCardInput!

Example

Query
mutation addBankCard($input: AddBankCardInput!) {
  addBankCard(input: $input) {
    bankCardId
    ownerAccountId
    addedUserId
    cardType
    cardProcessor
    cardholderName
    lastFourDigits
    expirationMonth
    expirationYear
    cardStatus
    billingAddressId
    nickname
  }
}
Variables
{"input": AddBankCardInput}
Response
{
  "data": {
    "addBankCard": {
      "bankCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "ownerAccountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "addedUserId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "cardType": "DEBIT",
      "cardProcessor": "abc123",
      "cardholderName": "abc123",
      "lastFourDigits": "xyz789",
      "expirationMonth": "xyz789",
      "expirationYear": "abc123",
      "cardStatus": "ACTIVE",
      "billingAddressId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "nickname": "xyz789"
    }
  }
}
Mutations

createTransfer

Description

Create a transfer between two accounts. Requires directional transfer scope based on your role in the transfer.

Response

Returns a CreateTransferResponse

Arguments
Name Description
input - CreateTransferInput!

Example

Query
mutation createTransfer($input: CreateTransferInput!) {
  createTransfer(input: $input) {
    success
    message
    transferId
  }
}
Variables
{"input": CreateTransferInput}
Response
{
  "data": {
    "createTransfer": {
      "success": false,
      "message": "abc123",
      "transferId": "1ce811c2-f17b-4800-bbd2-c9362839899d"
    }
  }
}
Mutations

createUserCashBalance

Description

Mutation for creating a new user cash balance account. Requires MANAGE_PAYMENT scope.

Response

Returns a UserCashBalance!

Arguments
Name Description
input - CreateUserCashBalanceInput!

Example

Query
mutation createUserCashBalance($input: CreateUserCashBalanceInput!) {
  createUserCashBalance(input: $input) {
    userCashBalanceId
    totalCashBalance
    availableCashBalance
    lifetimeCashBalance
    nickname
    status
    createdAt
  }
}
Variables
{"input": CreateUserCashBalanceInput}
Response
{
  "data": {
    "createUserCashBalance": {
      "userCashBalanceId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "totalCashBalance": "abc123",
      "availableCashBalance": "abc123",
      "lifetimeCashBalance": "xyz789",
      "nickname": "xyz789",
      "status": "ACTIVE",
      "createdAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

createVirtualCard

Description

Initiates virtual card creation. Requires CREATE_VIRTUALCARD scope. @throws INVALID_INPUT if:

  • idempotency key is not provided
  • spendLimit less than 5
  • lockDate is in the past
  • spendLimit is not within card program limit
  • offerId is defined and is in uuid format
Response

Returns a VirtualCard

Arguments
Name Description
input - CreateVirtualCardInput!

Example

Query
mutation createVirtualCard($input: CreateVirtualCardInput!) {
  createVirtualCard(input: $input) {
    virtualCardId
    userId
    cardholderName
    expiryMonth
    expiryYear
    virtualCardLast4
    status
    cardType
    initialAmount
    usedAmount
    createdAt
    authorizationSetting {
      ...VirtualCardAuthorizationSettingFragment
    }
  }
}
Variables
{"input": CreateVirtualCardInput}
Response
{
  "data": {
    "createVirtualCard": {
      "virtualCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "userId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "cardholderName": "abc123",
      "expiryMonth": "xyz789",
      "expiryYear": "xyz789",
      "virtualCardLast4": "abc123",
      "status": "PENDING",
      "cardType": "MULTI_USE",
      "initialAmount": 987.65,
      "usedAmount": 123.45,
      "createdAt": "2007-12-03T10:15:30Z",
      "authorizationSetting": VirtualCardAuthorizationSetting
    }
  }
}
Mutations

createVirtualCardBulkOrder

Description

Initiates bulk virtual card creation. Requires CREATE_VIRTUALCARD scope.

Response

Returns a VirtualCardBulkOrder

Arguments
Name Description
input - CreateVirtualCardBulkOrderInput!

Example

Query
mutation createVirtualCardBulkOrder($input: CreateVirtualCardBulkOrderInput!) {
  createVirtualCardBulkOrder(input: $input) {
    orderId
    orderStatus
    virtualCards {
      ...VirtualCardDetailsFragment
    }
    totalCards
    successfulCardCreations
    failedCardCreations
  }
}
Variables
{"input": CreateVirtualCardBulkOrderInput}
Response
{
  "data": {
    "createVirtualCardBulkOrder": {
      "orderId": "xyz789",
      "orderStatus": "PENDING",
      "virtualCards": [VirtualCardDetails],
      "totalCards": 987,
      "successfulCardCreations": 987,
      "failedCardCreations": 123
    }
  }
}
Mutations

deleteBankCard

Description

deleteBankCard set a bank card's status to INACTIVE. Requires MANAGE_PAYMENT scope.

Response

Returns a BankCard

Arguments
Name Description
input - DeleteBankCardInput!

Example

Query
mutation deleteBankCard($input: DeleteBankCardInput!) {
  deleteBankCard(input: $input) {
    bankCardId
    ownerAccountId
    addedUserId
    cardType
    cardProcessor
    cardholderName
    lastFourDigits
    expirationMonth
    expirationYear
    cardStatus
    billingAddressId
    nickname
  }
}
Variables
{"input": DeleteBankCardInput}
Response
{
  "data": {
    "deleteBankCard": {
      "bankCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "ownerAccountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "addedUserId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "cardType": "DEBIT",
      "cardProcessor": "abc123",
      "cardholderName": "xyz789",
      "lastFourDigits": "abc123",
      "expirationMonth": "xyz789",
      "expirationYear": "xyz789",
      "cardStatus": "ACTIVE",
      "billingAddressId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "nickname": "xyz789"
    }
  }
}
Mutations

depositCashBalance

Description

Mutation for depositing into a cash balance. Requires MAKE_DEPOSIT scope.

Response

Returns a DepositCashBalanceResponse!

Arguments
Name Description
input - DepositCashBalanceInput!

Example

Query
mutation depositCashBalance($input: DepositCashBalanceInput!) {
  depositCashBalance(input: $input) {
    cashBalanceDeposits {
      ...CashBalanceDepositFragment
    }
    balances {
      ...UserBalancesFragment
    }
  }
}
Variables
{"input": DepositCashBalanceInput}
Response
{
  "data": {
    "depositCashBalance": {
      "cashBalanceDeposits": [CashBalanceDeposit],
      "balances": UserBalances
    }
  }
}
Mutations

editVirtualCard

Description

Mutation to edit virtual cards. Requires EDIT_VIRTUALCARD scope.

Response

Returns a VirtualCard

Arguments
Name Description
input - EditVirtualCardInput!

Example

Query
mutation editVirtualCard($input: EditVirtualCardInput!) {
  editVirtualCard(input: $input) {
    virtualCardId
    userId
    cardholderName
    expiryMonth
    expiryYear
    virtualCardLast4
    status
    cardType
    initialAmount
    usedAmount
    createdAt
    authorizationSetting {
      ...VirtualCardAuthorizationSettingFragment
    }
  }
}
Variables
{"input": EditVirtualCardInput}
Response
{
  "data": {
    "editVirtualCard": {
      "virtualCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "userId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "cardholderName": "abc123",
      "expiryMonth": "abc123",
      "expiryYear": "xyz789",
      "virtualCardLast4": "xyz789",
      "status": "PENDING",
      "cardType": "MULTI_USE",
      "initialAmount": 987.65,
      "usedAmount": 123.45,
      "createdAt": "2007-12-03T10:15:30Z",
      "authorizationSetting": VirtualCardAuthorizationSetting
    }
  }
}
Mutations

generateUserAccessToken

Description

Generate a user token using 'Basic '. The token will be associated with the user_id and will have the specified scopes.

Response

Returns a GenerateUserAccessTokenResponse

Arguments
Name Description
userId - UUID! The userId that will be associated with the token.
accountId - UUID! The accountId that will be associated with the token.
scopes - [ScopeType!]! The scopes that the token will have access to.
seatId - UUID The seatId will be used to make transactions, default to the most recently created if not provided.

Example

Query
mutation generateUserAccessToken(
  $userId: UUID!,
  $accountId: UUID!,
  $scopes: [ScopeType!]!,
  $seatId: UUID
) {
  generateUserAccessToken(
    userId: $userId,
    accountId: $accountId,
    scopes: $scopes,
    seatId: $seatId
  ) {
    token
    refreshToken
    scopes
  }
}
Variables
{
  "userId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "accountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "scopes": ["LIST_PAYMENT"],
  "seatId": "1ce811c2-f17b-4800-bbd2-c9362839899d"
}
Response
{
  "data": {
    "generateUserAccessToken": {
      "token": "abc123",
      "refreshToken": "abc123",
      "scopes": ["LIST_PAYMENT"]
    }
  }
}
Mutations

lockVirtualCard

Description

Mutation to lock virtual cards. Requires EDIT_VIRTUALCARD scope.

Response

Returns a LockVirtualCardResponse

Arguments
Name Description
input - LockVirtualCardInput!

Example

Query
mutation lockVirtualCard($input: LockVirtualCardInput!) {
  lockVirtualCard(input: $input) {
    virtualCardId
    locked
  }
}
Variables
{"input": LockVirtualCardInput}
Response
{
  "data": {
    "lockVirtualCard": {
      "virtualCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "locked": true
    }
  }
}
Mutations

purchaseGiftCard

Description

Initiates a gift card purchase transaction. Requires PURCHASE_GIFTCARD scope. The offerId or merchantSlug fields cannot both be empty. If both are provided, offerId will be used.

Response

Returns a UserPurchase

Arguments
Name Description
input - PurchaseGiftCardInput!

Example

Query
mutation purchaseGiftCard($input: PurchaseGiftCardInput!) {
  purchaseGiftCard(input: $input) {
    purchaseId
    purchaseDisplayId
    purchaseBankCardId
    bankAccountId
    purchaseAmount
    fluzpayAmount
    seatRewardValue
    paypalVaultId
    createdAt
    giftCard {
      ...GiftCardFragment
    }
    virtualCard {
      ...VirtualCardFragment
    }
    accountId
    purchaserUserId
  }
}
Variables
{"input": PurchaseGiftCardInput}
Response
{
  "data": {
    "purchaseGiftCard": {
      "purchaseId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "purchaseDisplayId": "xyz789",
      "purchaseBankCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "bankAccountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "purchaseAmount": 987.65,
      "fluzpayAmount": 123.45,
      "seatRewardValue": 987.65,
      "paypalVaultId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "createdAt": "2007-12-03T10:15:30Z",
      "giftCard": GiftCard,
      "virtualCard": VirtualCard,
      "accountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "purchaserUserId": "1ce811c2-f17b-4800-bbd2-c9362839899d"
    }
  }
}
Mutations

refreshUserAccessToken

Description

Refresh a user token using 'Basic '. The token will be associated with the user_id and will have the specified scopes.

Response

Returns a RefreshUserAccessTokenResponse

Arguments
Name Description
refreshToken - String! The refreshToken issued to get a new access token.

Example

Query
mutation refreshUserAccessToken($refreshToken: String!) {
  refreshUserAccessToken(refreshToken: $refreshToken) {
    token
    scopes
  }
}
Variables
{"refreshToken": "xyz789"}
Response
{
  "data": {
    "refreshUserAccessToken": {
      "token": "xyz789",
      "scopes": ["LIST_PAYMENT"]
    }
  }
}
Mutations

registerUser

Description

Registration of a user. Requires special permission from Fluz to enable. Please contact support to enable this feature if needed.

Response

Returns a RegisterUserResponse

Arguments
Name Description
firstName - String! The first name of user for registration.
lastName - String! The last name of user for registration.
phoneNumber - String! The phone number name of user for registration.
regionCode - String! The region code of phone number for registration.
emailAddress - String! The email of user for registration.
dateOfBirth - String! The date of birth of user for registration.

Example

Query
mutation registerUser(
  $firstName: String!,
  $lastName: String!,
  $phoneNumber: String!,
  $regionCode: String!,
  $emailAddress: String!,
  $dateOfBirth: String!
) {
  registerUser(
    firstName: $firstName,
    lastName: $lastName,
    phoneNumber: $phoneNumber,
    regionCode: $regionCode,
    emailAddress: $emailAddress,
    dateOfBirth: $dateOfBirth
  ) {
    success
    error {
      ...RegisterUserErrorFragment
    }
  }
}
Variables
{
  "firstName": "abc123",
  "lastName": "xyz789",
  "phoneNumber": "xyz789",
  "regionCode": "abc123",
  "emailAddress": "xyz789",
  "dateOfBirth": "abc123"
}
Response
{
  "data": {
    "registerUser": {
      "success": true,
      "error": RegisterUserError
    }
  }
}
Mutations

revealGiftCardByGiftCardId

Description

Reveals the Gift Card Code. It has an irreversible effect on the Gift Card status. Requires REVEAL_GIFTCARD scope.

Response

Returns a GiftCardCode

Arguments
Name Description
giftCardId - UUID!

Example

Query
mutation revealGiftCardByGiftCardId($giftCardId: UUID!) {
  revealGiftCardByGiftCardId(giftCardId: $giftCardId) {
    code
    pin
    url
  }
}
Variables
{
  "giftCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d"
}
Response
{
  "data": {
    "revealGiftCardByGiftCardId": {
      "code": "xyz789",
      "pin": "xyz789",
      "url": "abc123"
    }
  }
}
Mutations

revealVirtualCardByVirtualCardId

Description

Reveals the full card number and CVV of a virtual card, along with its billing details. Requires PCI_COMPLIANCE from the developer and REVEAL_VIRTUALCARD scope. PERSONAL/Private applications are exempt from PCI_COMPLIANCE requirement.

Response

Returns a VirtualCardDetails

Arguments
Name Description
virtualCardId - UUID!

Example

Query
mutation revealVirtualCardByVirtualCardId($virtualCardId: UUID!) {
  revealVirtualCardByVirtualCardId(virtualCardId: $virtualCardId) {
    virtualCardId
    cardNumber
    expiryMMYY
    cvv
    cardHolderName
    billingAddress {
      ...VirtualCardAddressInfoFragment
    }
    authorizationSetting {
      ...VirtualCardAuthorizationSettingFragment
    }
  }
}
Variables
{
  "virtualCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d"
}
Response
{
  "data": {
    "revealVirtualCardByVirtualCardId": {
      "virtualCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "cardNumber": "xyz789",
      "expiryMMYY": "xyz789",
      "cvv": "abc123",
      "cardHolderName": "abc123",
      "billingAddress": VirtualCardAddressInfo,
      "authorizationSetting": VirtualCardAuthorizationSetting
    }
  }
}
Mutations

updateBankCardNickname

Description

updateBankCardNickname updates the nickname of a bank card. Requires MANAGE_PAYMENT scope.

Response

Returns a BankCard

Arguments
Name Description
input - UpdateBankCardNicknameInput!

Example

Query
mutation updateBankCardNickname($input: UpdateBankCardNicknameInput!) {
  updateBankCardNickname(input: $input) {
    bankCardId
    ownerAccountId
    addedUserId
    cardType
    cardProcessor
    cardholderName
    lastFourDigits
    expirationMonth
    expirationYear
    cardStatus
    billingAddressId
    nickname
  }
}
Variables
{"input": UpdateBankCardNicknameInput}
Response
{
  "data": {
    "updateBankCardNickname": {
      "bankCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "ownerAccountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "addedUserId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "cardType": "DEBIT",
      "cardProcessor": "abc123",
      "cardholderName": "xyz789",
      "lastFourDigits": "abc123",
      "expirationMonth": "abc123",
      "expirationYear": "xyz789",
      "cardStatus": "ACTIVE",
      "billingAddressId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "nickname": "xyz789"
    }
  }
}
Mutations

updateBankCardPreferredMerchantCategoryCode

Description

updateBankCardPreferredMerchantCategoryCode updates the preferred merchant category code (MCC) for a bank card. Requires MANAGE_PAYMENT scope.

Response

Returns a BankCard

Arguments
Name Description
input - UpdateBankCardPreferredMerchantCategoryCodeInput!

Example

Query
mutation updateBankCardPreferredMerchantCategoryCode($input: UpdateBankCardPreferredMerchantCategoryCodeInput!) {
  updateBankCardPreferredMerchantCategoryCode(input: $input) {
    bankCardId
    ownerAccountId
    addedUserId
    cardType
    cardProcessor
    cardholderName
    lastFourDigits
    expirationMonth
    expirationYear
    cardStatus
    billingAddressId
    nickname
  }
}
Variables
{
  "input": UpdateBankCardPreferredMerchantCategoryCodeInput
}
Response
{
  "data": {
    "updateBankCardPreferredMerchantCategoryCode": {
      "bankCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "ownerAccountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "addedUserId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "cardType": "DEBIT",
      "cardProcessor": "xyz789",
      "cardholderName": "abc123",
      "lastFourDigits": "abc123",
      "expirationMonth": "abc123",
      "expirationYear": "xyz789",
      "cardStatus": "ACTIVE",
      "billingAddressId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
      "nickname": "abc123"
    }
  }
}
Mutations

verifyUserInformation

Description

Verify and record a user's personal information.

Response

Returns a VerifyUserInformationResponse

Arguments
Name Description
firstName - String! The Fluz user's first name.
lastName - String! The Fluz user's last name.
streetLine1 - String! The street address line 1.
streetLine2 - String The street address line 2.
city - String! The address city.
state - String! The address state.
postalCode - String! The postal code.
country - String! The address country.
dateOfBirth - String! The user's date of birth (format MM/DD/YYYY).
ssnLast4 - String! The user's SSN last 4 digits.

Example

Query
mutation verifyUserInformation(
  $firstName: String!,
  $lastName: String!,
  $streetLine1: String!,
  $streetLine2: String,
  $city: String!,
  $state: String!,
  $postalCode: String!,
  $country: String!,
  $dateOfBirth: String!,
  $ssnLast4: String!
) {
  verifyUserInformation(
    firstName: $firstName,
    lastName: $lastName,
    streetLine1: $streetLine1,
    streetLine2: $streetLine2,
    city: $city,
    state: $state,
    postalCode: $postalCode,
    country: $country,
    dateOfBirth: $dateOfBirth,
    ssnLast4: $ssnLast4
  ) {
    status
    message
  }
}
Variables
{
  "firstName": "xyz789",
  "lastName": "xyz789",
  "streetLine1": "abc123",
  "streetLine2": "abc123",
  "city": "xyz789",
  "state": "xyz789",
  "postalCode": "xyz789",
  "country": "abc123",
  "dateOfBirth": "abc123",
  "ssnLast4": "xyz789"
}
Response
{
  "data": {
    "verifyUserInformation": {
      "status": "APPROVED",
      "message": "abc123"
    }
  }
}
Mutations

withdrawCashBalance

Description

Mutation for withdrawing from a cash balance. Requires MAKE_WITHDRAWAL scope.

Response

Returns a WithdrawCashBalanceResponse!

Arguments
Name Description
input - WithdrawCashBalanceInput!

Example

Query
mutation withdrawCashBalance($input: WithdrawCashBalanceInput!) {
  withdrawCashBalance(input: $input) {
    withdraws {
      ...WithdrawFragment
    }
    balances {
      ...UserBalancesFragment
    }
  }
}
Variables
{"input": WithdrawCashBalanceInput}
Response
{
  "data": {
    "withdrawCashBalance": {
      "withdraws": [Withdraw],
      "balances": UserBalances
    }
  }
}

SCALAR

Boolean

Description

The Boolean scalar type represents true or false.

SCALAR

DateTime

Description

A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.

Example
"2007-12-03T10:15:30Z"
SCALAR

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
987.65
SCALAR

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
987
SCALAR

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"xyz789"
SCALAR

UUID

Description

A version 4 UUID is randomly generated. 4 bits are used to indicate version 4, and 2 or 3 bits to indicate the variant (102 or 1102 for variants 1 and 2 respectively)

Example
"1ce811c2-f17b-4800-bbd2-c9362839899d"

INPUT_OBJECT

AddBankCardInput

Description

Input type for adding a bank card to the user's wallet.

Fields
Input Field Description
cardNumber - String! The card number.
expirationMonth - String! The expiration month in the format MM.
expirationYear - String! The expiration year in the format YYYY.
cvv - String! The three- or four-digit security numbers.
cardholderName - String! The name of the cardholder.
billingAddress - UserAddressInput Create the card with a new address.
userAddressId - UUID Create the card with an existing user address.
preferredMerchantCategoryCode - String Create the card with preferred mcc category.
nickname - String Create the card with nickname.
Example
{
  "cardNumber": "abc123",
  "expirationMonth": "xyz789",
  "expirationYear": "xyz789",
  "cvv": "xyz789",
  "cardholderName": "abc123",
  "billingAddress": UserAddressInput,
  "userAddressId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "preferredMerchantCategoryCode": "xyz789",
  "nickname": "xyz789"
}
INPUT_OBJECT

CreateTransferInput

Description

Represents the request payload for creating a transfer. All account and balance IDs are automatically inferred from the OAuth token and application settings.

Fields
Input Field Description
idempotencyKey - UUID! A unique client generated UUID to ensure a request is processed only once.
direction - TransferDirection! Transfer direction from user's perspective. RECEIVE: Operator sends money to user (application/operator → user) SEND: User sends money to operator (user → application/operator)
amount - Float! The amount to transfer (must be positive).
bankCardId - UUID Optional: Bank card ID to fund the transfer (alternative to using Fluz balance). Only applicable when direction is SEND (user sending to operator). If provided, funds are charged from this card and transferred.
bankAccountId - UUID Optional: Bank account ID to fund the transfer via ACH (alternative to using Fluz balance). Only applicable when direction is SEND (user sending to operator).
paypalVaultId - UUID Optional: PayPal vault ID to fund the transfer via PayPal (alternative to using Fluz balance). Only applicable when direction is SEND (user sending to operator).
Example
{
  "idempotencyKey": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "direction": "RECEIVE",
  "amount": 987.65,
  "bankCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "bankAccountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "paypalVaultId": "1ce811c2-f17b-4800-bbd2-c9362839899d"
}
INPUT_OBJECT

CreateUserCashBalanceInput

Description

Input type for creating a new user cash balance account.

Fields
Input Field Description
nickname - String! Nickname for the cash balance account.
Example
{"nickname": "xyz789"}
INPUT_OBJECT

CreateVirtualCardBulkOrderInput

Fields
Input Field Description
offerId - UUID! The Offer Id of Virtual Card Offer. This offer will be applied to all cards created in this order.
orderItems - [VirtualCardOrderItemInput!]! A list of configurations for the virtual cards to be created. Each item in this list represents a group of one or more cards with identical settings. The total number of cards across all items cannot exceed 100.
Example
{
  "offerId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "orderItems": [VirtualCardOrderItemInput]
}
INPUT_OBJECT

CreateVirtualCardInput

Description

Input type for creating virtual cards.

Fields
Input Field Description
idempotencyKey - UUID! A unique client generated UUID to ensure a request is processed only once.
spendLimit - Float! The maximum amount that you can charge to the card. You will only be charged for the amount you actually used.
spendLimitDuration - VirtualCardSpendLimitDuration Card limit duration type. Default Lifetime.
lockDate - String The date when the card will be locked. The default is 47 months.
lockCardNextUse - Boolean The setting to lock the card after next use. The default is false.
cardNickname - String The card's nickname.
primaryFundingSource - VirtualCardFundingSource Primary Funding Source for Virtual Card.
bankAccountId - UUID The unique identifier for the bank account.
offerId - UUID The Offer Id of Virtual Card Offer. Use getVirtualCardOffers to fetch a list of active offers.
userCashBalanceId - UUID The unique identifier of the user cash balance id
Example
{
  "idempotencyKey": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "spendLimit": 987.65,
  "spendLimitDuration": "DAILY",
  "lockDate": "xyz789",
  "lockCardNextUse": false,
  "cardNickname": "xyz789",
  "primaryFundingSource": "FLUZ_BALANCE",
  "bankAccountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "offerId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "userCashBalanceId": "1ce811c2-f17b-4800-bbd2-c9362839899d"
}
INPUT_OBJECT

DeleteBankCardInput

Description

Input type for deleting a bank card.

Fields
Input Field Description
bankCardId - UUID! The ID of the bank card to delete.
Example
{
  "bankCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d"
}
INPUT_OBJECT

DepositCashBalanceInput

Description

Input type for depositing cash balance, specifying the amount and deposit type.

Fields
Input Field Description
idempotencyKey - UUID! A unique client generated UUID to ensure a request is processed only once.
amount - Float! The amount deposited.
depositType - CashBalanceDepositType Type of the deposit being made.
merchantCategoryCode - Int A four-digit number that classifies a business by the type of products or services it offers
bankAccountId - UUID Identifier of the bank account for the deposit.
bankCardId - UUID Identifier of the bank card for the deposit.
paypalVaultId - UUID Identifier of the PayPal ID for the deposit.
userCashBalanceId - UUID Identifier of the UserCashBalance for the deposit. Ignored if depositType is not CASH_BALANCE
Example
{
  "idempotencyKey": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "amount": 123.45,
  "depositType": "CASH_BALANCE",
  "merchantCategoryCode": 123,
  "bankAccountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "bankCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "paypalVaultId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "userCashBalanceId": "1ce811c2-f17b-4800-bbd2-c9362839899d"
}
INPUT_OBJECT

EditVirtualCardInput

Description

Input type for edit virtual card.

Fields
Input Field Description
virtualCardId - UUID! The virtual card to update.
spendLimit - Float The maximum amount that you can charge to the card. You will only be charged for the amount you actually used.
spendLimitDuration - VirtualCardSpendLimitDuration Card limit duration type.
lockDate - String The date when the card will be locked.
lockCardNextUse - Boolean The setting to lock the card after next use.
cardNickname - String The card's nickname.
bankAccountId - UUID The bank account ID.
primaryFundingSource - VirtualCardFundingSource Primary Funding Source for Virtual Card.
Example
{
  "virtualCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "spendLimit": 987.65,
  "spendLimitDuration": "DAILY",
  "lockDate": "abc123",
  "lockCardNextUse": false,
  "cardNickname": "abc123",
  "bankAccountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "primaryFundingSource": "FLUZ_BALANCE"
}
INPUT_OBJECT

FilterByInput

Description

Input for applying fine-grained filters on offer attributes. This will filter the offers within a merchant. If all of a merchant's offers are filtered out, the merchant itself will be excluded.

Fields
Input Field Description
deliveryFormat - DeliveryFormatType Filters gift card offers by their delivery format.
Example
{"deliveryFormat": "URL"}
INPUT_OBJECT

GetOfferQuoteInput

Fields
Input Field Description
merchantSlug - String! Human readable unique identifier for merchant. Can be found in merchant list.
denomination - Float! The purchase amount
paymentMethod - PaymentMethodType The payment method to be used for the purchase. Default is FLUZPAY
Example
{
  "merchantSlug": "xyz789",
  "denomination": 123.45,
  "paymentMethod": "BANK_CARD"
}
INPUT_OBJECT

GetVirtualCardBalanceInput

Description

Input type for get virtual card balance.

Fields
Input Field Description
virtualCardIds - [UUID!]! The virtual card ids to fetch balances.
Example
{
  "virtualCardIds": [
    "1ce811c2-f17b-4800-bbd2-c9362839899d"
  ]
}
INPUT_OBJECT

GetVirtualCardBulkOrderStatusInput

Description

Input type for get bulk virtual card creation order.

Fields
Input Field Description
orderId - String!
Example
{"orderId": "abc123"}
INPUT_OBJECT

GetVirtualCardOffersInput

Description

Input type for get virtual card offers.

Fields
Input Field Description
cardBrandLocked - Boolean Specify if virtual card offers are brand locked.
cardType - VirtualCardOfferType Specify virtual card network type.
cardNetwork - VirtualCardNetwork Specify virtual card network type.
Example
{"cardBrandLocked": false, "cardType": "DEBIT", "cardNetwork": "MASTERCARD"}
INPUT_OBJECT

GetVirtualCardTransactionsInput

Description

Input type for fetching transactions for multiple virtual cards.

Fields
Input Field Description
virtualCardIds - [UUID!]! A list of virtual card IDs to fetch transactions for.
filters - VirtualCardTransactionFiltersInput Filters to apply to the transaction data, such as date range or transaction type.
paginate - OffsetInput Pagination settings for the results, including offset and limit.
Example
{
  "virtualCardIds": [
    "1ce811c2-f17b-4800-bbd2-c9362839899d"
  ],
  "filters": VirtualCardTransactionFiltersInput,
  "paginate": OffsetInput
}
INPUT_OBJECT

LockVirtualCardInput

Description

Input type for lock virtual card.

Fields
Input Field Description
virtualCardId - UUID! The virtual card to update.
Example
{
  "virtualCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d"
}
INPUT_OBJECT

MerchantInput

Description

Input type for getReferralUrl.

Fields
Input Field Description
id - UUID The unique identifier for the merchant.
slug - String Human readable unique identifier for merchant. Can be found in merchant list.
name - String Merchant name
Example
{
  "id": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "slug": "abc123",
  "name": "abc123"
}
INPUT_OBJECT

OfferTypesInput

Description

Input type for getMerchants.

Fields
Input Field Description
giftCardOffer - Boolean
cardLinkedOffer - Boolean
Example
{"giftCardOffer": true, "cardLinkedOffer": true}
INPUT_OBJECT

OffsetInput

Description

The page info.

Fields
Input Field Description
limit - Int The number of items to return per page. The maximum for limit is 20. Default = 20
offset - Int The number of items to skip. Default = 0
Example
{"limit": 987, "offset": 987}
INPUT_OBJECT

PurchaseGiftCardInput

Description

Input type for purchase gift card.

Fields
Input Field Description
idempotencyKey - UUID! A unique client generated UUID to ensure a request is processed only once.
offerId - UUID The unique identifier for the offer.
amount - Float! The amount to purchase.
balanceAmount - Float The balance amount.
bankAccountId - UUID The unique identifier for the bank account.
bankCardId - UUID The unique identifier of the bank card.
paypalVaultId - UUID The unique identifier of the PayPal account.
exclusiveRateId - UUID The unique identifier of the exclusive rate.
merchantSlug - String Human readable unique identifier for merchant. Can be found in merchant list.
defaultToBalance - Boolean Use balance as the fallback payment method if the primary payment method fails. Defaults to true.
minRewardRate - Float The minimum reward rate to purchase if merchantSlug option is chosen.
userCashBalanceId - UUID The unique identifier of the user cash balance id used for this purchase
Example
{
  "idempotencyKey": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "offerId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "amount": 987.65,
  "balanceAmount": 123.45,
  "bankAccountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "bankCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "paypalVaultId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "exclusiveRateId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "merchantSlug": "xyz789",
  "defaultToBalance": true,
  "minRewardRate": 987.65,
  "userCashBalanceId": "1ce811c2-f17b-4800-bbd2-c9362839899d"
}
INPUT_OBJECT

TransactionFilterInput

Description

Input filter for querying transactions.

Fields
Input Field Description
recordId - [UUID] Filter by specific transaction record IDs.
status - [TransactionStatus] Filter by transaction status.
amount - Float Filter by exact amount.
amountGte - Float Filter by minimum amount (greater than or equal).
amountLte - Float Filter by maximum amount (less than or equal).
cashbackAmount - Float Filter by exact cashback amount.
cashbackAmountGte - Float Filter by minimum cashback amount.
cashbackAmountLte - Float Filter by maximum cashback amount.
cashbackPercentage - Float Filter by exact cashback percentage.
cashbackPercentageGte - Float Filter by minimum cashback percentage.
cashbackPercentageLte - Float Filter by maximum cashback percentage.
feeAmount - Float Filter by exact fee amount.
feeAmountGte - Float Filter by minimum fee amount.
feeAmountLte - Float Filter by maximum fee amount.
createdGte - DateTime Filter by creation date (greater than or equal).
createdLte - DateTime Filter by creation date (less than or equal).
updatedGte - DateTime Filter by update date (greater than or equal).
updatedLte - DateTime Filter by update date (less than or equal).
merchantId - [UUID] Filter by merchant IDs.
merchant - [String] Filter by merchant names (destination field).
transactionType - [String] Filter by transaction types.
channel - [String!] Filter by channel.
category - [String] Filter by transaction category.
virtualCardProgram - [String] Filter by virtual card program.
virtualCard - [UUID] Filter by specific virtual card IDs.
fundingSource - [String] Filter by funding source names.
referenceId - String Filter by reference ID.
liabilityId - UUID Filter by liability ID (for bill payments).
Example
{
  "recordId": [
    "1ce811c2-f17b-4800-bbd2-c9362839899d"
  ],
  "status": ["PENDING"],
  "amount": 987.65,
  "amountGte": 987.65,
  "amountLte": 987.65,
  "cashbackAmount": 123.45,
  "cashbackAmountGte": 987.65,
  "cashbackAmountLte": 987.65,
  "cashbackPercentage": 987.65,
  "cashbackPercentageGte": 123.45,
  "cashbackPercentageLte": 987.65,
  "feeAmount": 987.65,
  "feeAmountGte": 123.45,
  "feeAmountLte": 987.65,
  "createdGte": "2007-12-03T10:15:30Z",
  "createdLte": "2007-12-03T10:15:30Z",
  "updatedGte": "2007-12-03T10:15:30Z",
  "updatedLte": "2007-12-03T10:15:30Z",
  "merchantId": [
    "1ce811c2-f17b-4800-bbd2-c9362839899d"
  ],
  "merchant": ["xyz789"],
  "transactionType": ["xyz789"],
  "channel": ["abc123"],
  "category": ["abc123"],
  "virtualCardProgram": ["xyz789"],
  "virtualCard": [
    "1ce811c2-f17b-4800-bbd2-c9362839899d"
  ],
  "fundingSource": ["xyz789"],
  "referenceId": "xyz789",
  "liabilityId": "1ce811c2-f17b-4800-bbd2-c9362839899d"
}
INPUT_OBJECT

UpdateBankCardNicknameInput

Description

Input type for updating a bank card's nickname.

Fields
Input Field Description
bankCardId - UUID! The ID of the bank card to update.
nickname - String! The nickname for the bank card.
Example
{
  "bankCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "nickname": "abc123"
}
INPUT_OBJECT

UpdateBankCardPreferredMerchantCategoryCodeInput

Description

Input type for updating a bank card's preferred merchant category code.

Fields
Input Field Description
bankCardId - UUID! The ID of the bank card to update.
preferredMerchantCategoryCode - String! The preferred merchant category code for the bank card.
Example
{
  "bankCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "preferredMerchantCategoryCode": "abc123"
}
INPUT_OBJECT

UserAddressInput

Description

Input type for adding an address to the user.

Fields
Input Field Description
streetAddressLine1 - String!
streetAddressLine2 - String
country - String!
city - String!
state - String!
postalCode - String
Example
{
  "streetAddressLine1": "abc123",
  "streetAddressLine2": "abc123",
  "country": "abc123",
  "city": "abc123",
  "state": "xyz789",
  "postalCode": "xyz789"
}
INPUT_OBJECT

UserPurchaseFilterInput

Description

Input filter type for getUserPurchases

  • Default [TOKEN_USER].
Fields
Input Field Description
scope - [PurchaseScopeFilter!]
Example
{"scope": ["TOKEN_USER"]}
INPUT_OBJECT

VirtualCardOrderItemInput

Fields
Input Field Description
quantity - Int! The number of virtual cards to create with this specific configuration.
spendLimit - Float! The maximum amount that you can charge to the card. You will only be charged for the amount you actually used.
spendLimitDuration - VirtualCardSpendLimitDuration Card limit duration type. Default is Lifetime.
lockDate - String The date when the card will be locked. The default is 47 months.
lockCardNextUse - Boolean The setting to lock the card after next use. The default is false.
cardNickname - String The card's nickname. This nickname will be applied to all cards in this item.
primaryFundingSource - VirtualCardFundingSource Primary Funding Source for Virtual Card.
bankAccountId - UUID The unique identifier for the bank account.
userCashBalanceId - UUID The unique identifier of the user cash balance id
Example
{
  "quantity": 987,
  "spendLimit": 123.45,
  "spendLimitDuration": "DAILY",
  "lockDate": "abc123",
  "lockCardNextUse": false,
  "cardNickname": "abc123",
  "primaryFundingSource": "FLUZ_BALANCE",
  "bankAccountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "userCashBalanceId": "1ce811c2-f17b-4800-bbd2-c9362839899d"
}
INPUT_OBJECT

VirtualCardTransactionFiltersInput

Description

Input type for filtering virtual card transactions.

Fields
Input Field Description
transactionTypes - [VirtualCardTransactionListType!] A list of transaction types to filter by (e.g., PURCHASE, REFUND).
Example
{"transactionTypes": ["PURCHASE"]}
INPUT_OBJECT

WithdrawCashBalanceInput

Fields
Input Field Description
idempotencyKey - UUID! A unique client generated UUID to ensure a request is processed only once.
amount - Float! The amount to withdraw.
method - WithdrawMethods! The withdrawal method to use.
source - WithdrawSource The source balance from which to withdraw funds.
bankAccountId - UUID Identifier of the bank account for ACH withdrawals.
bankCardId - UUID Identifier of the bank card for push-to-card withdrawals.
paypalVaultId - UUID Identifier of the PayPal vault for PayPal withdrawals.
venmoAccountId - UUID Identifier of the Venmo account for Venmo withdrawals.
cashBalanceId - UUID Identifier of the specific cash balance account to withdraw from (required when source is CASH_BALANCE).
Example
{
  "idempotencyKey": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "amount": 123.45,
  "method": "PAYPAL",
  "source": "CASH_BALANCE",
  "bankAccountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "bankCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "paypalVaultId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "venmoAccountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "cashBalanceId": "1ce811c2-f17b-4800-bbd2-c9362839899d"
}

ENUM

AccountType

Description

Enum describing the types of accounts.

Values
Enum Value Description

CONSUMER

 Account is a consumer/personal account.

BUSINESS

 Account is a business account.
Example
"CONSUMER"
ENUM

BankAccountStatus

Description

BankAccountStatus represents the current status of a bank account.

Values
Enum Value Description

ENABLED

DISABLED
Example
"ENABLED"
ENUM

BankAccountType

Description

BankAccountType represents the type of bank account.

Values
Enum Value Description

SAVING

CREDIT

CHECKING
Example
"SAVING"
ENUM

BankCardStatus

Description

BankCardStatus represents the status of bank card.

Values
Enum Value Description

ACTIVE

INACTIVE

PENDING_REMOVAL
Example
"ACTIVE"
ENUM

BankCardType

Description

BankCardType represents the type of bank card.

Values
Enum Value Description

DEBIT

CREDIT

PREPAID
Example
"DEBIT"
ENUM

CashBalanceAvailabilityType

Description

Enum defining the types of availability for a cash balance.

Values
Enum Value Description

INSTANT

 The deposit can be settled immediately.

STANDARD

 Standard processing times applies.
Example
"INSTANT"
ENUM

CashBalanceDepositStatus

Description

Enum representing the status of a cash balance deposit.

Values
Enum Value Description

AVAILABLE

 The deposit is available in the user's account.

FAILED

 The deposit attempt has failed.

PENDING

 The deposit is currently being processed.

REFUNDED

 The deposit was refunded.

REVERSED

 The deposit was reversed after being credited.

REVIEW

 The deposit is under review.
Example
"AVAILABLE"
ENUM

CashBalanceDepositType

Description

Enum representing different types of cash balance deposits.

Values
Enum Value Description

CASH_BALANCE

 A regular cash balance deposit.

RESERVE_BALANCE

 A deposit held in reserve balance.

GIFT_CARD_BALANCE

 A non-withdrawable deposit for gift card balance.
Example
"CASH_BALANCE"
ENUM

CloRateTypeEnum

Description

Indicates the type of rate active for a specific period of a Card Linked Offer.

Values
Enum Value Description

REGULAR

PROMO
Example
"REGULAR"
ENUM

DeliveryFormatType

Description

DeliveryFormatType defines the delivery format of the offer.

Values
Enum Value Description

URL

CODES

PIN_AS_CODE

PIN_WITH_URL

CODE_WITH_PREFIX
Example
"URL"
ENUM

GiftCardStatus

Description

GiftCardStatus represents the current state of a gift card.

Values
Enum Value Description

ACTIVE

 The default status when a Gift Card is generated.

NOT_ACTIVE

 The Gift Card has been marked as used by the user.

ARCHIVED

 The Gift Card is not currently active.

RESTRICTED

 The Gift Card has been marked as restricted.
Example
"ACTIVE"
ENUM

OfferDenominationType

Description

OfferDenominationType is the type of denomination of a specific offer.

Values
Enum Value Description

VARIABLE

 VARIABLE means that the offer has a variable denomination.

FIXED

 FIXED means that the offer has fixed value denominations.

VARIABLENOCENTS

 VARIABLENOCENTS means that the offer has a variable denomination but the value must be an integer.
Example
"VARIABLE"
ENUM

OfferType

Description

OfferType is the type of offer.

Values
Enum Value Description

GIFT_CARD_OFFER

 GIFT_CARD_OFFER means that the offer is a gift card.

EXCLUSIVE_RATE_OFFER

 EXCLUSIVE_RATE_OFFER means that the offer is a special rate for gift cards.

CARD_LINKED_OFFER

 CARD_LINKED_OFFER means that the offer is a special rate for virtual cards.
Example
"GIFT_CARD_OFFER"
ENUM

PayPalAccountStatus

Description

PayPalAccountStatus represents the current status of a PayPal account.

Values
Enum Value Description

ACTIVE

REMOVED
Example
"ACTIVE"
ENUM

PaymentMethodType

Description

PaymentMethodType represents the type of payment method.

Values
Enum Value Description

BANK_CARD

BANK_ACCOUNT

PAYPAL

FLUZPAY

APPLE_PAY

GOOGLE_PAY
Example
"BANK_CARD"
ENUM

PurchaseScopeFilter

Description

PurchaseScopeFilter indicates the type of filter to use for getUserPurchases query

  • TOKEN_USER: use the userId from the token
  • TOKEN_ACCOUNT: use the accountId from the token Presence of both filters means both userId and accountId will be used.
Values
Enum Value Description

TOKEN_USER

TOKEN_ACCOUNT
Example
"TOKEN_USER"
ENUM

ScopeType

Description

Enum describing the various types of access scopes available within the system. These scopes define the extent of access granted to user tokens for specific operations.

Values
Enum Value Description

LIST_PAYMENT

 Allows access to user's payment methods and account balance.

LIST_PURCHASES

 Allows access to user's purchase history.

LIST_OFFERS

 Allows access to offers catalog and inventory data.

MAKE_DEPOSIT

 Allows making a deposit to the user's balance.

MAKE_WITHDRAWAL

 Allows making a withdrawal from the user's balance.

PURCHASE_GIFTCARD

 Allows purchasing a gift card.

REVEAL_GIFTCARD

 Allows revealing a gift card code.

PCI_COMPLIANCE

 Allows handling payment card information. This scope is granted to a PCI compliant developer and all of their applications. You cannot request this when generating a token. PERSONAL/Private applications are exempt from PCI_COMPLIANCE requirement.

MANAGE_PAYMENT

 Allows making changes to user's payment methods.

REVEAL_VIRTUALCARD

 Allows revealing a virtual card details.

CREATE_VIRTUALCARD

 Allows access to create virtual card.

EDIT_VIRTUALCARD

 Allows access to edit virtual card.

VERIFY_KYC

 Allows application to request user KYC verification.

MAKE_PAYOUT_TRANSFER_SEND

 Allows sending payout transfers from user's account to other Fluz accounts. Required when account is the SOURCE in a transfer.

MAKE_PAYOUT_TRANSFER_RECEIVE

 Allows receiving payout transfers into user's account from other Fluz accounts. Required when account is the DESTINATION in a transfer.
Example
"LIST_PAYMENT"
ENUM

TransactionStatus

Description

TransactionStatus represents the current state of a transaction.

Values
Enum Value Description

PENDING

 Transaction is pending and not yet settled.

SETTLED

 Transaction has been completed and settled.
Example
"PENDING"
ENUM

TransferDirection

Description

Transfer direction from user's perspective.

Values
Enum Value Description

RECEIVE

 User is receiving money (application/operator → user).

SEND

 User is sending money (user → application/operator).
Example
"RECEIVE"
ENUM

UserCashBalanceStatus

Description

Enum representing the status of a user cash balance account.

Values
Enum Value Description

ACTIVE

 The cash balance account is active and can be used.

CLOSED

 The cash balance account has been closed.

SUSPENDED

 The cash balance account is temporarily suspended.
Example
"ACTIVE"
ENUM

UserVerificationStatus

Description

Enum describing the user verification status.

Values
Enum Value Description

APPROVED

 User verification is approved.

DECLINED

 User verification is declined.

DUPLICATE

 User verification is a duplicate.

ERROR

 User verification error.
Example
"APPROVED"
ENUM

VirtualCardBulkOrderStatus

Description

VirtualCardBulkOrderStatus represents the current state of a bulk virtual card order status.

Values
Enum Value Description

PENDING

IN_PROGRESS

COMPLETED

FAILED

CANCELED
Example
"PENDING"
ENUM

VirtualCardFundingSource

Description

VirtualCardFundingSource represents the funding sources available for Virtual Cards.

Values
Enum Value Description

FLUZ_BALANCE

BANK_ACCOUNT
Example
"FLUZ_BALANCE"
ENUM

VirtualCardNetwork

Description

VirtualCardNetwork represents the card network of a virtual card (MASTERCARD or VISA).

Values
Enum Value Description

MASTERCARD

VISA
Example
"MASTERCARD"
ENUM

VirtualCardOfferType

Description

VirtualCardOfferType represents the card type of a virtual card (DEBIT or PREPAID).

Values
Enum Value Description

DEBIT

PREPAID
Example
"DEBIT"
ENUM

VirtualCardSpendLimitDuration

Description

VirtualCardSpendLimitDuration represents the card limit duration type.

Values
Enum Value Description

DAILY

WEEKLY

MONTHLY

ANNUAL

LIFETIME
Example
"DAILY"
ENUM

VirtualCardStatus

Description

VirtualCardStatus represents the current state of a virtual card.

Values
Enum Value Description

PENDING

ACTIVE

USED

CANCELLED

REFUNDED

EXPIRED

DISPUTED
Example
"PENDING"
ENUM

VirtualCardTransactionListType

Values
Enum Value Description

PURCHASE

REFUND

DECLINE
Example
"PURCHASE"
ENUM

VirtualCardType

Description

VirtualCardType indicates whether the card is multi-use or single-use, defining its usability.

Values
Enum Value Description

MULTI_USE

 MULTI_USE is a Virtual Card that can be stored and reused.

SINGLE_USE

 SINGLE_USE is a Virtual Card that can be used once.
Example
"MULTI_USE"
ENUM

WithdrawMethods

Description

Enum representing different withdrawal methods available to users.

Values
Enum Value Description

PAYPAL

 Withdraw to a PayPal account.

BANK_ACH

 Withdraw via ACH transfer to a bank account.

BANK_CARD

 Withdraw via push-to-card to a debit card.

VENMO

 Withdraw to a Venmo account.
Example
"PAYPAL"
ENUM

WithdrawSource

Description

Enum representing the source balance type for withdrawals.

Values
Enum Value Description

CASH_BALANCE

 Withdraw from the user's cash balance.

REWARDS_BALANCE

 Withdraw from the user's rewards balance.
Example
"CASH_BALANCE"

OBJECT

Account

Description

Represents the account operable by the application.

Fields
Field Name Description
accountId - UUID The id of the account.
type - AccountType The type of account.
accountName - String The name of the business or first and last name of the user.
seats - [Seat] The seats owned with the account.
user - User The user associated with the account.
business - Business The business associated with the account.
Example
{
  "accountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "type": "CONSUMER",
  "accountName": "xyz789",
  "seats": [Seat],
  "user": User,
  "business": Business
}
OBJECT

ApplicationUser

Description

Represents the User who grants access to the application with scopes.

Fields
Field Name Description
userId - UUID The userId that has granted the scopes.
scopes - [ScopeType] The user scopes available the application.
accounts - [Account] The accounts that the user has access to.
Example
{
  "userId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "scopes": ["LIST_PAYMENT"],
  "accounts": [Account]
}
OBJECT

BankAccount

Description

BankAccount is a record of a bank account added by a user.

Fields
Field Name Description
bankAccountId - UUID! The ID of the bank account.
accountId - UUID!
type - BankAccountType!
accountName - String!
status - BankAccountStatus!
achRouting - String!
lastFour - String!
authChargeBackupPaymentMethod - Boolean!
billingAddressId - UUID!
nickname - String
Example
{
  "bankAccountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "accountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "type": "SAVING",
  "accountName": "xyz789",
  "status": "ENABLED",
  "achRouting": "xyz789",
  "lastFour": "abc123",
  "authChargeBackupPaymentMethod": false,
  "billingAddressId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "nickname": "xyz789"
}
OBJECT

BankCard

Description

BankCard is a record of a bank card added by a user.

Fields
Field Name Description
bankCardId - UUID! The ID of the bank card.
ownerAccountId - UUID!
addedUserId - UUID!
cardType - BankCardType
cardProcessor - String
cardholderName - String
lastFourDigits - String
expirationMonth - String
expirationYear - String
cardStatus - BankCardStatus
billingAddressId - UUID
nickname - String
Example
{
  "bankCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "ownerAccountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "addedUserId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "cardType": "DEBIT",
  "cardProcessor": "xyz789",
  "cardholderName": "xyz789",
  "lastFourDigits": "abc123",
  "expirationMonth": "abc123",
  "expirationYear": "xyz789",
  "cardStatus": "ACTIVE",
  "billingAddressId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "nickname": "abc123"
}
OBJECT

Business

Description

Represents the Business who has access to the account.

Fields
Field Name Description
businessId - UUID The businessId associated with the account.
businessName - String The name of the business.
Example
{
  "businessId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "businessName": "xyz789"
}
OBJECT

CashBalance

Description

CashBalance represents the balance of a user's cash.

Fields
Field Name Description
availableBalance - String The available balance of the user's cash.
totalBalance - String The total balance of the user's cash.
pendingBalance - String The pending balance of the user's cash.
lifetimeBalance - String The lifetime balance of the user's cash.
Example
{
  "availableBalance": "abc123",
  "totalBalance": "xyz789",
  "pendingBalance": "xyz789",
  "lifetimeBalance": "xyz789"
}
OBJECT

CashBalanceDeposit

Description

CashBalanceDeposit represents a cash balance deposit, including details like amount, fee, and status.

Fields
Field Name Description
cashBalanceDepositId - UUID! Unique identifier for the cash balance deposit.
depositDisplayId - String! Display identifier for the deposit, used for user-facing purposes.
depositAmount - String! The amount of the deposit.
depositFee - String Fee associated with the deposit, if applicable.
bankCardId - UUID Identifier of the bank card used for the deposit.
bankAccountId - UUID Identifier of the bank account used for the deposit.
paypalVaultId - UUID Identifier of the PayPal vault used for the deposit.
transactionDate - DateTime! Date and time when the transaction was made.
clearedDate - DateTime Date and time when the deposit cleared, if applicable.
status - CashBalanceDepositStatus! Current status of the deposit.
expectedClearedDate - DateTime! Expected date and time for the deposit to clear.
cashBalanceDepositType - CashBalanceDepositType! Type of the cash balance deposit.
cashBalanceSettlements - [CashBalanceSettlement] Associated settlements for the deposit.
Example
{
  "cashBalanceDepositId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "depositDisplayId": "abc123",
  "depositAmount": "abc123",
  "depositFee": "xyz789",
  "bankCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "bankAccountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "paypalVaultId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "transactionDate": "2007-12-03T10:15:30Z",
  "clearedDate": "2007-12-03T10:15:30Z",
  "status": "AVAILABLE",
  "expectedClearedDate": "2007-12-03T10:15:30Z",
  "cashBalanceDepositType": "CASH_BALANCE",
  "cashBalanceSettlements": [CashBalanceSettlement]
}
OBJECT

CashBalanceSettlement

Description

CashBalanceSettlement representing a settlement record of a cash balance.

Fields
Field Name Description
cashBalanceSettlementId - UUID! Unique identifier for the cash balance settlement.
cashBalanceDepositId - UUID! Identifier of the associated cash balance deposit.
availabilityType - CashBalanceAvailabilityType! Type of availability for the settlement (instant or standard).
status - CashBalanceDepositStatus! Current status of the cash balance settlement.
Example
{
  "cashBalanceSettlementId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "cashBalanceDepositId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "availabilityType": "INSTANT",
  "status": "AVAILABLE"
}
OBJECT

CloDetails

Description

[CLO Only] Contains specific details about rates and periods for a Card Linked Offer. This object is null for non-CLO offer types.

Fields
Field Name Description
currentRateType - CloRateTypeEnum! The type of rate currently active (REGULAR or PROMO) based on evaluation of all periods against the current time.
regularRate - Float The standard reward rate (%) for the offer.
promoRate - Float The promotional reward rate (%) potentially active during a PROMO period.
promoBaseRate - Float The reward rate (%) applied during a PROMO period after the promoMaxCap is exceeded.
promoMaxCap - Float The maximum purchase amount up to which the promoRate applies during a PROMO period.
applyPromoBaseRateAfterCap - Boolean If true, the promoBaseRate applies to the purchase amount exceeding the promoMaxCap during a PROMO period.
minimumPurchaseAmount - Float The minimum purchase amount required to qualify for the CLO reward, if any.
activePeriodStartDate - String The start date (YYYY-MM-DD) of the currently active offer period, if any.
activePeriodEndDate - String The end date (YYYY-MM-DD) of the currently active offer period, if any.
periods - [CloPeriod!]! List of all defined periods for this offer's rates (past, present, future).
Example
{
  "currentRateType": "REGULAR",
  "regularRate": 123.45,
  "promoRate": 123.45,
  "promoBaseRate": 123.45,
  "promoMaxCap": 123.45,
  "applyPromoBaseRateAfterCap": true,
  "minimumPurchaseAmount": 123.45,
  "activePeriodStartDate": "xyz789",
  "activePeriodEndDate": "xyz789",
  "periods": [CloPeriod]
}
OBJECT

CloPeriod

Description

[CLO Only] Represents a specific time period during which a Card Linked Offer rate applies.

Fields
Field Name Description
id - UUID!
offerRateType - CloRateTypeEnum!
periodType - String
startDate - String
endDate - String
startTime - String
endTime - String
daysOfWeek - [String]
daysOfMonth - [String]
Example
{
  "id": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "offerRateType": "REGULAR",
  "periodType": "xyz789",
  "startDate": "abc123",
  "endDate": "abc123",
  "startTime": "abc123",
  "endTime": "abc123",
  "daysOfWeek": ["abc123"],
  "daysOfMonth": ["xyz789"]
}
OBJECT

CreateTransferResponse

Description

Represents the response returned from the createTransfer mutation.

Fields
Field Name Description
success - Boolean! Indicates whether the transfer was successful.
message - String! A message describing the result of the transfer.
transferId - UUID The UUID of the transfer. Only present if success is true.
Example
{
  "success": false,
  "message": "xyz789",
  "transferId": "1ce811c2-f17b-4800-bbd2-c9362839899d"
}
OBJECT

DepositCashBalanceResponse

Description

Response type for the depositCashBalance mutation, returning the resulting deposits and current user balances.

Fields
Field Name Description
cashBalanceDeposits - [CashBalanceDeposit] List of cash balance deposits made as part of the mutation.
balances - UserBalances User's current balances.
Example
{
  "cashBalanceDeposits": [CashBalanceDeposit],
  "balances": UserBalances
}
OBJECT

GenerateUserAccessTokenResponse

Description

Represents the response returned from the generateUserAccessToken mutation. Includes the access token and the scopes that the token grants.

Fields
Field Name Description
token - String The User Access JWT for API requests.
refreshToken - String The User Access refresh token for API requests.
scopes - [ScopeType] The list of scopes granted to the token.
Example
{
  "token": "xyz789",
  "refreshToken": "abc123",
  "scopes": ["LIST_PAYMENT"]
}
OBJECT

GetWalletResponse

Description

GetWalletResponse represents the response to the get wallet request.

Fields
Field Name Description
bankCards - [BankCard]
Arguments
paginate - OffsetInput
bankAccounts - [BankAccount]
Arguments
paginate - OffsetInput
paypalAccounts - [Paypal]
blockedPaymentTypes - [PaymentMethodType]
balances - UserBalances
Example
{
  "bankCards": [BankCard],
  "bankAccounts": [BankAccount],
  "paypalAccounts": [Paypal],
  "blockedPaymentTypes": ["BANK_CARD"],
  "balances": UserBalances
}
OBJECT

GiftCard

Description

GiftCard represents a record of a gift card purchased by a user.

Fields
Field Name Description
giftCardId - UUID! The ID associated with the gift card.
purchaserUserId - UUID! The ID of the user who made the purchase.
endDate - DateTime! The expiration date of the gift card.
status - GiftCardStatus! The status of the Gift Card.
createdAt - DateTime! The time the gift card was created.
merchant - Merchant A connection to the merchant that the gift card can be redeemed at.
Example
{
  "giftCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "purchaserUserId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "endDate": "2007-12-03T10:15:30Z",
  "status": "ACTIVE",
  "createdAt": "2007-12-03T10:15:30Z",
  "merchant": Merchant
}
OBJECT

GiftCardCode

Description

GiftCardCode contains the redemption credentials for a Merchant.

Fields
Field Name Description
code - String
pin - String
url - String
Example
{
  "code": "xyz789",
  "pin": "xyz789",
  "url": "xyz789"
}
OBJECT

LockVirtualCardResponse

Fields
Field Name Description
virtualCardId - UUID!
locked - Boolean!
Example
{
  "virtualCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "locked": true
}
OBJECT

Merchant

Description

Merchant is place that a Gift Card can be use, or can charge a user's VirtualCard.

Fields
Field Name Description
merchantId - UUID
name - String
slug - String
offers - [Offer]
Example
{
  "merchantId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "name": "xyz789",
  "slug": "abc123",
  "offers": [Offer]
}
OBJECT

MerchantCategoryCode

Description

MerchantCategoryCode represents the classifier for a business by the types of goods or services it provides.

Fields
Field Name Description
code - String Four digit merchant category code.
displayDescription - String Display description.
description - String Mcc description.
Example
{
  "code": "xyz789",
  "displayDescription": "xyz789",
  "description": "xyz789"
}
OBJECT

Offer

Description

Offer is a discounted offer for a merchant.

Fields
Field Name Description
offeringMerchantId - UUID!
offerId - UUID!
type - OfferType!
deliveryFormat - DeliveryFormatType
hasStockInfo - Boolean
offerRates - [OfferRate]
denominationsType - OfferDenominationType
stockInfo - [StockInfoType]! StockInfo is an object where the key:value pairs represent the amount in stock for each denomination (key = denomination; value = amount in stock). It's only available if the offer hasStockInfo. This requires Fluz to confirm the inventory, response time varies by vendors.
cloDetails - CloDetails [CLO Only] Contains specific details about rates and periods for a Card Linked Offer. Returns null for non-CLO offer types.
Example
{
  "offeringMerchantId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "offerId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "type": "GIFT_CARD_OFFER",
  "deliveryFormat": "URL",
  "hasStockInfo": true,
  "offerRates": [OfferRate],
  "denominationsType": "VARIABLE",
  "stockInfo": [StockInfoFixedType],
  "cloDetails": CloDetails
}
OBJECT

OfferRate

Description

OfferRate is the rate of a specific offer.

Fields
Field Name Description
rate - Float
maxUserRewardValue - Float Use 'rate' instead
cashbackVoucherRewardValue - Float Use 'rate' instead
boostRewardValue - Float Use 'rate' instead
displayBoostReward - Boolean Use 'rate' instead
denominations - [String]
allowedPaymentMethods - [String]
Example
{
  "rate": 123.45,
  "maxUserRewardValue": 123.45,
  "cashbackVoucherRewardValue": 987.65,
  "boostRewardValue": 987.65,
  "displayBoostReward": false,
  "denominations": ["xyz789"],
  "allowedPaymentMethods": ["xyz789"]
}
OBJECT

Paypal

Description

Paypal represents a PayPal account added by a user.

Fields
Field Name Description
paypalVaultId - UUID! The ID of the PayPal account.
userId - UUID!
status - PayPalAccountStatus!
email - String!
Example
{
  "paypalVaultId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "userId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "status": "ACTIVE",
  "email": "xyz789"
}
OBJECT

ProgramLimits

Description

Represents the bank program spent limits.

Fields
Field Name Description
dailyLimit - String The bank program daily spend limit.
weeklyLimit - String The bank program weekly spend limit.
monthlyLimit - String The bank program monthly spend limit.
Example
{
  "dailyLimit": "abc123",
  "weeklyLimit": "xyz789",
  "monthlyLimit": "xyz789"
}
OBJECT

RefreshUserAccessTokenResponse

Description

Represents the response returned from the generateUserAccessToken mutation. Includes the access token and the scopes that the token grants.

Fields
Field Name Description
token - String The User Access JWT for API requests.
scopes - [ScopeType] The list of scopes granted to the token.
Example
{
  "token": "abc123",
  "scopes": ["LIST_PAYMENT"]
}
OBJECT

RegisterUserError

Description

Error details for registerUser mutation failures.

Fields
Field Name Description
message - String Brief error message describing the failure.
code - String Error code identifying the specific error type.
Example
{
  "message": "abc123",
  "code": "abc123"
}
OBJECT

RegisterUserResponse

Description

Represents the response returned from the registerUser mutation. Includes the success flag.

Fields
Field Name Description
success - Boolean Flag representing the success of calling registerUser mutation.
error - RegisterUserError Error object containing message and error code when registration fails.
Example
{"success": false, "error": RegisterUserError}
OBJECT

RewardsBalance

Description

RewardsBalance represents the balance of a user's rewards.

Fields
Field Name Description
availableBalance - String The available balance of the user's rewards.
totalBalance - String The total balance of the user's rewards.
lifetimeBalance - String The lifetime balance of the user's rewards.
Example
{
  "availableBalance": "abc123",
  "totalBalance": "xyz789",
  "lifetimeBalance": "xyz789"
}
OBJECT

Seat

Description

Represents the network position held by the entity.

Fields
Field Name Description
seatId - UUID The seat id associated with the account.
seatNumber - String The string value of seat position.
Example
{
  "seatId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "seatNumber": "xyz789"
}
OBJECT

StockInfoFixedType

Description

StockInfoFixedType describes the available denominations for fixed offers, and the amount in stock for each denomination.

Fields
Field Name Description
denomination - String
availableStock - String
Example
{
  "denomination": "xyz789",
  "availableStock": "abc123"
}
OBJECT

StockInfoVariableType

Description

StockInfoVariableType describes the available denomination range for variable offers.

Fields
Field Name Description
minDenomination - String
maxDenomination - String
description - String
Example
{
  "minDenomination": "abc123",
  "maxDenomination": "abc123",
  "description": "xyz789"
}
OBJECT

Transaction

Description

Transaction represents a comprehensive record of all account activity including purchases, deposits, withdrawals, transfers, and payouts.

Fields
Field Name Description
recordId - UUID Unique identifier for the transaction record.
user - String! The display name of the user associated with this transaction.
accountId - UUID! The ID of the account that owns this transaction.
userId - UUID The ID of the user that initiated this transaction.
transactionType - String The type of transaction (e.g., GIFT_CARD_PURCHASE, DEPOSIT, WITHDRAWAL, TRANSFER).
amount - Float! The primary transaction amount.
destination - String The destination of the transaction (merchant name, recipient, etc.).
source - String The source of the transaction (funding source, sender, etc.).
externalFundingSourceActivity - Float Activity from external funding sources (bank cards, bank accounts).
fluzBalanceActivity - Float Activity from Fluz internal balances (cash, rewards, prepayment).
fee - Float Transaction fee amount.
cashback - Float Cashback earned from this transaction.
giftCardPrepaymentBalanceAvailableBalance - Float Available balance in gift card prepayment after this transaction.
giftCardPrepaymentBalanceTotalBalance - Float Total balance in gift card prepayment after this transaction.
cashBalanceAvailableBalance - Float Available cash balance after this transaction.
cashBalanceTotalBalance - Float Total cash balance after this transaction.
seatBalanceAvailableBalance - Float Available rewards (seat) balance after this transaction.
seatBalanceTotalBalance - Float Total rewards (seat) balance after this transaction.
reserveBalanceAvailableBalance - Float Available reserve balance after this transaction.
reserveBalanceTotalBalance - Float Total reserve balance after this transaction.
otherCashBalanceAvailableBalance - Float Available balance in other cash accounts after this transaction.
otherCashBalanceTotalBalance - Float Total balance in other cash accounts after this transaction.
status - TransactionStatus Current status of the transaction.
referenceId - String External reference ID (e.g., purchase display ID, deposit ID).
description - String Human-readable description of the transaction.
note - String Additional notes about the transaction.
category - String Transaction category (e.g., Shopping, Travel, Bills).
cardLastFour - String Last four digits of the card used (if applicable).
cardDisplayName - String Display name of the card used (if applicable).
originalCurrencyAmount - Float Original amount in foreign currency (for international transactions).
originalCurrencyCode - String Currency code of the original amount (e.g., EUR, GBP).
conversionRate - Float Currency conversion rate applied.
merchantId - UUID ID of the merchant associated with this transaction.
descriptorId - UUID ID of the transaction descriptor.
virtualCardProgram - String Virtual card program used (e.g., LITHIC, MARQETA, HIGHNOTE_CFSB).
cashbackRate - Float Cashback rate percentage applied.
bonusCashbackRate - Float Bonus cashback rate percentage applied.
channel - String Channel through which the transaction was initiated.
sourceType - String Type of the funding source used.
logoUrl - String Logo URL for the merchant or source.
platformInstitutionLogo - String Logo URL for the banking institution (for bank-funded transactions).
challengeLogoUrl - String Logo URL for challenges/milestones (for bonus transactions).
invitedAccountId - UUID Account ID of invited user (for referral-related transactions).
expectedClearedDate - DateTime Expected date when pending transaction will be cleared.
liabilityId - UUID ID of associated liability (for bill payments).
isGiftCardBalanceAffected - Boolean Whether this transaction affected the gift card prepayment balance.
isCashBalanceAffected - Boolean Whether this transaction affected the cash balance.
isSeatBalanceAffected - Boolean Whether this transaction affected the rewards (seat) balance.
isReserveBalanceAffected - Boolean Whether this transaction affected the reserve balance.
transferId - UUID ID of the transfer record (for P2P transfers).
usedUserCashBalanceId - UUID ID of the specific user cash balance used for this transaction.
createdAt - DateTime Timestamp when the transaction was created.
updatedAt - DateTime Timestamp when the transaction was last updated.
Example
{
  "recordId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "user": "abc123",
  "accountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "userId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "transactionType": "xyz789",
  "amount": 123.45,
  "destination": "xyz789",
  "source": "xyz789",
  "externalFundingSourceActivity": 987.65,
  "fluzBalanceActivity": 987.65,
  "fee": 123.45,
  "cashback": 987.65,
  "giftCardPrepaymentBalanceAvailableBalance": 123.45,
  "giftCardPrepaymentBalanceTotalBalance": 123.45,
  "cashBalanceAvailableBalance": 123.45,
  "cashBalanceTotalBalance": 987.65,
  "seatBalanceAvailableBalance": 987.65,
  "seatBalanceTotalBalance": 123.45,
  "reserveBalanceAvailableBalance": 987.65,
  "reserveBalanceTotalBalance": 987.65,
  "otherCashBalanceAvailableBalance": 123.45,
  "otherCashBalanceTotalBalance": 987.65,
  "status": "PENDING",
  "referenceId": "abc123",
  "description": "abc123",
  "note": "abc123",
  "category": "abc123",
  "cardLastFour": "abc123",
  "cardDisplayName": "abc123",
  "originalCurrencyAmount": 987.65,
  "originalCurrencyCode": "abc123",
  "conversionRate": 123.45,
  "merchantId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "descriptorId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "virtualCardProgram": "xyz789",
  "cashbackRate": 123.45,
  "bonusCashbackRate": 123.45,
  "channel": "abc123",
  "sourceType": "xyz789",
  "logoUrl": "abc123",
  "platformInstitutionLogo": "xyz789",
  "challengeLogoUrl": "abc123",
  "invitedAccountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "expectedClearedDate": "2007-12-03T10:15:30Z",
  "liabilityId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "isGiftCardBalanceAffected": false,
  "isCashBalanceAffected": false,
  "isSeatBalanceAffected": false,
  "isReserveBalanceAffected": true,
  "transferId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "usedUserCashBalanceId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z"
}
OBJECT

TransactionConnection

Description

Paginated response for transactions query.

Fields
Field Name Description
transactions - [Transaction] List of transactions.
totalCount - Int! Total count of transactions matching the filter.
hasNextPage - Boolean! Whether there are more results available.
Example
{
  "transactions": [Transaction],
  "totalCount": 123,
  "hasNextPage": false
}
OBJECT

User

Description

Represents the User who has access to the account.

Fields
Field Name Description
userId - UUID The userId associated with the account.
firstName - String The first name of the user.
lastName - String The last name of the user.
Example
{
  "userId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "firstName": "abc123",
  "lastName": "xyz789"
}
OBJECT

UserAddress

Description

UserAddress represents a User Address record.

Fields
Field Name Description
userAddressId - UUID!
streetAddressLine1 - String
streetAddressLine2 - String
country - String!
city - String!
state - String
postalCode - String
Example
{
  "userAddressId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "streetAddressLine1": "xyz789",
  "streetAddressLine2": "abc123",
  "country": "xyz789",
  "city": "xyz789",
  "state": "abc123",
  "postalCode": "xyz789"
}
OBJECT

UserBalances

Description

UserBalances represents the balances of a user's rewards, cash, and gift card cash.

Fields
Field Name Description
rewardsBalance - RewardsBalance
cashBalance - CashBalance
giftCardCashBalance - CashBalance
userCashBalances - [UserCashBalance]
Arguments
paginate - OffsetInput
Example
{
  "rewardsBalance": RewardsBalance,
  "cashBalance": CashBalance,
  "giftCardCashBalance": CashBalance,
  "userCashBalances": [UserCashBalance]
}
OBJECT

UserCashBalance

Description

UserCashBalance represents a user's cash balance account.

Fields
Field Name Description
userCashBalanceId - UUID! Unique identifier for the user cash balance.
totalCashBalance - String! Total cash balance.
availableCashBalance - String! Available cash balance.
lifetimeCashBalance - String! Lifetime cash balance (cumulative total ever deposited).
nickname - String Custom nickname for the balance.
status - UserCashBalanceStatus! Status of the cash balance account.
createdAt - DateTime! Date and time when the account was created.
Example
{
  "userCashBalanceId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "totalCashBalance": "abc123",
  "availableCashBalance": "abc123",
  "lifetimeCashBalance": "abc123",
  "nickname": "abc123",
  "status": "ACTIVE",
  "createdAt": "2007-12-03T10:15:30Z"
}
OBJECT

UserPurchase

Description

UserPurchase represents a record of a purchase made by a user, detailing the payment methods and other relevant information.

Fields
Field Name Description
purchaseId - UUID! The ID associated with the purchase.
purchaseDisplayId - String The display ID of the purchase.
purchaseBankCardId - UUID The ID of the Bank Card used to make the purchase.
bankAccountId - UUID The ID of the Bank Account used to make the purchase.
purchaseAmount - Float! The amount of the purchase.
fluzpayAmount - Float The amount of the balance applied.
seatRewardValue - Float! The amount of the cashback reward from the purchase.
paypalVaultId - UUID The ID of the PayPal used to make the purchase.
createdAt - DateTime! The time the purchase was created.
giftCard - GiftCard A connection to the gift card associated with the purchase.
virtualCard - VirtualCard A connection to the virtual card associated with the purchase.
accountId - UUID The unique identifier for the fluz account.
purchaserUserId - UUID The unique identifier for the user who made the purchase.
Example
{
  "purchaseId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "purchaseDisplayId": "abc123",
  "purchaseBankCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "bankAccountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "purchaseAmount": 987.65,
  "fluzpayAmount": 123.45,
  "seatRewardValue": 987.65,
  "paypalVaultId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "createdAt": "2007-12-03T10:15:30Z",
  "giftCard": GiftCard,
  "virtualCard": VirtualCard,
  "accountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "purchaserUserId": "1ce811c2-f17b-4800-bbd2-c9362839899d"
}
OBJECT

VerifyUserInformationResponse

Description

Represents the response returned from the verifyUserInformation mutation.

Fields
Field Name Description
status - UserVerificationStatus! The verification status.
message - String The response message if any.
Example
{"status": "APPROVED", "message": "abc123"}
OBJECT

VirtualCard

Description

VirtualCard represents a record of a virtual card generated by a user.

Fields
Field Name Description
virtualCardId - UUID! The ID associated with the virtual card.
userId - UUID! The ID of the user who created the virtual card.
cardholderName - String! The cardholder name appeared on the virtual card.
expiryMonth - String! The expiration month of the virtual card.
expiryYear - String! The expiration year of the virtual card.
virtualCardLast4 - String! The last 4 digits of the virtual card number.
status - VirtualCardStatus! The status of the virtual card.
cardType - VirtualCardType! The type of the virtual card.
initialAmount - Float! The initial amount requested when the card was generated.
usedAmount - Float The total amount spent on the virtual card.
createdAt - DateTime! The time the virtual card was generated.
authorizationSetting - VirtualCardAuthorizationSetting A connection to the authorization setting of the virtual card.
Example
{
  "virtualCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "userId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "cardholderName": "abc123",
  "expiryMonth": "xyz789",
  "expiryYear": "xyz789",
  "virtualCardLast4": "abc123",
  "status": "PENDING",
  "cardType": "MULTI_USE",
  "initialAmount": 987.65,
  "usedAmount": 123.45,
  "createdAt": "2007-12-03T10:15:30Z",
  "authorizationSetting": VirtualCardAuthorizationSetting
}
OBJECT

VirtualCardAddressInfo

Description

VirtualCardAddressInfo provides the address information associated with a virtual card.

Fields
Field Name Description
streetAddress - String The street address.
billingAddrLine2 - String The second line of the billing address.
postalCode - String The postal code.
city - String The city.
state - String The state.
Example
{
  "streetAddress": "abc123",
  "billingAddrLine2": "xyz789",
  "postalCode": "xyz789",
  "city": "abc123",
  "state": "abc123"
}
OBJECT

VirtualCardAuthorizationSetting

Description

VirtualCardAuthorizationSetting defines the authorization settings for a virtual card.

Fields
Field Name Description
virtualCardAsaSettingsId - UUID! The unique identifier for the authorization setting of the virtual card.
virtualCardId - UUID! The unique identifier for the virtual card.
lockDate - String The date when the card was locked.
dailySpendLimit - String The daily spending limit for the card.
weeklySpendLimit - String The weekly spending limit for the card.
monthlySpendLimit - String The monthly spending limit for the card.
annualSpendLimit - String The annual spending limit for the card.
lifetimeSpendLimit - String The lifetime spending limit for the card.
dailySpent - String The amount spent daily on the card.
weeklySpent - String The amount spent weekly on the card.
monthlySpent - String The amount spent monthly on the card.
annualSpent - String The amount spent annually on the card.
lifetimeSpent - String The amount spent over the lifetime of the card.
tokenized - Boolean Whether the card is tokenized or not.
lockedByUser - Boolean Whether the card is locked by the user or not.
lockCardNextUse - Boolean Whether the card should be locked after the next use.
cardNickname - String The nickname of the card.
Example
{
  "virtualCardAsaSettingsId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "virtualCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "lockDate": "xyz789",
  "dailySpendLimit": "abc123",
  "weeklySpendLimit": "xyz789",
  "monthlySpendLimit": "xyz789",
  "annualSpendLimit": "xyz789",
  "lifetimeSpendLimit": "abc123",
  "dailySpent": "abc123",
  "weeklySpent": "abc123",
  "monthlySpent": "xyz789",
  "annualSpent": "xyz789",
  "lifetimeSpent": "abc123",
  "tokenized": true,
  "lockedByUser": false,
  "lockCardNextUse": false,
  "cardNickname": "xyz789"
}
OBJECT

VirtualCardBalance

Description

VirtualCardBalance provides information about virtual card balance.

Fields
Field Name Description
virtualCardId - UUID! Virtual Card ID.
spentAmount - Float! Current card spent amount.
remainingBalance - Float! Remaining card balance.
spendLimit - Float! Spend limit for card.
spendLimitDuration - VirtualCardSpendLimitDuration Card limit duration type. Default is Lifetime.
Example
{
  "virtualCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "spentAmount": 987.65,
  "remainingBalance": 123.45,
  "spendLimit": 123.45,
  "spendLimitDuration": "DAILY"
}
OBJECT

VirtualCardBulkOrder

Description

VirtualCardBulkOrder provides information about bulk creation order.

Fields
Field Name Description
orderId - String! Order ID.
orderStatus - VirtualCardBulkOrderStatus! Status of the order.
virtualCards - [VirtualCardDetails] Created virtual card details.
totalCards - Int Total cards count.
successfulCardCreations - Int Successful card creation count.
failedCardCreations - Int Failed card creation count.
Example
{
  "orderId": "xyz789",
  "orderStatus": "PENDING",
  "virtualCards": [VirtualCardDetails],
  "totalCards": 123,
  "successfulCardCreations": 123,
  "failedCardCreations": 987
}
OBJECT

VirtualCardDetails

Description

The VirtualCardDetails type represents the details of a virtual card.

Fields
Field Name Description
virtualCardId - UUID The card ID.
cardNumber - String The card number.
expiryMMYY - String The expiry date in MMYY format.
cvv - String The CVV code.
cardHolderName - String The card holder's name.
billingAddress - VirtualCardAddressInfo The billing address.
authorizationSetting - VirtualCardAuthorizationSetting The authorization setting.
Example
{
  "virtualCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "cardNumber": "abc123",
  "expiryMMYY": "xyz789",
  "cvv": "xyz789",
  "cardHolderName": "xyz789",
  "billingAddress": VirtualCardAddressInfo,
  "authorizationSetting": VirtualCardAuthorizationSetting
}
OBJECT

VirtualCardOffer

Description

Represents the Bank identification numbers (BINs).

Fields
Field Name Description
offerId - String Virtual Card offer ID.
programName - String Virtual Card program name.
bin - String The bank bin.
bankName - String The bank name.
programLimits - ProgramLimits The bank program spent limits.
rewardValue - String The bank program earn rate.
Example
{
  "offerId": "abc123",
  "programName": "abc123",
  "bin": "abc123",
  "bankName": "abc123",
  "programLimits": ProgramLimits,
  "rewardValue": "abc123"
}
OBJECT

VirtualCardTransaction

Description

Virtual card transaction type.

Fields
Field Name Description
transactionDate - String!
transactionType - VirtualCardTransactionListType!
transactionAmount - Float!
transactionApproval - String
transactionResponseCode - String
transactionStatus - String
merchantName - String
paymentMethod - String
Example
{
  "transactionDate": "abc123",
  "transactionType": "PURCHASE",
  "transactionAmount": 123.45,
  "transactionApproval": "abc123",
  "transactionResponseCode": "abc123",
  "transactionStatus": "xyz789",
  "merchantName": "xyz789",
  "paymentMethod": "xyz789"
}
OBJECT

VirtualCardTransactions

Description

Virtual card transactions, grouped by virtual card ID.

Fields
Field Name Description
virtualCardId - UUID!
transactions - [VirtualCardTransaction!]!
Example
{
  "virtualCardId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "transactions": [VirtualCardTransaction]
}
OBJECT

Withdraw

Description

Withdraw represents a withdrawal transaction record.

Fields
Field Name Description
withdrawId - UUID! Unique identifier for the withdrawal.
amount - String! The amount withdrawn.
processingFee - String! Fee charged for processing the withdrawal.
chargedFee - String! Fee charged to the user for the withdrawal.
status - String! Internal status of the withdrawal.
displayStatus - String! User-friendly display status of the withdrawal.
withdrawMethod - WithdrawMethods! The withdrawal method used.
withdrawSource - WithdrawSource! The source balance from which funds were withdrawn.
submissionDate - DateTime! Date and time when the withdrawal was submitted.
createdAt - DateTime! Date and time when the withdrawal was created.
updatedAt - DateTime! Date and time when the withdrawal was last updated.
transactionLogId - UUID Identifier of the associated transaction log.
externalTransactionId - String External transaction identifier from payment gateway (for ACH).
payoutId - String Payout identifier from payment gateway (for PayPal/Venmo).
emailAddress - String Email address associated with the withdrawal.
bankAccountId - UUID Identifier of the bank account used (if applicable).
userCashBalanceId - UUID Identifier of the user cash balance account withdrawn from.
seatId - UUID The seat id associated with the account.
Example
{
  "withdrawId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "amount": "xyz789",
  "processingFee": "abc123",
  "chargedFee": "abc123",
  "status": "abc123",
  "displayStatus": "xyz789",
  "withdrawMethod": "PAYPAL",
  "withdrawSource": "CASH_BALANCE",
  "submissionDate": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "transactionLogId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "externalTransactionId": "xyz789",
  "payoutId": "abc123",
  "emailAddress": "xyz789",
  "bankAccountId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "userCashBalanceId": "1ce811c2-f17b-4800-bbd2-c9362839899d",
  "seatId": "1ce811c2-f17b-4800-bbd2-c9362839899d"
}
OBJECT

WithdrawCashBalanceResponse

Description

Response type for the withdrawCashBalance mutation, returning the withdrawal record and updated balances.

Fields
Field Name Description
withdraws - [Withdraw!]! List of withdrawal transaction records created (usually one, but can be multiple if split across seats).
balances - UserBalances User's current balances after the withdrawal.
Example
{
  "withdraws": [Withdraw],
  "balances": UserBalances
}

UNION

StockInfoType

Description

StockInfoType describes the stock for either fixed or variable offers. Used by the Offer type.

Types
Union Types

StockInfoFixedType

StockInfoVariableType
Example
StockInfoFixedType