API reference

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

Get the user's available accounts and seats.

Response

Returns

[Account]

Query


  query getAccountsByUserId($userId: UUID!) {
    getAccountsByUserId(userId: $userId) {
      accountId
      type
      accountName
      seats {
        ...SeatFragment
      }
      user {
        ...UserFragment
      }
      business {
        ...BusinessFragment
      }
    }
  }

Variables


  {
    "userId": "fca6a3c5-1aad-4bf7-af25-9fcbc1bfb54d"
  }

Response


  {
    "data": {
      "getAccountsByUserId": [
          {
            "accountId": "a2c02ec6-357b-41cf-9229-4da34e727019",
            "type": "CONSUMER",
            "accountName": "abc123",
            "seats": [Seat],
            "user": User,
            "business": Business
          }
      ]
    }
  }

getApplicationScopes

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

Response

Returns

[ScopeType]

Query


   query getApplicationScopes {
    getApplicationScopes
  }

Response


  {
    "data": {
        "getApplicationScopes": ["LIST_PAYMENT"]
    }
  }

getApplicationUsers

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

Response

Returns

[ApplicationUser]

Arguments	Description
paginate: OffsetInput

Arguments

Description

paginate:

OffsetInput

Query


  query getApplicationUsers($paginate: OffsetInput) {
    getApplicationUsers(paginate: $paginate) {
      userId
      scopes
    }
  }

Variables

{"paginate": OffsetInput}

Response


  {
    data: {
      getApplicationUsers: [
        {
          userId: "8c8cf345-3f20-4708-9a78-eac27d54a535",
          scopes: ["LIST_PAYMENT"],
        },
      ],
    },
  }

getBINs

Get virtual card program bank identification numbers (BINs). Requires CREATE_VIRTUALCARD scope.

Response

Returns

[Bin]

Query


  query getBINs {
    getBINs {
        bin
        bankName
        programLimits {
          ...programLimitsFragment
        }
        rewardValue
      }
    }
  }

Response


  {
    "data": {
      "getBINs": [
        {
          "bin": "123456",
          "bankName": "xyz789",
          "programLimits": ProgramLimits,
          "rewardValue": "1%"
        }
      ]
    }
  }

getGiftCards

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

Response

Returns

[GiftCard]

Arguments	Description
status: [GiftCardStatus]
paginate: OffsetInput

Arguments

Description

status:

[GiftCardStatus]

paginate:

OffsetInput

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": "8c8cf345-3f20-4708-9a78-eac27d54a535",
          "purchaserUserId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
          "endDate": "2007-12-03T10:15:30Z",
          "status": "ACTIVE",
          "createdAt": "2007-12-03T10:15:30Z",
          "merchant": Merchant
        }
      ]
    }
  }

getMccList

Query for listing merchant category codes. Requires MAKE_DEPOSIT scope.

Response

Returns

[MerchantCategoryCode]

Arguments	Description
paginate: OffsetInput

Arguments

Description

paginate:

OffsetInput

Query


  query getMccList(
    $paginate: OffsetInput
  ) {
    getMccList(
      paginate: $paginate
    ) {
      code
      displayDescription
      description
    }
  }

Variables


  {
    "paginate": OffsetInput
  }

Response


  {
    "data": {
      "getMccList": [
        {
          "code": "abc123",
          "displayDescription": "xyz789",
          "description": "abc123"
        }
      ]
    }
  }

getReferralUrl

Get the referral url for a merchant.

Response

Returns

String

Arguments	Description
merchant: MerchantInput

Arguments

Description

merchant:

MerchantInput

Query


  query getReferralUrl($merchant: MerchantInput) {
    getReferralUrl(
      merchant: $merchant
    ) 
  }

Variables

{"merchant": MerchantInput}

Response


  {
    "data": {
      "getReferralUrl": "http://fluz.app/store/CVS?referred_by=ABC123"
    }
  }

getMerchants

Get the active merchant catalog. Requires LIST_OFFERS scope.

Response

Returns

[Merchant]

Arguments	Description
name: String
paginate: OffsetInput

Arguments

Description

name:

String

paginate:

OffsetInput

Query


  query getMerchants(
    $name: String,
    $paginate: OffsetInput
  ) {
    getMerchants(
      name: $name,
      paginate: $paginate
    ) {
      merchantId
      name
      slug
      offers {
        ...OfferFragment
      }
    }
  }

Variables


  {
    "name": "CVS",
    "paginate": OffsetInput
  }

Response


  {
    "data": {
      "getMerchants": [
        {
          "merchantId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
          "name": "CVS",
          "slug": "cvs",
          "offers": [Offer]
        }
      ]
    }
  }

getOfferQuote

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

[Offer]

Arguments	Description
GetOfferQuoteInput!	Input type for getOfferQuote query.

Arguments

Description

GetOfferQuoteInput!

Input type for getOfferQuote query.

Query


  query getOfferQuote($input: GetOfferQuoteInput!) {
    getOfferQuote(input: $input) {
      offeringMerchantId
      offerId
      type
      hasStockInfo
      offerRates {
        ...OfferRateFragment
      }
      denominationsType
      stockInfo
    }
  }

Variables

{"input": GetOfferQuoteInput}

Response


  {
    "data": {
      "getOfferQuote": {
        "offeringMerchantId": "7c57c381-4b19-49e4-bbb0-404a45166ee4",
        "offerId": "7c57c381-4b19-49e4-bbb0-404a45166ee4",
        "type": "GIFT_CARD_OFFER",
        "hasStockInfo": true,
        "offerRates": [OfferRate],
        "denominationsType": "VARIABLE",
        "stockInfo": [StockInfoVariableType]
      }
    }
  }

getUserAddresses

getUserAddresses returns the user's addresses.

Response

Returns

[UserAddress]

Arguments	Description
paginate: OffsetInput

Arguments

Description

paginate:

OffsetInput

Query


  query getUserAddresses($paginate: OffsetInput) {
    getUserAddresses(paginate: $paginate) {
      userAddressId
      streetAddressLine1
      streetAddressLine2
      country
      city
      state
      postalCode
    }
  }

Variables

{"paginate": OffsetInput}

Response


  {
    "data": {
      "getUserAddresses": [
        {
          "userAddressId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
          "streetAddressLine1": "351 Mueller Keys",
          "streetAddressLine2": null,
          "country": "United States",
          "city": "Dover",
          "state": "Delaware",
          "postalCode": "11223"
        }
      ]
    }
  }

getUserPurchases

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

Response

Returns

[UserPurchase]

Arguments	Description
paginate: OffsetInput

Arguments

Description

paginate:

OffsetInput

Query


  query getUserPurchases($paginate: OffsetInput) {
    getUserPurchases(paginate: $paginate) {
      purchaseId
      purchaseDisplayId
      purchaseBankCardId
      bankAccountId
      purchaseAmount
      fluzpayAmount
      seatRewardValue
      paypalVaultId
      createdAt
      giftCard {
        ...GiftCardFragment
      }
      virtualCard {
        ...VirtualCardFragment
      }
    }
  }

Variables

{"paginate": OffsetInput}

Response


  {
    "data": {
      "getUserPurchases": [
        {
          "purchaseId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
          "purchaseDisplayId": "1002405",
          "purchaseBankCardId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
          "bankAccountId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
          "purchaseAmount": 123.45,
          "fluzpayAmount": 987.65,
          "seatRewardValue": 987.65,
          "paypalVaultId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
          "createdAt": "2007-12-03T10:15:30Z",
          "giftCard": GiftCard,
          "virtualCard": VirtualCard
        }
      ]
    }
  }

getWallet

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

Response

Returns

GetWalletResponse

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

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

BankCard

Arguments	Description
input: AddBankCardInput!

Arguments

Description

input:

AddBankCardInput!

Query


  mutation addBankCard($input: AddBankCardInput!) {
    addBankCard(input: $input) {
      bankCardId
      ownerAccountId
      addedUserId
      cardType
      cardProcessor
      cardholderName
      lastFourDigits
      expirationMonth
      expirationYear
      cardStatus
      billingAddressId
    }
  }

Variables

{"input": AddBankCardInput}

Response


  {
    "data": {
      "addBankCard": {
        "bankCardId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
        "ownerAccountId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
        "addedUserId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
        "cardType": "DEBIT",
        "cardProcessor": "MASTERCARD",
        "cardholderName": "John Doe",
        "lastFourDigits": "1122",
        "expirationMonth": "11",
        "expirationYear": "2025",
        "cardStatus": "ACTIVE",
        "billingAddressId": "8c8cf345-3f20-4708-9a78-eac27d54a535"
      }
    }
  }

createVirtualCard

Initiates virtual card creation. Requires CREATE_VIRTUALCARD scope.

Response

Returns

UserPurchase

Arguments	Description
input: CreateVirtualCardInput!

Arguments

Description

input:

CreateVirtualCardInput!

Query


  mutation createVirtualCard($input: CreateVirtualCardInput!) {
    createVirtualCard(input: $input)
      purchaseId
      purchaseDisplayId
      purchaseBankCardId
      bankAccountId
      purchaseAmount
      fluzpayAmount
      seatRewardValue
      paypalVaultId
      createdAt
      giftCard {
        ...GiftCardFragment
      }
      virtualCard {
        ...VirtualCardFragment
      }
  }

Variables

{"input": CreateVirtualCardInput}

Response


  {
    "data": {
      "createVirtualCard": {
        "purchaseId": "07df5653-43a8-4532-9881-3ab5857bbe11",
        "purchaseDisplayId": "xyz789",
        "purchaseBankCardId": "07df5653-43a8-4532-9881-3ab5857bbe11",
        "bankAccountId": "07df5653-43a8-4532-9881-3ab5857bbe11",
        "purchaseAmount": 987.65,
        "fluzpayAmount": 987.65,
        "seatRewardValue": 123.45,
        "paypalVaultId": "07df5653-43a8-4532-9881-3ab5857bbe11",
        "createdAt": "2007-12-03T10:15:30Z",
        "giftCard": GiftCard,
        "virtualCard": VirtualCard
      }
    }
  }

depositCashBalance

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

Response

Returns

DepositCashBalanceResponse!

Arguments	Description
input: DepositCashBalanceInput!

Arguments

Description

input:

DepositCashBalanceInput!

Query


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

Variables

{"input": DepositCashBalanceInput}

Response


  {
    "data": {
      "depositCashBalance": {
        "cashBalanceDeposits": [CashBalanceDeposit],
        "balances": UserBalances
      }
    }
  }

generateUserAccessToken

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

Response

Returns

GenerateUserAccessTokenResponse

Arguments	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.

Query


  mutation generateUserAccessToken(
    $userId: UUID!,
    $accountId: UUID!,
    $scopes: [ScopeType!]!,
    $seatId: UUID
  ) {
    generateUserAccessToken(
      userId: $userId,
      accountId: $accountId,
      scopes: $scopes,
      seatId: $seatId
    ) {
      token
      scopes
    }
  }

Variables


  {
    "userId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "accountId": "a2c02ec6-357b-41cf-9229-4da34e727019",
    "scopes": ["LIST_PAYMENT"],
    "seatId": "8c8cf345-3f20-4708-9a78-eac27d54a535"
  }

Response


  {
    "data": {
      "generateUserAccessToken": {
        "token": "xyz789",
        "scopes": ["LIST_PAYMENT"]
      }
    }
  }

purchaseGiftCard

Initiates a gift card purchase transaction. Requires PURCHASE_GIFTCARD scope.

Response

Returns

UserPurchase

Arguments	Description
input: PurchaseGiftCardInput!

Arguments

Description

input:

PurchaseGiftCardInput!

Query


  mutation purchaseGiftCard($input: PurchaseGiftCardInput!) {
    purchaseGiftCard(input: $input) {
      purchaseId
      purchaseDisplayId
      purchaseBankCardId
      bankAccountId
      purchaseAmount
      fluzpayAmount
      seatRewardValue
      paypalVaultId
      createdAt
      giftCard {
        ...GiftCardFragment
      }
      virtualCard {
        ...VirtualCardFragment
      }
    }
  }

Variables

{"input": PurchaseGiftCardInput}

Response


  {
    "data": {
      "purchaseGiftCard": {
        "purchaseId": "7c57c381-4b19-49e4-bbb0-404a45166ee4",
        "purchaseDisplayId": "1002405",
        "purchaseBankCardId": "7c57c381-4b19-49e4-bbb0-404a45166ee4",
        "bankAccountId": "7c57c381-4b19-49e4-bbb0-404a45166ee4",
        "purchaseAmount": 987.65,
        "fluzpayAmount": 987.65,
        "seatRewardValue": 123.45,
        "paypalVaultId": "7c57c381-4b19-49e4-bbb0-404a45166ee4",
        "createdAt": "2007-12-03T10:15:30Z",
        "giftCard": GiftCard,
        "virtualCard": VirtualCard
      }
    }
  }

revealGiftCardByGiftCardId

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

Response

Returns

GiftCardCode

Arguments	Description
giftCardId: UUID!

Arguments

Description

giftCardId:

UUID!

Query


  mutation revealGiftCardByGiftCardId($giftCardId: UUID!) {
    revealGiftCardByGiftCardId(giftCardId: $giftCardId) {
      code
      pin
      url
    }
  }

Variables


  {
    "giftCardId": "8c8cf345-3f20-4708-9a78-eac27d54a535"
  }

Response


  {
    "data": {
      "revealGiftCardByGiftCardId": {
        "code": "9877890000000000",
        "pin": "2014",
        "url": "null"
      }
    }
  }

revealVirtualCardByVirtualCardId

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

VirtualCardDetails

Arguments	Description
virtualCardId: UUID!

Arguments

Description

virtualCardId:

UUID!

Query


  mutation revealVirtualCardByVirtualCardId($virtualCardId: UUID!) {
    revealVirtualCardByVirtualCardId(virtualCardId: $virtualCardId) {
      cardNumber
      expiryMMYY
      cvv
      cardHolderName
      billingAddress {
        ...VirtualCardAddressInfoFragment
      }
    }
  }

Variables


  {
    "virtualCardId": "8c8cf345-3f20-4708-9a78-eac27d54a535"
  }

Response


  {
    "data": {
      "revealVirtualCardByVirtualCardId": {
        "cardNumber": "4111111560324603",
        "expiryMMYY": "02/2023",
        "cvv": "486",
        "cardHolderName": "Susan Jones",
        "billingAddress": VirtualCardAddressInfo
      }
    }
  }

SCALAR

Boolean

The Boolean scalar type represents true or false.

Example

true

DateTime

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"

Float

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

Example

987.65

Int

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

Example

String

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"

UUID

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

"8c8cf345-3f20-4708-9a78-eac27d54a535"

INPUT_OBJECT

AddBankCardInput

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

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.

Example


  {
    "cardNumber": "4111111560324603",
    "expirationMonth": "02",
    "expirationYear": "2025",
    "cvv": "xyz789",
    "cardholderName": "John Doe",
    "billingAddress": UserAddressInput,
    "userAddressId": "8c8cf345-3f20-4708-9a78-eac27d54a535"
  }

CreateVirtualCardInput

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

Input Field	Description
idempotencyKey: UUID!	The unique client generated UUID value used to identify a request and ensure that it is only executed 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: DateTime	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.
balanceAmount: Float	The balance amount.
bankAccountId: UUID	The unique identifier for the bank account.
bin: String	The Bank Identification Number of the issuing bank. Use getBins to fetch a list of active BINs.

Example


  {
    "idempotencyKey": "07df5653-43a8-4532-9881-3ab5857bbe11",
    "spendLimit": 123.45,
    "spendLimitDuration": "DAILY",
    "lockDate": "2007-12-03T10:15:30Z",
    "lockCardNextUse": true,
    "cardNickname": "xyz789",
    "balanceAmount": 123.45,
    "bankAccountId": "31a46879-0926-424a-9932-259b8a015a7a",
    "bin": "537876"
  }

DepositCashBalanceInput

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

Input Field	Description
idempotencyKey: UUID!	The unique client generated UUID value used to identify a request and ensure that it is only executed 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.

Example


  {
    "idempotencyKey": "h0dffffb-26cf-4773-ada6-5564eb92a1e7",
    "amount": 123.45,
    "depositType": "CASH_BALANCE",
    "bankAccountId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "merchantCategoryCode": 5555,
    "bankCardId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "paypalVaultId": "8c8cf345-3f20-4708-9a78-eac27d54a535"
  }

GetOfferQuoteInput

Input type for getOfferQuote query.

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.

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": "cvs",
    "denomination": 987.65,
    "paymentMethod": "BANK_CARD"
  }

MerchantInput

Input type for getReferralUrl query.

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.

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": "f37cff96-6ca7-4197-b4ff-32ce94433455",
    "slug": "xyz789",
    "name": "xyz789"
  }

OffsetInput

The page info.

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

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": 123
  }

PurchaseGiftCardInput

Input type for purchase gift card.

Input Field	Description
idempotencyKey: UUID!	The unique client generated UUID value used to identify a request and ensure that it is only executed 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.

Example


  {
    "idempotencyKey": "h0dffffb-26cf-4773-ada6-5564eb92a1e7",
    "offerId": "7c57c381-4b19-49e4-bbb0-404a45166ee4",
    "amount": 123.45,
    "balanceAmount": 987.65,
    "bankAccountId": "7c57c381-4b19-49e4-bbb0-404a45166ee4",
    "bankCardId": "7c57c381-4b19-49e4-bbb0-404a45166ee4",
    "paypalVaultId": "7c57c381-4b19-49e4-bbb0-404a45166ee4",
    "exclusiveRateId": "7c57c381-4b19-49e4-bbb0-404a45166ee4",
    "merchantSlug": "abc123",
    "defaultToBalance": false
  }

UserAddressInput

Input type for adding an address to the user.

Input Field	Description
streetAddressLine1: String!
streetAddressLine2: String
country: String!
city: String!
state: String!
postalCode: String

Example


  {
    "streetAddressLine1": "351 Mueller Keys",
    "streetAddressLine2": null,
    "country": "United States",
    "city": "Dover",
    "state": "Delaware",
    "postalCode": "11223"
  }

ENUM

AccountType

Enum describing the types of accounts.

Enum Value	Description
CONSUMER	Account is a consumer/personal account.
BUSINESS	Account is a business account.

Enum Value

Description

CONSUMER

Account is a consumer/personal account.

BUSINESS

Account is a business account.

Example

"BUSINESS"

BankAccountStatus

BankAccountStatus represents the current status of a bank account.

Enum Value	Description
ENABLED
DISABLED

Enum Value

Description

ENABLED

DISABLED

Example

"ENABLED"

BankAccountType

BankAccountType represents the type of bank account.

Enum Value	Description
SAVING
CREDIT
CHECKING

Enum Value

Description

SAVING

CREDIT

CHECKING

Example

"SAVING"

BankCardStatus

BankCardStatus represents the status of bank card.

Enum Value	Description
ACTIVE
INACTIVE
PENDING_REMOVAL

Enum Value

Description

ACTIVE

INACTIVE

PENDING_REMOVAL

Example

"ACTIVE"

BankCardType

BankCardType represents the type of bank card.

Enum Value	Description
DEBIT
CREDIT
PREPAID

Enum Value

Description

DEBIT

CREDIT

PREPAID

Example

"DEBIT"

CashBalanceAvailabilityType

Enum defining the types of availability for a cash balance.

Enum Value	Description
INSTANT	The deposit can be settled immediately.
STANDARD	Standard processing times applies.

Enum Value

Description

INSTANT

The deposit can be settled immediately.

STANDARD

Standard processing times applies.

Example

"INSTANT"

CashBalanceDepositStatus

Enum representing the status of a cash balance deposit.

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"

CashBalanceDepositType

Enum representing different types of cash balance deposits.

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.

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"

GiftCardStatus

GiftCardStatus represents the current state of a gift card.

Enum Value	Description
ACTIVE	The default status when a Gift Card is generated.
ARCHIVED	The Gift Card has been marked as used by the user.

Enum Value

Description

ACTIVE

The default status when a Gift Card is generated.

ARCHIVED

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

Example

"ACTIVE"

OfferDenominationType

OfferDenominationType is the type of denomination of a specific offer.

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.

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"

OfferType

OfferType is the type of offer.

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.

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.

Example

"GIFT_CARD_OFFER"

PayPalAccountStatus

PayPalAccountStatus represents the current status of a PayPal account.

Enum Value	Description
ACTIVE
REMOVED

Enum Value

Description

ACTIVE

REMOVED

Example

"ACTIVE"

PaymentMethodType

PaymentMethodType represents the type of payment method.

Enum Value	Description
BANK_CARD
BANK_ACCOUNT
PAYPAL
FLUZPAY
APPLE_PAY
GOOGLE_PAY

Example

"BANK_CARD"

ScopeType

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.

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.
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.

Example

"LIST_PAYMENT"

VirtualCardSpendLimitDuration

VirtualCardSpendLimitDuration represents the card limit duration type.

Enum Value	Description
DAILY
WEEKLY
MONTHLY
ANNUAL
LIFETIME

Example

"LIFETIME"

VirtualCardStatus

VirtualCardStatus represents the current state of a virtual card.

Enum Value	Description
PENDING
ACTIVE
USED
CANCELLED
REFUNDED
EXPIRED
DISPUTED

Example

"PENDING"

VirtualCardType

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

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.

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"

OBJECT

Account

Represents the account operable by the application.

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": "a2c02ec6-357b-41cf-9229-4da34e727019",
    "type": "CONSUMER",
    "accountName": "xyz789",
    "seats": [Seat],
    "user": User,
    "business": Business
  }

ApplicationUser

Represents the user_id and the scopes that the user has made available to the application, expired and invalid scopes are not included.

Field Name	Description
userId: UUID	The userId that has granted the scopes.
scopes: [ScopeType]	The user scopes available the application.

Field Name

Description

userId:

UUID

The userId that has granted the scopes.

scopes:

[ScopeType]

The user scopes available the application.

Example


  {
    "userId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "scopes": ["LIST_PAYMENT"]
  }

BankAccount

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

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": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "accountId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "type": "SAVING",
    "accountName": "John's Account",
    "status": "ENABLED",
    "achRouting": "026009593",
    "lastFour": "1122",
    "authChargeBackupPaymentMethod": false,
    "billingAddressId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "nickname": "Johnny"
  }

BankCard

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

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

Example


  {
    "bankCardId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "ownerAccountId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "addedUserId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "cardType": "DEBIT",
    "cardProcessor": "MASTERCARD",
    "cardholderName": "John Doe",
    "lastFourDigits": "1122",
    "expirationMonth": "11",
    "expirationYear": "2025",
    "cardStatus": "ACTIVE",
    "billingAddressId": "8c8cf345-3f20-4708-9a78-eac27d54a535"
  }

Bin

Represents the Bank identification numbers (BINs).

Field Name	Description
bin: String	The bank bin.
bankName: String	The bank name.
programLimits: ProgramLimits	The bank program spent limits.
earnRate: String	The bank program earn rate.

Example


  {
    "bin": "123456",
    "bankName": "abc123",
    "programLimits": ProgramLimits,
    "earnRate": "1%"
  }

Business

Represents the Business who has access to the account.

Field Name	Description
businessId: UUID	The businessId associated with the account.
businessName: String	The name of the business.

Field Name

Description

businessId:

UUID

The businessId associated with the account.

businessName:

String

The name of the business.

Example


  {
    "businessId": "a2c02ec6-357b-41cf-9229-4da34e727019",
    "businessName": "xyz789"
  }

CashBalance

CashBalance represents the balance of a user's cash.

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": "5000.00",
    "totalBalance": "10000.00",
    "pendingBalance": "2000.00",
    "lifetimeBalance": "60000.00"
  }

CashBalanceDeposit

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

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": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "depositDisplayId": "102370",
    "depositAmount": "200.00",
    "depositFee": "2.00",
    "bankCardId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "bankAccountId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "paypalVaultId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "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]
  }

CashBalanceSettlement

CashBalanceSettlement representing a settlement record of a cash balance.

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": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "cashBalanceDepositId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "availabilityType": "INSTANT",
    "status": "AVAILABLE"
  }

DepositCashBalanceResponse

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

Field Name	Description
cashBalanceDeposits: [CashBalanceDeposit]	List of cash balance deposits made as part of the mutation.
balances: UserBalances	User's current balances.

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
  }

GenerateUserAccessTokenResponse

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

Field Name

Description

token:

String

The User Access JWT for API requests.

scopes:

[ScopeType]

The list of scopes granted to the token.

Example


  {
      "token": "eyJhbGciOiJItSEqOajcx..."
    "scopes": ["LIST_PAYMENT"]
  }

GetWalletResponse

GetWalletResponse represents the response to the get wallet request.

Field Name	Description
bankCards(paginate: OffsetInput): [BankCard]
bankAccounts(paginate: OffsetInput): [BankAccount]
paypalAccounts: [Paypal]
blockedPaymentTypes: [PaymentMethodType]
balances: UserBalances

Example


  {
    "bankCards": [BankCard],
    "bankAccounts": [BankAccount],
    "paypalAccounts": [Paypal],
    "blockedPaymentTypes": ["BANK_CARD"],
    "balances": UserBalances
  }

GiftCard

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

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": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "purchaserUserId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "endDate": "2007-12-03T10:15:30Z",
    "status": "ACTIVE",
    "createdAt": "2007-12-03T10:15:30Z",
    "merchant": Merchant
  }

GiftCardCode

GiftCardCode contains the redemption credentials for a Merchant.

Field Name

Description

code:

String

pin:

String

url:

String

Example


  {
    "code": "9877890000000000",
    "pin": "2014",
    "url": "null"
  }

Merchant

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

Field Name	Description
merchantId: UUID!
name: String
slug: String
offers: [Offer]

Example


  {
    "merchantId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "name": "CVS",
    "slug": "cvs",
    "offers": [Offer]
  }

MerchantCategoryCode

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

Field Name

Description

code:

String

Four digit merchant category code.

displayDescription:

String

Display description.

description:

String

Mcc description.

Example


  {
    "code": "xyz789",
    "displayDescription": "abc123",
    "description": "xyz789"
  }

Offer

Offer is a discounted offer for a merchant.

Field Name	Description
offeringMerchantId: UUID!
offerId: UUID!
type: OfferType!
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.

Example


  {
    "offeringMerchantId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "offerId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "type": "GIFT_CARD_OFFER",
    "hasStockInfo": false,
    "offerRates": [OfferRate],
    "denominationsType": "VARIABLE",
    "stockInfo": [StockInfoVariableType]
  }

OfferRate

OfferRate is the rate of a specific offer.

Field Name	Description
maxUserRewardValue: Float
cashbackVoucherRewardValue: Float
boostRewardValue: Float
displayBoostReward: Boolean
denominations: [String]
allowedPaymentMethods: [String]

Example


  {
    "maxUserRewardValue": 987.65,
    "cashbackVoucherRewardValue": 123.45,
    "boostRewardValue": 123.45,
    "displayBoostReward": false,
    "denominations": ["20", "50", "100"],
    "allowedPaymentMethods": ["BANK_CARD", "BANK_ACCOUNT"]
  }

Paypal

Paypal represents a PayPal account added by a user.

Field Name	Description
paypalVaultId: UUID!	The ID of the PayPal account.
userId: UUID!
status: PayPalAccountStatus!
email: String!

Example


  {
    "paypalVaultId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "userId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "status": "ACTIVE",
    "email": "[email protected]"
  }

ProgramLimits

Represents the bank program spent limits.

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": "200.00",
    "weeklyLimit": "5000.00",
    "monthlyLimit": "20000.00"
  }

RewardsBalance

RewardsBalance represents the balance of a user's rewards.

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": "200.00",
    "totalBalance": "5000.00",
    "lifetimeBalance": "20000.00"
  }

Seat

Represents the network position held by the entity.

Field Name

Description

seatId:

UUID

The seat id associated with the account.

seatNumber:

String

The string value of seat position.

Example


  {
    "seatId": "a2c02ec6-357b-41cf-9229-4da34e727019",
    "seatNumber": "xyz789"
  }

StockInfoFixedType

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

Field Name

Description

denomination:

String

The stock denomination value of the offer.

availableStock:

String

The available stock of the offer.

Example


  {
    "denomination": "xyz789",
    "availableStock": "xyz789"
  }

StockInfoVariableType

StockInfoVariableType describes the available denomination range for variable offers.

Field Name

Description

minDenomination:

String

The min denomination of the variable offer.

maxDenomination:

String

The max denomination of the variable offer.

description:

String

The variable stock description.

Example


  {
    "minDenomination": "xyz789",
    "maxDenomination": "xyz789",
    "description": "xyz789"
  }

User

Represents the User who has access to the account.

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": "a2c02ec6-357b-41cf-9229-4da34e727019",
    "firstName": "xyz789",
    "lastName": "xyz789"
  }

UserAddress

UserAddress represents a User Address record.

Field Name	Description
userAddressId: UUID!
streetAddressLine1: String
streetAddressLine2: String
country: String!
city: String!
state: String
postalCode: String

Example


  {
    "userAddressId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "streetAddressLine1": "351 Mueller Keys",
    "streetAddressLine2": null,
    "country": "United States",
    "city": "Dover",
    "state": "Delaware",
    "postalCode": "11223"
  }

UserBalances

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

Field Name

Description

rewardsBalance:

RewardsBalance

cashBalance:

CashBalance

giftCardCashBalance:

CashBalance

Example


  {
    "rewardsBalance": RewardsBalance,
    "cashBalance": CashBalance,
    "giftCardCashBalance": CashBalance
  }

UserPurchase

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

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.

Example


  {
    "purchaseId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "purchaseDisplayId": "1002405",
    "purchaseBankCardId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "bankAccountId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "purchaseAmount": 123.45,
    "fluzpayAmount": 123.45,
    "seatRewardValue": 123.45,
    "paypalVaultId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "createdAt": "2007-12-03T10:15:30Z",
    "giftCard": GiftCard,
    "virtualCard": VirtualCard
  }

VirtualCard

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

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": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "userId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "cardholderName": "Sue",
    "expiryMonth": "01",
    "expiryYear": "28",
    "virtualCardLast4": "abc123",
    "status": "PENDING",
    "cardType": "MULTI_USE",
    "initialAmount": 123.45,
    "usedAmount": 123.45,
    "createdAt": "2007-12-03T10:15:30Z",
    "authorizationSetting": VirtualCardAuthorizationSetting
  }

VirtualCardAddressInfo

VirtualCardAddressInfo provides the address information associated with a virtual card.

Field Name	Description
streetAddress: String	The street address.
billingAddrLine2: String	The second line of the billing address.
city: String	The city.
state: String	The state.
postalCode: String	The postal code.

Example


  {
    "streetAddress": : "351 Mueller Keys",
    "billingAddrLine2": null,
    "city": "Dover",
    "state": "Delaware",
    "postalCode": "11223"
  }

VirtualCardAuthorizationSetting

VirtualCardAuthorizationSetting defines the authorization settings for a virtual card.

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": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "virtualCardId": "8c8cf345-3f20-4708-9a78-eac27d54a535",
    "lockDate": "2028-06-01 03:59:59.999+00",
    "dailySpendLimit": "100.00",
    "weeklySpendLimit": "200.00",
    "monthlySpendLimit": "300.00",
    "annualSpendLimit": "500.00",
    "lifetimeSpendLimit": "1000.00",
    "dailySpent": "22.50",
    "weeklySpent": "100.00",
    "monthlySpent": "200.00",
    "annualSpent": "500.00",
    "lifetimeSpent": "500.00",
    "tokenized": true,
    "lockedByUser": true,
    "lockCardNextUse": false,
    "cardNickname": "Johnny"
  }

VirtualCardDetails

The VirtualCardDetails type represents the details of a virtual card.

Field Name	Description
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.

Example


  {
    "cardNumber": "4111111560324603",
    "expiryMMYY": "02/2023",
    "cvv": "486",
    "cardHolderName": "Susan Jones",
    "billingAddress": VirtualCardAddressInfo
  }

UNION

StockInfoType

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

Union Types

Description

StockInfoFixedType

The stock type associated with fixed offers.

StockInfoVariableType

The stock type associated with variable offers.

Example

StockInfoFixedType

Get the app

© 2025 Fluz Fluz, LLC.
Fluz is a financial technology company, not a bank. Banking services provided by partner banks, members FDIC.

Legal

Status

Trust center