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": "48713892-8dd4-41e6-9002-df8c03460692"
}
Response
{
  "data": {
    "getAccountsByUserId": [
      {
        "accountId": "48713892-8dd4-41e6-9002-df8c03460692",
        "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": "48713892-8dd4-41e6-9002-df8c03460692",
        "scopes": ["LIST_PAYMENT"],
        "accounts": [Account]
      }
    ]
  }
}
Queries

getBINs

Description

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

Response

Returns [Bin]

Example

Query
query getBiNs {
  getBINs {
    bin
    bankName
    programLimits {
      ...ProgramLimitsFragment
    }
    rewardValue
  }
}
Response
{
  "data": {
    "getBINs": [
      {
        "bin": "abc123",
        "bankName": "abc123",
        "programLimits": ProgramLimits,
        "rewardValue": "abc123"
      }
    ]
  }
}
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": "48713892-8dd4-41e6-9002-df8c03460692",
        "purchaserUserId": "48713892-8dd4-41e6-9002-df8c03460692",
        "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": "xyz789",
        "displayDescription": "xyz789",
        "description": "xyz789"
      }
    ]
  }
}
Queries

getMerchants

Description

Get the active merchant catalog. Requires LIST_OFFERS scope.

Response

Returns [Merchant]!

Arguments
Name Description
name - String
paginate - OffsetInput
offerTypes - OfferTypesInput

Example

Query
query getMerchants(
  $name: String,
  $paginate: OffsetInput,
  $offerTypes: OfferTypesInput
) {
  getMerchants(
    name: $name,
    paginate: $paginate,
    offerTypes: $offerTypes
  ) {
    merchantId
    name
    slug
    offers {
      ...OfferFragment
    }
  }
}
Variables
{
  "name": "xyz789",
  "paginate": OffsetInput,
  "offerTypes": OfferTypesInput
}
Response
{
  "data": {
    "getMerchants": [
      {
        "merchantId": "48713892-8dd4-41e6-9002-df8c03460692",
        "name": "abc123",
        "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
    hasStockInfo
    offerRates {
      ...OfferRateFragment
    }
    denominationsType
    stockInfo {
      ... on StockInfoFixedType {
        ...StockInfoFixedTypeFragment
      }
      ... on StockInfoVariableType {
        ...StockInfoVariableTypeFragment
      }
    }
    cloDetails {
      ...CloDetailsFragment
    }
  }
}
Variables
{"input": GetOfferQuoteInput}
Response
{
  "data": {
    "getOfferQuote": {
      "offeringMerchantId": "48713892-8dd4-41e6-9002-df8c03460692",
      "offerId": "48713892-8dd4-41e6-9002-df8c03460692",
      "type": "GIFT_CARD_OFFER",
      "hasStockInfo": false,
      "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

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": "48713892-8dd4-41e6-9002-df8c03460692",
        "streetAddressLine1": "abc123",
        "streetAddressLine2": "xyz789",
        "country": "abc123",
        "city": "xyz789",
        "state": "abc123",
        "postalCode": "xyz789"
      }
    ]
  }
}
Queries

getUserPurchases

Description

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

Response

Returns [UserPurchase]

Arguments
Name Description
paginate - OffsetInput

Example

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": "48713892-8dd4-41e6-9002-df8c03460692",
        "purchaseDisplayId": "abc123",
        "purchaseBankCardId": "48713892-8dd4-41e6-9002-df8c03460692",
        "bankAccountId": "48713892-8dd4-41e6-9002-df8c03460692",
        "purchaseAmount": 987.65,
        "fluzpayAmount": 987.65,
        "seatRewardValue": 987.65,
        "paypalVaultId": "48713892-8dd4-41e6-9002-df8c03460692",
        "createdAt": "2007-12-03T10:15:30Z",
        "giftCard": GiftCard,
        "virtualCard": VirtualCard
      }
    ]
  }
}
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
  }
}
Variables
{"input": AddBankCardInput}
Response
{
  "data": {
    "addBankCard": {
      "bankCardId": "48713892-8dd4-41e6-9002-df8c03460692",
      "ownerAccountId": "48713892-8dd4-41e6-9002-df8c03460692",
      "addedUserId": "48713892-8dd4-41e6-9002-df8c03460692",
      "cardType": "DEBIT",
      "cardProcessor": "xyz789",
      "cardholderName": "xyz789",
      "lastFourDigits": "abc123",
      "expirationMonth": "abc123",
      "expirationYear": "xyz789",
      "cardStatus": "ACTIVE",
      "billingAddressId": "48713892-8dd4-41e6-9002-df8c03460692"
    }
  }
}
Mutations

createVirtualCard

Description

Initiates virtual card creation. Requires BUSINESS account type. 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
  • bin is defined and access is not bin is false
Response

Returns a UserPurchase

Arguments
Name Description
input - CreateVirtualCardInput!

Example

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": "48713892-8dd4-41e6-9002-df8c03460692",
      "purchaseDisplayId": "abc123",
      "purchaseBankCardId": "48713892-8dd4-41e6-9002-df8c03460692",
      "bankAccountId": "48713892-8dd4-41e6-9002-df8c03460692",
      "purchaseAmount": 123.45,
      "fluzpayAmount": 987.65,
      "seatRewardValue": 123.45,
      "paypalVaultId": "48713892-8dd4-41e6-9002-df8c03460692",
      "createdAt": "2007-12-03T10:15:30Z",
      "giftCard": GiftCard,
      "virtualCard": VirtualCard
    }
  }
}
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

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
    scopes
  }
}
Variables
{
  "userId": "48713892-8dd4-41e6-9002-df8c03460692",
  "accountId": "48713892-8dd4-41e6-9002-df8c03460692",
  "scopes": ["LIST_PAYMENT"],
  "seatId": "48713892-8dd4-41e6-9002-df8c03460692"
}
Response
{
  "data": {
    "generateUserAccessToken": {
      "token": "abc123",
      "scopes": ["LIST_PAYMENT"]
    }
  }
}
Mutations

purchaseGiftCard

Description

Initiates a gift card purchase transaction. Requires PURCHASE_GIFTCARD scope. The offerId or merchanntSlug 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
    }
  }
}
Variables
{"input": PurchaseGiftCardInput}
Response
{
  "data": {
    "purchaseGiftCard": {
      "purchaseId": "48713892-8dd4-41e6-9002-df8c03460692",
      "purchaseDisplayId": "abc123",
      "purchaseBankCardId": "48713892-8dd4-41e6-9002-df8c03460692",
      "bankAccountId": "48713892-8dd4-41e6-9002-df8c03460692",
      "purchaseAmount": 987.65,
      "fluzpayAmount": 123.45,
      "seatRewardValue": 123.45,
      "paypalVaultId": "48713892-8dd4-41e6-9002-df8c03460692",
      "createdAt": "2007-12-03T10:15:30Z",
      "giftCard": GiftCard,
      "virtualCard": VirtualCard
    }
  }
}
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": "48713892-8dd4-41e6-9002-df8c03460692"
}
Response
{
  "data": {
    "revealGiftCardByGiftCardId": {
      "code": "xyz789",
      "pin": "abc123",
      "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) {
    cardNumber
    expiryMMYY
    cvv
    cardHolderName
    billingAddress {
      ...VirtualCardAddressInfoFragment
    }
  }
}
Variables
{
  "virtualCardId": "48713892-8dd4-41e6-9002-df8c03460692"
}
Response
{
  "data": {
    "revealVirtualCardByVirtualCardId": {
      "cardNumber": "abc123",
      "expiryMMYY": "abc123",
      "cvv": "xyz789",
      "cardHolderName": "xyz789",
      "billingAddress": VirtualCardAddressInfo
    }
  }
}

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
"48713892-8dd4-41e6-9002-df8c03460692"

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.
Example
{
  "cardNumber": "xyz789",
  "expirationMonth": "xyz789",
  "expirationYear": "xyz789",
  "cvv": "xyz789",
  "cardholderName": "xyz789",
  "billingAddress": UserAddressInput,
  "userAddressId": "48713892-8dd4-41e6-9002-df8c03460692"
}
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 - 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 amount of Fluz balance to be applied to the card.
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": "48713892-8dd4-41e6-9002-df8c03460692",
  "spendLimit": 987.65,
  "spendLimitDuration": "DAILY",
  "lockDate": "2007-12-03T10:15:30Z",
  "lockCardNextUse": false,
  "cardNickname": "abc123",
  "balanceAmount": 987.65,
  "bankAccountId": "48713892-8dd4-41e6-9002-df8c03460692",
  "bin": "xyz789"
}
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.
Example
{
  "idempotencyKey": "48713892-8dd4-41e6-9002-df8c03460692",
  "amount": 123.45,
  "depositType": "CASH_BALANCE",
  "merchantCategoryCode": 123,
  "bankAccountId": "48713892-8dd4-41e6-9002-df8c03460692",
  "bankCardId": "48713892-8dd4-41e6-9002-df8c03460692",
  "paypalVaultId": "48713892-8dd4-41e6-9002-df8c03460692"
}
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": 987.65,
  "paymentMethod": "BANK_CARD"
}
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": "48713892-8dd4-41e6-9002-df8c03460692",
  "slug": "xyz789",
  "name": "abc123"
}
INPUT_OBJECT

OfferTypesInput

Description

Input type for getMerchants.

Fields
Input Field Description
giftCardOffer - Boolean
cardLinkedOffer - Boolean
Example
{"giftCardOffer": false, "cardLinkedOffer": false}
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.
Example
{
  "idempotencyKey": "48713892-8dd4-41e6-9002-df8c03460692",
  "offerId": "48713892-8dd4-41e6-9002-df8c03460692",
  "amount": 987.65,
  "balanceAmount": 123.45,
  "bankAccountId": "48713892-8dd4-41e6-9002-df8c03460692",
  "bankCardId": "48713892-8dd4-41e6-9002-df8c03460692",
  "paypalVaultId": "48713892-8dd4-41e6-9002-df8c03460692",
  "exclusiveRateId": "48713892-8dd4-41e6-9002-df8c03460692",
  "merchantSlug": "abc123",
  "defaultToBalance": true
}
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": "xyz789",
  "country": "xyz789",
  "city": "abc123",
  "state": "xyz789",
  "postalCode": "xyz789"
}

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

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.

ARCHIVED

 The Gift Card has been marked as used by the user.
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

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.

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.
Example
"LIST_PAYMENT"
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

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"

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": "48713892-8dd4-41e6-9002-df8c03460692",
  "type": "CONSUMER",
  "accountName": "abc123",
  "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": "48713892-8dd4-41e6-9002-df8c03460692",
  "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": "48713892-8dd4-41e6-9002-df8c03460692",
  "accountId": "48713892-8dd4-41e6-9002-df8c03460692",
  "type": "SAVING",
  "accountName": "abc123",
  "status": "ENABLED",
  "achRouting": "abc123",
  "lastFour": "abc123",
  "authChargeBackupPaymentMethod": true,
  "billingAddressId": "48713892-8dd4-41e6-9002-df8c03460692",
  "nickname": "abc123"
}
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
Example
{
  "bankCardId": "48713892-8dd4-41e6-9002-df8c03460692",
  "ownerAccountId": "48713892-8dd4-41e6-9002-df8c03460692",
  "addedUserId": "48713892-8dd4-41e6-9002-df8c03460692",
  "cardType": "DEBIT",
  "cardProcessor": "abc123",
  "cardholderName": "xyz789",
  "lastFourDigits": "abc123",
  "expirationMonth": "abc123",
  "expirationYear": "abc123",
  "cardStatus": "ACTIVE",
  "billingAddressId": "48713892-8dd4-41e6-9002-df8c03460692"
}
OBJECT

Bin

Description

Represents the Bank identification numbers (BINs).

Fields
Field Name Description
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
{
  "bin": "abc123",
  "bankName": "abc123",
  "programLimits": ProgramLimits,
  "rewardValue": "xyz789"
}
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": "48713892-8dd4-41e6-9002-df8c03460692",
  "businessName": "abc123"
}
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": "abc123",
  "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": "48713892-8dd4-41e6-9002-df8c03460692",
  "depositDisplayId": "xyz789",
  "depositAmount": "abc123",
  "depositFee": "xyz789",
  "bankCardId": "48713892-8dd4-41e6-9002-df8c03460692",
  "bankAccountId": "48713892-8dd4-41e6-9002-df8c03460692",
  "paypalVaultId": "48713892-8dd4-41e6-9002-df8c03460692",
  "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": "48713892-8dd4-41e6-9002-df8c03460692",
  "cashBalanceDepositId": "48713892-8dd4-41e6-9002-df8c03460692",
  "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": 987.65,
  "applyPromoBaseRateAfterCap": true,
  "minimumPurchaseAmount": 123.45,
  "activePeriodStartDate": "xyz789",
  "activePeriodEndDate": "abc123",
  "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": "48713892-8dd4-41e6-9002-df8c03460692",
  "offerRateType": "REGULAR",
  "periodType": "abc123",
  "startDate": "xyz789",
  "endDate": "xyz789",
  "startTime": "xyz789",
  "endTime": "abc123",
  "daysOfWeek": ["xyz789"],
  "daysOfMonth": ["xyz789"]
}
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.
scopes - [ScopeType] The list of scopes granted to the token.
Example
{
  "token": "xyz789",
  "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": "48713892-8dd4-41e6-9002-df8c03460692",
  "purchaserUserId": "48713892-8dd4-41e6-9002-df8c03460692",
  "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": "abc123",
  "pin": "xyz789",
  "url": "xyz789"
}
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": "48713892-8dd4-41e6-9002-df8c03460692",
  "name": "abc123",
  "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": "abc123",
  "displayDescription": "xyz789",
  "description": "abc123"
}
OBJECT

Offer

Description

Offer is a discounted offer for a merchant.

Fields
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.
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": "48713892-8dd4-41e6-9002-df8c03460692",
  "offerId": "48713892-8dd4-41e6-9002-df8c03460692",
  "type": "GIFT_CARD_OFFER",
  "hasStockInfo": false,
  "offerRates": [OfferRate],
  "denominationsType": "VARIABLE",
  "stockInfo": [StockInfoFixedType],
  "cloDetails": CloDetails
}
OBJECT

OfferRate

Description

OfferRate is the rate of a specific offer.

Fields
Field Name Description
maxUserRewardValue - Float
cashbackVoucherRewardValue - Float
boostRewardValue - Float
displayBoostReward - Boolean
denominations - [String]
allowedPaymentMethods - [String]
Example
{
  "maxUserRewardValue": 123.45,
  "cashbackVoucherRewardValue": 987.65,
  "boostRewardValue": 987.65,
  "displayBoostReward": true,
  "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": "48713892-8dd4-41e6-9002-df8c03460692",
  "userId": "48713892-8dd4-41e6-9002-df8c03460692",
  "status": "ACTIVE",
  "email": "abc123"
}
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": "abc123",
  "monthlyLimit": "abc123"
}
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": "xyz789",
  "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": "48713892-8dd4-41e6-9002-df8c03460692",
  "seatNumber": "abc123"
}
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": "abc123",
  "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": "xyz789",
  "maxDenomination": "abc123",
  "description": "xyz789"
}
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": "48713892-8dd4-41e6-9002-df8c03460692",
  "firstName": "xyz789",
  "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": "48713892-8dd4-41e6-9002-df8c03460692",
  "streetAddressLine1": "xyz789",
  "streetAddressLine2": "xyz789",
  "country": "xyz789",
  "city": "xyz789",
  "state": "abc123",
  "postalCode": "abc123"
}
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
Example
{
  "rewardsBalance": RewardsBalance,
  "cashBalance": CashBalance,
  "giftCardCashBalance": CashBalance
}
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.
Example
{
  "purchaseId": "48713892-8dd4-41e6-9002-df8c03460692",
  "purchaseDisplayId": "abc123",
  "purchaseBankCardId": "48713892-8dd4-41e6-9002-df8c03460692",
  "bankAccountId": "48713892-8dd4-41e6-9002-df8c03460692",
  "purchaseAmount": 123.45,
  "fluzpayAmount": 123.45,
  "seatRewardValue": 123.45,
  "paypalVaultId": "48713892-8dd4-41e6-9002-df8c03460692",
  "createdAt": "2007-12-03T10:15:30Z",
  "giftCard": GiftCard,
  "virtualCard": VirtualCard
}
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": "48713892-8dd4-41e6-9002-df8c03460692",
  "userId": "48713892-8dd4-41e6-9002-df8c03460692",
  "cardholderName": "abc123",
  "expiryMonth": "abc123",
  "expiryYear": "xyz789",
  "virtualCardLast4": "abc123",
  "status": "PENDING",
  "cardType": "MULTI_USE",
  "initialAmount": 987.65,
  "usedAmount": 987.65,
  "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": "abc123",
  "city": "xyz789",
  "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": "48713892-8dd4-41e6-9002-df8c03460692",
  "virtualCardId": "48713892-8dd4-41e6-9002-df8c03460692",
  "lockDate": "abc123",
  "dailySpendLimit": "xyz789",
  "weeklySpendLimit": "xyz789",
  "monthlySpendLimit": "abc123",
  "annualSpendLimit": "xyz789",
  "lifetimeSpendLimit": "abc123",
  "dailySpent": "abc123",
  "weeklySpent": "xyz789",
  "monthlySpent": "abc123",
  "annualSpent": "xyz789",
  "lifetimeSpent": "xyz789",
  "tokenized": false,
  "lockedByUser": false,
  "lockCardNextUse": true,
  "cardNickname": "xyz789"
}
OBJECT

VirtualCardDetails

Description

The VirtualCardDetails type represents the details of a virtual card.

Fields
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": "xyz789",
  "expiryMMYY": "abc123",
  "cvv": "abc123",
  "cardHolderName": "abc123",
  "billingAddress": VirtualCardAddressInfo
}

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