Crew GraphQL API Reference

Complete GraphQL API documentation for Crew

API Endpoints

https://api.trycrew.com/willow/graphql

Version

1.0.0

Getting Started

API Endpoint: https://api.trycrew.com/willow

Authentication `/auth`

Authenticate with the Crew API using the following process.

Send SMS OTP
Auth SMS OTP
Send Email OTP
Auth Email OTP

Send SMS OTP `/send_sms_otp`

Sends an SMS OTP message to the provided phone number.

curl -X POST https://api.trycrew.com/willow/auth/send_sms_otp \
     -H 'Content-Type: application/json' \
     -d '{
          "phone": "1234567890"
        }'

Auth SMS OTP `/auth_sms_otp`

Authenticates the OTP message received from the previous step.

curl -X POST https://api.trycrew.com/willow/auth/auth_sms_otp \
     -H 'Content-Type: application/json' \
     -d '{
          "otp":"413951",
          "phone_id":"phone-number-live-<uuid>"
        }'

Send Email OTP `/send_email_otp`

Sends an email OTP to the provided email address.

curl -X POST https://api.trycrew.com/willow/auth/send_email_otp \
     -H 'Content-Type: application/json' \
     -d '{
          "email": "<email>"
        }'

Auth Email OTP `/auth_email_otp`

Authenticates the OTP message received from the previous step.

curl -v -X POST https://api.trycrew.com/willow/auth/auth_email_otp \
     -H 'Content-Type: application/json' \
     -d '{
          "otp": "163103",
          "email_id": "email-live-<uuid>"
        }'

Test the connection

Take the token from the final request and use it as your Bearer token in subsequent requests.

Test the connection by fetching your current account balance.

curl -X POST https://api.trycrew.com/willow/graphql \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <TOKEN>' \
  -d '{"query":"query currentUser {id email spendAccount {id overallBalance clearedBalance}}"}'

Queries

`cashDepositLocations`

Response

Returns [CashDepositLocation!]!

Example

Query

query cashDepositLocations {
  cashDepositLocations {
    address
    coordinates
  }
}

Response

{
  "data": {
    "cashDepositLocations": [
      {
        "address": CashDepositAddress,
        "coordinates": Coordinates
      }
    ]
  }
}

Queries

`currentUser`

Response

Returns a User!

Example

Query

query currentUser {
  currentUser {
    accounts {
      ...AccountFragment
    }
    activePhysicalDebitCard {
      ...DebitCardFragment
    }
    activeProvisionalDebitCard {
      ...DebitCardFragment
    }
    address
    allowance {
      ...AllowanceFragment
    }
    cardColor
    cashDepositBarcode {
      ...CashDepositBarcodeFragment
    }
    cashTransactions {
      ...CashTransactionConnectionFragment
    }
    checkDeposits {
      ...CheckDepositFragment
    }
    comments {
      ...UserCommentFragment
    }
    currentDebitCardOrder {
      ...DebitCardOrderFragment
    }
    currentUserApplication {
      ...UserApplicationFragment
    }
    debitCardOrders {
      ...DebitCardOrderFragment
    }
    debitCards {
      ...DebitCardFragment
    }
    dob
    externalAccounts {
      ...AccountFragment
    }
    family {
      ...FamilyFragment
    }
    flags
    frozenReason
    frozenStatus
    invitedAt
    issuingPhysicalDebitCard {
      ...DebitCardFragment
    }
    latestUtmEntry {
      ...UtmEntryFragment
    }
    monthInReview {
      ...UserMonthInReviewFragment
    }
    pennyChatHistory {
      ...PennyThreadConnectionFragment
    }
    permittedActions
    prompts {
      ...PromptFragment
    }
    receivedReferral {
      ...ReferralFragment
    }
    recipientAccounts {
      ...AccountFragment
    }
    referralBonusEndDate
    referralBonuses {
      ...ReferralBonusConnectionFragment
    }
    roles {
      ...UserRoleFragment
    }
    saveAccount {
      ...AccountFragment
    }
    scheduledAllowance {
      ...ScheduledTransferFragment
    }
    scheduledTransfers {
      ...ScheduledTransferFragment
    }
    spendAccount {
      ...AccountFragment
    }
    status
    transfers {
      ...TransferConnectionFragment
    }
    userApplications {
      ...UserApplicationFragment
    }
    userBonusEndDate
    userBonuses {
      ...UserBonusConnectionFragment
    }
    userSettings {
      ...UserSettingFragment
    }
    userSpendConfig {
      ...UserSpendConfigFragment
    }
    utmEntryOverride {
      ...UtmEntryFragment
    }
    virtualDebitCards {
      ...DebitCardFragment
    }
  }
}

Response

{
  "data": {
    "currentUser": {
      "accounts": [Account],
      "activePhysicalDebitCard": DebitCard,
      "activeProvisionalDebitCard": DebitCard,
      "address": Address,
      "allowance": Allowance,
      "cardColor": "BANANA",
      "cashDepositBarcode": CashDepositBarcode,
      "cashTransactions": CashTransactionConnection,
      "checkDeposits": [CheckDeposit],
      "comments": [UserComment],
      "currentDebitCardOrder": DebitCardOrder,
      "currentUserApplication": UserApplication,
      "debitCardOrders": [DebitCardOrder],
      "debitCards": [DebitCard],
      "dob": "2007-12-03",
      "externalAccounts": [Account],
      "family": Family,
      "flags": UserFlags,
      "frozenReason": "FRAUD_DETECTED",
      "frozenStatus": "FREEZING",
      "invitedAt": "2007-12-03T10:15:30Z",
      "issuingPhysicalDebitCard": DebitCard,
      "latestUtmEntry": UtmEntry,
      "monthInReview": UserMonthInReview,
      "pennyChatHistory": PennyThreadConnection,
      "permittedActions": UserPermittedActions,
      "prompts": [Prompt],
      "receivedReferral": Referral,
      "recipientAccounts": [Account],
      "referralBonusEndDate": "2007-12-03",
      "referralBonuses": ReferralBonusConnection,
      "roles": [UserRole],
      "saveAccount": Account,
      "scheduledAllowance": ScheduledTransfer,
      "scheduledTransfers": [ScheduledTransfer],
      "spendAccount": Account,
      "status": "ACTIVATED",
      "transfers": TransferConnection,
      "userApplications": [UserApplication],
      "userBonusEndDate": "2007-12-03",
      "userBonuses": UserBonusConnection,
      "userSettings": [UserSetting],
      "userSpendConfig": UserSpendConfig,
      "utmEntryOverride": UtmEntry,
      "virtualDebitCards": [DebitCard]
    }
  }
}

Mutations

`activateDebitCards`

Description

Activates the debit cards

Response

Returns an ActivateDebitCardsPayload

Arguments

Name	Description
`input` - `ActivateDebitCardsInput!`

Example

Query

mutation activateDebitCards($input: ActivateDebitCardsInput!) {
  activateDebitCards(input: $input) {
    result {
      ...DebitCardFragment
    }
  }
}

Variables

{"input": ActivateDebitCardsInput}

Response

{"data": {"activateDebitCards": {"result": [DebitCard]}}}

Mutations

`addChild`

Description

Add child to your Crew

Response

Returns an AddChildPayload

Arguments

Name	Description
`input` - `AddChildInput!`

Example

Query

mutation addChild($input: AddChildInput!) {
  addChild(input: $input) {
    result {
      ...UserFragment
    }
  }
}

Variables

{"input": AddChildInput}

Response

{"data": {"addChild": {"result": User}}}

Mutations

`addDebitCardToAppleWalletSync`

Description

Provision a card for apple wallet for an account

Response

Returns an AddDebitCardToAppleWalletSyncPayload

Arguments

Name	Description
`input` - `AddDebitCardToAppleWalletSyncInput!`

Example

Query

mutation addDebitCardToAppleWalletSync($input: AddDebitCardToAppleWalletSyncInput!) {
  addDebitCardToAppleWalletSync(input: $input) {
    result
  }
}

Variables

{"input": AddDebitCardToAppleWalletSyncInput}

Response

{
  "data": {
    "addDebitCardToAppleWalletSync": {
      "result": AppleWalletProvisionResponse
    }
  }
}

Mutations

`addDebitCardToGoogleWalletSync`

Description

Provision a card for google wallet for an account

Response

Returns an AddDebitCardToGoogleWalletSyncPayload

Arguments

Name	Description
`input` - `AddDebitCardToGoogleWalletSyncInput!`

Example

Query

mutation addDebitCardToGoogleWalletSync($input: AddDebitCardToGoogleWalletSyncInput!) {
  addDebitCardToGoogleWalletSync(input: $input) {
    result {
      ...GoogleWalletProvisionResponseFragment
    }
  }
}

Variables

{"input": AddDebitCardToGoogleWalletSyncInput}

Response

{
  "data": {
    "addDebitCardToGoogleWalletSync": {
      "result": GoogleWalletProvisionResponse
    }
  }
}

Mutations

`addFamilyMembers`

Description

Adds multiple family members to the current_user's family

Response

Returns an AddFamilyMembersPayload

Arguments

Name	Description
`input` - `AddFamilyMembersInput!`

Example

Query

mutation addFamilyMembers($input: AddFamilyMembersInput!) {
  addFamilyMembers(input: $input) {
    result {
      ...UserFragment
    }
  }
}

Variables

{"input": AddFamilyMembersInput}

Response

{"data": {"addFamilyMembers": {"result": [User]}}}

Mutations

`addParent`

Description

Add a parent to your Crew

Response

Returns an AddParentPayload

Arguments

Name	Description
`input` - `AddParentInput!`

Example

Query

mutation addParent($input: AddParentInput!) {
  addParent(input: $input) {
    result {
      ...UserFragment
    }
  }
}

Variables

{"input": AddParentInput}

Response

{"data": {"addParent": {"result": User}}}

Mutations

`addRecipientAccount`

Description

Creates a recipient account for the current user to send to

Response

Returns an AddRecipientAccountPayload

Arguments

Name	Description
`input` - `AddRecipientAccountInput!`

Example

Query

mutation addRecipientAccount($input: AddRecipientAccountInput!) {
  addRecipientAccount(input: $input) {
    result {
      ...AccountFragment
    }
  }
}

Variables

{"input": AddRecipientAccountInput}

Response

{"data": {"addRecipientAccount": {"result": Account}}}

Mutations

`assignTransactionToBillPayment`

Response

Returns an AssignTransactionToBillPaymentPayload

Arguments

Name	Description
`input` - `AssignTransactionToBillPaymentInput!`

Example

Query

mutation assignTransactionToBillPayment($input: AssignTransactionToBillPaymentInput!) {
  assignTransactionToBillPayment(input: $input) {
    result {
      ...BillPaymentFragment
    }
  }
}

Variables

{"input": AssignTransactionToBillPaymentInput}

Response

{
  "data": {
    "assignTransactionToBillPayment": {
      "result": BillPayment
    }
  }
}

Mutations

`attachVirtualDebitCardToBill`

Response

Returns an AttachVirtualDebitCardToBillPayload

Arguments

Name	Description
`input` - `AttachVirtualDebitCardToBillInput!`

Example

Query

mutation attachVirtualDebitCardToBill($input: AttachVirtualDebitCardToBillInput!) {
  attachVirtualDebitCardToBill(input: $input) {
    result {
      ...BillFragment
    }
  }
}

Variables

{"input": AttachVirtualDebitCardToBillInput}

Response

{
  "data": {
    "attachVirtualDebitCardToBill": {"result": Bill}
  }
}

Mutations

`autoAssignTransactionToBillPayment`

Response

Returns an AutoAssignTransactionToBillPaymentPayload

Arguments

Name	Description
`input` - `AutoAssignTransactionToBillPaymentInput!`

Example

Query

mutation autoAssignTransactionToBillPayment($input: AutoAssignTransactionToBillPaymentInput!) {
  autoAssignTransactionToBillPayment(input: $input) {
    result {
      ...BillPaymentFragment
    }
  }
}

Variables

{"input": AutoAssignTransactionToBillPaymentInput}

Response

{
  "data": {
    "autoAssignTransactionToBillPayment": {
      "result": BillPayment
    }
  }
}

Mutations

`bulkSetSubaccountVisibility`

Response

Returns a BulkSetSubaccountVisibilityPayload

Arguments

Name	Description
`input` - `BulkSetSubaccountVisibilityInput!`

Example

Query

mutation bulkSetSubaccountVisibility($input: BulkSetSubaccountVisibilityInput!) {
  bulkSetSubaccountVisibility(input: $input) {
    result {
      ...SubaccountFragment
    }
  }
}

Variables

{"input": BulkSetSubaccountVisibilityInput}

Response

{
  "data": {
    "bulkSetSubaccountVisibility": {
      "result": [Subaccount]
    }
  }
}

Mutations

`calculateCashTransactionEnrichment`

Response

Returns a CalculateCashTransactionEnrichmentPayload

Arguments

Name	Description
`input` - `CalculateCashTransactionEnrichmentInput!`

Example

Query

mutation calculateCashTransactionEnrichment($input: CalculateCashTransactionEnrichmentInput!) {
  calculateCashTransactionEnrichment(input: $input) {
    result
  }
}

Variables

{"input": CalculateCashTransactionEnrichmentInput}

Response

{
  "data": {
    "calculateCashTransactionEnrichment": {
      "result": CashTransactionEnrichment
    }
  }
}

Mutations

`cancelDebitCard`

Description

Cancel a debit card

Response

Returns a CancelDebitCardPayload

Arguments

Name	Description
`input` - `CancelDebitCardInput!`

Example

Query

mutation cancelDebitCard($input: CancelDebitCardInput!) {
  cancelDebitCard(input: $input) {
    result {
      ...DebitCardFragment
    }
  }
}

Variables

{"input": CancelDebitCardInput}

Response

{"data": {"cancelDebitCard": {"result": DebitCard}}}

Mutations

`cancelDebitCardOrder`

Response

Returns a CancelDebitCardOrderPayload

Arguments

Name	Description
`input` - `CancelDebitCardOrderInput!`

Example

Query

mutation cancelDebitCardOrder($input: CancelDebitCardOrderInput!) {
  cancelDebitCardOrder(input: $input) {
    result {
      ...DebitCardOrderFragment
    }
  }
}

Variables

{"input": CancelDebitCardOrderInput}

Response

{
  "data": {
    "cancelDebitCardOrder": {"result": DebitCardOrder}
  }
}

Mutations

`cancelPayment`

Description

Cancel a scheduled payment

Response

Returns a CancelPaymentPayload

Arguments

Name	Description
`input` - `CancelPaymentInput!`

Example

Query

mutation cancelPayment($input: CancelPaymentInput!) {
  cancelPayment(input: $input) {
    result {
      ...ScheduledTransferFragment
    }
  }
}

Variables

{"input": CancelPaymentInput}

Response

{"data": {"cancelPayment": {"result": ScheduledTransfer}}}

Mutations

`cancelTransfer`

Description

Cancels a pending ACH or wire transfer

Response

Returns a CancelTransferPayload

Arguments

Name	Description
`input` - `CancelTransferInput!`

Example

Query

mutation cancelTransfer($input: CancelTransferInput!) {
  cancelTransfer(input: $input) {
    result {
      ...TransferFragment
    }
  }
}

Variables

{"input": CancelTransferInput}

Response

{"data": {"cancelTransfer": {"result": Transfer}}}

Mutations

`consentToESignAgreement`

Response

Returns a ConsentToESignAgreementPayload

Example

Query

mutation consentToESignAgreement {
  consentToESignAgreement {
    result {
      ...UserFragment
    }
  }
}

Response

{"data": {"consentToESignAgreement": {"result": User}}}

Mutations

`createBill`

Description

Creates a bill

Response

Returns a CreateBillPayload

Arguments

Name	Description
`input` - `CreateBillInput!`

Example

Query

mutation createBill($input: CreateBillInput!) {
  createBill(input: $input) {
    result {
      ...BillFragment
    }
  }
}

Variables

{"input": CreateBillInput}

Response

{"data": {"createBill": {"result": Bill}}}

Mutations

`createBillsBulk`

Response

Returns a CreateBillsBulkPayload

Arguments

Name	Description
`input` - `CreateBillsBulkInput!`

Example

Query

mutation createBillsBulk($input: CreateBillsBulkInput!) {
  createBillsBulk(input: $input) {
    result {
      ...BillFragment
    }
  }
}

Variables

{"input": CreateBillsBulkInput}

Response

{"data": {"createBillsBulk": {"result": [Bill]}}}

Mutations

`createPayment`

Description

Create a scheduled payment

Response

Returns a CreatePaymentPayload

Arguments

Name	Description
`input` - `CreatePaymentInput!`

Example

Query

mutation createPayment($input: CreatePaymentInput!) {
  createPayment(input: $input) {
    result {
      ...ScheduledTransferFragment
    }
  }
}

Variables

{"input": CreatePaymentInput}

Response

{"data": {"createPayment": {"result": ScheduledTransfer}}}

Mutations

`createProvisionalCopyForWalletSync`

We no longer need to use separate provisional cards

Response

Returns a CreateProvisionalCopyForWalletSyncPayload

Arguments

Name	Description
`input` - `CreateProvisionalCopyForWalletSyncInput!`

Example

Query

mutation createProvisionalCopyForWalletSync($input: CreateProvisionalCopyForWalletSyncInput!) {
  createProvisionalCopyForWalletSync(input: $input) {
    result {
      ...DebitCardFragment
    }
  }
}

Variables

{"input": CreateProvisionalCopyForWalletSyncInput}

Response

{
  "data": {
    "createProvisionalCopyForWalletSync": {
      "result": DebitCard
    }
  }
}

Mutations

`createReassignmentRule`

Response

Returns a CreateReassignmentRulePayload

Arguments

Name	Description
`input` - `CreateReassignmentRuleInput!`

Example

Query

mutation createReassignmentRule($input: CreateReassignmentRuleInput!) {
  createReassignmentRule(input: $input) {
    result {
      ...ReassignmentRuleFragment
    }
  }
}

Variables

{"input": CreateReassignmentRuleInput}

Response

{
  "data": {
    "createReassignmentRule": {"result": ReassignmentRule}
  }
}

Mutations

`createRecipient`

Response

Returns a CreateRecipientPayload

Arguments

Name	Description
`input` - `CreateRecipientInput!`

Example

Query

mutation createRecipient($input: CreateRecipientInput!) {
  createRecipient(input: $input) {
    result {
      ...RecipientFragment
    }
  }
}

Variables

{"input": CreateRecipientInput}

Response

{"data": {"createRecipient": {"result": Recipient}}}

Mutations

`createRule`

Response

Returns a CreateRulePayload

Arguments

Name	Description
`input` - `CreateRuleInput!`

Example

Query

mutation createRule($input: CreateRuleInput!) {
  createRule(input: $input) {
    result {
      ...RuleFragment
    }
  }
}

Variables

{"input": CreateRuleInput}

Response

{"data": {"createRule": {"result": Rule}}}

Mutations

`createSubaccount`

Description

Creates a new subaccount

Response

Returns a CreateSubaccountPayload

Arguments

Name	Description
`input` - `CreateSubaccountInput!`

Example

Query

mutation createSubaccount($input: CreateSubaccountInput!) {
  createSubaccount(input: $input) {
    result {
      ...SubaccountFragment
    }
  }
}

Variables

{"input": CreateSubaccountInput}

Response

{"data": {"createSubaccount": {"result": Subaccount}}}

Mutations

`createUnscheduledBillPayment`

Response

Returns a CreateUnscheduledBillPaymentPayload

Arguments

Name	Description
`input` - `CreateUnscheduledBillPaymentInput!`

Example

Query

mutation createUnscheduledBillPayment($input: CreateUnscheduledBillPaymentInput!) {
  createUnscheduledBillPayment(input: $input) {
    result {
      ...BillPaymentFragment
    }
  }
}

Variables

{"input": CreateUnscheduledBillPaymentInput}

Response

{
  "data": {
    "createUnscheduledBillPayment": {
      "result": BillPayment
    }
  }
}

Mutations

`createVirtualDebitCard`

Description

Create a virtual debit card for a user

Response

Returns a CreateVirtualDebitCardPayload

Arguments

Name	Description
`input` - `CreateVirtualDebitCardInput!`

Example

Query

mutation createVirtualDebitCard($input: CreateVirtualDebitCardInput!) {
  createVirtualDebitCard(input: $input) {
    result {
      ...DebitCardFragment
    }
  }
}

Variables

{"input": CreateVirtualDebitCardInput}

Response

{
  "data": {
    "createVirtualDebitCard": {"result": DebitCard}
  }
}

Mutations

`deleteAccount`

Description

Deletes an account. If it's an external account, unlink from Quiltt.

Response

Returns a DeleteAccountPayload

Arguments

Name	Description
`input` - `DeleteAccountInput!`

Example

Query

mutation deleteAccount($input: DeleteAccountInput!) {
  deleteAccount(input: $input) {
    result {
      ...AccountFragment
    }
  }
}

Variables

{"input": DeleteAccountInput}

Response

{"data": {"deleteAccount": {"result": Account}}}

Mutations

`deleteBill`

Response

Returns a DeleteBillPayload

Arguments

Name	Description
`input` - `DeleteBillInput!`

Example

Query

mutation deleteBill($input: DeleteBillInput!) {
  deleteBill(input: $input) {
    result {
      ...BillFragment
    }
  }
}

Variables

{"input": DeleteBillInput}

Response

{"data": {"deleteBill": {"result": Bill}}}

Mutations

`deleteReassignmentRule`

Response

Returns a DeleteReassignmentRulePayload

Arguments

Name	Description
`input` - `DeleteReassignmentRuleInput!`

Example

Query

mutation deleteReassignmentRule($input: DeleteReassignmentRuleInput!) {
  deleteReassignmentRule(input: $input) {
    result {
      ...ReassignmentRuleFragment
    }
  }
}

Variables

{"input": DeleteReassignmentRuleInput}

Response

{
  "data": {
    "deleteReassignmentRule": {"result": ReassignmentRule}
  }
}

Mutations

`deleteRecipient`

Response

Returns a DeleteRecipientPayload

Arguments

Name	Description
`input` - `DeleteRecipientInput!`

Example

Query

mutation deleteRecipient($input: DeleteRecipientInput!) {
  deleteRecipient(input: $input) {
    result {
      ...RecipientFragment
    }
  }
}

Variables

{"input": DeleteRecipientInput}

Response

{"data": {"deleteRecipient": {"result": Recipient}}}

Mutations

`deleteRule`

Response

Returns a DeleteRulePayload

Arguments

Name	Description
`input` - `DeleteRuleInput!`

Example

Query

mutation deleteRule($input: DeleteRuleInput!) {
  deleteRule(input: $input) {
    result {
      ...RuleFragment
    }
  }
}

Variables

{"input": DeleteRuleInput}

Response

{"data": {"deleteRule": {"result": Rule}}}

Mutations

`deleteSubaccount`

Description

Deletes a subaccount

Response

Returns a DeleteSubaccountPayload

Arguments

Name	Description
`input` - `DeleteSubaccountInput!`

Example

Query

mutation deleteSubaccount($input: DeleteSubaccountInput!) {
  deleteSubaccount(input: $input) {
    result {
      ...SubaccountFragment
    }
  }
}

Variables

{"input": DeleteSubaccountInput}

Response

{"data": {"deleteSubaccount": {"result": Subaccount}}}

Mutations

`deleteThread`

Description

Delete a thread

Response

Returns a DeleteThreadPayload

Arguments

Name	Description
`input` - `DeleteThreadInput!`

Example

Query

mutation deleteThread($input: DeleteThreadInput!) {
  deleteThread(input: $input) {
    result {
      ...PennyThreadFragment
    }
  }
}

Variables

{"input": DeleteThreadInput}

Response

{"data": {"deleteThread": {"result": PennyThread}}}

Mutations

`depositCheck`

Response

Returns a DepositCheckPayload

Arguments

Name	Description
`input` - `DepositCheckInput!`

Example

Query

mutation depositCheck($input: DepositCheckInput!) {
  depositCheck(input: $input) {
    result {
      ...CheckDepositFragment
    }
  }
}

Variables

{"input": DepositCheckInput}

Response

{"data": {"depositCheck": {"result": CheckDeposit}}}

Mutations

`detachVirtualDebitCardFromBill`

Response

Returns a DetachVirtualDebitCardFromBillPayload

Arguments

Name	Description
`input` - `DetachVirtualDebitCardFromBillInput!`

Example

Query

mutation detachVirtualDebitCardFromBill($input: DetachVirtualDebitCardFromBillInput!) {
  detachVirtualDebitCardFromBill(input: $input) {
    result {
      ...BillFragment
    }
  }
}

Variables

{"input": DetachVirtualDebitCardFromBillInput}

Response

{
  "data": {
    "detachVirtualDebitCardFromBill": {"result": Bill}
  }
}

Mutations

`dismissPrompt`

Response

Returns a DismissPromptPayload

Arguments

Name	Description
`input` - `DismissPromptInput!`

Example

Query

mutation dismissPrompt($input: DismissPromptInput!) {
  dismissPrompt(input: $input) {
    result {
      ...PromptFragment
    }
  }
}

Variables

{"input": DismissPromptInput}

Response

{"data": {"dismissPrompt": {"result": Prompt}}}

Mutations

`dismissTakeover`

Response

Returns a DismissTakeoverPayload

Arguments

Name	Description
`input` - `DismissTakeoverInput!`

Example

Query

mutation dismissTakeover($input: DismissTakeoverInput!) {
  dismissTakeover(input: $input) {
    result {
      ...UserFragment
    }
  }
}

Variables

{"input": DismissTakeoverInput}

Response

{"data": {"dismissTakeover": {"result": User}}}

Mutations

`freezeDebitCard`

Description

Freeze a debit card

Response

Returns a FreezeDebitCardPayload

Arguments

Name	Description
`input` - `FreezeDebitCardInput!`

Example

Query

mutation freezeDebitCard($input: FreezeDebitCardInput!) {
  freezeDebitCard(input: $input) {
    result {
      ...DebitCardFragment
    }
  }
}

Variables

{"input": FreezeDebitCardInput}

Response

{"data": {"freezeDebitCard": {"result": DebitCard}}}

Mutations

`generateBarcode`

Description

Creates a barcode to scan at a merchant to deposit cash into a Crew account

Response

Returns a GenerateBarcodePayload

Arguments

Name	Description
`input` - `GenerateBarcodeInput!`

Example

Query

mutation generateBarcode($input: GenerateBarcodeInput!) {
  generateBarcode(input: $input) {
    result {
      ...CashDepositBarcodeFragment
    }
  }
}

Variables

{"input": GenerateBarcodeInput}

Response

{
  "data": {
    "generateBarcode": {"result": CashDepositBarcode}
  }
}

Mutations

`generateSetPinToken`

Description

Generate a JWT to set a debit card's pin

Response

Returns a GenerateSetPinTokenPayload

Arguments

Name	Description
`input` - `GenerateSetPinTokenInput!`

Example

Query

mutation generateSetPinToken($input: GenerateSetPinTokenInput!) {
  generateSetPinToken(input: $input)
}

Variables

{"input": GenerateSetPinTokenInput}

Response

{"data": {"generateSetPinToken": {}}}

Mutations

`generateViewSadToken`

Description

Generate a JWT to view a debit card's Sensitive Account Data

Response

Returns a GenerateViewSadTokenPayload

Arguments

Name	Description
`input` - `GenerateViewSadTokenInput!`

Example

Query

mutation generateViewSadToken($input: GenerateViewSadTokenInput!) {
  generateViewSadToken(input: $input)
}

Variables

{"input": GenerateViewSadTokenInput}

Response

{"data": {"generateViewSadToken": {}}}

Mutations

`initializeProvisionalDebitCardSync`

We no longer need to use separate provisional cards

Response

Returns an InitializeProvisionalDebitCardSyncPayload

Arguments

Name	Description
`input` - `InitializeProvisionalDebitCardSyncInput!`

Example

Query

mutation initializeProvisionalDebitCardSync($input: InitializeProvisionalDebitCardSyncInput!) {
  initializeProvisionalDebitCardSync(input: $input) {
    result {
      ...DebitCardFragment
    }
  }
}

Variables

{"input": InitializeProvisionalDebitCardSyncInput}

Response

{
  "data": {
    "initializeProvisionalDebitCardSync": {
      "result": DebitCard
    }
  }
}

Mutations

`initiateMultiTransfer`

Description

Initiates a transfer with several destinations

Response

Returns an InitiateMultiTransferPayload

Arguments

Name	Description
`input` - `InitiateMultiTransferInput!`

Example

Query

mutation initiateMultiTransfer($input: InitiateMultiTransferInput!) {
  initiateMultiTransfer(input: $input) {
    result {
      ...TransferFragment
    }
  }
}

Variables

{"input": InitiateMultiTransferInput}

Response

{
  "data": {
    "initiateMultiTransfer": {"result": [Transfer]}
  }
}

Mutations

`initiateTransfer`

Description

Initiates a transfer between two accounts

Response

Returns an InitiateTransferPayload

Arguments

Name	Description
`input` - `InitiateTransferInput!`

Example

Query

mutation initiateTransfer($input: InitiateTransferInput!) {
  initiateTransfer(input: $input) {
    result {
      ...TransferFragment
    }
  }
}

Variables

{"input": InitiateTransferInput}

Response

{"data": {"initiateTransfer": {"result": Transfer}}}

Mutations

`logout`

Use the logout REST endpoint in AuthController instead.

Response

Returns a LogoutPayload

Example

Query

mutation logout {
  logout {
    result {
      ...UserFragment
    }
  }
}

Response

{"data": {"logout": {"result": User}}}

Mutations

`manualActivateCashAccount`

Response

Returns a ManualActivateCashAccountPayload

Arguments

Name	Description
`input` - `ManualActivateCashAccountInput!`

Example

Query

mutation manualActivateCashAccount($input: ManualActivateCashAccountInput!) {
  manualActivateCashAccount(input: $input) {
    result {
      ...AccountFragment
    }
  }
}

Variables

{"input": ManualActivateCashAccountInput}

Response

{
  "data": {
    "manualActivateCashAccount": {"result": Account}
  }
}

Mutations

`manualAddExternalAccount`

Response

Returns a ManualAddExternalAccountPayload

Arguments

Name	Description
`input` - `ManualAddExternalAccountInput!`

Example

Query

mutation manualAddExternalAccount($input: ManualAddExternalAccountInput!) {
  manualAddExternalAccount(input: $input) {
    result {
      ...AccountFragment
    }
  }
}

Variables

{"input": ManualAddExternalAccountInput}

Response

{
  "data": {
    "manualAddExternalAccount": {"result": Account}
  }
}

Mutations

`manuallyTriggerRule`

Use the run_rule_now mutation instead.

Response

Returns a ManuallyTriggerRulePayload

Arguments

Name	Description
`input` - `ManuallyTriggerRuleInput!`

Example

Query

mutation manuallyTriggerRule($input: ManuallyTriggerRuleInput!) {
  manuallyTriggerRule(input: $input) {
    result {
      ...RuleFragment
    }
  }
}

Variables

{"input": ManuallyTriggerRuleInput}

Response

{"data": {"manuallyTriggerRule": {"result": Rule}}}

Mutations

`markRuleBroken`

Response

Returns a MarkRuleBrokenPayload

Arguments

Name	Description
`input` - `MarkRuleBrokenInput!`

Example

Query

mutation markRuleBroken($input: MarkRuleBrokenInput!) {
  markRuleBroken(input: $input) {
    result {
      ...RuleFragment
    }
  }
}

Variables

{"input": MarkRuleBrokenInput}

Response

{"data": {"markRuleBroken": {"result": Rule}}}

Mutations

`muteDebitCardNotifications`

Response

Returns a MuteDebitCardNotificationsPayload

Arguments

Name	Description
`input` - `MuteDebitCardNotificationsInput!`

Example

Query

mutation muteDebitCardNotifications($input: MuteDebitCardNotificationsInput!) {
  muteDebitCardNotifications(input: $input) {
    result {
      ...DebitCardFragment
    }
  }
}

Variables

{"input": MuteDebitCardNotificationsInput}

Response

{
  "data": {
    "muteDebitCardNotifications": {"result": DebitCard}
  }
}

Mutations

`overrideDigitalWalletTokenStatus`

Response

Returns an OverrideDigitalWalletTokenStatusPayload

Arguments

Name	Description
`input` - `OverrideDigitalWalletTokenStatusInput!`

Example

Query

mutation overrideDigitalWalletTokenStatus($input: OverrideDigitalWalletTokenStatusInput!) {
  overrideDigitalWalletTokenStatus(input: $input) {
    result {
      ...DigitalWalletTokenFragment
    }
  }
}

Variables

{"input": OverrideDigitalWalletTokenStatusInput}

Response

{
  "data": {
    "overrideDigitalWalletTokenStatus": {
      "result": DigitalWalletToken
    }
  }
}

Mutations

`reassignCashTransaction`

Response

Returns a ReassignCashTransactionPayload

Arguments

Name	Description
`input` - `ReassignCashTransactionInput!`

Example

Query

mutation reassignCashTransaction($input: ReassignCashTransactionInput!) {
  reassignCashTransaction(input: $input) {
    result {
      ...CashTransactionFragment
    }
  }
}

Variables

{"input": ReassignCashTransactionInput}

Response

{
  "data": {
    "reassignCashTransaction": {"result": CashTransaction}
  }
}

Mutations

`reassignTransfer`

Description

Reassigns the Crew side of an external transfer to a different subaccount

Response

Returns a ReassignTransferPayload

Arguments

Name	Description
`input` - `ReassignTransferInput!`

Example

Query

mutation reassignTransfer($input: ReassignTransferInput!) {
  reassignTransfer(input: $input) {
    result {
      ...TransferFragment
    }
  }
}

Variables

{"input": ReassignTransferInput}

Response

{"data": {"reassignTransfer": {"result": Transfer}}}

Mutations

`refreshAccountBalance`

Description

Requests a refresh of the balance for an external account

Response

Returns a RefreshAccountBalancePayload

Arguments

Name	Description
`input` - `RefreshAccountBalanceInput!`

Example

Query

mutation refreshAccountBalance($input: RefreshAccountBalanceInput!) {
  refreshAccountBalance(input: $input)
}

Variables

{"input": RefreshAccountBalanceInput}

Response

{"data": {"refreshAccountBalance": {}}}

Mutations

`removeTargetBalance`

Description

Removes a target balance for an account

Response

Returns a RemoveTargetBalancePayload

Arguments

Name	Description
`input` - `RemoveTargetBalanceInput!`

Example

Query

mutation removeTargetBalance($input: RemoveTargetBalanceInput!) {
  removeTargetBalance(input: $input) {
    result {
      ...TargetBalanceSettingFragment
    }
  }
}

Variables

{"input": RemoveTargetBalanceInput}

Response

{
  "data": {
    "removeTargetBalance": {
      "result": TargetBalanceSetting
    }
  }
}

Mutations

`resendChildInvite`

We don't send invites anymore, we use the parents phone to send them.

Response

Returns a ResendChildInvitePayload

Arguments

Name	Description
`input` - `ResendChildInviteInput!`

Example

Query

mutation resendChildInvite($input: ResendChildInviteInput!) {
  resendChildInvite(input: $input) {
    result {
      ...UserFragment
    }
  }
}

Variables

{"input": ResendChildInviteInput}

Response

{"data": {"resendChildInvite": {"result": User}}}

Mutations

`resendPartnerInvite`

Response

Returns a ResendPartnerInvitePayload

Arguments

Name	Description
`input` - `ResendPartnerInviteInput!`

Example

Query

mutation resendPartnerInvite($input: ResendPartnerInviteInput!) {
  resendPartnerInvite(input: $input) {
    result {
      ...UserFragment
    }
  }
}

Variables

{"input": ResendPartnerInviteInput}

Response

{"data": {"resendPartnerInvite": {"result": User}}}

Mutations

`runRuleNow`

Response

Returns a RunRuleNowPayload

Arguments

Name	Description
`input` - `RunRuleNowInput!`

Example

Query

mutation runRuleNow($input: RunRuleNowInput!) {
  runRuleNow(input: $input) {
    result {
      ...RuleExecutionFragment
    }
  }
}

Variables

{"input": RunRuleNowInput}

Response

{"data": {"runRuleNow": {"result": RuleExecution}}}

Mutations

`saveQuilttAccount`

No longer used - Quiltt webhooks will automatically insert an account once verified.

Description

DEPRECATED - Saves a Quiltt account after authorization

Response

Returns a SaveQuilttAccountPayload

Arguments

Name	Description
`input` - `SaveQuilttAccountInput!`

Example

Query

mutation saveQuilttAccount($input: SaveQuilttAccountInput!) {
  saveQuilttAccount(input: $input) {
    result {
      ...AccountFragment
    }
  }
}

Variables

{"input": SaveQuilttAccountInput}

Response

{"data": {"saveQuilttAccount": {"result": [Account]}}}

Mutations

`setAllowOverspending`

Description

Turns overspending on or off for the given user

Response

Returns a SetAllowOverspendingPayload

Arguments

Name	Description
`input` - `SetAllowOverspendingInput!`

Example

Query

mutation setAllowOverspending($input: SetAllowOverspendingInput!) {
  setAllowOverspending(input: $input) {
    result {
      ...UserFragment
    }
  }
}

Variables

{"input": SetAllowOverspendingInput}

Response

{"data": {"setAllowOverspending": {"result": User}}}

Mutations

`setPostSpendPocketAssignment`

Description

Sets the user's preference for card subaccount behaviors after card transactions are received

Response

Returns a SetPostSpendPocketAssignmentPayload

Arguments

Name	Description
`input` - `SetPostSpendPocketAssignmentInput!`

Example

Query

mutation setPostSpendPocketAssignment($input: SetPostSpendPocketAssignmentInput!) {
  setPostSpendPocketAssignment(input: $input) {
    result {
      ...UserFragment
    }
  }
}

Variables

{"input": SetPostSpendPocketAssignmentInput}

Response

{
  "data": {
    "setPostSpendPocketAssignment": {"result": User}
  }
}

Mutations

`setSpendSubaccount`

Description

Sets spend subaccount for the specified user

Response

Returns a SetSpendSubaccountPayload

Arguments

Name	Description
`input` - `SetSpendSubaccountInput!`

Example

Query

mutation setSpendSubaccount($input: SetSpendSubaccountInput!) {
  setSpendSubaccount(input: $input) {
    result {
      ...UserFragment
    }
  }
}

Variables

{"input": SetSpendSubaccountInput}

Response

{"data": {"setSpendSubaccount": {"result": User}}}

Mutations

`setSubaccountOrdering`

Response

Returns a SetSubaccountOrderingPayload

Arguments

Name	Description
`input` - `SetSubaccountOrderingInput!`

Example

Query

mutation setSubaccountOrdering($input: SetSubaccountOrderingInput!) {
  setSubaccountOrdering(input: $input) {
    result {
      ...SubaccountFragment
    }
  }
}

Variables

{"input": SetSubaccountOrderingInput}

Response

{
  "data": {
    "setSubaccountOrdering": {"result": [Subaccount]}
  }
}

Mutations

`setSubaccountVisibility`

Response

Returns a SetSubaccountVisibilityPayload

Arguments

Name	Description
`input` - `SetSubaccountVisibilityInput!`

Example

Query

mutation setSubaccountVisibility($input: SetSubaccountVisibilityInput!) {
  setSubaccountVisibility(input: $input) {
    result {
      ...SubaccountFragment
    }
  }
}

Variables

{"input": SetSubaccountVisibilityInput}

Response

{
  "data": {
    "setSubaccountVisibility": {"result": Subaccount}
  }
}

Mutations

`setTargetBalance`

Description

Sets a target balance for an account

Response

Returns a SetTargetBalancePayload

Arguments

Name	Description
`input` - `SetTargetBalanceInput!`

Example

Query

mutation setTargetBalance($input: SetTargetBalanceInput!) {
  setTargetBalance(input: $input) {
    result {
      ...TargetBalanceSettingFragment
    }
  }
}

Variables

{"input": SetTargetBalanceInput}

Response

{
  "data": {
    "setTargetBalance": {"result": TargetBalanceSetting}
  }
}

Mutations

`skipBillPayment`

Response

Returns a SkipBillPaymentPayload

Arguments

Name	Description
`input` - `SkipBillPaymentInput!`

Example

Query

mutation skipBillPayment($input: SkipBillPaymentInput!) {
  skipBillPayment(input: $input) {
    result {
      ...BillPaymentFragment
    }
  }
}

Variables

{"input": SkipBillPaymentInput}

Response

{"data": {"skipBillPayment": {"result": BillPayment}}}

Mutations

`splitCashTransaction`

Response

Returns a SplitCashTransactionPayload

Arguments

Name	Description
`input` - `SplitCashTransactionInput!`

Example

Query

mutation splitCashTransaction($input: SplitCashTransactionInput!) {
  splitCashTransaction(input: $input) {
    result {
      ...CashTransactionFragment
    }
  }
}

Variables

{"input": SplitCashTransactionInput}

Response

{
  "data": {
    "splitCashTransaction": {"result": CashTransaction}
  }
}

Mutations

`submitDebitCardOrders`

Description

Orders physical debit cards

Response

Returns a SubmitDebitCardOrdersPayload

Arguments

Name	Description
`input` - `SubmitDebitCardOrdersInput!`

Example

Query

mutation submitDebitCardOrders($input: SubmitDebitCardOrdersInput!) {
  submitDebitCardOrders(input: $input) {
    result {
      ...DebitCardOrderFragment
    }
  }
}

Variables

{"input": SubmitDebitCardOrdersInput}

Response

{
  "data": {
    "submitDebitCardOrders": {"result": [DebitCardOrder]}
  }
}

Mutations

`submitUserApplication`

Description

Submit a user application

Response

Returns a SubmitUserApplicationPayload

Arguments

Name	Description
`input` - `SubmitUserApplicationInput!`

Example

Query

mutation submitUserApplication($input: SubmitUserApplicationInput!) {
  submitUserApplication(input: $input) {
    result {
      ...UserApplicationFragment
    }
  }
}

Variables

{"input": SubmitUserApplicationInput}

Response

{
  "data": {
    "submitUserApplication": {"result": UserApplication}
  }
}

Mutations

`unassignTransactionFromBill`

Response

Returns an UnassignTransactionFromBillPayload

Arguments

Name	Description
`input` - `UnassignTransactionFromBillInput!`

Example

Query

mutation unassignTransactionFromBill($input: UnassignTransactionFromBillInput!) {
  unassignTransactionFromBill(input: $input) {
    result {
      ...CashTransactionFragment
    }
  }
}

Variables

{"input": UnassignTransactionFromBillInput}

Response

{
  "data": {
    "unassignTransactionFromBill": {
      "result": CashTransaction
    }
  }
}

Mutations

`undeleteBill`

Response

Returns an UndeleteBillPayload

Arguments

Name	Description
`input` - `UndeleteBillInput!`

Example

Query

mutation undeleteBill($input: UndeleteBillInput!) {
  undeleteBill(input: $input) {
    result {
      ...BillFragment
    }
  }
}

Variables

{"input": UndeleteBillInput}

Response

{"data": {"undeleteBill": {"result": Bill}}}

Mutations

`undoCashTransaction`

Response

Returns an UndoCashTransactionPayload

Arguments

Name	Description
`input` - `UndoCashTransactionInput!`

Example

Query

mutation undoCashTransaction($input: UndoCashTransactionInput!) {
  undoCashTransaction(input: $input)
}

Variables

{"input": UndoCashTransactionInput}

Response

{"data": {"undoCashTransaction": {}}}

Mutations

`unfreezeDebitCard`

Description

Unfreeze a debit card

Response

Returns an UnfreezeDebitCardPayload

Arguments

Name	Description
`input` - `UnfreezeDebitCardInput!`

Example

Query

mutation unfreezeDebitCard($input: UnfreezeDebitCardInput!) {
  unfreezeDebitCard(input: $input) {
    result {
      ...DebitCardFragment
    }
  }
}

Variables

{"input": UnfreezeDebitCardInput}

Response

{"data": {"unfreezeDebitCard": {"result": DebitCard}}}

Mutations

`unsetSpendSubaccount`

Description

Sets the user's spend pocket selection as expired, effectively setting it to 'none'

Response

Returns an UnsetSpendSubaccountPayload

Arguments

Name	Description
`input` - `UnsetSpendSubaccountInput!`

Example

Query

mutation unsetSpendSubaccount($input: UnsetSpendSubaccountInput!) {
  unsetSpendSubaccount(input: $input) {
    result {
      ...UserFragment
    }
  }
}

Variables

{"input": UnsetSpendSubaccountInput}

Response

{"data": {"unsetSpendSubaccount": {"result": User}}}

Mutations

`unsplitCashTransaction`

Response

Returns an UnsplitCashTransactionPayload

Arguments

Name	Description
`input` - `UnsplitCashTransactionInput!`

Example

Query

mutation unsplitCashTransaction($input: UnsplitCashTransactionInput!) {
  unsplitCashTransaction(input: $input) {
    result {
      ...CashTransactionFragment
    }
  }
}

Variables

{"input": UnsplitCashTransactionInput}

Response

{
  "data": {
    "unsplitCashTransaction": {"result": CashTransaction}
  }
}

Mutations

`updateAccount`

Description

Updates an account

Response

Returns an UpdateAccountPayload

Arguments

Name	Description
`input` - `UpdateAccountInput!`

Example

Query

mutation updateAccount($input: UpdateAccountInput!) {
  updateAccount(input: $input) {
    result {
      ...AccountFragment
    }
  }
}

Variables

{"input": UpdateAccountInput}

Response

{"data": {"updateAccount": {"result": Account}}}

Mutations

`updateAutopaySettings`

Description

Update autopay settings

Response

Returns an UpdateAutopaySettingsPayload

Arguments

Name	Description
`input` - `UpdateAutopaySettingsInput!`

Example

Query

mutation updateAutopaySettings($input: UpdateAutopaySettingsInput!) {
  updateAutopaySettings(input: $input) {
    result {
      ...FamilyFragment
    }
  }
}

Variables

{"input": UpdateAutopaySettingsInput}

Response

{"data": {"updateAutopaySettings": {"result": Family}}}

Mutations

`updateBarcodeSubaccount`

Response

Returns an UpdateBarcodeSubaccountPayload

Arguments

Name	Description
`input` - `UpdateBarcodeSubaccountInput!`

Example

Query

mutation updateBarcodeSubaccount($input: UpdateBarcodeSubaccountInput!) {
  updateBarcodeSubaccount(input: $input) {
    result {
      ...CashDepositBarcodeFragment
    }
  }
}

Variables

{"input": UpdateBarcodeSubaccountInput}

Response

{
  "data": {
    "updateBarcodeSubaccount": {
      "result": CashDepositBarcode
    }
  }
}

Mutations

`updateBill`

Response

Returns an UpdateBillPayload

Arguments

Name	Description
`input` - `UpdateBillInput!`

Example

Query

mutation updateBill($input: UpdateBillInput!) {
  updateBill(input: $input) {
    result {
      ...BillFragment
    }
  }
}

Variables

{"input": UpdateBillInput}

Response

{"data": {"updateBill": {"result": Bill}}}

Mutations

`updateBillReserveSettings`

Description

Updates the settings for a bill reserve

Response

Returns an UpdateBillReserveSettingsPayload

Arguments

Name	Description
`input` - `UpdateBillReserveSettingsInput!`

Example

Query

mutation updateBillReserveSettings($input: UpdateBillReserveSettingsInput!) {
  updateBillReserveSettings(input: $input) {
    result {
      ...BillReserveFragment
    }
  }
}

Variables

{"input": UpdateBillReserveSettingsInput}

Response

{
  "data": {
    "updateBillReserveSettings": {"result": BillReserve}
  }
}

Mutations

`updateCashTransaction`

Response

Returns an UpdateCashTransactionPayload

Arguments

Name	Description
`input` - `UpdateCashTransactionInput!`

Example

Query

mutation updateCashTransaction($input: UpdateCashTransactionInput!) {
  updateCashTransaction(input: $input) {
    result {
      ...CashTransactionFragment
    }
  }
}

Variables

{"input": UpdateCashTransactionInput}

Response

{
  "data": {
    "updateCashTransaction": {"result": CashTransaction}
  }
}

Mutations

`updatePayment`

Description

Update a scheduled payment

Response

Returns an UpdatePaymentPayload

Arguments

Name	Description
`input` - `UpdatePaymentInput!`

Example

Query

mutation updatePayment($input: UpdatePaymentInput!) {
  updatePayment(input: $input) {
    result {
      ...ScheduledTransferFragment
    }
  }
}

Variables

{"input": UpdatePaymentInput}

Response

{"data": {"updatePayment": {"result": ScheduledTransfer}}}

Mutations

`updateReassignmentRule`

Response

Returns an UpdateReassignmentRulePayload

Arguments

Name	Description
`input` - `UpdateReassignmentRuleInput!`

Example

Query

mutation updateReassignmentRule($input: UpdateReassignmentRuleInput!) {
  updateReassignmentRule(input: $input) {
    result {
      ...ReassignmentRuleFragment
    }
  }
}

Variables

{"input": UpdateReassignmentRuleInput}

Response

{
  "data": {
    "updateReassignmentRule": {"result": ReassignmentRule}
  }
}

Mutations

`updateRecipient`

Response

Returns an UpdateRecipientPayload

Arguments

Name	Description
`input` - `UpdateRecipientInput!`

Example

Query

mutation updateRecipient($input: UpdateRecipientInput!) {
  updateRecipient(input: $input) {
    result {
      ...RecipientFragment
    }
  }
}

Variables

{"input": UpdateRecipientInput}

Response

{"data": {"updateRecipient": {"result": Recipient}}}

Mutations

`updateRule`

Response

Returns an UpdateRulePayload

Arguments

Name	Description
`input` - `UpdateRuleInput!`

Example

Query

mutation updateRule($input: UpdateRuleInput!) {
  updateRule(input: $input) {
    result {
      ...RuleFragment
    }
  }
}

Variables

{"input": UpdateRuleInput}

Response

{"data": {"updateRule": {"result": Rule}}}

Mutations

`updateSubaccount`

Description

Updates a subaccount

Response

Returns an UpdateSubaccountPayload

Arguments

Name	Description
`input` - `UpdateSubaccountInput!`

Example

Query

mutation updateSubaccount($input: UpdateSubaccountInput!) {
  updateSubaccount(input: $input) {
    result {
      ...SubaccountFragment
    }
  }
}

Variables

{"input": UpdateSubaccountInput}

Response

{"data": {"updateSubaccount": {"result": Subaccount}}}

Mutations

`updateTransfer`

Response

Returns an UpdateTransferPayload

Arguments

Name	Description
`input` - `UpdateTransferInput!`

Example

Query

mutation updateTransfer($input: UpdateTransferInput!) {
  updateTransfer(input: $input) {
    result {
      ...TransferFragment
    }
  }
}

Variables

{"input": UpdateTransferInput}

Response

{"data": {"updateTransfer": {"result": Transfer}}}

Mutations

`updateUserFlag`

Description

Updates the user flag for the specified user

Response

Returns an UpdateUserFlagPayload

Arguments

Name	Description
`input` - `UpdateUserFlagInput!`

Example

Query

mutation updateUserFlag($input: UpdateUserFlagInput!) {
  updateUserFlag(input: $input) {
    result {
      ...UserFragment
    }
  }
}

Variables

{"input": UpdateUserFlagInput}

Response

{"data": {"updateUserFlag": {"result": User}}}

Mutations

`updateUserProfile`

Description

Updates a user profile

Response

Returns an UpdateUserProfilePayload

Arguments

Name	Description
`input` - `UpdateUserProfileInput!`

Example

Query

mutation updateUserProfile($input: UpdateUserProfileInput!) {
  updateUserProfile(input: $input) {
    result {
      ...UserFragment
    }
  }
}

Variables

{"input": UpdateUserProfileInput}

Response

{"data": {"updateUserProfile": {"result": User}}}

Mutations

`updateUserSetting`

Description

Updates the user setting for the specified user

Response

Returns an UpdateUserSettingPayload

Arguments

Name	Description
`input` - `UpdateUserSettingInput!`

Example

Query

mutation updateUserSetting($input: UpdateUserSettingInput!) {
  updateUserSetting(input: $input) {
    result {
      ...UserSettingFragment
    }
  }
}

Variables

{"input": UpdateUserSettingInput}

Response

{"data": {"updateUserSetting": {"result": UserSetting}}}

Mutations

`updateVirtualDebitCard`

Response

Returns an UpdateVirtualDebitCardPayload

Arguments

Name	Description
`input` - `UpdateVirtualDebitCardInput!`

Example

Query

mutation updateVirtualDebitCard($input: UpdateVirtualDebitCardInput!) {
  updateVirtualDebitCard(input: $input) {
    result {
      ...DebitCardFragment
    }
  }
}

Variables

{"input": UpdateVirtualDebitCardInput}

Response

{
  "data": {
    "updateVirtualDebitCard": {"result": DebitCard}
  }
}

Mutations

`uploadProfilePic`

Description

Uploads a new profile pic for the specified user

Response

Returns an UploadProfilePicPayload

Arguments

Name	Description
`input` - `UploadProfilePicInput!`

Example

Query

mutation uploadProfilePic($input: UploadProfilePicInput!) {
  uploadProfilePic(input: $input) {
    result {
      ...UserFragment
    }
  }
}

Variables

{"input": UploadProfilePicInput}

Response

{"data": {"uploadProfilePic": {"result": User}}}

Mutations

`upsertAchDetails`

Response

Returns an UpsertAchDetailsPayload

Arguments

Name	Description
`input` - `UpsertAchDetailsInput!`

Example

Query

mutation upsertAchDetails($input: UpsertAchDetailsInput!) {
  upsertAchDetails(input: $input) {
    result {
      ...AccountFragment
    }
  }
}

Variables

{"input": UpsertAchDetailsInput}

Response

{"data": {"upsertAchDetails": {"result": Account}}}

Mutations

`upsertDebitCardOrder`

Description

Upsert debit card order

Response

Returns an UpsertDebitCardOrderPayload

Arguments

Name	Description
`input` - `UpsertDebitCardOrderInput!`

Example

Query

mutation upsertDebitCardOrder($input: UpsertDebitCardOrderInput!) {
  upsertDebitCardOrder(input: $input) {
    result {
      ...DebitCardOrderFragment
    }
  }
}

Variables

{"input": UpsertDebitCardOrderInput}

Response

{
  "data": {
    "upsertDebitCardOrder": {"result": DebitCardOrder}
  }
}

Mutations

`upsertFamilyBeneficiary`

Description

Upsert a payable-on-death beneficiary for the family

Response

Returns an UpsertFamilyBeneficiaryPayload

Arguments

Name	Description
`input` - `UpsertFamilyBeneficiaryInput!`

Example

Query

mutation upsertFamilyBeneficiary($input: UpsertFamilyBeneficiaryInput!) {
  upsertFamilyBeneficiary(input: $input) {
    result {
      ...BeneficiaryFragment
    }
  }
}

Variables

{"input": UpsertFamilyBeneficiaryInput}

Response

{
  "data": {
    "upsertFamilyBeneficiary": {"result": Beneficiary}
  }
}

Mutations

`upsertScheduledAllowance`

Description

Create or update an allowance

Response

Returns an UpsertScheduledAllowancePayload

Arguments

Name	Description
`input` - `UpsertScheduledAllowanceInput!`

Example

Query

mutation upsertScheduledAllowance($input: UpsertScheduledAllowanceInput!) {
  upsertScheduledAllowance(input: $input) {
    result {
      ...ScheduledTransferFragment
    }
  }
}

Variables

{"input": UpsertScheduledAllowanceInput}

Response

{
  "data": {
    "upsertScheduledAllowance": {
      "result": ScheduledTransfer
    }
  }
}

Mutations

`upsertUserApplication`

Description

Creates (or updates) a user application

Response

Returns an UpsertUserApplicationPayload

Arguments

Name	Description
`input` - `UpsertUserApplicationInput!`

Example

Query

mutation upsertUserApplication($input: UpsertUserApplicationInput!) {
  upsertUserApplication(input: $input) {
    result {
      ...UserApplicationFragment
    }
  }
}

Variables

{"input": UpsertUserApplicationInput}

Response

{
  "data": {
    "upsertUserApplication": {"result": UserApplication}
  }
}

Mutations

`upsertWireDetails`

Response

Returns an UpsertWireDetailsPayload

Arguments

Name	Description
`input` - `UpsertWireDetailsInput!`

Example

Query

mutation upsertWireDetails($input: UpsertWireDetailsInput!) {
  upsertWireDetails(input: $input) {
    result {
      ...AccountFragment
    }
  }
}

Variables

{"input": UpsertWireDetailsInput}

Response

{"data": {"upsertWireDetails": {"result": Account}}}

Mutations

`useReferralCode`

Description

Attaches a submitted referral code to the users user_application

Response

Returns a UseReferralCodePayload

Arguments

Name	Description
`input` - `UseReferralCodeInput!`

Example

Query

mutation useReferralCode($input: UseReferralCodeInput!) {
  useReferralCode(input: $input) {
    result {
      ...UserApplicationFragment
    }
  }
}

Variables

{"input": UseReferralCodeInput}

Response

{"data": {"useReferralCode": {"result": UserApplication}}}

Types

Account

Description

Represents an account (spend, saving, credit, ...) that will maintain its balance and has associated events that affect the balance.

Fields

Field Name	Description
`authorizedUsers` - `[User!]!`
`balanceLastRefreshed` - `DateTime`
`balanceOverTime` - `BalanceOverTime!`	Use simple_balance_over_time instead.
Arguments `endDate` - `Date` `frequency` - `BalanceFrequency` `startDate` - `Date`
`billReserve` - `BillReserve!`
`cashTransactions` - `CashTransactionConnection!`
Arguments `searchFilters` - `CashTransactionFilter`
`family` - `Family!`
`frozenReason` - `AccountFrozenReason`
`frozenStatus` - `AccountFrozenStatus!`
`icon` - `AccountIcon`
`insertedAt` - `DateTime!`
`institution` - `Institution`	The institution related to the account. Contains relevant information to the institution (routing_number, logo_url, etc.)
`interestDetails` - `AccountInterestDetails!`	Details around the account's interest (rate, earned YTD, etc.)
`owner` - `AccountOwnerDisplay!`
`owners` - `[User!]!`	The legal owners on the account as compared to `authorized_users`. If you are looking to see who owns the account in the context of Crew, see `account_owners`.
`partner` - `AccountPartner!`
`pendingCheckDeposits` - `[CheckDeposit!]!`
`pendingTransfers` - `[Transfer!]!`	No longer used - all transfers immediately get a transaction now.
`permittedActions` - `AccountPermittedActions!`
`physicalDebitCards` - `[DebitCard!]!`
`primaryOwner` - `User`	The user who owns this account in the context of Crew. Not to be confused with the legal `owners` of the account.
`primarySubaccount` - `Subaccount`
`reassignmentRules` - `[ReassignmentRule!]!`
`recipient` - `Recipient`	The recipient that this payment method is tied to.
`recipientAddress` - `Address`	Address for recipient accounts that can be used for wires
`scheduledTransfers` - `[ScheduledTransfer]`
`statements` - `[Statement!]!`
`status` - `AccountStatus!`
`subaccounts` - `[Subaccount!]!`	All subaccounts for the account, excluding :bill and :bill_reserve types since items cannot be directly assigned to them.
Arguments `types` - `[SubaccountType!]`
`targetBalanceSetting` - `TargetBalanceSetting`
`transfersFrom` - `TransferConnection!`
Arguments `searchFilters` - `TransferFilter`
`transfersTo` - `TransferConnection!`
Arguments `searchFilters` - `TransferFilter`
`type` - `AccountType!`	spend: The spend account save: The savings account
`userAccounts` - `[UserAccount!]!`	Use primary_owner instead.
`users` - `[User!]!`
`virtualDebitCards` - `[DebitCard!]!`
`visibleSubaccountBalanceOverTime` - `[BalanceOnDate!]!`	Use simple_balance_over_time from each subaccount instead. Filtering on the backend is slow.

Example

{
  "authorizedUsers": [User],
  "balanceLastRefreshed": "2007-12-03T10:15:30Z",
  "balanceOverTime": BalanceOverTime,
  "billReserve": BillReserve,
  "cashTransactions": CashTransactionConnection,
  "family": Family,
  "frozenReason": "USER_FROZEN",
  "frozenStatus": "FAILED",
  "icon": "BANK",
  "insertedAt": "2007-12-03T10:15:30Z",
  "institution": Institution,
  "interestDetails": AccountInterestDetails,
  "owner": AccountOwnerDisplay,
  "owners": [User],
  "partner": "INTERNAL",
  "pendingCheckDeposits": [CheckDeposit],
  "pendingTransfers": [Transfer],
  "permittedActions": AccountPermittedActions,
  "physicalDebitCards": [DebitCard],
  "primaryOwner": User,
  "primarySubaccount": Subaccount,
  "reassignmentRules": [ReassignmentRule],
  "recipient": Recipient,
  "recipientAddress": Address,
  "scheduledTransfers": [ScheduledTransfer],
  "statements": [Statement],
  "status": "ACTIVATED",
  "subaccounts": [Subaccount],
  "targetBalanceSetting": TargetBalanceSetting,
  "transfersFrom": TransferConnection,
  "transfersTo": TransferConnection,
  "type": "ACH_CHECKING_RECIPIENT",
  "userAccounts": [UserAccount],
  "users": [User],
  "virtualDebitCards": [DebitCard],
  "visibleSubaccountBalanceOverTime": [BalanceOnDate]
}

Types

AccountFrozenReason

Values

Enum Value	Description
`USER_FROZEN`

Example

"USER_FROZEN"

Types

AccountFrozenStatus

Values

Enum Value	Description
`FAILED`
`FREEZING`
`FROZEN`
`UNFREEZING`
`UNFROZEN`

Example

"FAILED"

Types

AccountIcon

Values

Enum Value	Description
`BANK`
`CARD`
`POCKET`

Example

"BANK"

Types

AccountInterestDetails

Fields

Field Name	Description
`boostDetails` - `InterestBoost`

Example

{"boostDetails": InterestBoost}

Types

AccountOwnerDisplay

Fields

Field Name	Description
`avatarColor` - `DebitCardColor`

Example

{"avatarColor": "BANANA"}

Types

AccountPartner

Values

Enum Value	Description
`INTERNAL`
`NONE`
`QUILTT`
`QUILTT_FINICITY`
`QUILTT_MX`
`QUILTT_PLAID`
`TREASURY`

Example

"INTERNAL"

Types

AccountPermittedActions

Example

{}

Types

AccountStatus

Values

Enum Value	Description
`ACTIVATED`
`ACTIVATING`
`CREATED`
`CREATING`
`DELETED`
`DELETING`
`EMANCIPATED`
`FAILED`

Example

"ACTIVATED"

Types

AccountType

Values

Enum Value	Description
`ACH_CHECKING_RECIPIENT`
`ACH_SAVINGS_RECIPIENT`
`EXTERNAL_OTHER`
`EXTERNAL_SAVE`
`EXTERNAL_SPEND`
`PEER_RECIPIENT`
`SAVE`
`SPEND`
`SUBACCOUNT`
`SYSTEM`
`WIRE_RECIPIENT`

Example

"ACH_CHECKING_RECIPIENT"

Types

ActionAccountType

Values

Enum Value	Description
`ACCOUNT`
`SUBACCOUNT`

Example

"ACCOUNT"

Types

ActivateDebitCardsInput

Example

{}

Types

ActivateDebitCardsPayload

Fields

Field Name	Description
`result` - `[DebitCard!]!`

Example

{"result": [DebitCard]}

Types

AddChildInput

Fields

Input Field	Description
`dob` - `Date!`
`profilePic` - `Upload`	Profile pic data (See: https://www.npmjs.com/package/apollo-absinthe-upload-link)

Example

{
  "dob": "2007-12-03",
  "profilePic": Upload
}

Types

AddChildPayload

Fields

Field Name	Description
`result` - `User!`

Example

{"result": User}

Types

AddDebitCardToAppleWalletSyncInput

Fields

Input Field	Description
`deviceType` - `ProvisioningDeviceType!`

Example

{"deviceType": "MOBILE_PHONE"}

Types

AddDebitCardToAppleWalletSyncPayload

Fields

Field Name	Description
`result` - `AppleWalletProvisionResponse!`

Example

{"result": AppleWalletProvisionResponse}

Types

AddDebitCardToGoogleWalletSyncInput

Fields

Input Field	Description
`deviceType` - `ProvisioningDeviceType!`

Example

{"deviceType": "MOBILE_PHONE"}

Types

AddDebitCardToGoogleWalletSyncPayload

Fields

Field Name	Description
`result` - `GoogleWalletProvisionResponse!`

Example

{"result": GoogleWalletProvisionResponse}

Types

AddFamilyMemberInput

Fields

Input Field	Description
`dob` - `Date`
`profilePic` - `Upload`	Profile pic data (See: https://www.npmjs.com/package/apollo-absinthe-upload-link)
`roles` - `[AppRole!]!`

Example

{
  "dob": "2007-12-03",
  "profilePic": Upload,
  "roles": ["ADMIN"]
}

Types

AddFamilyMembersInput

Fields

Input Field	Description
`familyMembers` - `[AddFamilyMemberInput!]!`

Example

{"familyMembers": [AddFamilyMemberInput]}

Types

AddFamilyMembersPayload

Fields

Field Name	Description
`result` - `[User!]!`

Example

{"result": [User]}

Types

AddParentInput

Fields

Input Field	Description
`dob` - `Date`
`profilePic` - `Upload`	Profile pic data (See: https://www.npmjs.com/package/apollo-absinthe-upload-link)

Example

{
  "dob": "2007-12-03",
  "profilePic": Upload
}

Types

AddParentPayload

Fields

Field Name	Description
`result` - `User!`

Example

{"result": User}

Types

AddRecipientAccountInput

Fields

Input Field	Description
`recipientAddress` - `AddressInput!`

Example

{"recipientAddress": AddressInput}

Types

AddRecipientAccountPayload

Fields

Field Name	Description
`result` - `Account!`

Example

{"result": Account}

Types

Address

Example

{}

Types

AddressInput

Example

{}

Types

Allowance

Fields

Field Name	Description
`dayOfWeek` - `DayOfWeek`
`nextTransferDate` - `Date!`
`type` - `AllowanceSchedule!`

Example

{
  "dayOfWeek": "FRIDAY",
  "nextTransferDate": "2007-12-03",
  "type": "MONTHLY"
}

Types

AllowanceSchedule

Values

Enum Value	Description
`MONTHLY`
`ONE_TIME`
`WEEKLY`

Example

"MONTHLY"

Types

AndCondition

Fields

Field Name	Description
`conditions` - `[RuleCondition!]!`
`type` - `RuleConditionType!`

Example

{"conditions": [RuleCondition], "type": "AND"}

Types

AndConditionInput

Fields

Input Field	Description
`conditions` - `[RuleConditionInput!]`

Example

{"conditions": [RuleConditionInput]}

Types

AppRole

Values

Enum Value	Description
`ADMIN`
`APPLICANT`
`CHILD`
`DEMO`
`ENGINEER`
`PARENT`
`SUPPORT`

Example

"ADMIN"

Types

AppleWalletProvisionResponse

Example

{}

Types

AssignTransactionToBillPaymentInput

Example

{}

Types

AssignTransactionToBillPaymentPayload

Fields

Field Name	Description
`result` - `BillPayment!`

Example

{"result": BillPayment}

Types

AttachVirtualDebitCardToBillInput

Example

{}

Types

AttachVirtualDebitCardToBillPayload

Fields

Field Name	Description
`result` - `Bill!`

Example

{"result": Bill}

Types

AutoAssignTransactionToBillPaymentInput

Example

{}

Types

AutoAssignTransactionToBillPaymentPayload

Fields

Field Name	Description
`result` - `BillPayment!`

Example

{"result": BillPayment}

Types

AutopayFrequency

Values

Enum Value	Description
`DISABLED`
`MONTHLY`
`WEEKLY`

Example

"DISABLED"

Types

BalanceFrequency

Values

Enum Value	Description
`DAILY`
`WEEKLY`

Example

"DAILY"

Types

BalanceOnDate

Fields

Field Name	Description
`date` - `Date!`

Example

{"date": "2007-12-03"}

Types

BalanceOverTime

Fields

Field Name	Description
`balances` - `[BalanceOnDate!]!`
`frequency` - `BalanceFrequency!`

Example

{"balances": [BalanceOnDate], "frequency": "DAILY"}

Types

Beneficiary

Fields

Field Name	Description
`family` - `Family`
`type` - `BeneficiaryType!`

Example

{"family": Family, "type": "ENTITY"}

Types

BeneficiaryType

Values

Enum Value	Description
`ENTITY`
`INDIVIDUAL`

Example

"ENTITY"

Types

Bill

Fields

Field Name	Description
`account` - `Account!`
`anchorDate` - `Date!`
`billPayments` - `[BillPayment!]!`
`billReserve` - `BillReserve!`
`cashTransactions` - `CashTransactionConnection!`
Arguments `searchFilters` - `CashTransactionFilter`
`dayOfWeek` - `DayOfWeek!`
`firstLatePayment` - `BillPayment`
Arguments `date` - `Date`
`firstUpcomingPayment` - `BillPayment`
Arguments `date` - `Date`
`frequency` - `BillFrequency!`
`history` - `BillHistory!`
`permittedActions` - `BillPermittedActions!`
`reassignmentRule` - `ReassignmentRule`
`reservedBy` - `Date`
Arguments `date` - `Date`
`status` - `BillStatus!`
`virtualDebitCard` - `DebitCard`

Example

{
  "account": Account,
  "anchorDate": "2007-12-03",
  "billPayments": [BillPayment],
  "billReserve": BillReserve,
  "cashTransactions": CashTransactionConnection,
  "dayOfWeek": "FRIDAY",
  "firstLatePayment": BillPayment,
  "firstUpcomingPayment": BillPayment,
  "frequency": "MONTHLY",
  "history": BillHistory,
  "permittedActions": BillPermittedActions,
  "reassignmentRule": ReassignmentRule,
  "reservedBy": "2007-12-03",
  "status": "ACTIVATED",
  "virtualDebitCard": DebitCard
}

Types

BillFrequency

Values

Enum Value	Description
`MONTHLY`
`WEEKLY`

Example

"MONTHLY"

Types

BillHistory

Fields

Field Name	Description
`groupedHistoricPayments` - `[GroupedHistoricPayment!]!`
Arguments `date` - `Date` `startDate` - `Date!`

Example

{"groupedHistoricPayments": [GroupedHistoricPayment]}

Types

BillPayment

Fields

Field Name	Description
`actualDate` - `Date`
`bill` - `Bill!`
`cashTransaction` - `CashTransaction`
`expectedDate` - `Date!`
`status` - `BillPaymentStatus!`

Example

{
  "actualDate": "2007-12-03",
  "bill": Bill,
  "cashTransaction": CashTransaction,
  "expectedDate": "2007-12-03",
  "status": "FULL"
}

Types

BillPaymentStatus

Values

Enum Value	Description
`FULL`
`OVERDUE`
`PAID`
`PARTIAL`
`UNFUNDED`

Example

"FULL"

Types

BillPayments

Fields

Field Name	Description
`currentMonth` - `[BillPayment!]!`
Arguments `date` - `Date!`
`future` - `[BillPayment!]!`	Not used in latest bill reserve designs
Arguments `date` - `Date!`

Example

{
  "currentMonth": [BillPayment],
  "future": [BillPayment]
}

Types

BillPermittedActions

Example

{}

Types

BillPreview

Fields

Input Field	Description
`anchorDate` - `Date!`
`frequency` - `BillFrequency!`

Example

{
  "anchorDate": "2007-12-03",
  "frequency": "MONTHLY"
}

Types

BillPreviewResult

Fields

Field Name	Description
`anchorDate` - `Date!`
`frequency` - `BillFrequency!`

Example

{
  "anchorDate": "2007-12-03",
  "frequency": "MONTHLY"
}

Types

BillReassignmentRuleInput

Fields

Input Field	Description
`transactionType` - `ReassignmentRuleTransactionType`

Example

{"transactionType": "ACH"}

Types

BillReserve

Fields

Field Name	Description
`archivedBills` - `[Bill!]!`
`assignableCashTransactions` - `CashTransactionConnection`
Arguments `searchFilters` - `CashTransactionFilter`
`billPayments` - `BillPayments!`
`billSuggestions` - `[BillSuggestion!]!`
`bills` - `[Bill!]!`
`nextFundingDate` - `Date!`
`paidBillPayments` - `[BillPayment!]!`	List of paid bill payments for this month
Arguments `date` - `Date!`
`pausedBills` - `[Bill!]!`
`reservedAmountPreview` - `[BillPreviewResult!]!`
Arguments `bills` - `[BillPreview!]!`
`settings` - `BillReserveSettings!`

Example

{
  "archivedBills": [Bill],
  "assignableCashTransactions": CashTransactionConnection,
  "billPayments": BillPayments,
  "billSuggestions": [BillSuggestion],
  "bills": [Bill],
  "nextFundingDate": "2007-12-03",
  "paidBillPayments": [BillPayment],
  "pausedBills": [Bill],
  "reservedAmountPreview": [BillPreviewResult],
  "settings": BillReserveSettings
}

Types

BillReserveFundingFrequency

Values

Enum Value	Description
`BIMONTHLY`
`MONTHLY`
`WEEKLY`

Example

"BIMONTHLY"

Types

BillReserveFundingSettings

Fields

Field Name	Description
`anchorDate` - `Date!`
`dayOfWeek` - `DayOfWeek!`
`frequency` - `BillReserveFundingFrequency!`
`subaccount` - `Subaccount!`

Example

{
  "anchorDate": "2007-12-03",
  "dayOfWeek": "FRIDAY",
  "frequency": "BIMONTHLY",
  "subaccount": Subaccount
}

Types

BillReserveSettings

Fields

Field Name	Description
`funding` - `BillReserveFundingSettings!`

Example

{"funding": BillReserveFundingSettings}

Types

BillStatus

Values

Enum Value	Description
`ACTIVATED`
`DEACTIVATED`

Example

"ACTIVATED"

Types

BillSuggestion

Fields

Field Name	Description
`anchorDate` - `Date!`
`frequency` - `BillFrequency!`

Example

{
  "anchorDate": "2007-12-03",
  "frequency": "MONTHLY"
}

Types

BoostStatus

Values

Enum Value	Description
`ACTIVE`
`INACTIVE`
`MAXED`
`SCHEDULED`

Example

"ACTIVE"

Types

BulkBill

Fields

Input Field	Description
`anchorDate` - `Date!`
`frequency` - `BillFrequency!`
`reassignmentRule` - `BillReassignmentRuleInput!`

Example

{
  "anchorDate": "2007-12-03",
  "frequency": "MONTHLY",
  "reassignmentRule": BillReassignmentRuleInput
}

Types

BulkSetSubaccountVisibilityInput

Fields

Input Field	Description
`visibilitySettings` - `[BulkSubaccountVisibilitySetting!]!`

Example

{"visibilitySettings": [BulkSubaccountVisibilitySetting]}

Types

BulkSetSubaccountVisibilityPayload

Fields

Field Name	Description
`result` - `[Subaccount!]!`

Example

{"result": [Subaccount]}

Types

BulkSubaccountVisibilitySetting

Example

{}

Types

CalculateCashTransactionEnrichmentInput

Example

{}

Types

CalculateCashTransactionEnrichmentPayload

Fields

Field Name	Description
`result` - `CashTransactionEnrichment!`

Example

{"result": CashTransactionEnrichment}

Types

CancelDebitCardInput

Example

{}

Types

CancelDebitCardOrderInput

Example

{}

Types

CancelDebitCardOrderPayload

Fields

Field Name	Description
`result` - `DebitCardOrder!`

Example

{"result": DebitCardOrder}

Types

CancelDebitCardPayload

Fields

Field Name	Description
`result` - `DebitCard!`

Example

{"result": DebitCard}

Types

CancelPaymentInput

Example

{}

Types

CancelPaymentPayload

Fields

Field Name	Description
`result` - `ScheduledTransfer!`

Example

{"result": ScheduledTransfer}

Types

CancelTransferInput

Example

{}

Types

CancelTransferPayload

Fields

Field Name	Description
`result` - `Transfer!`

Example

{"result": Transfer}

Types

CardFrozenReason

Values

Enum Value	Description
`FRAUD_DETECTED`
`FROZEN_BY_BANK`
`LOST_OR_STOLEN`
`PARENT_REQUESTED`
`USER_FROZEN`
`USER_REQUESTED`

Example

"FRAUD_DETECTED"

Types

CardFrozenStatus

Values

Enum Value	Description
`FAILED`
`FREEZING`
`FROZEN`
`UNFREEZING`
`UNFROZEN`

Example

"FAILED"

Types

CashDepositAddress

Example

{}

Types

CashDepositBarcode

Fields

Field Name	Description
`expiresAt` - `DateTime!`
`status` - `CashDepositBarcodeStatus!`
`subaccount` - `Subaccount`

Example

{
  "expiresAt": "2007-12-03T10:15:30Z",
  "status": "CLOSED",
  "subaccount": Subaccount
}

Types

CashDepositBarcodeStatus

Values

Enum Value	Description
`CLOSED`
`EXPIRED`
`READY`
`USED`
`VOID`

Example

"CLOSED"

Types

CashDepositLocation

Fields

Field Name	Description
`address` - `CashDepositAddress!`
`coordinates` - `Coordinates!`

Example

{
  "address": CashDepositAddress,
  "coordinates": Coordinates
}

Types

CashFlowInMonth

Fields

Field Name	Description
`date` - `Date!`

Example

{"date": "2007-12-03"}

Types

CashTransaction

Description

A transaction against a non-credit account

Fields

Field Name	Description
`account` - `Account!`
`avatarFallbackColor` - `DebitCardColor`
`bill` - `Bill`
`clearedAt` - `DateTime`
`debitCard` - `DebitCard`
`family` - `Family!`
`latestDebitCardTransactionDetail` - `DebitCardTransactionDetail`
`occurredAt` - `DateTime!`
`permittedActions` - `CashTransactionPermittedActions!`
`relatedTransactions` - `[CashTransaction!]!`
`splitTransactions` - `[CashTransaction!]!`
`status` - `CashTransactionStatus!`
`subaccount` - `Subaccount`
`transfer` - `Transfer`
`type` - `CashTransactionType!`

Example

{
  "account": Account,
  "avatarFallbackColor": "BANANA",
  "bill": Bill,
  "clearedAt": "2007-12-03T10:15:30Z",
  "debitCard": DebitCard,
  "family": Family,
  "latestDebitCardTransactionDetail": DebitCardTransactionDetail,
  "occurredAt": "2007-12-03T10:15:30Z",
  "permittedActions": CashTransactionPermittedActions,
  "relatedTransactions": [CashTransaction],
  "splitTransactions": [CashTransaction],
  "status": "CANCELED",
  "subaccount": Subaccount,
  "transfer": Transfer,
  "type": "ACH"
}

Types

CashTransactionConnection

Fields

Field Name	Description
`edges` - `[CashTransactionEdge!]!`
`pageInfo` - `PageInfo!`

Example

{
  "edges": [CashTransactionEdge],
  "pageInfo": PageInfo
}

Types

CashTransactionEdge

Fields

Field Name	Description
`node` - `CashTransaction!`

Example

{"node": CashTransaction}

Types

CashTransactionEnrichment

Example

{}

Types

CashTransactionFilter

Fields

Input Field	Description
`amount` - `IntegerRange`
`amountV2` - `[IntegerRange]`
`matchingName` - `StringFilter`
`type` - `CashTransactionType`

Example

{
  "amount": IntegerRange,
  "amountV2": [IntegerRange],
  "matchingName": StringFilter,
  "type": "ACH"
}

Types

CashTransactionPermittedActions

Example

{}

Types

CashTransactionSplitInput

Example

{}

Types

CashTransactionStatus

Values

Enum Value	Description
`CANCELED`
`CLEARED`
`EXPIRED`
`FAILED`
`PENDING`
`RETURNED`

Example

"CANCELED"

Types

CashTransactionType

Values

Enum Value	Description
`ACH`
`ADJUSTMENT`
`ALLOWANCE`
`BANK`
`BILL_SUBACCOUNT`
`BONUS`
`BOOK`
`CARD`
`CASH_DEPOSIT`
`CHECK`
`FEE`
`FEE_REIMBURSEMENT`
`INTEREST`
`OTHER`
`PEER_TO_PEER`
`REFERRAL_BONUS`
`REWARD`
`SHALLOW_COPY`
`SUBACCOUNT`
`SUBSCRIPTION_FEE`
`TARGET`
`UNDO`
`WIRE`

Example

"ACH"

Types

CheckDeposit

Fields

Field Name	Description
`permittedActions` - `CheckDepositPermittedActions!`
`subaccount` - `Subaccount!`

Example

{
  "permittedActions": CheckDepositPermittedActions,
  "subaccount": Subaccount
}

Types

CheckDepositPermittedActions

Example

{}

Types

ConditionAttribute

Values

Enum Value	Description
`AMOUNT`
`BALANCE`
`MERCHANT_NAME`
`STATUS`

Example

"AMOUNT"

Types

ConditionEntitySchema

Values

Enum Value	Description
`ACCOUNTS`
`CASH_TRANSACTIONS`
`DEBIT_CARDS`
`SUBACCOUNTS`

Example

"ACCOUNTS"

Types

ConsentToESignAgreementPayload

Fields

Field Name	Description
`result` - `User!`

Example

{"result": User}

Types

Coordinates

Example

{}

Types

CreateBillInput

Fields

Input Field	Description
`anchorDate` - `Date!`
`frequency` - `BillFrequency!`
`reassignmentRule` - `BillReassignmentRuleInput!`

Example

{
  "anchorDate": "2007-12-03",
  "frequency": "MONTHLY",
  "reassignmentRule": BillReassignmentRuleInput
}

Types

CreateBillPayload

Fields

Field Name	Description
`result` - `Bill!`

Example

{"result": Bill}

Types

CreateBillsBulkInput

Fields

Input Field	Description
`bills` - `[BulkBill!]!`

Example

{"bills": [BulkBill]}

Types

CreateBillsBulkPayload

Fields

Field Name	Description
`result` - `[Bill!]!`

Example

{"result": [Bill]}

Types

CreatePaymentInput

Fields

Input Field	Description
`dayOfWeek` - `DayOfWeek`
`frequency` - `ScheduledTransferFrequency!`
`monthCadence` - `MonthCadence`
`scheduledDate` - `Date`
`weekCadence` - `WeekCadence`

Example

{
  "dayOfWeek": "FRIDAY",
  "frequency": "MONTHLY",
  "monthCadence": "ONCE",
  "scheduledDate": "2007-12-03",
  "weekCadence": "EVEN"
}

Types

CreatePaymentPayload

Fields

Field Name	Description
`result` - `ScheduledTransfer!`

Example

{"result": ScheduledTransfer}

Types

CreateProvisionalCopyForWalletSyncInput

Example

{}

Types

CreateProvisionalCopyForWalletSyncPayload

Fields

Field Name	Description
`result` - `DebitCard!`

Example

{"result": DebitCard}

Types

CreateReassignmentRuleInput

Fields

Input Field	Description
`transactionType` - `ReassignmentRuleTransactionType`

Example

{"transactionType": "ACH"}

Types

CreateReassignmentRulePayload

Fields

Field Name	Description
`result` - `ReassignmentRule!`

Example

{"result": ReassignmentRule}

Types

CreateRecipientInput

Fields

Input Field	Description
`address` - `AddressInput!`
`type` - `RecipientType!`

Example

{"address": AddressInput, "type": "BUSINESS"}

Types

CreateRecipientPayload

Fields

Field Name	Description
`result` - `Recipient!`

Example

{"result": Recipient}

Types

CreateRuleInput

Fields

Input Field	Description
`formula` - `RuleFormulaInput!`

Example

{"formula": RuleFormulaInput}

Types

CreateRulePayload

Fields

Field Name	Description
`result` - `Rule!`

Example

{"result": Rule}

Types

CreateSubaccountInput

Fields

Input Field	Description
`type` - `SubaccountType`

Example

{"type": "BILL"}

Types

CreateSubaccountPayload

Fields

Field Name	Description
`result` - `Subaccount!`

Example

{"result": Subaccount}

Types

CreateUnscheduledBillPaymentInput

Example

{}

Types

CreateUnscheduledBillPaymentPayload

Fields

Field Name	Description
`result` - `BillPayment!`

Example

{"result": BillPayment}

Types

CreateVirtualDebitCardInput

Fields

Input Field	Description
`cancelAfter` - `DateTime`	Datetime after which the card should be canceled
`cardColor` - `DebitCardColor`	Card color for the virtual debit card
`type` - `VirtualDebitCardType`	Optionally specify a different type of virtual card than the default (such as single_use)

Example

{
  "cancelAfter": "2007-12-03T10:15:30Z",
  "cardColor": "BANANA",
  "type": "SINGLE_USE"
}

Types

CreateVirtualDebitCardPayload

Fields

Field Name	Description
`result` - `DebitCard!`

Example

{"result": DebitCard}

Types

Date

Description

The Date scalar type represents a date. The Date appears in a JSON response as an ISO8601 formatted string, without a time component.

Example

"2007-12-03"

Types

DateTime

Description

The DateTime scalar type represents a date and time in the UTC timezone. The DateTime appears in a JSON response as an ISO8601 formatted string, including UTC timezone ("Z"). The parsed date and time string will be converted to UTC if there is an offset.

Example

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

Types

DayOfMonthCondition

Fields

Field Name	Description
`monthCadence` - `MonthCadence!`
`type` - `RuleConditionType!`

Example

{"monthCadence": "ONCE", "type": "AND"}

Types

DayOfMonthConditionInput

Fields

Input Field	Description
`monthCadence` - `MonthCadence`

Example

{"monthCadence": "ONCE"}

Types

DayOfWeek

Values

Enum Value	Description
`FRIDAY`
`MONDAY`
`SATURDAY`
`SUNDAY`
`THURSDAY`
`TUESDAY`
`WEDNESDAY`

Example

"FRIDAY"

Types

DayOfWeekCondition

Fields

Field Name	Description
`dayOfWeek` - `DayOfWeek!`
`type` - `RuleConditionType!`
`weekCadence` - `WeekCadence!`

Example

{"dayOfWeek": "FRIDAY", "type": "AND", "weekCadence": "EVEN"}

Types

DayOfWeekConditionInput

Fields

Input Field	Description
`dayOfWeek` - `DayOfWeek!`
`weekCadence` - `WeekCadence`

Example

{"dayOfWeek": "FRIDAY", "weekCadence": "EVEN"}

Types

DebitCard

Fields

Field Name	Description
`account` - `Account!`
`activeProvisionalDebitCard` - `DebitCard`	We no longer need to use separate provisional cards
`bill` - `Bill`
`billingAddress` - `Address`
`bills` - `[Bill!]!`
`cancelAfter` - `DateTime`
`color` - `DebitCardColor`
`debitCardOrder` - `DebitCardOrder`
`digitalWalletTokens` - `[DigitalWalletToken!]!`
`family` - `Family!`
`frozenReason` - `CardFrozenReason`
`frozenStatus` - `CardFrozenStatus`
`permittedActions` - `DebitCardPermittedActions!`
`status` - `DebitCardStatus!`
`subaccount` - `Subaccount`
`transactions` - `CashTransactionConnection!`
`type` - `DebitCardType!`
`user` - `User!`

Example

{
  "account": Account,
  "activeProvisionalDebitCard": DebitCard,
  "bill": Bill,
  "billingAddress": Address,
  "bills": [Bill],
  "cancelAfter": "2007-12-03T10:15:30Z",
  "color": "BANANA",
  "debitCardOrder": DebitCardOrder,
  "digitalWalletTokens": [DigitalWalletToken],
  "family": Family,
  "frozenReason": "FRAUD_DETECTED",
  "frozenStatus": "FAILED",
  "permittedActions": DebitCardPermittedActions,
  "status": "ACTIVATED",
  "subaccount": Subaccount,
  "transactions": CashTransactionConnection,
  "type": "PHYSICAL",
  "user": User
}

Types

DebitCardColor

Values

Enum Value	Description
`BANANA`
`BEIGE`
`BLACK`
`CORAL`
`DENIM`
`JADE`
`LILAC`
`TEAL`

Example

"BANANA"

Types

DebitCardOrder

Fields

Field Name	Description
`cardColor` - `DebitCardColor!`
`debitCard` - `DebitCard`
`family` - `Family!`
`insertedAt` - `DateTime`
`permittedActions` - `DebitCardOrderPermittedActions!`
`shippedAt` - `DateTime`
`shippedTo` - `Address`
`status` - `DebitCardOrderStatus!`
`user` - `User!`

Example

{
  "cardColor": "BANANA",
  "debitCard": DebitCard,
  "family": Family,
  "insertedAt": "2007-12-03T10:15:30Z",
  "permittedActions": DebitCardOrderPermittedActions,
  "shippedAt": "2007-12-03T10:15:30Z",
  "shippedTo": Address,
  "status": "CANCELED",
  "user": User
}

Types

DebitCardOrderDeliveryTimeline

Values

Enum Value	Description
`STANDARD`
`TWO_DAY`

Example

"STANDARD"

Types

DebitCardOrderPermittedActions

Example

{}

Types

DebitCardOrderStatus

Values

Enum Value	Description
`CANCELED`
`CREATING`
`FAILED`
`ORDERED`
`ORDERING`
`REJECTED`
`REORDERED`
`REORDERING`
`SHIPPED`

Example

"CANCELED"

Types

DebitCardPermittedActions

Example

{}

Types

DebitCardStatus

Values

Enum Value	Description
`ACTIVATED`
`ACTIVATING`
`DEACTIVATED`
`DEACTIVATING`
`EMANCIPATED`
`EXPIRED`
`FAILED`
`ISSUED`
`ISSUING`

Example

"ACTIVATED"

Types

DebitCardTransactionDetail

Example

{}

Types

DebitCardType

Values

Enum Value	Description
`PHYSICAL`
`PROVISIONAL`
`SINGLE_USE`
`VIRTUAL`

Example

"PHYSICAL"

Types

DeleteAccountInput

Example

{}

Types

DeleteAccountPayload

Fields

Field Name	Description
`result` - `Account!`

Example

{"result": Account}

Types

DeleteBillInput

Example

{}

Types

DeleteBillPayload

Fields

Field Name	Description
`result` - `Bill!`

Example

{"result": Bill}

Types

DeleteReassignmentRuleInput

Example

{}

Types

DeleteReassignmentRulePayload

Fields

Field Name	Description
`result` - `ReassignmentRule!`

Example

{"result": ReassignmentRule}

Types

DeleteRecipientInput

Example

{}

Types

DeleteRecipientPayload

Fields

Field Name	Description
`result` - `Recipient!`

Example

{"result": Recipient}

Types

DeleteRuleInput

Example

{}

Types

DeleteRulePayload

Fields

Field Name	Description
`result` - `Rule!`

Example

{"result": Rule}

Types

DeleteSubaccountInput

Example

{}

Types

DeleteSubaccountPayload

Fields

Field Name	Description
`result` - `Subaccount!`

Example

{"result": Subaccount}

Types

DeleteThreadInput

Example

{}

Types

DeleteThreadPayload

Fields

Field Name	Description
`result` - `PennyThread!`

Example

{"result": PennyThread}

Types

DepositCheckInput

Fields

Input Field	Description
`backImage` - `Upload!`
`frontImage` - `Upload!`

Example

{
  "backImage": Upload,
  "frontImage": Upload
}

Types

DepositCheckPayload

Fields

Field Name	Description
`result` - `CheckDeposit!`

Example

{"result": CheckDeposit}

Types

DetachVirtualDebitCardFromBillInput

Example

{}

Types

DetachVirtualDebitCardFromBillPayload

Fields

Field Name	Description
`result` - `Bill!`

Example

{"result": Bill}

Types

DigitalWalletToken

Fields

Field Name	Description
`deviceType` - `DigitalWalletTokenDeviceType`
`frozenStatus` - `CardFrozenStatus`
`fulfillmentStatus` - `DigitalWalletTokenFulfillmentStatus`
`insertedAt` - `DateTime!`
`network` - `DigitalWalletTokenNetwork`
`status` - `DigitalWalletTokenStatus`
`updatedAt` - `DateTime!`
`user` - `User`

Example

{
  "deviceType": "MOBILE_PHONE",
  "frozenStatus": "FAILED",
  "fulfillmentStatus": "DECISION_GREEN",
  "insertedAt": "2007-12-03T10:15:30Z",
  "network": "MASTERCARD",
  "status": "ACTIVATED",
  "updatedAt": "2007-12-03T10:15:30Z",
  "user": User
}

Types

DigitalWalletTokenDeviceType

Values

Enum Value	Description
`MOBILE_PHONE`
`TABLET`
`UNKNOWN`
`WATCH`

Example

"MOBILE_PHONE"

Types

DigitalWalletTokenFulfillmentStatus

Values

Enum Value	Description
`DECISION_GREEN`
`DECISION_YELLOW`
`PROVISIONED`
`REJECTED`

Example

"DECISION_GREEN"

Types

DigitalWalletTokenNetwork

Values

Enum Value	Description
`MASTERCARD`
`VISA`

Example

"MASTERCARD"

Types

DigitalWalletTokenStatus

Values

Enum Value	Description
`ACTIVATED`
`DEACTIVATED`
`DECLINED`
`REQUESTED`

Example

"ACTIVATED"

Types

DigitalWalletTokenStatusOverride

Values

Enum Value	Description
`ACTIVE`
`SUSPENDED`
`TERMINATED`

Example

"ACTIVE"

Types

DismissPromptInput

Fields

Input Field	Description
`userAction` - `UserAction`

Example

{"userAction": "CTA"}

Types

DismissPromptPayload

Fields

Field Name	Description
`result` - `Prompt!`

Example

{"result": Prompt}

Types

DismissTakeoverInput

Example

{}

Types

DismissTakeoverPayload

Fields

Field Name	Description
`result` - `User!`

Example

{"result": User}

Types

ExternalManualAccountType

Values

Enum Value	Description
`EXTERNAL_SAVE`
`EXTERNAL_SPEND`

Example

"EXTERNAL_SAVE"

Types

Family

Fields

Field Name	Description
`accounts` - `[Account!]!`
`address` - `Address`
`autopayAccount` - `Account`
`autopayFrequency` - `AutopayFrequency`
`beneficiary` - `Beneficiary`
`cashTransactions` - `CashTransactionConnection!`
`children` - `[User!]!`
`comments` - `[UserComment!]!`
`deletedCashAccounts` - `[Account!]!`
`externalAccounts` - `[Account!]!`
`flags` - `FamilyFlags!`
`frozenReason` - `FamilyFrozenReason`
`frozenStatus` - `FamilyFrozenStatus!`
`groupedTransactions` - `[GroupedTransaction!]!`
Arguments `types` - `[CashTransactionType]`
`influencer` - `Influencer`
`lastTransactionUpdatedAt` - `DateTime`
`mailingAddress` - `Address`
`merchantFilterTransactions` - `[CashTransaction!]!`
Arguments `types` - `[CashTransactionType]`
`parents` - `[User!]!`
`peerRecipientAccounts` - `[Account!]!`
`permittedActions` - `FamilyPermittedActions!`
`promotionBonuses` - `[PromotionBonus]`
`reassignmentRules` - `[ReassignmentRule!]!`
`recipients` - `[Recipient!]!`
`referralBonuses` - `[ReferralBonus]`
`riskLevelOverrideUpdatedAt` - `DateTime`
`riskLevelUpdatedAt` - `DateTime`
`ruleExecutions` - `RuleExecutionConnection!`
Arguments `searchFilters` - `RuleExecutionFilter`
`rules` - `[Rule!]!`
`scheduledPayments` - `[ScheduledTransfer]`
`scheduledTransfers` - `[ScheduledTransfer]`
`signerSaveAccount` - `Account`
`signerSpendAccount` - `Account`
`status` - `FamilyStatus!`
`transfers` - `TransferConnection!`
`users` - `[User!]!`
`virtualDebitCards` - `[DebitCard]`

Example

{
  "accounts": [Account],
  "address": Address,
  "autopayAccount": Account,
  "autopayFrequency": "DISABLED",
  "beneficiary": Beneficiary,
  "cashTransactions": CashTransactionConnection,
  "children": [User],
  "comments": [UserComment],
  "deletedCashAccounts": [Account],
  "externalAccounts": [Account],
  "flags": FamilyFlags,
  "frozenReason": "FRAUD_DETECTED",
  "frozenStatus": "FREEZING",
  "groupedTransactions": [GroupedTransaction],
  "influencer": Influencer,
  "lastTransactionUpdatedAt": "2007-12-03T10:15:30Z",
  "mailingAddress": Address,
  "merchantFilterTransactions": [CashTransaction],
  "parents": [User],
  "peerRecipientAccounts": [Account],
  "permittedActions": FamilyPermittedActions,
  "promotionBonuses": [PromotionBonus],
  "reassignmentRules": [ReassignmentRule],
  "recipients": [Recipient],
  "referralBonuses": [ReferralBonus],
  "riskLevelOverrideUpdatedAt": "2007-12-03T10:15:30Z",
  "riskLevelUpdatedAt": "2007-12-03T10:15:30Z",
  "ruleExecutions": RuleExecutionConnection,
  "rules": [Rule],
  "scheduledPayments": [ScheduledTransfer],
  "scheduledTransfers": [ScheduledTransfer],
  "signerSaveAccount": Account,
  "signerSpendAccount": Account,
  "status": "ACTIVATED",
  "transfers": TransferConnection,
  "users": [User],
  "virtualDebitCards": [DebitCard]
}

Types

FamilyFlags

Example

{}

Types

FamilyFrozenReason

Values

Enum Value	Description
`FRAUD_DETECTED`

Example

"FRAUD_DETECTED"

Types

FamilyFrozenStatus

Values

Enum Value	Description
`FREEZING`
`FROZEN`
`UNFREEZING`
`UNFROZEN`

Example

"FREEZING"

Types

FamilyPermittedActions

Example

{}

Types

FamilyStatus

Values

Enum Value	Description
`ACTIVATED`
`DEACTIVATED`
`DEACTIVATING`
`FAILED`

Example

"ACTIVATED"

Types

FreezeDebitCardInput

Fields

Input Field	Description
`reason` - `CardFrozenReason!`	The reason the debit card is being frozen

Example

{"reason": "FRAUD_DETECTED"}

Types

FreezeDebitCardPayload

Fields

Field Name	Description
`result` - `DebitCard!`

Example

{"result": DebitCard}

Types

GenerateBarcodeInput

Example

{}

Types

GenerateBarcodePayload

Fields

Field Name	Description
`result` - `CashDepositBarcode!`

Example

{"result": CashDepositBarcode}

Types

GenerateSetPinTokenInput

Example

{}

Types

GenerateSetPinTokenPayload

Example

{}

Types

GenerateViewSadTokenInput

Example

{}

Types

GenerateViewSadTokenPayload

Example

{}

Types

GoogleWalletProvisionResponse

Fields

Field Name	Description
`pushTokenizeRequestData` - `GoogleWalletPushTokenizeRequestData!`

Example

{
  "pushTokenizeRequestData": GoogleWalletPushTokenizeRequestData
}

Types

GoogleWalletPushTokenizeRequestData

Fields

Field Name	Description
`userAddress` - `GoogleWalletUserAddress!`

Example

{"userAddress": GoogleWalletUserAddress}

Types

GoogleWalletUserAddress

Example

{}

Types

GroupedHistoricPayment

Fields

Field Name	Description
`date` - `Date!`

Example

{"date": "2007-12-03"}

Types

GroupedTransaction

Example

{}

Types

IdMatchCondition

Fields

Field Name	Description
`entitySchema` - `ConditionEntitySchema!`
`type` - `RuleConditionType!`

Example

{"entitySchema": "ACCOUNTS", "type": "AND"}

Types

IdMatchConditionInput

Fields

Input Field	Description
`entitySchema` - `ConditionEntitySchema!`

Example

{"entitySchema": "ACCOUNTS"}

Types

Influencer

Fields

Field Name	Description
`family` - `Family`
`permittedActions` - `InfluencerPermittedActions!`
`status` - `InfluencerStatus`

Example

{
  "family": Family,
  "permittedActions": InfluencerPermittedActions,
  "status": "ACTIVATED"
}

Types

InfluencerPermittedActions

Example

{}

Types

InfluencerStatus

Values

Enum Value	Description
`ACTIVATED`
`DEACTIVATED`

Example

"ACTIVATED"

Types

InitializeProvisionalDebitCardSyncInput

Fields

Input Field	Description
`cardColor` - `DebitCardColor`

Example

{"cardColor": "BANANA"}

Types

InitializeProvisionalDebitCardSyncPayload

Fields

Field Name	Description
`result` - `DebitCard`

Example

{"result": DebitCard}

Types

InitiateMultiTransferInput

Fields

Input Field	Description
`destinations` - `[TransferDestinationInput]`	Encoded ID of the destinations of this multi-transfer group

Example

{"destinations": [TransferDestinationInput]}

Types

InitiateMultiTransferPayload

Fields

Field Name	Description
`result` - `[Transfer]`

Example

{"result": [Transfer]}

Types

InitiateTransferInput

Fields

Input Field	Description
`type` - `TransferType`

Example

{"type": "ACH"}

Types

InitiateTransferPayload

Fields

Field Name	Description
`result` - `Transfer!`

Example

{"result": Transfer}

Types

Institution

Example

{}

Types

IntegerRange

Example

{}

Types

InterestBoost

Fields

Field Name	Description
`boostEndDate` - `Date`
`status` - `BoostStatus`

Example

{
  "boostEndDate": "2007-12-03",
  "status": "ACTIVE"
}

Types

InterestEarnedInMonth

Fields

Field Name	Description
`date` - `Date!`

Example

{"date": "2007-12-03"}

Types

InternalTransferAction

Fields

Field Name	Description
`accountFromType` - `ActionAccountType!`
`accountToType` - `ActionAccountType!`
`type` - `RuleActionType!`

Example

{
  "accountFromType": "ACCOUNT",
  "accountToType": "ACCOUNT",
  "type": "INTERNAL_TRANSFER"
}

Types

InternalTransferActionInput

Fields

Input Field	Description
`accountFromType` - `ActionAccountType`
`accountToType` - `ActionAccountType`

Example

{"accountFromType": "ACCOUNT", "accountToType": "ACCOUNT"}

Types

LogoutPayload

Fields

Field Name	Description
`result` - `User!`

Example

{"result": User}

Types

ManualActivateCashAccountInput

Example

{}

Types

ManualActivateCashAccountPayload

Fields

Field Name	Description
`result` - `Account!`

Example

{"result": Account}

Types

ManualAddExternalAccountInput

Fields

Input Field	Description
`type` - `ExternalManualAccountType!`

Example

{"type": "EXTERNAL_SAVE"}

Types

ManualAddExternalAccountPayload

Fields

Field Name	Description
`result` - `Account!`

Example

{"result": Account}

Types

ManuallyTriggerRuleInput

Example

{}

Types

ManuallyTriggerRulePayload

Fields

Field Name	Description
`result` - `Rule!`

Example

{"result": Rule}

Types

MarkRuleBrokenInput

Fields

Input Field	Description
`brokenReason` - `RuleBrokenReason`

Example

{"brokenReason": "CIRCULAR_LOGIC"}

Types

MarkRuleBrokenPayload

Fields

Field Name	Description
`result` - `Rule!`

Example

{"result": Rule}

Types

MerchantAmountInMonth

Example

{}

Types

MerchantFrequencyInMonth

Example

{}

Types

MoneyInByCategoryInMonth

Example

{}

Types

MonthCadence

Values

Enum Value	Description
`ONCE`
`TWICE`

Example

"ONCE"

Types

MuteDebitCardNotificationsInput

Example

{}

Types

MuteDebitCardNotificationsPayload

Fields

Field Name	Description
`result` - `DebitCard!`

Example

{"result": DebitCard}

Types

NumericAttributeCondition

Fields

Field Name	Description
`attribute` - `ConditionAttribute!`
`comparisonOp` - `NumericComparisonOp!`
`entitySchema` - `ConditionEntitySchema!`
`type` - `RuleConditionType!`

Example

{
  "attribute": "AMOUNT",
  "comparisonOp": "EQ",
  "entitySchema": "ACCOUNTS",
  "type": "AND"
}

Types

NumericAttributeConditionInput

Fields

Input Field	Description
`attribute` - `ConditionAttribute!`
`comparisonOp` - `NumericComparisonOp!`
`entitySchema` - `ConditionEntitySchema!`

Example

{"attribute": "AMOUNT", "comparisonOp": "EQ", "entitySchema": "ACCOUNTS"}

Types

NumericComparisonOp

Values

Enum Value	Description
`EQ`
`GT`
`GTE`
`LT`
`LTE`

Example

"EQ"

Types

OrCondition

Fields

Field Name	Description
`conditions` - `[RuleCondition!]!`
`type` - `RuleConditionType!`

Example

{"conditions": [RuleCondition], "type": "AND"}

Types

OrConditionInput

Fields

Input Field	Description
`conditions` - `[RuleConditionInput!]`

Example

{"conditions": [RuleConditionInput]}

Types

OrderedSubaccount

Example

{}

Types

OverrideDigitalWalletTokenStatusInput

Fields

Input Field	Description
`status` - `DigitalWalletTokenStatusOverride!`

Example

{"status": "ACTIVE"}

Types

OverrideDigitalWalletTokenStatusPayload

Fields

Field Name	Description
`result` - `DigitalWalletToken!`

Example

{"result": DigitalWalletToken}

Types

PageInfo

Example

{}

Types

PaymentAccountType

Values

Enum Value	Description
`CHECKING`
`SAVINGS`

Example

"CHECKING"

Types

PaymentType

Values

Enum Value	Description
`ACH`
`CHECK`
`WIRE`

Example

"ACH"

Types

PennyChat

Fields

Field Name	Description
`insertedAt` - `DateTime!`

Example

{"insertedAt": "2007-12-03T10:15:30Z"}

Types

PennyThread

Fields

Field Name	Description
`insertedAt` - `DateTime!`
`messages` - `[PennyChat!]!`

Example

{
  "insertedAt": "2007-12-03T10:15:30Z",
  "messages": [PennyChat]
}

Types

PennyThreadConnection

Fields

Field Name	Description
`edges` - `[PennyThreadEdge!]!`
`pageInfo` - `PageInfo!`

Example

{
  "edges": [PennyThreadEdge],
  "pageInfo": PageInfo
}

Types

PennyThreadEdge

Fields

Field Name	Description
`node` - `PennyThread!`

Example

{"node": PennyThread}

Types

PostSpendPocketAssignments

Values

Enum Value	Description
`KEEP_SAME`
`MAIN_CHECKING`
`UNASSIGN`

Example

"KEEP_SAME"

Types

PromotionBonus

Fields

Field Name	Description
`endDate` - `Date`
`family` - `Family!`
`startDate` - `Date`
`transfers` - `[Transfer!]!`
`user` - `User!`

Example

{
  "endDate": "2007-12-03",
  "family": Family,
  "startDate": "2007-12-03",
  "transfers": [Transfer],
  "user": User
}

Types

Prompt

Fields

Field Name	Description
`permittedActions` - `PromptPermittedActions!`
`target` - `PromptTarget`
`urgency` - `PromptUrgency`

Example

{
  "permittedActions": PromptPermittedActions,
  "target": PromptTarget,
  "urgency": "DEFAULT"
}

Types

PromptActionKey

Values

Enum Value	Description
`CARD_CANCELLED_MUTE`
`CARD_CANCELLED_SUPPORT`
`CARD_DECLINED_SUPPORT`
`CARD_EXCEEDED_DAILY_LIMIT_SUPPORT`
`CARD_EXCEEDED_MONTHLY_LIMIT_SUPPORT`
`DECLINE_ADD_MONEY`
`DIGITAL_WALLET_SUPPORT`
`EXTERNAL_LINK`
`FUND_ACCOUNT`
`RESEND_PARTNER_INVITE`
`UNFREEZE_CARD`
`VIEW_TAX_DOCUMENT`

Example

"CARD_CANCELLED_MUTE"

Types

PromptActionTarget

Description

A prompt that performs an action, like unfreezing a card. The target_id is the id of the object to act on.

Fields

Field Name	Description
`actionKey` - `PromptActionKey!`

Example

{"actionKey": "CARD_CANCELLED_MUTE"}

Types

PromptPermittedActions

Example

{}

Types

PromptScreenTarget

Description

A prompt that navigates the user to the specified screen. The target_id is the id of the object to navigate to.

Example

{}

Types

PromptTarget

Description

There are two types of prompt targets: screen and action. Screens navigate the user and actions perform an action.

Possible Types

PromptTarget Types
`PromptActionTarget`
`PromptScreenTarget`

Example

{}

Types

PromptUrgency

Values

Enum Value	Description
`DEFAULT`
`URGENT`

Example

"DEFAULT"

Types

ProvisioningDeviceType

Values

Enum Value	Description
`MOBILE_PHONE`
`TABLET`
`WATCH`

Example

"MOBILE_PHONE"

Types

ReassignCashTransactionInput

Example

{}

Types

ReassignCashTransactionPayload

Fields

Field Name	Description
`result` - `CashTransaction!`

Example

{"result": CashTransaction}

Types

ReassignTransferInput

Example

{}

Types

ReassignTransferPayload

Fields

Field Name	Description
`result` - `Transfer!`

Example

{"result": Transfer}

Types

ReassignmentRule

Fields

Field Name	Description
`account` - `Account!`
`assignmentSubaccount` - `Subaccount`
`debitCard` - `DebitCard`
`insertedAt` - `DateTime!`
`transactionType` - `ReassignmentRuleTransactionType`

Example

{
  "account": Account,
  "assignmentSubaccount": Subaccount,
  "debitCard": DebitCard,
  "insertedAt": "2007-12-03T10:15:30Z",
  "transactionType": "ACH"
}

Types

ReassignmentRuleTransactionType

Values

Enum Value	Description
`ACH`
`CARD`

Example

"ACH"

Types

Recipient

Fields

Field Name	Description
`achAccount` - `Account`
`address` - `Address`
`lastPaymentDate` - `Date`
`lastPaymentType` - `PaymentType`
`scheduledTransfers` - `[ScheduledTransfer]`
`status` - `RecipientStatus!`
`wireAccount` - `Account`

Possible Types

Recipient Types
`RecipientBusiness`
`RecipientPerson`

Example

{
  "achAccount": Account,
  "address": Address,
  "lastPaymentDate": "2007-12-03",
  "lastPaymentType": "ACH",
  "scheduledTransfers": [ScheduledTransfer],
  "status": "ACTIVATED",
  "wireAccount": Account
}

Types

RecipientBusiness

Fields

Field Name	Description
`achAccount` - `Account`
`address` - `Address`
`lastPaymentDate` - `Date`
`lastPaymentType` - `PaymentType`
`scheduledTransfers` - `[ScheduledTransfer]`
`status` - `RecipientStatus!`
`wireAccount` - `Account`

Example

{
  "achAccount": Account,
  "address": Address,
  "lastPaymentDate": "2007-12-03",
  "lastPaymentType": "ACH",
  "scheduledTransfers": [ScheduledTransfer],
  "status": "ACTIVATED",
  "wireAccount": Account
}

Types

RecipientPerson

Fields

Field Name	Description
`achAccount` - `Account`
`address` - `Address`
`lastPaymentDate` - `Date`
`lastPaymentType` - `PaymentType`
`scheduledTransfers` - `[ScheduledTransfer]`
`status` - `RecipientStatus!`
`wireAccount` - `Account`

Example

{
  "achAccount": Account,
  "address": Address,
  "lastPaymentDate": "2007-12-03",
  "lastPaymentType": "ACH",
  "scheduledTransfers": [ScheduledTransfer],
  "status": "ACTIVATED",
  "wireAccount": Account
}

Types

RecipientStatus

Values

Enum Value	Description
`ACTIVATED`
`DEACTIVATED`

Example

"ACTIVATED"

Types

RecipientType

Values

Enum Value	Description
`BUSINESS`
`PERSON`

Example

"BUSINESS"

Types

Referral

Fields

Field Name	Description
`referralCode` - `ReferralCode`
`referredOn` - `Date!`

Example

{
  "referralCode": ReferralCode,
  "referredOn": "2007-12-03"
}

Types

ReferralBonus

Fields

Field Name	Description
`endDate` - `Date`
`family` - `Family!`
`referral` - `Referral!`
`startDate` - `Date`
`transfers` - `[Transfer!]!`
`user` - `User!`

Example

{
  "endDate": "2007-12-03",
  "family": Family,
  "referral": Referral,
  "startDate": "2007-12-03",
  "transfers": [Transfer],
  "user": User
}

Types

ReferralBonusConnection

Fields

Field Name	Description
`edges` - `[ReferralBonusEdge!]!`
`pageInfo` - `PageInfo!`

Example

{
  "edges": [ReferralBonusEdge],
  "pageInfo": PageInfo
}

Types

ReferralBonusEdge

Fields

Field Name	Description
`node` - `ReferralBonus!`

Example

{"node": ReferralBonus}

Types

ReferralCode

Fields

Field Name	Description
`insertedAt` - `DateTime!`
`permittedActions` - `ReferralCodePermittedActions!`
`referrals` - `[Referral!]!`
`source` - `ReferralCodeSource!`
`updatedAt` - `DateTime!`
`user` - `User!`

Example

{
  "insertedAt": "2007-12-03T10:15:30Z",
  "permittedActions": ReferralCodePermittedActions,
  "referrals": [Referral],
  "source": "BILLBOARD",
  "updatedAt": "2007-12-03T10:15:30Z",
  "user": User
}

Types

ReferralCodePermittedActions

Example

{}

Types

ReferralCodeSource

Values

Enum Value	Description
`BILLBOARD`
`FRIEND`
`INFLUENCER`
`INTERNET_SEARCH`
`MOVIE_THEATER`
`OTHER`
`SOCIAL_MEDIA`

Example

"BILLBOARD"

Types

RefreshAccountBalanceInput

Example

{}

Types

RefreshAccountBalancePayload

Example

{}

Types

RemoveTargetBalanceInput

Example

{}

Types

RemoveTargetBalancePayload

Fields

Field Name	Description
`result` - `TargetBalanceSetting!`

Example

{"result": TargetBalanceSetting}

Types

ResendChildInviteInput

Example

{}

Types

ResendChildInvitePayload

Fields

Field Name	Description
`result` - `User!`

Example

{"result": User}

Types

ResendPartnerInviteInput

Example

{}

Types

ResendPartnerInvitePayload

Fields

Field Name	Description
`result` - `User!`

Example

{"result": User}

Types

RoundUpTransferAction

Fields

Field Name	Description
`accountType` - `ActionAccountType!`
`type` - `RuleActionType!`

Example

{"accountType": "ACCOUNT", "type": "INTERNAL_TRANSFER"}

Types

RoundUpTransferActionInput

Fields

Input Field	Description
`accountType` - `ActionAccountType`

Example

{"accountType": "ACCOUNT"}

Types

Rule

Fields

Field Name	Description
`brokenReason` - `RuleBrokenReason`
`formula` - `RuleFormula!`
`lastCompletedAt` - `DateTime`
`latestExecution` - `RuleExecution`
`runNowTransactions` - `CashTransactionConnection`
Arguments `searchFilters` - `CashTransactionFilter`

Example

{
  "brokenReason": "CIRCULAR_LOGIC",
  "formula": RuleFormula,
  "lastCompletedAt": "2007-12-03T10:15:30Z",
  "latestExecution": RuleExecution,
  "runNowTransactions": CashTransactionConnection
}

Types

RuleAction

Fields

Field Name	Description
`type` - `RuleActionType!`

Possible Types

RuleAction Types
`InternalTransferAction`
`RoundUpTransferAction`
`SendNotificationAction`
`SendWebhookAction`
`SplitDepositAction`
`SplitDepositByAmountAction`
`TargetBalanceTransferAction`

Example

{"type": "INTERNAL_TRANSFER"}

Types

RuleActionInput

Fields

Input Field	Description
`internalTransfer` - `InternalTransferActionInput`
`roundUpTransfer` - `RoundUpTransferActionInput`
`sendNotification` - `SendNotificationActionInput`
`sendWebhook` - `SendWebhookActionInput`
`splitDeposit` - `SplitDepositActionInput`
`splitDepositByAmount` - `SplitDepositByAmountActionInput`
`targetBalanceTransfer` - `TargetBalanceTransferActionInput`

Example

{
  "internalTransfer": InternalTransferActionInput,
  "roundUpTransfer": RoundUpTransferActionInput,
  "sendNotification": SendNotificationActionInput,
  "sendWebhook": SendWebhookActionInput,
  "splitDeposit": SplitDepositActionInput,
  "splitDepositByAmount": SplitDepositByAmountActionInput,
  "targetBalanceTransfer": TargetBalanceTransferActionInput
}

Types

RuleActionType

Values

Enum Value	Description
`INTERNAL_TRANSFER`
`ROUND_UP_TRANSFER`
`SEND_NOTIFICATION`
`SEND_WEBHOOK`
`SPLIT_DEPOSIT`
`SPLIT_DEPOSIT_BY_AMOUNT`
`TARGET_BALANCE_TRANSFER`

Example

"INTERNAL_TRANSFER"

Types

RuleBrokenReason

Values

Enum Value	Description
`CIRCULAR_LOGIC`
`MISSING_REFERENCE`
`UNKNOWN`

Example

"CIRCULAR_LOGIC"

Types

RuleCondition

Fields

Field Name	Description
`type` - `RuleConditionType!`

Possible Types

RuleCondition Types
`AndCondition`
`DayOfMonthCondition`
`DayOfWeekCondition`
`IdMatchCondition`
`NumericAttributeCondition`
`OrCondition`
`StringAttributeCondition`

Example

{"type": "AND"}

Types

RuleConditionInput

Fields

Input Field	Description
`and` - `AndConditionInput`
`dayOfMonth` - `DayOfMonthConditionInput`
`dayOfWeek` - `DayOfWeekConditionInput`
`idMatch` - `IdMatchConditionInput`
`numericAttribute` - `NumericAttributeConditionInput`
`or` - `OrConditionInput`
`stringAttribute` - `StringAttributeConditionInput`

Example

{
  "and": AndConditionInput,
  "dayOfMonth": DayOfMonthConditionInput,
  "dayOfWeek": DayOfWeekConditionInput,
  "idMatch": IdMatchConditionInput,
  "numericAttribute": NumericAttributeConditionInput,
  "or": OrConditionInput,
  "stringAttribute": StringAttributeConditionInput
}

Types

RuleConditionType

Values

Enum Value	Description
`AND`
`DAY_OF_MONTH`
`DAY_OF_WEEK`
`ID_MATCH`
`NUMERIC_ATTRIBUTE`
`OR`
`STRING_ATTRIBUTE`

Example

"AND"

Types

RuleExecution

Fields

Field Name	Description
`completedAt` - `DateTime`
`failureReason` - `RuleExecutionFailureReason`
`insertedAt` - `DateTime`
`rule` - `Rule!`
`status` - `RuleExecutionStatus!`

Example

{
  "completedAt": "2007-12-03T10:15:30Z",
  "failureReason": "CIRCULAR_LOGIC",
  "insertedAt": "2007-12-03T10:15:30Z",
  "rule": Rule,
  "status": "COMPLETED"
}

Types

RuleExecutionConnection

Fields

Field Name	Description
`edges` - `[RuleExecutionEdge!]!`
`pageInfo` - `PageInfo!`

Example

{
  "edges": [RuleExecutionEdge],
  "pageInfo": PageInfo
}

Types

RuleExecutionEdge

Fields

Field Name	Description
`node` - `RuleExecution!`

Example

{"node": RuleExecution}

Types

RuleExecutionFailureReason

Values

Enum Value	Description
`CIRCULAR_LOGIC`
`INSUFFICIENT_FUNDS`
`MISSING_REFERENCE`
`UNKNOWN`

Example

"CIRCULAR_LOGIC"

Types

RuleExecutionFilter

Fields

Input Field	Description
`status` - `[RuleExecutionStatus!]`

Example

{"status": ["COMPLETED"]}

Types

RuleExecutionStatus

Values

Enum Value	Description
`COMPLETED`
`CREATED`
`EXECUTING`
`FAILED`
`SKIPPED`

Example

"COMPLETED"

Types

RuleFormula

Fields

Field Name	Description
`actions` - `[RuleAction!]!`
`conditions` - `RuleCondition`
`triggers` - `[RuleTriggerType!]!`

Example

{
  "actions": [RuleAction],
  "conditions": RuleCondition,
  "triggers": ["ACCOUNT_BALANCE_UPDATED"]
}

Types

RuleFormulaInput

Fields

Input Field	Description
`actions` - `[RuleActionInput!]!`
`conditions` - `RuleConditionInput`
`triggers` - `[RuleTriggerType!]!`

Example

{
  "actions": [RuleActionInput],
  "conditions": RuleConditionInput,
  "triggers": ["ACCOUNT_BALANCE_UPDATED"]
}

Types

RuleTriggerType

Values

Enum Value	Description
`ACCOUNT_BALANCE_UPDATED`
`ACCOUNT_DEPOSIT_RECEIVED`
`CASH_TRANSACTION_OCCURRED`
`DATE`
`DEBIT_CARD_TRANSACTION`
`MANUAL`

Example

"ACCOUNT_BALANCE_UPDATED"

Types

RunRuleNowInput

Example

{}

Types

RunRuleNowPayload

Fields

Field Name	Description
`result` - `RuleExecution!`

Example

{"result": RuleExecution}

Types

SaveQuilttAccountInput

Example

{}

Types

SaveQuilttAccountPayload

Fields

Field Name	Description
`result` - `[Account!]!`

Example

{"result": [Account]}

Types

ScheduledTransfer

Fields

Field Name	Description
`accountFrom` - `Account`
`dayOfWeek` - `DayOfWeek`
`destinations` - `[ScheduledTransferDestination]`
`frequency` - `ScheduledTransferFrequency!`
`monthCadence` - `MonthCadence`
`nextTransferDate` - `Date`
`scheduledDate` - `Date`
`status` - `ScheduledTransferStatus!`
`subaccountFrom` - `Subaccount`
`transfers` - `[Transfer]`
`type` - `ScheduledTransferType!`
`weekCadence` - `WeekCadence`

Example

{
  "accountFrom": Account,
  "dayOfWeek": "FRIDAY",
  "destinations": [ScheduledTransferDestination],
  "frequency": "MONTHLY",
  "monthCadence": "ONCE",
  "nextTransferDate": "2007-12-03",
  "scheduledDate": "2007-12-03",
  "status": "CANCELED",
  "subaccountFrom": Subaccount,
  "transfers": [Transfer],
  "type": "ACH",
  "weekCadence": "EVEN"
}

Types

ScheduledTransferDestination

Fields

Field Name	Description
`account` - `Account`
`subaccount` - `Subaccount`

Example

{
  "account": Account,
  "subaccount": Subaccount
}

Types

ScheduledTransferDestinationInput

Example

{}

Types

ScheduledTransferFrequency

Values

Enum Value	Description
`MONTHLY`
`ONE_TIME`
`WEEKLY`

Example

"MONTHLY"

Types

ScheduledTransferStatus

Values

Enum Value	Description
`CANCELED`
`COMPLETED`
`PAUSED`
`SCHEDULED`

Example

"CANCELED"

Types

ScheduledTransferType

Values

Enum Value	Description
`ACH`
`ALLOWANCE`
`CHECK`
`WIRE`

Example

"ACH"

Types

SendNotificationAction

Fields

Field Name	Description
`method` - `SendNotificationMethod!`
`type` - `RuleActionType!`

Example

{"method": "EMAIL", "type": "INTERNAL_TRANSFER"}

Types

SendNotificationActionInput

Fields

Input Field	Description
`method` - `SendNotificationMethod!`

Example

{"method": "EMAIL"}

Types

SendNotificationMethod

Values

Enum Value	Description
`EMAIL`
`PUSH`
`SMS`

Example

"EMAIL"

Types

SendWebhookAction

Fields

Field Name	Description
`type` - `RuleActionType!`

Example

{"type": "INTERNAL_TRANSFER"}

Types

SendWebhookActionInput

Example

{}

Types

SetAllowOverspendingInput

Example

{}

Types

SetAllowOverspendingPayload

Fields

Field Name	Description
`result` - `User!`

Example

{"result": User}

Types

SetPostSpendPocketAssignmentInput

Fields

Input Field	Description
`postSpendPocketAssignment` - `PostSpendPocketAssignments`	What should happen to the user's spend setting after a card transaction is received

Example

{"postSpendPocketAssignment": "KEEP_SAME"}

Types

SetPostSpendPocketAssignmentPayload

Fields

Field Name	Description
`result` - `User!`

Example

{"result": User}

Types

SetSpendSubaccountInput

Example

{}

Types

SetSpendSubaccountPayload

Fields

Field Name	Description
`result` - `User!`

Example

{"result": User}

Types

SetSubaccountOrderingInput

Fields

Input Field	Description
`orderedSubaccounts` - `[OrderedSubaccount!]!`

Example

{"orderedSubaccounts": [OrderedSubaccount]}

Types

SetSubaccountOrderingPayload

Fields

Field Name	Description
`result` - `[Subaccount!]!`

Example

{"result": [Subaccount]}

Types

SetSubaccountVisibilityInput

Example

{}

Types

SetSubaccountVisibilityPayload

Fields

Field Name	Description
`result` - `Subaccount!`

Example

{"result": Subaccount}

Types

SetTargetBalanceInput

Fields

Input Field	Description
`direction` - `TargetBalanceSettingDirection`

Example

{"direction": "BOTH"}

Types

SetTargetBalancePayload

Fields

Field Name	Description
`result` - `TargetBalanceSetting!`

Example

{"result": TargetBalanceSetting}

Types

SkipBillPaymentInput

Example

{}

Types

SkipBillPaymentPayload

Fields

Field Name	Description
`result` - `BillPayment!`

Example

{"result": BillPayment}

Types

SplitCashTransactionInput

Fields

Input Field	Description
`splits` - `[CashTransactionSplitInput]`

Example

{"splits": [CashTransactionSplitInput]}

Types

SplitCashTransactionPayload

Fields

Field Name	Description
`result` - `CashTransaction!`

Example

{"result": CashTransaction}

Types

SplitDepositAction

Fields

Field Name	Description
`destinations` - `[SplitDepositDestination!]!`
`type` - `RuleActionType!`

Example

{
  "destinations": [SplitDepositDestination],
  "type": "INTERNAL_TRANSFER"
}

Types

SplitDepositActionInput

Fields

Input Field	Description
`destinations` - `[SplitDepositDestinationInput!]!`

Example

{"destinations": [SplitDepositDestinationInput]}

Types

SplitDepositByAmountAction

Fields

Field Name	Description
`destinations` - `[SplitDepositByAmountDestination!]!`
`surplusAccountType` - `SurplusAccountType!`
`type` - `RuleActionType!`

Example

{
  "destinations": [SplitDepositByAmountDestination],
  "surplusAccountType": "ACCOUNT",
  "type": "INTERNAL_TRANSFER"
}

Types

SplitDepositByAmountActionInput

Fields

Input Field	Description
`destinations` - `[SplitDepositByAmountDestinationInput!]!`
`surplusAccountType` - `SurplusAccountType!`

Example

{
  "destinations": [SplitDepositByAmountDestinationInput],
  "surplusAccountType": "ACCOUNT"
}

Types

SplitDepositByAmountDestination

Fields

Field Name	Description
`type` - `SplitDestinationByAmountType!`

Example

{"type": "ACCOUNT"}

Types

SplitDepositByAmountDestinationInput

Fields

Input Field	Description
`type` - `SplitDestinationByAmountType!`

Example

{"type": "ACCOUNT"}

Types

SplitDepositDestination

Fields

Field Name	Description
`type` - `SplitDestinationType!`

Example

{"type": "ACCOUNT"}

Types

SplitDepositDestinationInput

Fields

Input Field	Description
`type` - `SplitDestinationType!`

Example

{"type": "ACCOUNT"}

Types

SplitDestinationByAmountType

Values

Enum Value	Description
`ACCOUNT`
`SUBACCOUNT`

Example

"ACCOUNT"

Types

SplitDestinationType

Values

Enum Value	Description
`ACCOUNT`
`SUBACCOUNT`

Example

"ACCOUNT"

Types

Statement

Fields

Field Name	Description
`account` - `Account`
`family` - `Family`
`permittedActions` - `StatementPermittedActions!`
`type` - `StatementType!`

Example

{
  "account": Account,
  "family": Family,
  "permittedActions": StatementPermittedActions,
  "type": "MONTHLY"
}

Types

StatementPermittedActions

Example

{}

Types

StatementType

Values

Enum Value	Description
`MONTHLY`
`YEARLY`

Example

"MONTHLY"

Types

StringAttributeCondition

Fields

Field Name	Description
`attribute` - `ConditionAttribute!`
`comparisonOp` - `StringComparisonOp!`
`entitySchema` - `ConditionEntitySchema!`
`type` - `RuleConditionType!`

Example

{
  "attribute": "AMOUNT",
  "comparisonOp": "CONTAINS",
  "entitySchema": "ACCOUNTS",
  "type": "AND"
}

Types

StringAttributeConditionInput

Fields

Input Field	Description
`attribute` - `ConditionAttribute!`
`comparisonOp` - `StringComparisonOp!`
`entitySchema` - `ConditionEntitySchema!`

Example

{"attribute": "AMOUNT", "comparisonOp": "CONTAINS", "entitySchema": "ACCOUNTS"}

Types

StringComparisonOp

Values

Enum Value	Description
`CONTAINS`
`EQUALS`

Example

"CONTAINS"

Types

StringFilter

Example

{}

Types

Subaccount

Description

Represents a portion of an account set aside for a specific purpose.

Fields

Field Name	Description
`account` - `Account!`
`accountOwners` - `[User!]!`
`balanceOverTime` - `BalanceOverTime!`	Use simple_balance_over_time instead.
Arguments `endDate` - `Date` `frequency` - `BalanceFrequency` `startDate` - `Date`
`cashTransactions` - `CashTransactionConnection!`
Arguments `searchFilters` - `CashTransactionFilter`
`family` - `Family!`
`icon` - `AccountIcon`
`owner` - `AccountOwnerDisplay!`
`pendingCheckDeposits` - `[CheckDeposit!]!`
`pendingTransfers` - `[Transfer!]!`	No longer used - all transfers immediately get a transaction now.
`permittedActions` - `SubaccountPermittedActions!`
`primaryOwner` - `User`	The user who owns the parent account of this subaccount in the context of Crew. Not to be confused with the legal `owners` of the account.
`simpleBalanceOverTime` - `[BalanceOnDate!]!`
`status` - `SubaccountStatus`
`subaccountType` - `SubaccountType!`
`type` - `AccountType!`
`userAccounts` - `[UserAccount!]!`	Use primary_owner instead.

Example

{
  "account": Account,
  "accountOwners": [User],
  "balanceOverTime": BalanceOverTime,
  "cashTransactions": CashTransactionConnection,
  "family": Family,
  "icon": "BANK",
  "owner": AccountOwnerDisplay,
  "pendingCheckDeposits": [CheckDeposit],
  "pendingTransfers": [Transfer],
  "permittedActions": SubaccountPermittedActions,
  "primaryOwner": User,
  "simpleBalanceOverTime": [BalanceOnDate],
  "status": "ACTIVATED",
  "subaccountType": "BILL",
  "type": "ACH_CHECKING_RECIPIENT",
  "userAccounts": [UserAccount]
}

Types

SubaccountPermittedActions

Example

{}

Types

SubaccountStatus

Values

Enum Value	Description
`ACTIVATED`
`DEACTIVATED`

Example

"ACTIVATED"

Types

SubaccountType

Values

Enum Value	Description
`BILL`
`BILL_RESERVE`
`SAVINGS`
`SPENDING`

Example

"BILL"

Types

SubmitDebitCardOrdersInput

Example

{}

Types

SubmitDebitCardOrdersPayload

Fields

Field Name	Description
`result` - `[DebitCardOrder!]!`

Example

{"result": [DebitCardOrder]}

Types

SubmitUserApplicationInput

Example

{}

Types

SubmitUserApplicationPayload

Fields

Field Name	Description
`result` - `UserApplication!`

Example

{"result": UserApplication}

Types

SurplusAccountType

Values

Enum Value	Description
`ACCOUNT`
`SUBACCOUNT`

Example

"ACCOUNT"

Types

TargetBalanceSetting

Fields

Field Name	Description
`balancedAccount` - `Account!`
`direction` - `TargetBalanceSettingDirection!`
`family` - `Family!`
`overflowAccount` - `Account!`

Example

{
  "balancedAccount": Account,
  "direction": "BOTH",
  "family": Family,
  "overflowAccount": Account
}

Types

TargetBalanceSettingDirection

Values

Enum Value	Description
`BOTH`
`FROM_OVERFLOW`
`TO_OVERFLOW`

Example

"BOTH"

Types

TargetBalanceTransferAction

Fields

Field Name	Description
`accountType` - `ActionAccountType!`
`direction` - `TargetTransferDirection!`
`type` - `RuleActionType!`

Example

{"accountType": "ACCOUNT", "direction": "FROM", "type": "INTERNAL_TRANSFER"}

Types

TargetBalanceTransferActionInput

Fields

Input Field	Description
`accountType` - `ActionAccountType`
`direction` - `TargetTransferDirection!`

Example

{"accountType": "ACCOUNT", "direction": "FROM"}

Types

TargetTransferDirection

Values

Enum Value	Description
`FROM`
`TO`

Example

"FROM"

Types

Transfer

Description

A representation of moving money between two accounts

Fields

Field Name	Description
`accountFrom` - `Account`
`accountTo` - `Account!`
`family` - `Family!`
`occurredAt` - `DateTime!`
`permittedActions` - `TransferPermittedActions!`
`scheduledSettlement` - `DateTime`
`scheduledTransfer` - `ScheduledTransfer`
`status` - `TransferStatus!`
`subaccountFrom` - `Subaccount`
`subaccountTo` - `Subaccount`
`type` - `TransferType!`
`user` - `User!`

Example

{
  "accountFrom": Account,
  "accountTo": Account,
  "family": Family,
  "occurredAt": "2007-12-03T10:15:30Z",
  "permittedActions": TransferPermittedActions,
  "scheduledSettlement": "2007-12-03T10:15:30Z",
  "scheduledTransfer": ScheduledTransfer,
  "status": "CANCELED",
  "subaccountFrom": Subaccount,
  "subaccountTo": Subaccount,
  "type": "ACH",
  "user": User
}

Types

TransferConnection

Fields

Field Name	Description
`edges` - `[TransferEdge!]!`
`pageInfo` - `PageInfo!`

Example

{
  "edges": [TransferEdge],
  "pageInfo": PageInfo
}

Types

TransferDestinationInput

Example

{}

Types

TransferEdge

Fields

Field Name	Description
`node` - `Transfer!`

Example

{"node": Transfer}

Types

TransferFilter

Fields

Input Field	Description
`status` - `[TransferStatus!]`

Example

{"status": ["CANCELED"]}

Types

TransferPermittedActions

Example

{}

Types

TransferStatus

Values

Enum Value	Description
`CANCELED`
`CANCELING`
`COMPLETED`
`DECISION_ACCEPTED`
`DECISION_MANUAL_REVIEW`
`DECISION_PENDING`
`DECISION_REJECTED`
`DECISION_RETRYING`
`ERROR`
`FAILED`
`PENDING`
`PROCESSING`
`REQUESTED`
`RETURNED`
`SENT`
`USER_REQUESTED`

Example

"CANCELED"

Types

TransferType

Values

Enum Value	Description
`ACH`
`ADJUSTMENT`
`ALLOWANCE`
`BILL_SUBACCOUNT`
`BONUS`
`BOOK`
`CASH_DEPOSIT`
`CHECK`
`FEE`
`FEE_REIMBURSEMENT`
`INTEREST`
`PEER_TO_PEER`
`REFERRAL_BONUS`
`REWARD`
`SUBACCOUNT`
`SUBSCRIPTION_FEE`
`TARGET`
`UNDO`
`WIRE`

Example

"ACH"

Types

UnassignTransactionFromBillInput

Example

{}

Types

UnassignTransactionFromBillPayload

Fields

Field Name	Description
`result` - `CashTransaction!`

Example

{"result": CashTransaction}

Types

UndeleteBillInput

Example

{}

Types

UndeleteBillPayload

Fields

Field Name	Description
`result` - `Bill!`

Example

{"result": Bill}

Types

UndoCashTransactionInput

Example

{}

Types

UndoCashTransactionPayload

Example

{}

Types

UnfreezeDebitCardInput

Example

{}

Types

UnfreezeDebitCardPayload

Fields

Field Name	Description
`result` - `DebitCard!`

Example

{"result": DebitCard}

Types

UnsetSpendSubaccountInput

Example

{}

Types

UnsetSpendSubaccountPayload

Fields

Field Name	Description
`result` - `User!`

Example

{"result": User}

Types

UnsplitCashTransactionInput

Example

{}

Types

UnsplitCashTransactionPayload

Fields

Field Name	Description
`result` - `CashTransaction!`

Example

{"result": CashTransaction}

Types

UpdateAccountInput

Example

{}

Types

UpdateAccountPayload

Fields

Field Name	Description
`result` - `Account!`

Example

{"result": Account}

Types

UpdateAutopaySettingsInput

Fields

Input Field	Description
`frequency` - `AutopayFrequency!`

Example

{"frequency": "DISABLED"}

Types

UpdateAutopaySettingsPayload

Fields

Field Name	Description
`result` - `Family!`

Example

{"result": Family}

Types

UpdateBarcodeSubaccountInput

Example

{}

Types

UpdateBarcodeSubaccountPayload

Fields

Field Name	Description
`result` - `CashDepositBarcode!`

Example

{"result": CashDepositBarcode}

Types

UpdateBillInput

Fields

Input Field	Description
`anchorDate` - `Date`
`frequency` - `BillFrequency`
`reassignmentRule` - `BillReassignmentRuleInput`

Example

{
  "anchorDate": "2007-12-03",
  "frequency": "MONTHLY",
  "reassignmentRule": BillReassignmentRuleInput
}

Types

UpdateBillPayload

Fields

Field Name	Description
`result` - `Bill!`

Example

{"result": Bill}

Types

UpdateBillReserveSettingsInput

Fields

Input Field	Description
`anchorDate` - `Date`
`frequency` - `BillReserveFundingFrequency`

Example

{
  "anchorDate": "2007-12-03",
  "frequency": "BIMONTHLY"
}

Types

UpdateBillReserveSettingsPayload

Fields

Field Name	Description
`result` - `BillReserve!`

Example

{"result": BillReserve}

Types

UpdateCashTransactionInput

Example

{}

Types

UpdateCashTransactionPayload

Fields

Field Name	Description
`result` - `CashTransaction!`

Example

{"result": CashTransaction}

Types

UpdatePaymentInput

Fields

Input Field	Description
`dayOfWeek` - `DayOfWeek`
`frequency` - `ScheduledTransferFrequency`
`monthCadence` - `MonthCadence`
`scheduledDate` - `Date`
`weekCadence` - `WeekCadence`

Example

{
  "dayOfWeek": "FRIDAY",
  "frequency": "MONTHLY",
  "monthCadence": "ONCE",
  "scheduledDate": "2007-12-03",
  "weekCadence": "EVEN"
}

Types

UpdatePaymentPayload

Fields

Field Name	Description
`result` - `ScheduledTransfer!`

Example

{"result": ScheduledTransfer}

Types

UpdateReassignmentRuleInput

Fields

Input Field	Description
`transactionType` - `ReassignmentRuleTransactionType`

Example

{"transactionType": "ACH"}

Types

UpdateReassignmentRulePayload

Fields

Field Name	Description
`result` - `ReassignmentRule!`

Example

{"result": ReassignmentRule}

Types

UpdateRecipientInput

Fields

Input Field	Description
`address` - `AddressInput`
`type` - `RecipientType`

Example

{"address": AddressInput, "type": "BUSINESS"}

Types

UpdateRecipientPayload

Fields

Field Name	Description
`result` - `Recipient!`

Example

{"result": Recipient}

Types

UpdateRuleInput

Fields

Input Field	Description
`formula` - `RuleFormulaInput`

Example

{"formula": RuleFormulaInput}

Types

UpdateRulePayload

Fields

Field Name	Description
`result` - `Rule!`

Example

{"result": Rule}

Types

UpdateSubaccountInput

Fields

Input Field	Description
`type` - `SubaccountType`

Example

{"type": "BILL"}

Types

UpdateSubaccountPayload

Fields

Field Name	Description
`result` - `Subaccount!`

Example

{"result": Subaccount}

Types

UpdateTransferInput

Example

{}

Types

UpdateTransferPayload

Fields

Field Name	Description
`result` - `Transfer!`

Example

{"result": Transfer}

Types

UpdateUserFlagInput

Fields

Input Field	Description
`flag` - `UserFlagKey!`	Flag to update

Example

{"flag": "HAD_CHILD_SEEN_NOTIFICATION_PROMPT"}

Types

UpdateUserFlagPayload

Fields

Field Name	Description
`result` - `User!`

Example

{"result": User}

Types

UpdateUserProfileInput

Fields

Input Field	Description
`dob` - `Date`

Example

{"dob": "2007-12-03"}

Types

UpdateUserProfilePayload

Fields

Field Name	Description
`result` - `User!`

Example

{"result": User}

Types

UpdateUserSettingInput

Fields

Input Field	Description
`setting` - `UserSettingKey!`	Setting to update

Example

{"setting": "CHILD_CARD_ACTIVITY"}

Types

UpdateUserSettingPayload

Fields

Field Name	Description
`result` - `UserSetting!`

Example

{"result": UserSetting}

Types

UpdateVirtualDebitCardInput

Fields

Input Field	Description
`cancelAfter` - `DateTime`	Datetime after which the card should be canceled
`cardColor` - `DebitCardColor`	Card color for the virtual debit card

Example

{
  "cancelAfter": "2007-12-03T10:15:30Z",
  "cardColor": "BANANA"
}

Types

UpdateVirtualDebitCardPayload

Fields

Field Name	Description
`result` - `DebitCard!`

Example

{"result": DebitCard}

Types

Upload

Description

Represents an uploaded file.

Example

Upload

Types

UploadProfilePicInput

Fields

Input Field	Description
`profilePic` - `Upload!`	Profile pic data (See: https://www.npmjs.com/package/apollo-absinthe-upload-link)

Example

{"profilePic": Upload}

Types

UploadProfilePicPayload

Fields

Field Name	Description
`result` - `User!`

Example

{"result": User}

Types

UpsertAchDetailsInput

Fields

Input Field	Description
`accountType` - `PaymentAccountType!`

Example

{"accountType": "CHECKING"}

Types

UpsertAchDetailsPayload

Fields

Field Name	Description
`result` - `Account!`

Example

{"result": Account}

Types

UpsertDebitCardOrderInput

Fields

Input Field	Description
`cardColor` - `DebitCardColor!`	The color of the card to be ordered
`deliveryTimeline` - `DebitCardOrderDeliveryTimeline`	Delivery timeline for the card order

Example

{"cardColor": "BANANA", "deliveryTimeline": "STANDARD"}

Types

UpsertDebitCardOrderPayload

Fields

Field Name	Description
`result` - `DebitCardOrder!`

Example

{"result": DebitCardOrder}

Types

UpsertFamilyBeneficiaryInput

Fields

Input Field	Description
`type` - `BeneficiaryType!`

Example

{"type": "ENTITY"}

Types

UpsertFamilyBeneficiaryPayload

Fields

Field Name	Description
`result` - `Beneficiary!`

Example

{"result": Beneficiary}

Types

UpsertScheduledAllowanceInput

Fields

Input Field	Description
`dayOfWeek` - `DayOfWeek`
`destinations` - `[ScheduledTransferDestinationInput]`
`frequency` - `ScheduledTransferFrequency!`
`monthCadence` - `MonthCadence`
`status` - `ScheduledTransferStatus`
`weekCadence` - `WeekCadence`

Example

{
  "dayOfWeek": "FRIDAY",
  "destinations": [ScheduledTransferDestinationInput],
  "frequency": "MONTHLY",
  "monthCadence": "ONCE",
  "status": "CANCELED",
  "weekCadence": "EVEN"
}

Types

UpsertScheduledAllowancePayload

Fields

Field Name	Description
`result` - `ScheduledTransfer!`

Example

{"result": ScheduledTransfer}

Types

UpsertUserApplicationInput

Fields

Input Field	Description
`dob` - `Date`
`referralSource` - `ReferralCodeSource`

Example

{
  "dob": "2007-12-03",
  "referralSource": "BILLBOARD"
}

Types

UpsertUserApplicationPayload

Fields

Field Name	Description
`result` - `UserApplication!`

Example

{"result": UserApplication}

Types

UpsertWireDetailsInput

Example

{}

Types

UpsertWireDetailsPayload

Fields

Field Name	Description
`result` - `Account!`

Example

{"result": Account}

Types

UseReferralCodeInput

Example

{}

Types

UseReferralCodePayload

Fields

Field Name	Description
`result` - `UserApplication!`

Example

{"result": UserApplication}

Types

User

Fields

Field Name	Description
`accounts` - `[Account!]!`
`activePhysicalDebitCard` - `DebitCard`
`activeProvisionalDebitCard` - `DebitCard`	We no longer need to use separate provisional cards
`address` - `Address`
`allowance` - `Allowance`
`cardColor` - `DebitCardColor`
`cashDepositBarcode` - `CashDepositBarcode`
`cashTransactions` - `CashTransactionConnection!`
Arguments `searchFilters` - `CashTransactionFilter`
`checkDeposits` - `[CheckDeposit]`
`comments` - `[UserComment!]!`
`currentDebitCardOrder` - `DebitCardOrder`
`currentUserApplication` - `UserApplication`
`debitCardOrders` - `[DebitCardOrder!]!`
`debitCards` - `[DebitCard!]!`
`dob` - `Date`
`externalAccounts` - `[Account!]!`
`family` - `Family`
`flags` - `UserFlags!`
`frozenReason` - `UserFrozenReason`
`frozenStatus` - `UserFrozenStatus!`
`invitedAt` - `DateTime`
`issuingPhysicalDebitCard` - `DebitCard`
`latestUtmEntry` - `UtmEntry`
`monthInReview` - `UserMonthInReview`
Arguments `firstOfMonth` - `Date!`
`pennyChatHistory` - `PennyThreadConnection!`
`permittedActions` - `UserPermittedActions!`
`prompts` - `[Prompt!]!`
`receivedReferral` - `Referral`
`recipientAccounts` - `[Account!]!`
`referralBonusEndDate` - `Date`	Use `user_bonus_end_date` instead
`referralBonuses` - `ReferralBonusConnection!`	Use `user_bonuses` instead
`roles` - `[UserRole!]!`
`saveAccount` - `Account`
`scheduledAllowance` - `ScheduledTransfer`
`scheduledTransfers` - `[ScheduledTransfer]`	Use scheduled_allowance or query for transfers at account or family level
`spendAccount` - `Account`
`status` - `UserStatus!`
`transfers` - `TransferConnection!`
`userApplications` - `[UserApplication!]!`
`userBonusEndDate` - `Date`
`userBonuses` - `UserBonusConnection!`
`userSettings` - `[UserSetting!]!`
`userSpendConfig` - `UserSpendConfig`
`utmEntryOverride` - `UtmEntry`
`virtualDebitCards` - `[DebitCard]`

Example

{
  "accounts": [Account],
  "activePhysicalDebitCard": DebitCard,
  "activeProvisionalDebitCard": DebitCard,
  "address": Address,
  "allowance": Allowance,
  "cardColor": "BANANA",
  "cashDepositBarcode": CashDepositBarcode,
  "cashTransactions": CashTransactionConnection,
  "checkDeposits": [CheckDeposit],
  "comments": [UserComment],
  "currentDebitCardOrder": DebitCardOrder,
  "currentUserApplication": UserApplication,
  "debitCardOrders": [DebitCardOrder],
  "debitCards": [DebitCard],
  "dob": "2007-12-03",
  "externalAccounts": [Account],
  "family": Family,
  "flags": UserFlags,
  "frozenReason": "FRAUD_DETECTED",
  "frozenStatus": "FREEZING",
  "invitedAt": "2007-12-03T10:15:30Z",
  "issuingPhysicalDebitCard": DebitCard,
  "latestUtmEntry": UtmEntry,
  "monthInReview": UserMonthInReview,
  "pennyChatHistory": PennyThreadConnection,
  "permittedActions": UserPermittedActions,
  "prompts": [Prompt],
  "receivedReferral": Referral,
  "recipientAccounts": [Account],
  "referralBonusEndDate": "2007-12-03",
  "referralBonuses": ReferralBonusConnection,
  "roles": [UserRole],
  "saveAccount": Account,
  "scheduledAllowance": ScheduledTransfer,
  "scheduledTransfers": [ScheduledTransfer],
  "spendAccount": Account,
  "status": "ACTIVATED",
  "transfers": TransferConnection,
  "userApplications": [UserApplication],
  "userBonusEndDate": "2007-12-03",
  "userBonuses": UserBonusConnection,
  "userSettings": [UserSetting],
  "userSpendConfig": UserSpendConfig,
  "utmEntryOverride": UtmEntry,
  "virtualDebitCards": [DebitCard]
}

Types

UserAccount

Fields

Field Name	Description
`account` - `Account!`
`relationship` - `UserAccountRelationship!`
`user` - `User!`

Example

{
  "account": Account,
  "relationship": "OWNER",
  "user": User
}

Types

UserAccountRelationship

Values

Enum Value	Description
`OWNER`
`SUPERVISOR`

Example

"OWNER"

Types

UserAction

Values

Enum Value	Description
`CTA`
`DISMISSED`

Example

"CTA"

Types

UserApplication

Description

Represents an application when applying for Crew.

Fields

Field Name	Description
`dob` - `Date`
`insertedAt` - `DateTime`
`permittedActions` - `UserApplicationPermittedActions!`
`referralSource` - `ReferralCodeSource`
`referrer` - `User`
`status` - `UserApplicationStatus!`
`submittedAt` - `DateTime`
`updatedAt` - `DateTime!`

Example

{
  "dob": "2007-12-03",
  "insertedAt": "2007-12-03T10:15:30Z",
  "permittedActions": UserApplicationPermittedActions,
  "referralSource": "BILLBOARD",
  "referrer": User,
  "status": "APPROVED",
  "submittedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z"
}

Types

UserApplicationPermittedActions

Example

{}

Types

UserApplicationStatus

Values

Enum Value	Description
`APPROVED`
`CORRECTIONS_NEEDED`
`DELETED`
`DENIED`
`FAILED`
`FILLING_OUT`
`MANUAL_REVIEW`
`PROCESSING`
`RETRYING`
`STEP_UP`
`STEP_UP_PROCESSING`

Example

"APPROVED"

Types

UserBonusConnection

Fields

Field Name	Description
`edges` - `[UserBonusEdge!]!`
`pageInfo` - `PageInfo!`

Example

{
  "edges": [UserBonusEdge],
  "pageInfo": PageInfo
}

Types

UserBonusEdge

Example

{}

Types

UserComment

Fields

Field Name	Description
`commenter` - `User!`
`family` - `Family!`
`insertedAt` - `DateTime!`
`user` - `User!`

Example

{
  "commenter": User,
  "family": Family,
  "insertedAt": "2007-12-03T10:15:30Z",
  "user": User
}

Types

UserFlagKey

Values

Enum Value	Description
`HAD_CHILD_SEEN_NOTIFICATION_PROMPT`
`HAS_ABUSED_REFERRAL_CODE`
`HAS_BEEN_WELCOMED`
`HAS_DECLINED_SSN_INPUT`
`HAS_DISMISSED_BILL_VIRTUAL_CARD_CALLOUT`
`HAS_DISMISSED_CHILD_INVITE_CALLOUT`
`HAS_DISMISSED_FAMILY_DEBIT_CALLOUT`
`HAS_DISMISSED_POCKETS_CALLOUT`
`HAS_DISMISSED_POCKETS_CHILD_CALLOUT`
`HAS_INCREASED_CHILD_MAX`
`HAS_INCREASED_SUBACCOUNT_MAX`
`HAS_INCREASED_VIRTUAL_DEBIT_CARD_LIMIT`
`HAS_INITIATED_FIRST_TRANSFER`
`HAS_OPENED_AUTOPILOT_EDITOR`
`HAS_OPENED_BONUSES_TAB`
`HAS_OPENED_CRUISE_CONTROL`
`HAS_OPENED_FAMILY_TAB`
`HAS_OPTED_OUT_OF_INTEREST`
`HAS_POSTPONED_DEBIT_CARD`
`HAS_SEEN_BILL_RESERVE_FTUX`
`HAS_SEEN_CASH_DEPOSIT_INTRO`
`HAS_SEEN_PENNY_FTUX`
`HAS_SEEN_POCKET_FTUX`
`HAS_SILENT_PUSH_SUPPORT`
`HAS_SKIPPED_FIRST_TRANSFER`
`HAS_SUBSCRIPTION_FEE_WAIVED`

Example

"HAD_CHILD_SEEN_NOTIFICATION_PROMPT"

Types

UserFlags

Example

{}

Types

UserFrozenReason

Values

Enum Value	Description
`FRAUD_DETECTED`
`PARENT_REQUESTED`

Example

"FRAUD_DETECTED"

Types

UserFrozenStatus

Values

Enum Value	Description
`FREEZING`
`FROZEN`
`UNFREEZING`
`UNFROZEN`

Example

"FREEZING"

Types

UserMonthInReview

Fields

Field Name	Description
`cashFlowOverTime` - `[CashFlowInMonth!]!`
Arguments `startDate` - `Date`
`interestEarnedOverTime` - `[InterestEarnedInMonth!]!`
Arguments `startDate` - `Date`
`moneyInByCategory` - `[MoneyInByCategoryInMonth!]!`
`topCardPurchaseMerchantsByAmount` - `[MerchantAmountInMonth!]!`
`topCardPurchaseMerchantsByFrequency` - `[MerchantFrequencyInMonth!]!`
`topCardPurchases` - `[CashTransaction!]!`
`topOutgoingExternalTransfers` - `[CashTransaction!]!`

Example

{
  "cashFlowOverTime": [CashFlowInMonth],
  "interestEarnedOverTime": [InterestEarnedInMonth],
  "moneyInByCategory": [MoneyInByCategoryInMonth],
  "topCardPurchaseMerchantsByAmount": [
    MerchantAmountInMonth
  ],
  "topCardPurchaseMerchantsByFrequency": [
    MerchantFrequencyInMonth
  ],
  "topCardPurchases": [CashTransaction],
  "topOutgoingExternalTransfers": [CashTransaction]
}

Types

UserPermittedActions

Example

{}

Types

UserRole

Fields

Field Name	Description
`role` - `AppRole!`

Example

{"role": "ADMIN"}

Types

UserSetting

Fields

Field Name	Description
`setting` - `UserSettingKey!`

Example

{"setting": "CHILD_CARD_ACTIVITY"}

Types

UserSettingKey

Values

Enum Value	Description
`CHILD_CARD_ACTIVITY`
`CREW_SUPPORT_ACCESS`
`DECLINED_SSN_INPUT`
`EARLY_ACCESS_OPT_IN`
`INCOMING_TRANSFERS`
`MONTHLY_STATEMENTS_AVAILABLE`
`NOTIFY_ALLOWANCE_PAID`
`NOTIFY_CHILD_CARD_ACTIVITY`
`NOTIFY_CHILD_TO_CHILD_TRANSFER`
`NOTIFY_CHILD_TRANSFERS_IN_OUT`
`NOTIFY_CRUISE_CONTROL_TRANSFERS`
`NOTIFY_FAMILY_TRANSFERS`
`NOTIFY_INCOMING_TRANSFERS`
`NOTIFY_INTEREST_PAID`
`NOTIFY_MARKETING`
`NOTIFY_MONTHLY_STATEMENTS`
`NOTIFY_OUTGOING_TRANSFERS`
`NOTIFY_OWN_CARD_ACTIVITY`
`NOTIFY_PARTNER_CARD_ACTIVITY`
`NOTIFY_REFERRAL_BONUS_UPDATES`
`OUTGOING_TRANSFERS`
`PARENT_CARD_ACTIVITY`
`TARGET_BALANCE_TOUCHED`

Example

"CHILD_CARD_ACTIVITY"

Types

UserSpendConfig

Fields

Field Name	Description
`permittedActions` - `UserSpendConfigPermittedActions!`
`postSpendPocketAssignment` - `PostSpendPocketAssignments`
`selectedSpendSubaccount` - `Subaccount`

Example

{
  "permittedActions": UserSpendConfigPermittedActions,
  "postSpendPocketAssignment": "KEEP_SAME",
  "selectedSpendSubaccount": Subaccount
}

Types

UserSpendConfigPermittedActions

Example

{}

Types

UserStatus

Values

Enum Value	Description
`ACTIVATED`
`ACTIVATING`
`APPLYING`
`CREATED`
`DEACTIVATED`
`DEACTIVATING`
`EMANCIPATED`
`EMANCIPATING`
`FAILED`
`WAITLISTED`

Example

"ACTIVATED"

Types

UtmEntry

Fields

Field Name	Description
`type` - `UtmEntryType!`

Example

{"type": "BRANCH"}

Types

UtmEntryType

Values

Enum Value	Description
`BRANCH`
`MANUAL`

Example

"BRANCH"

Types

VirtualDebitCardType

Values

Enum Value	Description
`SINGLE_USE`
`VIRTUAL`

Example

"SINGLE_USE"

Types

WeekCadence

Values

Enum Value	Description
`EVEN`
`EVERY`
`ODD`

Example

"EVEN"

Crew GraphQL API Reference

API Endpoints

Version

Getting Started

Authentication /auth

Send SMS OTP /send_sms_otp

Auth SMS OTP /auth_sms_otp

Send Email OTP /send_email_otp

Auth Email OTP /auth_email_otp

Test the connection

Queries

cashDepositLocations

Response

Example

Query

Response

currentUser

Response

Example

Query

Response

Mutations

activateDebitCards

Description

Response

Arguments

Example

Query

Variables

Response

addChild

Description

Response

Arguments

Example

Query

Variables

Response

addDebitCardToAppleWalletSync

Description

Response

Arguments

Example

Query

Variables

Response

addDebitCardToGoogleWalletSync

Description

Response

Arguments

Example

Query

Variables

Response

addFamilyMembers

Description

Response

Arguments

Example

Query

Variables

Response

addParent

Description

Response

Arguments

Example

Query

Variables

Response

addRecipientAccount

Description

Response

Arguments

Example

Query

Variables

Response

assignTransactionToBillPayment

Response

Authentication `/auth`

Send SMS OTP `/send_sms_otp`

Auth SMS OTP `/auth_sms_otp`

Send Email OTP `/send_email_otp`

Auth Email OTP `/auth_email_otp`

`cashDepositLocations`

`currentUser`

`activateDebitCards`

`addChild`

`addDebitCardToAppleWalletSync`

`addDebitCardToGoogleWalletSync`

`addFamilyMembers`

`addParent`

`addRecipientAccount`

`assignTransactionToBillPayment`

`attachVirtualDebitCardToBill`

`autoAssignTransactionToBillPayment`

`bulkSetSubaccountVisibility`

`calculateCashTransactionEnrichment`

`cancelDebitCard`

`cancelDebitCardOrder`

`cancelPayment`

`cancelTransfer`

`consentToESignAgreement`