changePreferredBankAccount

Overview

This mutation changes the preferred bank account of the current user to the bank account specified by the bank account ID given.

Special Considerations

  • Requires a bank account ID as an input.

Inputs

MutationChangePreferredBankAccountArgs

Required Data

bankAccountId: string

Returns

Promise<SuccessResult>

A promise containing a success message.

Example

Running this mutation:

mutation {
  changePreferredBankAccount(bankAccountId: "ckb6tx8tn00ho07723ir1f6ak") {
    message
  }
}

Gives us:

{
  "data": {
    "changePreferredBankAccount": {
      "message": "Preferred Bank Account Changed!"
    }
  }
}

Common Errors

When running this mutation some of the common errors encountered include:

  • Bank account does not exist on your account. (I-4407)
    • There is no bank account with that ID associated with your current account. Check the ID and current account.
← changePasswordlogin →