Mutation

Object

accountCapabilityUpgradeRequest

accountDelete

accountDisableNotificationCategory

accountDisableNotificationChannel

accountEnableNotificationCategory

accountEnableNotificationChannel

accountUpdateDefaultWalletId

accountUpdateDisplayCurrency

apiKeyCreate

Generate a new API key for external service authentication. The raw key is only shown once and cannot be retrieved later.

apiKeyRevoke

Revoke an API key. Verification stops honoring it immediately; this cannot be undone.

apiKeyRotate

Rotate an API key: a replacement with a new secret (and keyId) is created with the same name, scopes, and expiry, and the old key is revoked. The new raw key is only shown once.

bankAccountAdd

Adds a bank account for cashouts. Takes effect immediately (no review).

bankAccountDelete

Deletes a bank account. It can no longer be cashed out to. If it was the default, another account becomes the default.

bankAccountSetDefault

Makes one of the customer's bank accounts the default cashout account.

bankAccountUpdate

Updates a bank account's details. Takes effect immediately (no review) and closes any pending update request for the account.

bankAccountUpdateRequest

bridgeAddExternalAccount

bridgeCancelWithdrawalRequest

bridgeCreateExternalAccount

bridgeCreateVirtualAccount

bridgeDeleteExternalAccount

bridgeExchangePlaidPublicToken

bridgeInitiateKyc

bridgeInitiateWithdrawal

bridgeRequestWithdrawal

bridgeSetDefaultExternalAccount

businessAccountUpgradeRequest

callbackEndpointAdd

callbackEndpointDelete

captchaCreateChallenge

captchaRequestAuthCode

createInvite

deviceNotificationTokenCreate

feedbackSubmit

fygaroCheckoutCreate

idDocumentUploadUrlGenerate

initiateCashout

Start the Cashout process; User sends USD to Flash via Ibex and receives USD or JMD to bank account.

intraLedgerPaymentSend

Actions a payment which is internal to the ledger e.g. it does not use onchain/lightning. Returns payment status (success, failed, pending, already_paid).

intraLedgerUsdPaymentSend

Galoy: Actions a payment which is internal to the ledger e.g. it does not use onchain/lightning. Returns payment status (success, failed, pending, already_paid).

Flash: We do not currently have an internal ledger. Consequently, intraledger payments have been updated to call Ibex instead.

lnInvoiceCreate

Returns a lightning invoice for an associated wallet. When invoice is paid the value will be credited to a BTC wallet. Expires after 'expiresIn' or 24 hours.

lnInvoiceCreateOnBehalfOfRecipient

Returns a lightning invoice for an associated wallet. When invoice is paid the value will be credited to a BTC wallet. Expires after 'expiresIn' or 24 hours.

lnInvoiceFeeProbe

lnInvoicePaymentSend

Pay a lightning invoice using a balance from a wallet which is owned by the account of the current user. Provided wallet can be USD or BTC and must have sufficient balance to cover amount in lightning invoice. Returns payment status (success, failed, pending, already_paid).

lnNoAmountInvoiceCreate

Returns a lightning invoice for an associated wallet. Can be used to receive any supported currency value (currently USD or BTC). Expires after 'expiresIn' or 24 hours for BTC invoices or 5 minutes for USD invoices.

lnNoAmountInvoiceCreateOnBehalfOfRecipient

Returns a lightning invoice for an associated wallet. Can be used to receive any supported currency value (currently USD or BTC). Expires after 'expiresIn' or 24 hours for BTC invoices or 5 minutes for USD invoices.

lnNoAmountInvoiceFeeProbe

lnNoAmountInvoicePaymentSend

Pay a lightning invoice using a balance from a wallet which is owned by the account of the current user. Provided wallet must be BTC and must have sufficient balance to cover amount specified in mutation request. Returns payment status (success, failed, pending, already_paid).

lnNoAmountUsdInvoiceFeeProbe

lnNoAmountUsdInvoicePaymentSend

Pay a lightning invoice using a balance from a wallet which is owned by the account of the current user. Provided wallet must be USD and have sufficient balance to cover amount specified in mutation request. Returns payment status (success, failed, pending, already_paid).

lnUsdInvoiceCreate

Returns a lightning invoice denominated in satoshis for an associated wallet. When invoice is paid the equivalent value at invoice creation will be credited to a USD wallet. Expires after 'expiresIn' or 5 minutes (short expiry time because there is a USD/BTC exchange rate associated with the amount).

lnUsdInvoiceCreateOnBehalfOfRecipient

Returns a lightning invoice denominated in satoshis for an associated wallet. When invoice is paid the equivalent value at invoice creation will be credited to a USD wallet. Expires after 'expiresIn' or 5 minutes (short expiry time because there is a USD/BTC exchange rate associated with the amount).

lnUsdInvoiceFeeProbe

lnurlPaymentSend

Pay a LNURL-pay endpoint using a USD/USDT wallet balance. The wallet amount is converted to whole-satoshi millisatoshis before calling IBEX.

merchantMapSuggest

onChainAddressCreate

onChainAddressCurrent

onChainPaymentSend

onChainPaymentSendAll

onChainUsdPaymentSend

onChainUsdPaymentSendAsBtcDenominated

quizCompleted

redeemInvite

requestCashout

Returns an offer from Flash for a user to withdraw from their USD wallet (denominated in cents). The user can review this offer and then execute the withdrawal by calling the initiateCashout mutation.

updateExternalWallet

userContactUpdateAlias

userEmailDelete

userEmailRegistrationInitiate

userEmailRegistrationValidate

userLogin

userLoginUpgrade

userLogout

userPhoneDelete

userPhoneRegistrationInitiate

userPhoneRegistrationValidate

userQuizQuestionUpdateCompleted

userTotpDelete

userTotpRegistrationInitiate

userTotpRegistrationValidate

userUpdateLanguage

userUpdateNpub

userUpdateUsername

walletSplitDelete

Deletes one payment split from a wallet. Splits already triggered still pay out.

walletSplitsSet

Replaces the payment splits on a USD or USDT wallet. Each external Lightning receive on the wallet then pays the given percentages on to the destination wallets. Percentages must add up to at most 100.