diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 28548a3..b0e7446 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -25,7 +25,7 @@ jobs: - name: Setup Node.js uses: actions/setup-node@v4 with: - node-version: '18' + node-version: '20' cache: 'npm' - name: Install dependencies diff --git a/.github/workflows/update-docs.yml b/.github/workflows/update-docs.yml index 573cf5a..326c008 100644 --- a/.github/workflows/update-docs.yml +++ b/.github/workflows/update-docs.yml @@ -15,7 +15,7 @@ jobs: - name: Set up Node.js uses: actions/setup-node@v3 with: - node-version: '16' + node-version: '20' cache: 'npm' - name: Install dependencies @@ -49,5 +49,5 @@ jobs: git config --local user.email "action@github.com" git config --local user.name "GitHub Action" git add schema.graphql public/ - git commit -m "Update API documentation based on schema changes [skip ci]" + git commit -m "Update API documentation based on schema changes" git push \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index f9bbcb7..c10c227 100644 --- a/docs/index.html +++ b/docs/index.html @@ -36,12 +36,19 @@ @@ -67,12 +76,24 @@
  • AccountLevel
  • AccountLimit
  • AccountLimits
  • +
  • AccountNumber
  • AccountUpdateDefaultWalletIdInput
  • AccountUpdateDefaultWalletIdPayload
  • AccountUpdateDisplayCurrencyInput
  • AccountUpdateDisplayCurrencyPayload
  • AccountUpdateNotificationSettingsPayload
  • +
  • AccountUpgradePayload
  • +
  • AccountUpgradeRequest
  • +
  • AccountUpgradeRequestPayload
  • +
  • Address
  • +
  • AddressInput
  • AuthToken
  • AuthTokenPayload
  • BTCWallet
  • +
  • Bank
  • +
  • BankAccount
  • +
  • BankAccountInput
  • Boolean
  • +
  • BridgeAddExternalAccountPayload
  • +
  • BridgeCancelWithdrawalRequestInput
  • +
  • BridgeCancelWithdrawalRequestPayload
  • +
  • BridgeCreateExternalAccountInput
  • +
  • BridgeCreateExternalAccountPayload
  • +
  • BridgeCreateVirtualAccountPayload
  • +
  • BridgeDeleteExternalAccountInput
  • +
  • BridgeDeleteExternalAccountPayload
  • +
  • BridgeExternalAccount
  • +
  • BridgeExternalAccountLink
  • +
  • BridgeInitiateKycInput
  • +
  • BridgeInitiateKycPayload
  • +
  • BridgeInitiateWithdrawalInput
  • +
  • BridgeInitiateWithdrawalPayload
  • +
  • BridgeKycLink
  • +
  • BridgeRequestWithdrawalInput
  • +
  • BridgeRequestWithdrawalPayload
  • +
  • BridgeSetDefaultExternalAccountInput
  • +
  • BridgeSetDefaultExternalAccountPayload
  • +
  • BridgeVirtualAccount
  • +
  • BridgeWithdrawal
  • BuildInformation
  • +
  • BusinessAccountUpgradeRequestInput
  • CallbackEndpoint
  • CallbackEndpointAddInput
  • CallbackEndpointAddPayload
  • @@ -157,6 +212,9 @@
  • CaptchaCreateChallengePayload
  • CaptchaCreateChallengeResult
  • CaptchaRequestAuthCodeInput
  • +
  • CashWalletCutover
  • +
  • CashWalletCutoverState
  • +
  • CashoutOffer
  • CentAmount
  • CentAmountPayload
  • ConsumerAccount
  • @@ -184,6 +242,10 @@
  • GraphQLApplicationError
  • Hex32Bytes
  • ID
  • +
  • IdDocumentUploadUrlGenerateInput
  • +
  • IdDocumentUploadUrlPayload
  • +
  • InitiateCashoutInput
  • +
  • InitiatedCashoutResponse
  • InitiationVia
  • InitiationViaIntraLedger
  • InitiationViaLn
  • @@ -195,6 +257,7 @@
  • InvoicePaymentStatus
  • IsFlashNpubInput
  • IsFlashNpubPayload
  • +
  • JMDCents
  • Language
  • LnInvoice
  • LnInvoiceCreateInput
  • @@ -220,6 +283,7 @@
  • LnUsdInvoiceCreateOnBehalfOfRecipientInput
  • LnUsdInvoiceFeeProbeInput
  • Lnurl
  • +
  • LnurlPaymentSendInput
  • MapInfo
  • MapMarker
  • Memo
  • @@ -272,6 +336,8 @@
  • RealtimePrice
  • RealtimePriceInput
  • RealtimePricePayload
  • +
  • RequestCashoutInput
  • +
  • RequestCashoutResponse
  • SafeInt
  • SatAmount
  • SatAmountPayload
  • @@ -290,12 +356,20 @@
  • TotpSecret
  • Transaction
  • TransactionConnection
  • +
  • TransactionDetails
  • +
  • TransactionDetailsError
  • +
  • TransactionDetailsInput
  • +
  • TransactionDetailsPayload
  • TransactionEdge
  • TxDirection
  • TxNotificationType
  • TxStatus
  • +
  • USDCents
  • +
  • UpdateExternalWalletInput
  • +
  • UpdateExternalWalletPayload
  • UpgradePayload
  • UsdWallet
  • +
  • UsdtWallet
  • User
  • UserContact
  • UserContactUpdateAliasInput
  • @@ -447,12 +521,333 @@
    Response
    {
       "data": {
         "accountDefaultWallet": {
    -      "id": 4,
    +      "id": "4",
           "lnurlp": Lnurl,
           "walletCurrency": "BTC"
         }
       }
     }
    +
    + + + + +
    +
    + Queries +
    +

    + bridgeExternalAccounts +

    +
    +
    +
    +
    Response
    +

    Returns [BridgeExternalAccount] +

    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    query BridgeExternalAccounts {
    +  bridgeExternalAccounts {
    +    accountNumberLast4
    +    bankName
    +    id
    +    isDefault
    +    status
    +  }
    +}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "bridgeExternalAccounts": [
    +      {
    +        "accountNumberLast4": "abc123",
    +        "bankName": "abc123",
    +        "id": "4",
    +        "isDefault": false,
    +        "status": "xyz789"
    +      }
    +    ]
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Queries +
    +

    + bridgeKycStatus +

    +
    +
    +
    +
    Response
    +

    Returns a String +

    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    query BridgeKycStatus {
    +  bridgeKycStatus
    +}
    +
    +
    +
    +
    Response
    +
    {"data": {"bridgeKycStatus": "abc123"}}
    +
    +
    +
    +
    +
    +
    +
    + Queries +
    +

    + bridgeVirtualAccount +

    +
    +
    +
    +
    Response
    +

    Returns a BridgeVirtualAccount +

    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    query BridgeVirtualAccount {
    +  bridgeVirtualAccount {
    +    accountNumber
    +    accountNumberLast4
    +    bankName
    +    id
    +    kycLink
    +    message
    +    pending
    +    routingNumber
    +    tosLink
    +  }
    +}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "bridgeVirtualAccount": {
    +      "accountNumber": "xyz789",
    +      "accountNumberLast4": "abc123",
    +      "bankName": "xyz789",
    +      "id": "4",
    +      "kycLink": "xyz789",
    +      "message": "abc123",
    +      "pending": true,
    +      "routingNumber": "abc123",
    +      "tosLink": "xyz789"
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Queries +
    +

    + bridgeWithdrawalRequest +

    +
    +
    +
    +
    Response
    +

    Returns a BridgeWithdrawal +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + id - ID! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    query BridgeWithdrawalRequest($id: ID!) {
    +  bridgeWithdrawalRequest(id: $id) {
    +    amount
    +    bridgeDeveloperFee
    +    bridgeExchangeFee
    +    bridgeTransferId
    +    createdAt
    +    currency
    +    estimatedBridgeFee
    +    estimatedBridgeFeePercent
    +    estimatedCustomerFee
    +    estimatedGasBuffer
    +    externalAccountId
    +    failureReason
    +    finalAmount
    +    flashFee
    +    flashFeeIsEstimate
    +    flashFeeNotice
    +    flashFeePercent
    +    id
    +    status
    +    subtotalAmount
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"id": "4"}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "bridgeWithdrawalRequest": {
    +      "amount": "xyz789",
    +      "bridgeDeveloperFee": "xyz789",
    +      "bridgeExchangeFee": "abc123",
    +      "bridgeTransferId": "abc123",
    +      "createdAt": "xyz789",
    +      "currency": "abc123",
    +      "estimatedBridgeFee": "xyz789",
    +      "estimatedBridgeFeePercent": "xyz789",
    +      "estimatedCustomerFee": "xyz789",
    +      "estimatedGasBuffer": "abc123",
    +      "externalAccountId": "abc123",
    +      "failureReason": "abc123",
    +      "finalAmount": "abc123",
    +      "flashFee": "xyz789",
    +      "flashFeeIsEstimate": false,
    +      "flashFeeNotice": "xyz789",
    +      "flashFeePercent": "xyz789",
    +      "id": 4,
    +      "status": "abc123",
    +      "subtotalAmount": "abc123"
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Queries +
    +

    + bridgeWithdrawals +

    +
    +
    +
    +
    Response
    +

    Returns [BridgeWithdrawal] +

    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    query BridgeWithdrawals {
    +  bridgeWithdrawals {
    +    amount
    +    bridgeDeveloperFee
    +    bridgeExchangeFee
    +    bridgeTransferId
    +    createdAt
    +    currency
    +    estimatedBridgeFee
    +    estimatedBridgeFeePercent
    +    estimatedCustomerFee
    +    estimatedGasBuffer
    +    externalAccountId
    +    failureReason
    +    finalAmount
    +    flashFee
    +    flashFeeIsEstimate
    +    flashFeeNotice
    +    flashFeePercent
    +    id
    +    status
    +    subtotalAmount
    +  }
    +}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "bridgeWithdrawals": [
    +      {
    +        "amount": "xyz789",
    +        "bridgeDeveloperFee": "abc123",
    +        "bridgeExchangeFee": "abc123",
    +        "bridgeTransferId": "abc123",
    +        "createdAt": "xyz789",
    +        "currency": "xyz789",
    +        "estimatedBridgeFee": "xyz789",
    +        "estimatedBridgeFeePercent": "abc123",
    +        "estimatedCustomerFee": "xyz789",
    +        "estimatedGasBuffer": "abc123",
    +        "externalAccountId": "xyz789",
    +        "failureReason": "xyz789",
    +        "finalAmount": "abc123",
    +        "flashFee": "abc123",
    +        "flashFeeIsEstimate": true,
    +        "flashFeeNotice": "xyz789",
    +        "flashFeePercent": "abc123",
    +        "id": 4,
    +        "status": "xyz789",
    +        "subtotalAmount": "xyz789"
    +      }
    +    ]
    +  }
    +}
     
    @@ -650,6 +1045,64 @@
    Response
    ] } } + +
    + + +
    +
    +
    + Queries +
    +

    + cashWalletCutover +

    +
    +
    +
    +
    Response
    +

    Returns a CashWalletCutover! +

    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    query CashWalletCutover {
    +  cashWalletCutover {
    +    completedAt
    +    cutoverVersion
    +    pauseReason
    +    pausedAt
    +    runId
    +    scheduledAt
    +    startedAt
    +    state
    +    updatedAt
    +    updatedBy
    +  }
    +}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "cashWalletCutover": {
    +      "completedAt": 1592577642,
    +      "cutoverVersion": 987,
    +      "pauseReason": "xyz789",
    +      "pausedAt": 1592577642,
    +      "runId": "abc123",
    +      "scheduledAt": 1592577642,
    +      "startedAt": 1592577642,
    +      "state": "COMPLETE",
    +      "updatedAt": 1592577642,
    +      "updatedBy": "xyz789"
    +    }
    +  }
    +}
     
    @@ -692,7 +1145,7 @@
    Response
    "currencyList": [ { "flag": "abc123", - "fractionDigits": 987, + "fractionDigits": 123, "id": "4", "name": "abc123", "symbol": "xyz789" @@ -726,10 +1179,12 @@

    Example

    Query
    query Globals {
       globals {
    +    bridgeEnabled
         buildInformation {
           commitHash
           helmRevision
         }
    +    cashoutEnabled
         feesInformation {
           deposit {
             ...DepositFeesInformationFragment
    @@ -743,6 +1198,7 @@ 
    Query
    id supportedAuthChannels }
    + topupEnabled }
    }
    @@ -752,7 +1208,9 @@
    Response
    {
       "data": {
         "globals": {
    +      "bridgeEnabled": true,
           "buildInformation": BuildInformation,
    +      "cashoutEnabled": false,
           "feesInformation": FeesInformation,
           "lightningAddressDomain": "abc123",
           "lightningAddressDomainAliases": [
    @@ -760,7 +1218,8 @@ 
    Response
    ], "network": "mainnet", "nodesIds": ["xyz789"], - "supportedCountries": [Country] + "supportedCountries": [Country], + "topupEnabled": true } } } @@ -831,7 +1290,7 @@
    Response
    "data": { "isFlashNpub": { "errors": [Error], - "isFlashNpub": false + "isFlashNpub": true } } } @@ -840,54 +1299,117 @@
    Response
    -
    +

    - lnInvoicePaymentStatus + latestAccountUpgradeRequest

    -
    -
    Arguments
    - - - - - - - - - - - - - -
    NameDescription
    - input - LnInvoicePaymentStatusInput! - -
    -

    Example

    Query
    -
    query LnInvoicePaymentStatus($input: LnInvoicePaymentStatusInput!) {
    -  lnInvoicePaymentStatus(input: $input) {
    +                  
    query LatestAccountUpgradeRequest {
    +  latestAccountUpgradeRequest {
         errors {
           code
           message
           path
         }
    -    status
    -  }
    +    upgradeRequest {
    +      address {
    +        ...AddressFragment
    +      }
    +      bankAccount {
    +        ...BankAccountFragment
    +      }
    +      currentLevel
    +      email
    +      fullName
    +      idDocument
    +      name
    +      phoneNumber
    +      requestedLevel
    +      status
    +      terminalsRequested
    +      username
    +    }
    +  }
    +}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "latestAccountUpgradeRequest": {
    +      "errors": [Error],
    +      "upgradeRequest": AccountUpgradeRequest
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Queries +
    +

    + lnInvoicePaymentStatus +

    +
    +
    +
    +
    Response
    +

    Returns a LnInvoicePaymentStatusPayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - LnInvoicePaymentStatusInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    query LnInvoicePaymentStatus($input: LnInvoicePaymentStatusInput!) {
    +  lnInvoicePaymentStatus(input: $input) {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    status
    +  }
     }
     
    @@ -932,6 +1454,16 @@

    Example

    Query
    query Me {
       me {
    +    bankAccounts {
    +      accountName
    +      accountNumber
    +      accountType
    +      bankBranch
    +      bankName
    +      currency
    +      id
    +      isDefault
    +    }
         contactByUsername {
           alias
           id
    @@ -1001,6 +1533,7 @@ 
    Response
    {
       "data": {
         "me": {
    +      "bankAccounts": [BankAccount],
           "contactByUsername": UserContact,
           "contacts": [UserContact],
           "createdAt": 1592577642,
    @@ -1055,9 +1588,9 @@ 
    Response
    "data": { "mobileVersions": [ { - "currentSupported": 987, - "minSupported": 987, - "platform": "xyz789" + "currentSupported": 123, + "minSupported": 123, + "platform": "abc123" } ] } @@ -1261,7 +1794,7 @@
    Arguments
    - amount - CentAmount! + amount - FractionalCentAmount! @@ -1289,7 +1822,7 @@

    Example

    Query
    query OnChainUsdTxFee(
       $address: OnChainAddress!,
    -  $amount: CentAmount!,
    +  $amount: FractionalCentAmount!,
       $speed: PayoutSpeed,
       $walletId: WalletId!
     ) {
    @@ -1308,7 +1841,7 @@ 
    Query
    Variables
    {
       "address": OnChainAddress,
    -  "amount": CentAmount,
    +  "amount": FractionalCentAmount,
       "speed": "FAST",
       "walletId": WalletId
     }
    @@ -1316,7 +1849,11 @@ 
    Variables
    Response
    -
    {"data": {"onChainUsdTxFee": {"amount": CentAmount}}}
    +                  
    {
    +  "data": {
    +    "onChainUsdTxFee": {"amount": FractionalCentAmount}
    +  }
    +}
     
    @@ -1413,7 +1950,7 @@
    Response
    {
       "data": {
         "onChainUsdTxFeeAsBtcDenominated": {
    -      "amount": CentAmount
    +      "amount": FractionalCentAmount
         }
       }
     }
    @@ -1556,6 +2093,131 @@ 
    Response
    } } } +
    + + + +
    +
    +
    + Queries +
    +

    + supportedBanks +

    +
    +
    +
    +
    Response
    +

    Returns [Bank!]! +

    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    query SupportedBanks {
    +  supportedBanks {
    +    name
    +  }
    +}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "supportedBanks": [{"name": "xyz789"}]
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Queries +
    +

    + transactionDetails +

    +
    +
    +
    +
    Response
    +

    Returns a TransactionDetailsPayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - TransactionDetailsInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    query TransactionDetails($input: TransactionDetailsInput!) {
    +  transactionDetails(input: $input) {
    +    errors {
    +      message
    +    }
    +    transactionDetails {
    +      accountId
    +      address
    +      amount
    +      confirmations
    +      createdAt
    +      currency
    +      fee
    +      id
    +      invoice
    +      memo
    +      paymentHash
    +      paymentPreimage
    +      status
    +      txid
    +      type
    +      updatedAt
    +      vout
    +    }
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": TransactionDetailsInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "transactionDetails": {
    +      "errors": [TransactionDetailsError],
    +      "transactionDetails": TransactionDetails
    +    }
    +  }
    +}
     
    @@ -2311,18 +2973,67 @@
    Response
    -
    +

    - callbackEndpointAdd + bridgeAddExternalAccount

    Response
    -

    Returns a CallbackEndpointAddPayload! +

    Returns a BridgeAddExternalAccountPayload! +

    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    mutation BridgeAddExternalAccount {
    +  bridgeAddExternalAccount {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    externalAccount {
    +      expiresAt
    +      linkUrl
    +    }
    +  }
    +}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "bridgeAddExternalAccount": {
    +      "errors": [Error],
    +      "externalAccount": BridgeExternalAccountLink
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Mutations +
    +

    + bridgeCancelWithdrawalRequest +

    +
    +
    +
    +
    Response
    +

    Returns a BridgeCancelWithdrawalRequestPayload!

    @@ -2337,7 +3048,7 @@
    Arguments
    - input - CallbackEndpointAddInput! + input - BridgeCancelWithdrawalRequestInput! @@ -2350,30 +3061,51 @@
    Arguments

    Example

    Query
    -
    mutation CallbackEndpointAdd($input: CallbackEndpointAddInput!) {
    -  callbackEndpointAdd(input: $input) {
    +                  
    mutation BridgeCancelWithdrawalRequest($input: BridgeCancelWithdrawalRequestInput!) {
    +  bridgeCancelWithdrawalRequest(input: $input) {
         errors {
           code
           message
           path
         }
    -    id
    +    withdrawal {
    +      amount
    +      bridgeDeveloperFee
    +      bridgeExchangeFee
    +      bridgeTransferId
    +      createdAt
    +      currency
    +      estimatedBridgeFee
    +      estimatedBridgeFeePercent
    +      estimatedCustomerFee
    +      estimatedGasBuffer
    +      externalAccountId
    +      failureReason
    +      finalAmount
    +      flashFee
    +      flashFeeIsEstimate
    +      flashFeeNotice
    +      flashFeePercent
    +      id
    +      status
    +      subtotalAmount
    +    }
       }
     }
     
    Variables
    -
    {"input": CallbackEndpointAddInput}
    +                  
    {"input": BridgeCancelWithdrawalRequestInput}
     
    Response
    {
       "data": {
    -    "callbackEndpointAdd": {
    +    "bridgeCancelWithdrawalRequest": {
           "errors": [Error],
    -      "id": EndpointId
    +      "withdrawal": BridgeWithdrawal
         }
       }
     }
    @@ -2382,18 +3114,18 @@ 
    Response
    -
    +

    - callbackEndpointDelete + bridgeCreateExternalAccount

    Response
    -

    Returns a SuccessPayload! +

    Returns a BridgeCreateExternalAccountPayload!

    @@ -2408,7 +3140,7 @@
    Arguments
    - input - CallbackEndpointDeleteInput! + input - BridgeCreateExternalAccountInput! @@ -2421,30 +3153,36 @@
    Arguments

    Example

    Query
    -
    mutation CallbackEndpointDelete($input: CallbackEndpointDeleteInput!) {
    -  callbackEndpointDelete(input: $input) {
    +                  
    mutation BridgeCreateExternalAccount($input: BridgeCreateExternalAccountInput!) {
    +  bridgeCreateExternalAccount(input: $input) {
         errors {
           code
           message
           path
         }
    -    success
    +    externalAccount {
    +      accountNumberLast4
    +      bankName
    +      id
    +      isDefault
    +      status
    +    }
       }
     }
     
    Variables
    -
    {"input": CallbackEndpointDeleteInput}
    +                  
    {"input": BridgeCreateExternalAccountInput}
     
    Response
    {
       "data": {
    -    "callbackEndpointDelete": {
    +    "bridgeCreateExternalAccount": {
           "errors": [Error],
    -      "success": false
    +      "externalAccount": BridgeExternalAccount
         }
       }
     }
    @@ -2453,18 +3191,18 @@ 
    Response
    -
    +

    - captchaCreateChallenge + bridgeCreateVirtualAccount

    @@ -2472,18 +3210,23 @@
    Response

    Example

    Query
    -
    mutation CaptchaCreateChallenge {
    -  captchaCreateChallenge {
    +                  
    mutation BridgeCreateVirtualAccount {
    +  bridgeCreateVirtualAccount {
         errors {
           code
           message
           path
         }
    -    result {
    -      challengeCode
    -      failbackMode
    +    virtualAccount {
    +      accountNumber
    +      accountNumberLast4
    +      bankName
           id
    -      newCaptcha
    +      kycLink
    +      message
    +      pending
    +      routingNumber
    +      tosLink
         }
       }
     }
    @@ -2493,9 +3236,9 @@ 
    Query
    Response
    {
       "data": {
    -    "captchaCreateChallenge": {
    +    "bridgeCreateVirtualAccount": {
           "errors": [Error],
    -      "result": CaptchaCreateChallengeResult
    +      "virtualAccount": BridgeVirtualAccount
         }
       }
     }
    @@ -2504,18 +3247,18 @@ 
    Response
    -
    +

    - captchaRequestAuthCode + bridgeDeleteExternalAccount

    Response
    -

    Returns a SuccessPayload! +

    Returns a BridgeDeleteExternalAccountPayload!

    @@ -2530,7 +3273,7 @@
    Arguments
    - input - CaptchaRequestAuthCodeInput! + input - BridgeDeleteExternalAccountInput! @@ -2543,30 +3286,36 @@
    Arguments

    Example

    Query
    -
    mutation CaptchaRequestAuthCode($input: CaptchaRequestAuthCodeInput!) {
    -  captchaRequestAuthCode(input: $input) {
    +                  
    mutation BridgeDeleteExternalAccount($input: BridgeDeleteExternalAccountInput!) {
    +  bridgeDeleteExternalAccount(input: $input) {
         errors {
           code
           message
           path
         }
    -    success
    +    externalAccount {
    +      accountNumberLast4
    +      bankName
    +      id
    +      isDefault
    +      status
    +    }
       }
     }
     
    Variables
    -
    {"input": CaptchaRequestAuthCodeInput}
    +                  
    {"input": BridgeDeleteExternalAccountInput}
     
    Response
    {
       "data": {
    -    "captchaRequestAuthCode": {
    +    "bridgeDeleteExternalAccount": {
           "errors": [Error],
    -      "success": false
    +      "externalAccount": BridgeExternalAccount
         }
       }
     }
    @@ -2575,18 +3324,18 @@ 
    Response
    -
    +

    - deviceNotificationTokenCreate + bridgeInitiateKyc

    Response
    -

    Returns a SuccessPayload! +

    Returns a BridgeInitiateKycPayload!

    @@ -2601,7 +3350,7 @@
    Arguments
    - input - DeviceNotificationTokenCreateInput! + input - BridgeInitiateKycInput! @@ -2614,30 +3363,33 @@
    Arguments

    Example

    Query
    -
    mutation DeviceNotificationTokenCreate($input: DeviceNotificationTokenCreateInput!) {
    -  deviceNotificationTokenCreate(input: $input) {
    +                  
    mutation BridgeInitiateKyc($input: BridgeInitiateKycInput!) {
    +  bridgeInitiateKyc(input: $input) {
         errors {
           code
           message
           path
         }
    -    success
    +    kycLink {
    +      kycLink
    +      tosLink
    +    }
       }
     }
     
    Variables
    -
    {"input": DeviceNotificationTokenCreateInput}
    +                  
    {"input": BridgeInitiateKycInput}
     
    Response
    {
       "data": {
    -    "deviceNotificationTokenCreate": {
    +    "bridgeInitiateKyc": {
           "errors": [Error],
    -      "success": true
    +      "kycLink": BridgeKycLink
         }
       }
     }
    @@ -2646,18 +3398,18 @@ 
    Response
    -
    +

    - feedbackSubmit + bridgeInitiateWithdrawal

    Response
    -

    Returns a SuccessPayload! +

    Returns a BridgeInitiateWithdrawalPayload!

    @@ -2672,7 +3424,7 @@
    Arguments
    - input - FeedbackSubmitInput! + input - BridgeInitiateWithdrawalInput! @@ -2685,28 +3437,52 @@
    Arguments

    Example

    Query
    -
    mutation FeedbackSubmit($input: FeedbackSubmitInput!) {
    -  feedbackSubmit(input: $input) {
    +                  
    mutation BridgeInitiateWithdrawal($input: BridgeInitiateWithdrawalInput!) {
    +  bridgeInitiateWithdrawal(input: $input) {
         errors {
           code
           message
           path
         }
    -    success
    +    withdrawal {
    +      amount
    +      bridgeDeveloperFee
    +      bridgeExchangeFee
    +      bridgeTransferId
    +      createdAt
    +      currency
    +      estimatedBridgeFee
    +      estimatedBridgeFeePercent
    +      estimatedCustomerFee
    +      estimatedGasBuffer
    +      externalAccountId
    +      failureReason
    +      finalAmount
    +      flashFee
    +      flashFeeIsEstimate
    +      flashFeeNotice
    +      flashFeePercent
    +      id
    +      status
    +      subtotalAmount
    +    }
       }
     }
     
    Variables
    -
    {"input": FeedbackSubmitInput}
    +                  
    {"input": BridgeInitiateWithdrawalInput}
     
    Response
    {
       "data": {
    -    "feedbackSubmit": {"errors": [Error], "success": true}
    +    "bridgeInitiateWithdrawal": {
    +      "errors": [Error],
    +      "withdrawal": BridgeWithdrawal
    +    }
       }
     }
     
    @@ -2714,26 +3490,18 @@
    Response
    -
    +

    - intraLedgerPaymentSend + bridgeRequestWithdrawal

    -
    -
    -
    -
    Description
    -

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

    -
    -
    -
    Response
    -

    Returns a PaymentSendPayload! +

    Returns a BridgeRequestWithdrawalPayload!

    @@ -2748,7 +3516,7 @@
    Arguments
    - input - IntraLedgerPaymentSendInput! + input - BridgeRequestWithdrawalInput! @@ -2761,30 +3529,51 @@
    Arguments

    Example

    Query
    -
    mutation IntraLedgerPaymentSend($input: IntraLedgerPaymentSendInput!) {
    -  intraLedgerPaymentSend(input: $input) {
    +                  
    mutation BridgeRequestWithdrawal($input: BridgeRequestWithdrawalInput!) {
    +  bridgeRequestWithdrawal(input: $input) {
         errors {
           code
           message
           path
         }
    -    status
    +    withdrawal {
    +      amount
    +      bridgeDeveloperFee
    +      bridgeExchangeFee
    +      bridgeTransferId
    +      createdAt
    +      currency
    +      estimatedBridgeFee
    +      estimatedBridgeFeePercent
    +      estimatedCustomerFee
    +      estimatedGasBuffer
    +      externalAccountId
    +      failureReason
    +      finalAmount
    +      flashFee
    +      flashFeeIsEstimate
    +      flashFeeNotice
    +      flashFeePercent
    +      id
    +      status
    +      subtotalAmount
    +    }
       }
     }
     
    Variables
    -
    {"input": IntraLedgerPaymentSendInput}
    +                  
    {"input": BridgeRequestWithdrawalInput}
     
    Response
    {
       "data": {
    -    "intraLedgerPaymentSend": {
    +    "bridgeRequestWithdrawal": {
           "errors": [Error],
    -      "status": "ALREADY_PAID"
    +      "withdrawal": BridgeWithdrawal
         }
       }
     }
    @@ -2793,27 +3582,18 @@ 
    Response
    -
    +

    - intraLedgerUsdPaymentSend + bridgeSetDefaultExternalAccount

    -
    -
    -
    -
    Description
    -

    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.

    -
    -
    -
    @@ -2828,7 +3608,7 @@
    Arguments
    - input - IntraLedgerUsdPaymentSendInput! + input - BridgeSetDefaultExternalAccountInput! @@ -2841,30 +3621,36 @@
    Arguments

    Example

    Query
    -
    mutation IntraLedgerUsdPaymentSend($input: IntraLedgerUsdPaymentSendInput!) {
    -  intraLedgerUsdPaymentSend(input: $input) {
    +                  
    mutation BridgeSetDefaultExternalAccount($input: BridgeSetDefaultExternalAccountInput!) {
    +  bridgeSetDefaultExternalAccount(input: $input) {
         errors {
           code
           message
           path
         }
    -    status
    +    externalAccount {
    +      accountNumberLast4
    +      bankName
    +      id
    +      isDefault
    +      status
    +    }
       }
     }
     
    Variables
    -
    {"input": IntraLedgerUsdPaymentSendInput}
    +                  
    {"input": BridgeSetDefaultExternalAccountInput}
     
    Response
    {
       "data": {
    -    "intraLedgerUsdPaymentSend": {
    +    "bridgeSetDefaultExternalAccount": {
           "errors": [Error],
    -      "status": "ALREADY_PAID"
    +      "externalAccount": BridgeExternalAccount
         }
       }
     }
    @@ -2873,26 +3659,18 @@ 
    Response
    -
    +

    - lnInvoiceCreate + businessAccountUpgradeRequest

    -
    -
    -
    -
    Description
    -

    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.

    -
    -
    -
    Response
    -

    Returns a LnInvoicePayload! +

    Returns an AccountUpgradePayload!

    @@ -2907,7 +3685,7 @@
    Arguments
    - input - LnInvoiceCreateInput! + input - BusinessAccountUpgradeRequestInput! @@ -2920,35 +3698,32 @@
    Arguments

    Example

    Query
    -
    mutation LnInvoiceCreate($input: LnInvoiceCreateInput!) {
    -  lnInvoiceCreate(input: $input) {
    +                  
    mutation BusinessAccountUpgradeRequest($input: BusinessAccountUpgradeRequestInput!) {
    +  businessAccountUpgradeRequest(input: $input) {
         errors {
           code
           message
           path
         }
    -    invoice {
    -      paymentHash
    -      paymentRequest
    -      paymentSecret
    -      satoshis
    -    }
    +    id
    +    status
       }
     }
     
    Variables
    -
    {"input": LnInvoiceCreateInput}
    +                  
    {"input": BusinessAccountUpgradeRequestInput}
     
    Response
    {
       "data": {
    -    "lnInvoiceCreate": {
    +    "businessAccountUpgradeRequest": {
           "errors": [Error],
    -      "invoice": LnInvoice
    +      "id": "abc123",
    +      "status": "abc123"
         }
       }
     }
    @@ -2957,26 +3732,18 @@ 
    Response
    -
    +

    - lnInvoiceCreateOnBehalfOfRecipient + callbackEndpointAdd

    -
    -
    -
    -
    Description
    -

    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.

    -
    -
    -
    Response
    -

    Returns a LnInvoicePayload! +

    Returns a CallbackEndpointAddPayload!

    @@ -2991,7 +3758,7 @@
    Arguments
    - input - LnInvoiceCreateOnBehalfOfRecipientInput! + input - CallbackEndpointAddInput! @@ -3004,35 +3771,30 @@
    Arguments

    Example

    Query
    -
    mutation LnInvoiceCreateOnBehalfOfRecipient($input: LnInvoiceCreateOnBehalfOfRecipientInput!) {
    -  lnInvoiceCreateOnBehalfOfRecipient(input: $input) {
    +                  
    mutation CallbackEndpointAdd($input: CallbackEndpointAddInput!) {
    +  callbackEndpointAdd(input: $input) {
         errors {
           code
           message
           path
         }
    -    invoice {
    -      paymentHash
    -      paymentRequest
    -      paymentSecret
    -      satoshis
    -    }
    +    id
       }
     }
     
    Variables
    -
    {"input": LnInvoiceCreateOnBehalfOfRecipientInput}
    +                  
    {"input": CallbackEndpointAddInput}
     
    Response
    {
       "data": {
    -    "lnInvoiceCreateOnBehalfOfRecipient": {
    +    "callbackEndpointAdd": {
           "errors": [Error],
    -      "invoice": LnInvoice
    +      "id": EndpointId
         }
       }
     }
    @@ -3041,18 +3803,18 @@ 
    Response
    -
    +

    - lnInvoiceFeeProbe + callbackEndpointDelete

    Response
    -

    Returns a SatAmountPayload! +

    Returns a SuccessPayload!

    @@ -3067,7 +3829,7 @@
    Arguments
    - input - LnInvoiceFeeProbeInput! + input - CallbackEndpointDeleteInput! @@ -3080,30 +3842,30 @@
    Arguments

    Example

    Query
    -
    mutation LnInvoiceFeeProbe($input: LnInvoiceFeeProbeInput!) {
    -  lnInvoiceFeeProbe(input: $input) {
    -    amount
    +                  
    mutation CallbackEndpointDelete($input: CallbackEndpointDeleteInput!) {
    +  callbackEndpointDelete(input: $input) {
         errors {
           code
           message
           path
         }
    +    success
       }
     }
     
    Variables
    -
    {"input": LnInvoiceFeeProbeInput}
    +                  
    {"input": CallbackEndpointDeleteInput}
     
    Response
    {
       "data": {
    -    "lnInvoiceFeeProbe": {
    -      "amount": SatAmount,
    -      "errors": [Error]
    +    "callbackEndpointDelete": {
    +      "errors": [Error],
    +      "success": false
         }
       }
     }
    @@ -3112,77 +3874,49 @@ 
    Response
    -
    +

    - lnInvoicePaymentSend + captchaCreateChallenge

    -
    -
    -
    -
    Description
    -

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

    -
    -
    -
    Response
    -

    Returns a PaymentSendPayload! +

    Returns a CaptchaCreateChallengePayload!

    -
    -
    Arguments
    - - - - - - - - - - - - - -
    NameDescription
    - input - LnInvoicePaymentInput! - -
    -

    Example

    Query
    -
    mutation LnInvoicePaymentSend($input: LnInvoicePaymentInput!) {
    -  lnInvoicePaymentSend(input: $input) {
    +                  
    mutation CaptchaCreateChallenge {
    +  captchaCreateChallenge {
         errors {
           code
           message
           path
         }
    -    status
    +    result {
    +      challengeCode
    +      failbackMode
    +      id
    +      newCaptcha
    +    }
       }
     }
    -
    -
    -
    -
    Variables
    -
    {"input": LnInvoicePaymentInput}
     
    Response
    {
       "data": {
    -    "lnInvoicePaymentSend": {
    +    "captchaCreateChallenge": {
           "errors": [Error],
    -      "status": "ALREADY_PAID"
    +      "result": CaptchaCreateChallengeResult
         }
       }
     }
    @@ -3191,26 +3925,18 @@ 
    Response
    -
    +

    - lnNoAmountInvoiceCreate + captchaRequestAuthCode

    -
    -
    -
    -
    Description
    -

    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.

    -
    -
    -
    Response
    -

    Returns a LnNoAmountInvoicePayload! +

    Returns a SuccessPayload!

    @@ -3225,7 +3951,7 @@
    Arguments
    - input - LnNoAmountInvoiceCreateInput! + input - CaptchaRequestAuthCodeInput! @@ -3238,34 +3964,30 @@
    Arguments

    Example

    Query
    -
    mutation LnNoAmountInvoiceCreate($input: LnNoAmountInvoiceCreateInput!) {
    -  lnNoAmountInvoiceCreate(input: $input) {
    +                  
    mutation CaptchaRequestAuthCode($input: CaptchaRequestAuthCodeInput!) {
    +  captchaRequestAuthCode(input: $input) {
         errors {
           code
           message
           path
         }
    -    invoice {
    -      paymentHash
    -      paymentRequest
    -      paymentSecret
    -    }
    +    success
       }
     }
     
    Variables
    -
    {"input": LnNoAmountInvoiceCreateInput}
    +                  
    {"input": CaptchaRequestAuthCodeInput}
     
    Response
    {
       "data": {
    -    "lnNoAmountInvoiceCreate": {
    +    "captchaRequestAuthCode": {
           "errors": [Error],
    -      "invoice": LnNoAmountInvoice
    +      "success": true
         }
       }
     }
    @@ -3274,26 +3996,18 @@ 
    Response
    -
    +

    - lnNoAmountInvoiceCreateOnBehalfOfRecipient + deviceNotificationTokenCreate

    -
    -
    -
    -
    Description
    -

    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.

    -
    -
    -
    Response
    -

    Returns a LnNoAmountInvoicePayload! +

    Returns a SuccessPayload!

    @@ -3308,7 +4022,7 @@
    Arguments
    - input - LnNoAmountInvoiceCreateOnBehalfOfRecipientInput! + input - DeviceNotificationTokenCreateInput! @@ -3321,34 +4035,30 @@
    Arguments

    Example

    Query
    -
    mutation LnNoAmountInvoiceCreateOnBehalfOfRecipient($input: LnNoAmountInvoiceCreateOnBehalfOfRecipientInput!) {
    -  lnNoAmountInvoiceCreateOnBehalfOfRecipient(input: $input) {
    +                  
    mutation DeviceNotificationTokenCreate($input: DeviceNotificationTokenCreateInput!) {
    +  deviceNotificationTokenCreate(input: $input) {
         errors {
           code
           message
           path
         }
    -    invoice {
    -      paymentHash
    -      paymentRequest
    -      paymentSecret
    -    }
    +    success
       }
     }
     
    Variables
    -
    {"input": LnNoAmountInvoiceCreateOnBehalfOfRecipientInput}
    +                  
    {"input": DeviceNotificationTokenCreateInput}
     
    Response
    {
       "data": {
    -    "lnNoAmountInvoiceCreateOnBehalfOfRecipient": {
    +    "deviceNotificationTokenCreate": {
           "errors": [Error],
    -      "invoice": LnNoAmountInvoice
    +      "success": false
         }
       }
     }
    @@ -3357,18 +4067,18 @@ 
    Response
    -
    +

    - lnNoAmountInvoiceFeeProbe + feedbackSubmit

    Response
    -

    Returns a SatAmountPayload! +

    Returns a SuccessPayload!

    @@ -3383,7 +4093,7 @@
    Arguments
    - input - LnNoAmountInvoiceFeeProbeInput! + input - FeedbackSubmitInput! @@ -3396,30 +4106,30 @@
    Arguments

    Example

    Query
    -
    mutation LnNoAmountInvoiceFeeProbe($input: LnNoAmountInvoiceFeeProbeInput!) {
    -  lnNoAmountInvoiceFeeProbe(input: $input) {
    -    amount
    +                  
    mutation FeedbackSubmit($input: FeedbackSubmitInput!) {
    +  feedbackSubmit(input: $input) {
         errors {
           code
           message
           path
         }
    +    success
       }
     }
     
    Variables
    -
    {"input": LnNoAmountInvoiceFeeProbeInput}
    +                  
    {"input": FeedbackSubmitInput}
     
    Response
    {
       "data": {
    -    "lnNoAmountInvoiceFeeProbe": {
    -      "amount": SatAmount,
    -      "errors": [Error]
    +    "feedbackSubmit": {
    +      "errors": [Error],
    +      "success": false
         }
       }
     }
    @@ -3428,26 +4138,18 @@ 
    Response
    -
    +

    - lnNoAmountInvoicePaymentSend + idDocumentUploadUrlGenerate

    -
    -
    -
    -
    Description
    -

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

    -
    -
    -
    Response
    -

    Returns a PaymentSendPayload! +

    Returns an IdDocumentUploadUrlPayload!

    @@ -3462,7 +4164,7 @@
    Arguments
    - input - LnNoAmountInvoicePaymentInput! + input - IdDocumentUploadUrlGenerateInput! @@ -3475,30 +4177,32 @@
    Arguments

    Example

    Query
    -
    mutation LnNoAmountInvoicePaymentSend($input: LnNoAmountInvoicePaymentInput!) {
    -  lnNoAmountInvoicePaymentSend(input: $input) {
    +                  
    mutation IdDocumentUploadUrlGenerate($input: IdDocumentUploadUrlGenerateInput!) {
    +  idDocumentUploadUrlGenerate(input: $input) {
         errors {
           code
           message
           path
         }
    -    status
    +    fileKey
    +    uploadUrl
       }
     }
     
    Variables
    -
    {"input": LnNoAmountInvoicePaymentInput}
    +                  
    {"input": IdDocumentUploadUrlGenerateInput}
     
    Response
    {
       "data": {
    -    "lnNoAmountInvoicePaymentSend": {
    +    "idDocumentUploadUrlGenerate": {
           "errors": [Error],
    -      "status": "ALREADY_PAID"
    +      "fileKey": "xyz789",
    +      "uploadUrl": "xyz789"
         }
       }
     }
    @@ -3507,18 +4211,26 @@ 
    Response
    -
    +

    - lnNoAmountUsdInvoiceFeeProbe + initiateCashout

    +
    +
    +
    +
    Description
    +

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

    +
    +
    +
    Response
    -

    Returns a CentAmountPayload! +

    Returns an InitiatedCashoutResponse!

    @@ -3533,7 +4245,7 @@
    Arguments
    - input - LnNoAmountUsdInvoiceFeeProbeInput! + input - InitiateCashoutInput! @@ -3546,30 +4258,30 @@
    Arguments

    Example

    Query
    -
    mutation LnNoAmountUsdInvoiceFeeProbe($input: LnNoAmountUsdInvoiceFeeProbeInput!) {
    -  lnNoAmountUsdInvoiceFeeProbe(input: $input) {
    -    amount
    +                  
    mutation InitiateCashout($input: InitiateCashoutInput!) {
    +  initiateCashout(input: $input) {
         errors {
           code
           message
           path
         }
    +    id
       }
     }
     
    Variables
    -
    {"input": LnNoAmountUsdInvoiceFeeProbeInput}
    +                  
    {"input": InitiateCashoutInput}
     
    Response
    {
       "data": {
    -    "lnNoAmountUsdInvoiceFeeProbe": {
    -      "amount": CentAmount,
    -      "errors": [Error]
    +    "initiateCashout": {
    +      "errors": [Error],
    +      "id": "4"
         }
       }
     }
    @@ -3578,18 +4290,18 @@ 
    Response
    -
    +

    - lnNoAmountUsdInvoicePaymentSend + intraLedgerPaymentSend

    Description
    -

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

    +

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

    @@ -3612,7 +4324,7 @@
    Arguments
    - input - LnNoAmountUsdInvoicePaymentInput! + input - IntraLedgerPaymentSendInput! @@ -3625,8 +4337,8 @@
    Arguments

    Example

    Query
    -
    mutation LnNoAmountUsdInvoicePaymentSend($input: LnNoAmountUsdInvoicePaymentInput!) {
    -  lnNoAmountUsdInvoicePaymentSend(input: $input) {
    +                  
    mutation IntraLedgerPaymentSend($input: IntraLedgerPaymentSendInput!) {
    +  intraLedgerPaymentSend(input: $input) {
         errors {
           code
           message
    @@ -3639,14 +4351,14 @@ 
    Query
    Variables
    -
    {"input": LnNoAmountUsdInvoicePaymentInput}
    +                  
    {"input": IntraLedgerPaymentSendInput}
     
    Response
    {
       "data": {
    -    "lnNoAmountUsdInvoicePaymentSend": {
    +    "intraLedgerPaymentSend": {
           "errors": [Error],
           "status": "ALREADY_PAID"
         }
    @@ -3657,18 +4369,19 @@ 
    Response
    -
    +

    - lnUsdInvoiceCreate + intraLedgerUsdPaymentSend

    Description
    -

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

    +

    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.

    @@ -3676,7 +4389,7 @@
    Description
    Response
    -

    Returns a LnInvoicePayload! +

    Returns a PaymentSendPayload!

    @@ -3691,7 +4404,7 @@
    Arguments
    - input - LnUsdInvoiceCreateInput! + input - IntraLedgerUsdPaymentSendInput! @@ -3704,35 +4417,30 @@
    Arguments

    Example

    Query
    -
    mutation LnUsdInvoiceCreate($input: LnUsdInvoiceCreateInput!) {
    -  lnUsdInvoiceCreate(input: $input) {
    +                  
    mutation IntraLedgerUsdPaymentSend($input: IntraLedgerUsdPaymentSendInput!) {
    +  intraLedgerUsdPaymentSend(input: $input) {
         errors {
           code
           message
           path
         }
    -    invoice {
    -      paymentHash
    -      paymentRequest
    -      paymentSecret
    -      satoshis
    -    }
    +    status
       }
     }
     
    Variables
    -
    {"input": LnUsdInvoiceCreateInput}
    +                  
    {"input": IntraLedgerUsdPaymentSendInput}
     
    Response
    {
       "data": {
    -    "lnUsdInvoiceCreate": {
    +    "intraLedgerUsdPaymentSend": {
           "errors": [Error],
    -      "invoice": LnInvoice
    +      "status": "ALREADY_PAID"
         }
       }
     }
    @@ -3741,18 +4449,18 @@ 
    Response
    -
    +

    - lnUsdInvoiceCreateOnBehalfOfRecipient + lnInvoiceCreate

    Description
    -

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

    +

    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.

    @@ -3775,7 +4483,7 @@
    Arguments
    - input - LnUsdInvoiceCreateOnBehalfOfRecipientInput! + input - LnInvoiceCreateInput! @@ -3788,8 +4496,8 @@
    Arguments

    Example

    Query
    -
    mutation LnUsdInvoiceCreateOnBehalfOfRecipient($input: LnUsdInvoiceCreateOnBehalfOfRecipientInput!) {
    -  lnUsdInvoiceCreateOnBehalfOfRecipient(input: $input) {
    +                  
    mutation LnInvoiceCreate($input: LnInvoiceCreateInput!) {
    +  lnInvoiceCreate(input: $input) {
         errors {
           code
           message
    @@ -3807,14 +4515,14 @@ 
    Query
    Variables
    -
    {"input": LnUsdInvoiceCreateOnBehalfOfRecipientInput}
    +                  
    {"input": LnInvoiceCreateInput}
     
    Response
    {
       "data": {
    -    "lnUsdInvoiceCreateOnBehalfOfRecipient": {
    +    "lnInvoiceCreate": {
           "errors": [Error],
           "invoice": LnInvoice
         }
    @@ -3825,18 +4533,26 @@ 
    Response
    -
    +

    - lnUsdInvoiceFeeProbe + lnInvoiceCreateOnBehalfOfRecipient

    +
    +
    +
    +
    Description
    +

    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.

    +
    +
    +
    Response
    -

    Returns a CentAmountPayload! +

    Returns a LnInvoicePayload!

    @@ -3851,7 +4567,7 @@
    Arguments
    - input - LnUsdInvoiceFeeProbeInput! + input - LnInvoiceCreateOnBehalfOfRecipientInput! @@ -3864,30 +4580,35 @@
    Arguments

    Example

    Query
    -
    mutation LnUsdInvoiceFeeProbe($input: LnUsdInvoiceFeeProbeInput!) {
    -  lnUsdInvoiceFeeProbe(input: $input) {
    -    amount
    +                  
    mutation LnInvoiceCreateOnBehalfOfRecipient($input: LnInvoiceCreateOnBehalfOfRecipientInput!) {
    +  lnInvoiceCreateOnBehalfOfRecipient(input: $input) {
         errors {
           code
           message
           path
         }
    +    invoice {
    +      paymentHash
    +      paymentRequest
    +      paymentSecret
    +      satoshis
    +    }
       }
     }
     
    Variables
    -
    {"input": LnUsdInvoiceFeeProbeInput}
    +                  
    {"input": LnInvoiceCreateOnBehalfOfRecipientInput}
     
    Response
    {
       "data": {
    -    "lnUsdInvoiceFeeProbe": {
    -      "amount": CentAmount,
    -      "errors": [Error]
    +    "lnInvoiceCreateOnBehalfOfRecipient": {
    +      "errors": [Error],
    +      "invoice": LnInvoice
         }
       }
     }
    @@ -3896,18 +4617,18 @@ 
    Response
    -
    +

    - merchantMapSuggest + lnInvoiceFeeProbe

    Response
    -

    Returns a MerchantPayload! +

    Returns a SatAmountPayload!

    @@ -3922,7 +4643,7 @@
    Arguments
    - input - MerchantMapSuggestInput! + input - LnInvoiceFeeProbeInput! @@ -3935,39 +4656,30 @@
    Arguments

    Example

    Query
    -
    mutation MerchantMapSuggest($input: MerchantMapSuggestInput!) {
    -  merchantMapSuggest(input: $input) {
    +                  
    mutation LnInvoiceFeeProbe($input: LnInvoiceFeeProbeInput!) {
    +  lnInvoiceFeeProbe(input: $input) {
    +    amount
         errors {
           code
           message
           path
         }
    -    merchant {
    -      coordinates {
    -        ...CoordinatesFragment
    -      }
    -      createdAt
    -      id
    -      title
    -      username
    -      validated
    -    }
       }
     }
     
    Variables
    -
    {"input": MerchantMapSuggestInput}
    +                  
    {"input": LnInvoiceFeeProbeInput}
     
    Response
    {
       "data": {
    -    "merchantMapSuggest": {
    -      "errors": [Error],
    -      "merchant": Merchant
    +    "lnInvoiceFeeProbe": {
    +      "amount": SatAmount,
    +      "errors": [Error]
         }
       }
     }
    @@ -3976,18 +4688,26 @@ 
    Response
    -
    +

    - onChainAddressCreate + lnInvoicePaymentSend

    +
    +
    +
    +
    Description
    +

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

    +
    +
    +
    Response
    -

    Returns an OnChainAddressPayload! +

    Returns a PaymentSendPayload!

    @@ -4002,7 +4722,7 @@
    Arguments
    - input - OnChainAddressCreateInput! + input - LnInvoicePaymentInput! @@ -4015,30 +4735,30 @@
    Arguments

    Example

    Query
    -
    mutation OnChainAddressCreate($input: OnChainAddressCreateInput!) {
    -  onChainAddressCreate(input: $input) {
    -    address
    +                  
    mutation LnInvoicePaymentSend($input: LnInvoicePaymentInput!) {
    +  lnInvoicePaymentSend(input: $input) {
         errors {
           code
           message
           path
         }
    +    status
       }
     }
     
    Variables
    -
    {"input": OnChainAddressCreateInput}
    +                  
    {"input": LnInvoicePaymentInput}
     
    Response
    {
       "data": {
    -    "onChainAddressCreate": {
    -      "address": OnChainAddress,
    -      "errors": [Error]
    +    "lnInvoicePaymentSend": {
    +      "errors": [Error],
    +      "status": "ALREADY_PAID"
         }
       }
     }
    @@ -4047,18 +4767,26 @@ 
    Response
    -
    +

    - onChainAddressCurrent + lnNoAmountInvoiceCreate

    +
    +
    +
    +
    Description
    +

    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.

    +
    +
    +
    Response
    -

    Returns an OnChainAddressPayload! +

    Returns a LnNoAmountInvoicePayload!

    @@ -4073,7 +4801,7 @@
    Arguments
    - input - OnChainAddressCurrentInput! + input - LnNoAmountInvoiceCreateInput! @@ -4086,30 +4814,34 @@
    Arguments

    Example

    Query
    -
    mutation OnChainAddressCurrent($input: OnChainAddressCurrentInput!) {
    -  onChainAddressCurrent(input: $input) {
    -    address
    +                  
    mutation LnNoAmountInvoiceCreate($input: LnNoAmountInvoiceCreateInput!) {
    +  lnNoAmountInvoiceCreate(input: $input) {
         errors {
           code
           message
           path
         }
    +    invoice {
    +      paymentHash
    +      paymentRequest
    +      paymentSecret
    +    }
       }
     }
     
    Variables
    -
    {"input": OnChainAddressCurrentInput}
    +                  
    {"input": LnNoAmountInvoiceCreateInput}
     
    Response
    {
       "data": {
    -    "onChainAddressCurrent": {
    -      "address": OnChainAddress,
    -      "errors": [Error]
    +    "lnNoAmountInvoiceCreate": {
    +      "errors": [Error],
    +      "invoice": LnNoAmountInvoice
         }
       }
     }
    @@ -4118,18 +4850,26 @@ 
    Response
    -
    +

    - onChainPaymentSend + lnNoAmountInvoiceCreateOnBehalfOfRecipient

    +
    +
    +
    +
    Description
    +

    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.

    +
    +
    +
    Response
    -

    Returns a PaymentSendPayload! +

    Returns a LnNoAmountInvoicePayload!

    @@ -4144,7 +4884,7 @@
    Arguments
    - input - OnChainPaymentSendInput! + input - LnNoAmountInvoiceCreateOnBehalfOfRecipientInput! @@ -4157,30 +4897,34 @@
    Arguments

    Example

    Query
    -
    mutation OnChainPaymentSend($input: OnChainPaymentSendInput!) {
    -  onChainPaymentSend(input: $input) {
    +                  
    mutation LnNoAmountInvoiceCreateOnBehalfOfRecipient($input: LnNoAmountInvoiceCreateOnBehalfOfRecipientInput!) {
    +  lnNoAmountInvoiceCreateOnBehalfOfRecipient(input: $input) {
         errors {
           code
           message
           path
         }
    -    status
    +    invoice {
    +      paymentHash
    +      paymentRequest
    +      paymentSecret
    +    }
       }
     }
     
    Variables
    -
    {"input": OnChainPaymentSendInput}
    +                  
    {"input": LnNoAmountInvoiceCreateOnBehalfOfRecipientInput}
     
    Response
    {
       "data": {
    -    "onChainPaymentSend": {
    +    "lnNoAmountInvoiceCreateOnBehalfOfRecipient": {
           "errors": [Error],
    -      "status": "ALREADY_PAID"
    +      "invoice": LnNoAmountInvoice
         }
       }
     }
    @@ -4189,18 +4933,18 @@ 
    Response
    -
    +

    - onChainPaymentSendAll + lnNoAmountInvoiceFeeProbe

    Response
    -

    Returns a PaymentSendPayload! +

    Returns a SatAmountPayload!

    @@ -4215,7 +4959,7 @@
    Arguments
    - input - OnChainPaymentSendAllInput! + input - LnNoAmountInvoiceFeeProbeInput! @@ -4228,30 +4972,30 @@
    Arguments

    Example

    Query
    -
    mutation OnChainPaymentSendAll($input: OnChainPaymentSendAllInput!) {
    -  onChainPaymentSendAll(input: $input) {
    +                  
    mutation LnNoAmountInvoiceFeeProbe($input: LnNoAmountInvoiceFeeProbeInput!) {
    +  lnNoAmountInvoiceFeeProbe(input: $input) {
    +    amount
         errors {
           code
           message
           path
         }
    -    status
       }
     }
     
    Variables
    -
    {"input": OnChainPaymentSendAllInput}
    +                  
    {"input": LnNoAmountInvoiceFeeProbeInput}
     
    Response
    {
       "data": {
    -    "onChainPaymentSendAll": {
    -      "errors": [Error],
    -      "status": "ALREADY_PAID"
    +    "lnNoAmountInvoiceFeeProbe": {
    +      "amount": SatAmount,
    +      "errors": [Error]
         }
       }
     }
    @@ -4260,13 +5004,21 @@ 
    Response
    -
    +

    - onChainUsdPaymentSend + lnNoAmountInvoicePaymentSend

    +
    +
    +
    +
    Description
    +

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

    +
    +
    +
    @@ -4286,7 +5038,7 @@
    Arguments
    - input - OnChainUsdPaymentSendInput! + input - LnNoAmountInvoicePaymentInput! @@ -4299,8 +5051,8 @@
    Arguments

    Example

    Query
    -
    mutation OnChainUsdPaymentSend($input: OnChainUsdPaymentSendInput!) {
    -  onChainUsdPaymentSend(input: $input) {
    +                  
    mutation LnNoAmountInvoicePaymentSend($input: LnNoAmountInvoicePaymentInput!) {
    +  lnNoAmountInvoicePaymentSend(input: $input) {
         errors {
           code
           message
    @@ -4313,14 +5065,14 @@ 
    Query
    Variables
    -
    {"input": OnChainUsdPaymentSendInput}
    +                  
    {"input": LnNoAmountInvoicePaymentInput}
     
    Response
    {
       "data": {
    -    "onChainUsdPaymentSend": {
    +    "lnNoAmountInvoicePaymentSend": {
           "errors": [Error],
           "status": "ALREADY_PAID"
         }
    @@ -4331,18 +5083,18 @@ 
    Response
    -
    +

    - onChainUsdPaymentSendAsBtcDenominated + lnNoAmountUsdInvoiceFeeProbe

    Response
    -

    Returns a PaymentSendPayload! +

    Returns a CentAmountPayload!

    @@ -4357,7 +5109,7 @@
    Arguments
    - input - OnChainUsdPaymentSendAsBtcDenominatedInput! + input - LnNoAmountUsdInvoiceFeeProbeInput! @@ -4370,30 +5122,32 @@
    Arguments

    Example

    Query
    -
    mutation OnChainUsdPaymentSendAsBtcDenominated($input: OnChainUsdPaymentSendAsBtcDenominatedInput!) {
    -  onChainUsdPaymentSendAsBtcDenominated(input: $input) {
    +                  
    mutation LnNoAmountUsdInvoiceFeeProbe($input: LnNoAmountUsdInvoiceFeeProbeInput!) {
    +  lnNoAmountUsdInvoiceFeeProbe(input: $input) {
    +    amount
         errors {
           code
           message
           path
         }
    -    status
    +    invoiceAmount
       }
     }
     
    Variables
    -
    {"input": OnChainUsdPaymentSendAsBtcDenominatedInput}
    +                  
    {"input": LnNoAmountUsdInvoiceFeeProbeInput}
     
    Response
    {
       "data": {
    -    "onChainUsdPaymentSendAsBtcDenominated": {
    +    "lnNoAmountUsdInvoiceFeeProbe": {
    +      "amount": USDCents,
           "errors": [Error],
    -      "status": "ALREADY_PAID"
    +      "invoiceAmount": USDCents
         }
       }
     }
    @@ -4402,18 +5156,26 @@ 
    Response
    -
    +

    - quizCompleted + lnNoAmountUsdInvoicePaymentSend

    +
    +
    +
    +
    Description
    +

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

    +
    +
    +
    Response
    -

    Returns a QuizCompletedPayload! +

    Returns a PaymentSendPayload!

    @@ -4428,7 +5190,7 @@
    Arguments
    - input - QuizCompletedInput! + input - LnNoAmountUsdInvoicePaymentInput! @@ -4441,34 +5203,30 @@
    Arguments

    Example

    Query
    -
    mutation QuizCompleted($input: QuizCompletedInput!) {
    -  quizCompleted(input: $input) {
    +                  
    mutation LnNoAmountUsdInvoicePaymentSend($input: LnNoAmountUsdInvoicePaymentInput!) {
    +  lnNoAmountUsdInvoicePaymentSend(input: $input) {
         errors {
           code
           message
           path
         }
    -    quiz {
    -      amount
    -      completed
    -      id
    -    }
    +    status
       }
     }
     
    Variables
    -
    {"input": QuizCompletedInput}
    +                  
    {"input": LnNoAmountUsdInvoicePaymentInput}
     
    Response
    {
       "data": {
    -    "quizCompleted": {
    +    "lnNoAmountUsdInvoicePaymentSend": {
           "errors": [Error],
    -      "quiz": Quiz
    +      "status": "ALREADY_PAID"
         }
       }
     }
    @@ -4477,17 +5235,18 @@ 
    Response
    -
    +
    -

    - userContactUpdateAlias +

    + lnUsdInvoiceCreate

    -
    -
    will be moved to AccountContact
    +
    +
    Description
    +

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

    @@ -4495,7 +5254,7 @@

    Response
    -

    Returns a UserContactUpdateAliasPayload! +

    Returns a LnInvoicePayload!

    @@ -4510,7 +5269,7 @@
    Arguments
    - input - UserContactUpdateAliasInput! + input - LnUsdInvoiceCreateInput! @@ -4523,38 +5282,35 @@
    Arguments

    Example

    Query
    -
    mutation UserContactUpdateAlias($input: UserContactUpdateAliasInput!) {
    -  userContactUpdateAlias(input: $input) {
    -    contact {
    -      alias
    -      id
    -      transactions {
    -        ...TransactionConnectionFragment
    -      }
    -      transactionsCount
    -      username
    -    }
    +                  
    mutation LnUsdInvoiceCreate($input: LnUsdInvoiceCreateInput!) {
    +  lnUsdInvoiceCreate(input: $input) {
         errors {
           code
           message
           path
         }
    +    invoice {
    +      paymentHash
    +      paymentRequest
    +      paymentSecret
    +      satoshis
    +    }
       }
     }
     
    Variables
    -
    {"input": UserContactUpdateAliasInput}
    +                  
    {"input": LnUsdInvoiceCreateInput}
     
    Response
    {
       "data": {
    -    "userContactUpdateAlias": {
    -      "contact": UserContact,
    -      "errors": [Error]
    +    "lnUsdInvoiceCreate": {
    +      "errors": [Error],
    +      "invoice": LnInvoice
         }
       }
     }
    @@ -4563,67 +5319,82 @@ 
    Response

    -
    +

    - userEmailDelete + lnUsdInvoiceCreateOnBehalfOfRecipient

    +
    +
    +
    +
    Description
    +

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

    +
    +
    +
    Response
    -

    Returns a UserEmailDeletePayload! +

    Returns a LnInvoicePayload!

    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - LnUsdInvoiceCreateOnBehalfOfRecipientInput! + +
    +

    Example

    Query
    -
    mutation UserEmailDelete {
    -  userEmailDelete {
    +                  
    mutation LnUsdInvoiceCreateOnBehalfOfRecipient($input: LnUsdInvoiceCreateOnBehalfOfRecipientInput!) {
    +  lnUsdInvoiceCreateOnBehalfOfRecipient(input: $input) {
         errors {
           code
           message
           path
         }
    -    me {
    -      contactByUsername {
    -        ...UserContactFragment
    -      }
    -      contacts {
    -        ...UserContactFragment
    -      }
    -      createdAt
    -      defaultAccount {
    -        ...AccountFragment
    -      }
    -      email {
    -        ...EmailFragment
    -      }
    -      id
    -      language
    -      npub
    -      phone
    -      quizQuestions {
    -        ...UserQuizQuestionFragment
    -      }
    -      totpEnabled
    -      username
    +    invoice {
    +      paymentHash
    +      paymentRequest
    +      paymentSecret
    +      satoshis
         }
       }
     }
    +
    +
    +
    +
    Variables
    +
    {"input": LnUsdInvoiceCreateOnBehalfOfRecipientInput}
     
    Response
    {
       "data": {
    -    "userEmailDelete": {
    +    "lnUsdInvoiceCreateOnBehalfOfRecipient": {
           "errors": [Error],
    -      "me": User
    +      "invoice": LnInvoice
         }
       }
     }
    @@ -4632,18 +5403,18 @@ 
    Response
    -
    +

    - userEmailRegistrationInitiate + lnUsdInvoiceFeeProbe

    @@ -4658,7 +5429,7 @@
    Arguments
    - input - UserEmailRegistrationInitiateInput! + input - LnUsdInvoiceFeeProbeInput! @@ -4671,55 +5442,32 @@
    Arguments

    Example

    Query
    -
    mutation UserEmailRegistrationInitiate($input: UserEmailRegistrationInitiateInput!) {
    -  userEmailRegistrationInitiate(input: $input) {
    -    emailRegistrationId
    +                  
    mutation LnUsdInvoiceFeeProbe($input: LnUsdInvoiceFeeProbeInput!) {
    +  lnUsdInvoiceFeeProbe(input: $input) {
    +    amount
         errors {
           code
           message
           path
         }
    -    me {
    -      contactByUsername {
    -        ...UserContactFragment
    -      }
    -      contacts {
    -        ...UserContactFragment
    -      }
    -      createdAt
    -      defaultAccount {
    -        ...AccountFragment
    -      }
    -      email {
    -        ...EmailFragment
    -      }
    -      id
    -      language
    -      npub
    -      phone
    -      quizQuestions {
    -        ...UserQuizQuestionFragment
    -      }
    -      totpEnabled
    -      username
    -    }
    +    invoiceAmount
       }
     }
     
    Variables
    -
    {"input": UserEmailRegistrationInitiateInput}
    +                  
    {"input": LnUsdInvoiceFeeProbeInput}
     
    Response
    {
       "data": {
    -    "userEmailRegistrationInitiate": {
    -      "emailRegistrationId": EmailRegistrationId,
    +    "lnUsdInvoiceFeeProbe": {
    +      "amount": USDCents,
           "errors": [Error],
    -      "me": User
    +      "invoiceAmount": USDCents
         }
       }
     }
    @@ -4728,18 +5476,26 @@ 
    Response
    -
    +

    - userEmailRegistrationValidate + lnurlPaymentSend

    +
    +
    +
    +
    Description
    +

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

    +
    +
    +
    @@ -4754,7 +5510,7 @@
    Arguments
    - input - UserEmailRegistrationValidateInput! + input - LnurlPaymentSendInput! @@ -4767,53 +5523,30 @@
    Arguments

    Example

    Query
    -
    mutation UserEmailRegistrationValidate($input: UserEmailRegistrationValidateInput!) {
    -  userEmailRegistrationValidate(input: $input) {
    +                  
    mutation LnurlPaymentSend($input: LnurlPaymentSendInput!) {
    +  lnurlPaymentSend(input: $input) {
         errors {
           code
           message
           path
         }
    -    me {
    -      contactByUsername {
    -        ...UserContactFragment
    -      }
    -      contacts {
    -        ...UserContactFragment
    -      }
    -      createdAt
    -      defaultAccount {
    -        ...AccountFragment
    -      }
    -      email {
    -        ...EmailFragment
    -      }
    -      id
    -      language
    -      npub
    -      phone
    -      quizQuestions {
    -        ...UserQuizQuestionFragment
    -      }
    -      totpEnabled
    -      username
    -    }
    +    status
       }
     }
     
    Variables
    -
    {"input": UserEmailRegistrationValidateInput}
    +                  
    {"input": LnurlPaymentSendInput}
     
    Response
    {
       "data": {
    -    "userEmailRegistrationValidate": {
    +    "lnurlPaymentSend": {
           "errors": [Error],
    -      "me": User
    +      "status": "ALREADY_PAID"
         }
       }
     }
    @@ -4822,18 +5555,18 @@ 
    Response
    -
    +

    - userLogin + merchantMapSuggest

    Response
    -

    Returns an AuthTokenPayload! +

    Returns a MerchantPayload!

    @@ -4848,7 +5581,7 @@
    Arguments
    - input - UserLoginInput! + input - MerchantMapSuggestInput! @@ -4861,32 +5594,39 @@
    Arguments

    Example

    Query
    -
    mutation UserLogin($input: UserLoginInput!) {
    -  userLogin(input: $input) {
    -    authToken
    +                  
    mutation MerchantMapSuggest($input: MerchantMapSuggestInput!) {
    +  merchantMapSuggest(input: $input) {
         errors {
           code
           message
           path
         }
    -    totpRequired
    +    merchant {
    +      coordinates {
    +        ...CoordinatesFragment
    +      }
    +      createdAt
    +      id
    +      title
    +      username
    +      validated
    +    }
       }
     }
     
    Variables
    -
    {"input": UserLoginInput}
    +                  
    {"input": MerchantMapSuggestInput}
     
    Response
    {
       "data": {
    -    "userLogin": {
    -      "authToken": AuthToken,
    +    "merchantMapSuggest": {
           "errors": [Error],
    -      "totpRequired": true
    +      "merchant": Merchant
         }
       }
     }
    @@ -4895,18 +5635,18 @@ 
    Response
    -
    +

    - userLoginUpgrade + onChainAddressCreate

    Response
    -

    Returns an UpgradePayload! +

    Returns an OnChainAddressPayload!

    @@ -4921,7 +5661,7 @@
    Arguments
    - input - UserLoginUpgradeInput! + input - OnChainAddressCreateInput! @@ -4934,32 +5674,30 @@
    Arguments

    Example

    Query
    -
    mutation UserLoginUpgrade($input: UserLoginUpgradeInput!) {
    -  userLoginUpgrade(input: $input) {
    -    authToken
    +                  
    mutation OnChainAddressCreate($input: OnChainAddressCreateInput!) {
    +  onChainAddressCreate(input: $input) {
    +    address
         errors {
           code
           message
           path
         }
    -    success
       }
     }
     
    Variables
    -
    {"input": UserLoginUpgradeInput}
    +                  
    {"input": OnChainAddressCreateInput}
     
    Response
    {
       "data": {
    -    "userLoginUpgrade": {
    -      "authToken": AuthToken,
    -      "errors": [Error],
    -      "success": false
    +    "onChainAddressCreate": {
    +      "address": OnChainAddress,
    +      "errors": [Error]
         }
       }
     }
    @@ -4968,18 +5706,18 @@ 
    Response
    -
    +

    - userLogout + onChainAddressCurrent

    Response
    -

    Returns a SuccessPayload! +

    Returns an OnChainAddressPayload!

    @@ -4994,7 +5732,7 @@
    Arguments
    - input - UserLogoutInput + input - OnChainAddressCurrentInput! @@ -5007,28 +5745,31 @@
    Arguments

    Example

    Query
    -
    mutation UserLogout($input: UserLogoutInput) {
    -  userLogout(input: $input) {
    +                  
    mutation OnChainAddressCurrent($input: OnChainAddressCurrentInput!) {
    +  onChainAddressCurrent(input: $input) {
    +    address
         errors {
           code
           message
           path
         }
    -    success
       }
    -}
    +}
     
    Variables
    -
    {"input": UserLogoutInput}
    +                  
    {"input": OnChainAddressCurrentInput}
     
    Response
    {
       "data": {
    -    "userLogout": {"errors": [Error], "success": false}
    +    "onChainAddressCurrent": {
    +      "address": OnChainAddress,
    +      "errors": [Error]
    +    }
       }
     }
     
    @@ -5036,67 +5777,69 @@
    Response
    -
    +

    - userPhoneDelete + onChainPaymentSend

    Response
    -

    Returns a UserPhoneDeletePayload! +

    Returns a PaymentSendPayload!

    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - OnChainPaymentSendInput! + +
    +

    Example

    Query
    -
    mutation UserPhoneDelete {
    -  userPhoneDelete {
    +                  
    mutation OnChainPaymentSend($input: OnChainPaymentSendInput!) {
    +  onChainPaymentSend(input: $input) {
         errors {
           code
           message
           path
         }
    -    me {
    -      contactByUsername {
    -        ...UserContactFragment
    -      }
    -      contacts {
    -        ...UserContactFragment
    -      }
    -      createdAt
    -      defaultAccount {
    -        ...AccountFragment
    -      }
    -      email {
    -        ...EmailFragment
    -      }
    -      id
    -      language
    -      npub
    -      phone
    -      quizQuestions {
    -        ...UserQuizQuestionFragment
    -      }
    -      totpEnabled
    -      username
    -    }
    +    status
       }
     }
    +
    +
    +
    +
    Variables
    +
    {"input": OnChainPaymentSendInput}
     
    Response
    {
       "data": {
    -    "userPhoneDelete": {
    +    "onChainPaymentSend": {
           "errors": [Error],
    -      "me": User
    +      "status": "ALREADY_PAID"
         }
       }
     }
    @@ -5105,18 +5848,18 @@ 
    Response
    -
    +

    - userPhoneRegistrationInitiate + onChainPaymentSendAll

    Response
    -

    Returns a SuccessPayload! +

    Returns a PaymentSendPayload!

    @@ -5131,7 +5874,7 @@
    Arguments
    - input - UserPhoneRegistrationInitiateInput! + input - OnChainPaymentSendAllInput! @@ -5144,30 +5887,30 @@
    Arguments

    Example

    Query
    -
    mutation UserPhoneRegistrationInitiate($input: UserPhoneRegistrationInitiateInput!) {
    -  userPhoneRegistrationInitiate(input: $input) {
    +                  
    mutation OnChainPaymentSendAll($input: OnChainPaymentSendAllInput!) {
    +  onChainPaymentSendAll(input: $input) {
         errors {
           code
           message
           path
         }
    -    success
    +    status
       }
     }
     
    Variables
    -
    {"input": UserPhoneRegistrationInitiateInput}
    +                  
    {"input": OnChainPaymentSendAllInput}
     
    Response
    {
       "data": {
    -    "userPhoneRegistrationInitiate": {
    +    "onChainPaymentSendAll": {
           "errors": [Error],
    -      "success": true
    +      "status": "ALREADY_PAID"
         }
       }
     }
    @@ -5176,18 +5919,18 @@ 
    Response
    -
    +

    - userPhoneRegistrationValidate + onChainUsdPaymentSend

    @@ -5202,7 +5945,7 @@
    Arguments
    - input - UserPhoneRegistrationValidateInput! + input - OnChainUsdPaymentSendInput! @@ -5215,53 +5958,30 @@
    Arguments

    Example

    Query
    -
    mutation UserPhoneRegistrationValidate($input: UserPhoneRegistrationValidateInput!) {
    -  userPhoneRegistrationValidate(input: $input) {
    +                  
    mutation OnChainUsdPaymentSend($input: OnChainUsdPaymentSendInput!) {
    +  onChainUsdPaymentSend(input: $input) {
         errors {
           code
           message
           path
         }
    -    me {
    -      contactByUsername {
    -        ...UserContactFragment
    -      }
    -      contacts {
    -        ...UserContactFragment
    -      }
    -      createdAt
    -      defaultAccount {
    -        ...AccountFragment
    -      }
    -      email {
    -        ...EmailFragment
    -      }
    -      id
    -      language
    -      npub
    -      phone
    -      quizQuestions {
    -        ...UserQuizQuestionFragment
    -      }
    -      totpEnabled
    -      username
    -    }
    +    status
       }
     }
     
    Variables
    -
    {"input": UserPhoneRegistrationValidateInput}
    +                  
    {"input": OnChainUsdPaymentSendInput}
     
    Response
    {
       "data": {
    -    "userPhoneRegistrationValidate": {
    +    "onChainUsdPaymentSend": {
           "errors": [Error],
    -      "me": User
    +      "status": "ALREADY_PAID"
         }
       }
     }
    @@ -5270,25 +5990,18 @@ 
    Response
    -
    +
    -

    - userQuizQuestionUpdateCompleted +

    + onChainUsdPaymentSendAsBtcDenominated

    -
    -
    -
    -
    Use QuizCompletedMutation instead
    -
    -
    -
    @@ -5303,7 +6016,7 @@
    Arguments
    - input - UserQuizQuestionUpdateCompletedInput! + input - OnChainUsdPaymentSendAsBtcDenominatedInput! @@ -5316,35 +6029,30 @@
    Arguments

    Example

    Query
    -
    mutation UserQuizQuestionUpdateCompleted($input: UserQuizQuestionUpdateCompletedInput!) {
    -  userQuizQuestionUpdateCompleted(input: $input) {
    +                  
    mutation OnChainUsdPaymentSendAsBtcDenominated($input: OnChainUsdPaymentSendAsBtcDenominatedInput!) {
    +  onChainUsdPaymentSendAsBtcDenominated(input: $input) {
         errors {
           code
           message
           path
         }
    -    userQuizQuestion {
    -      completed
    -      question {
    -        ...QuizQuestionFragment
    -      }
    -    }
    +    status
       }
     }
     
    Variables
    -
    {"input": UserQuizQuestionUpdateCompletedInput}
    +                  
    {"input": OnChainUsdPaymentSendAsBtcDenominatedInput}
     
    Response
    {
       "data": {
    -    "userQuizQuestionUpdateCompleted": {
    +    "onChainUsdPaymentSendAsBtcDenominated": {
           "errors": [Error],
    -      "userQuizQuestion": UserQuizQuestion
    +      "status": "ALREADY_PAID"
         }
       }
     }
    @@ -5353,18 +6061,18 @@ 
    Response
    -
    +

    - userTotpDelete + quizCompleted

    Response
    -

    Returns a UserTotpDeletePayload! +

    Returns a QuizCompletedPayload!

    @@ -5379,7 +6087,7 @@
    Arguments
    - input - UserTotpDeleteInput! + input - QuizCompletedInput! @@ -5392,36 +6100,17 @@
    Arguments

    Example

    Query
    -
    mutation UserTotpDelete($input: UserTotpDeleteInput!) {
    -  userTotpDelete(input: $input) {
    +                  
    mutation QuizCompleted($input: QuizCompletedInput!) {
    +  quizCompleted(input: $input) {
         errors {
           code
           message
           path
         }
    -    me {
    -      contactByUsername {
    -        ...UserContactFragment
    -      }
    -      contacts {
    -        ...UserContactFragment
    -      }
    -      createdAt
    -      defaultAccount {
    -        ...AccountFragment
    -      }
    -      email {
    -        ...EmailFragment
    -      }
    +    quiz {
    +      amount
    +      completed
           id
    -      language
    -      npub
    -      phone
    -      quizQuestions {
    -        ...UserQuizQuestionFragment
    -      }
    -      totpEnabled
    -      username
         }
       }
     }
    @@ -5429,16 +6118,16 @@ 
    Query
    Variables
    -
    {"input": UserTotpDeleteInput}
    +                  
    {"input": QuizCompletedInput}
     
    Response
    {
       "data": {
    -    "userTotpDelete": {
    +    "quizCompleted": {
           "errors": [Error],
    -      "me": User
    +      "quiz": Quiz
         }
       }
     }
    @@ -5447,18 +6136,26 @@ 
    Response
    -
    +

    - userTotpRegistrationInitiate + requestCashout

    +
    +
    +
    +
    Description
    +

    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.

    +
    +
    +
    @@ -5473,7 +6170,7 @@
    Arguments
    - input - UserTotpRegistrationInitiateInput! + input - RequestCashoutInput! @@ -5486,32 +6183,39 @@
    Arguments

    Example

    Query
    -
    mutation UserTotpRegistrationInitiate($input: UserTotpRegistrationInitiateInput!) {
    -  userTotpRegistrationInitiate(input: $input) {
    +                  
    mutation RequestCashout($input: RequestCashoutInput!) {
    +  requestCashout(input: $input) {
         errors {
           code
           message
           path
         }
    -    totpRegistrationId
    -    totpSecret
    +    offer {
    +      exchangeRate
    +      expiresAt
    +      flashFee
    +      offerId
    +      receiveJmd
    +      receiveUsd
    +      send
    +      walletId
    +    }
       }
     }
     
    Variables
    -
    {"input": UserTotpRegistrationInitiateInput}
    +                  
    {"input": RequestCashoutInput}
     
    Response
    {
       "data": {
    -    "userTotpRegistrationInitiate": {
    +    "requestCashout": {
           "errors": [Error],
    -      "totpRegistrationId": TotpRegistrationId,
    -      "totpSecret": TotpSecret
    +      "offer": CashoutOffer
         }
       }
     }
    @@ -5520,18 +6224,18 @@ 
    Response
    -
    +

    - userTotpRegistrationValidate + updateExternalWallet

    @@ -5546,7 +6250,7 @@
    Arguments
    - input - UserTotpRegistrationValidateInput! + input - UpdateExternalWalletInput! @@ -5559,53 +6263,30 @@
    Arguments

    Example

    Query
    -
    mutation UserTotpRegistrationValidate($input: UserTotpRegistrationValidateInput!) {
    -  userTotpRegistrationValidate(input: $input) {
    +                  
    mutation UpdateExternalWallet($input: UpdateExternalWalletInput!) {
    +  updateExternalWallet(input: $input) {
         errors {
           code
           message
           path
         }
    -    me {
    -      contactByUsername {
    -        ...UserContactFragment
    -      }
    -      contacts {
    -        ...UserContactFragment
    -      }
    -      createdAt
    -      defaultAccount {
    -        ...AccountFragment
    -      }
    -      email {
    -        ...EmailFragment
    -      }
    -      id
    -      language
    -      npub
    -      phone
    -      quizQuestions {
    -        ...UserQuizQuestionFragment
    -      }
    -      totpEnabled
    -      username
    -    }
    +    walletId
       }
     }
     
    Variables
    -
    {"input": UserTotpRegistrationValidateInput}
    +                  
    {"input": UpdateExternalWalletInput}
     
    Response
    {
       "data": {
    -    "userTotpRegistrationValidate": {
    +    "updateExternalWallet": {
           "errors": [Error],
    -      "me": User
    +      "walletId": WalletId
         }
       }
     }
    @@ -5614,18 +6295,25 @@ 
    Response
    -
    +
    -

    - userUpdateLanguage +

    + userContactUpdateAlias

    +
    +
    +
    +
    will be moved to AccountContact
    +
    +
    +
    @@ -5640,7 +6328,7 @@
    Arguments
    - input - UserUpdateLanguageInput! + input - UserContactUpdateAliasInput! @@ -5653,53 +6341,38 @@
    Arguments

    Example

    Query
    -
    mutation UserUpdateLanguage($input: UserUpdateLanguageInput!) {
    -  userUpdateLanguage(input: $input) {
    +                  
    mutation UserContactUpdateAlias($input: UserContactUpdateAliasInput!) {
    +  userContactUpdateAlias(input: $input) {
    +    contact {
    +      alias
    +      id
    +      transactions {
    +        ...TransactionConnectionFragment
    +      }
    +      transactionsCount
    +      username
    +    }
         errors {
           code
           message
           path
         }
    -    user {
    -      contactByUsername {
    -        ...UserContactFragment
    -      }
    -      contacts {
    -        ...UserContactFragment
    -      }
    -      createdAt
    -      defaultAccount {
    -        ...AccountFragment
    -      }
    -      email {
    -        ...EmailFragment
    -      }
    -      id
    -      language
    -      npub
    -      phone
    -      quizQuestions {
    -        ...UserQuizQuestionFragment
    -      }
    -      totpEnabled
    -      username
    -    }
       }
     }
     
    Variables
    -
    {"input": UserUpdateLanguageInput}
    +                  
    {"input": UserContactUpdateAliasInput}
     
    Response
    {
       "data": {
    -    "userUpdateLanguage": {
    -      "errors": [Error],
    -      "user": User
    +    "userContactUpdateAlias": {
    +      "contact": UserContact,
    +      "errors": [Error]
         }
       }
     }
    @@ -5708,53 +6381,36 @@ 
    Response
    -
    +

    - userUpdateNpub + userEmailDelete

    Response
    -

    Returns a UserUpdateNpubPayload! +

    Returns a UserEmailDeletePayload!

    -
    -
    Arguments
    - - - - - - - - - - - - - -
    NameDescription
    - input - UserUpdateNpubInput! - -
    -

    Example

    Query
    -
    mutation UserUpdateNpub($input: UserUpdateNpubInput!) {
    -  userUpdateNpub(input: $input) {
    +                  
    mutation UserEmailDelete {
    +  userEmailDelete {
         errors {
           code
           message
           path
         }
    -    user {
    +    me {
    +      bankAccounts {
    +        ...BankAccountFragment
    +      }
           contactByUsername {
             ...UserContactFragment
           }
    @@ -5780,20 +6436,15 @@ 
    Query
    }
    }
    }
    -
    -
    -
    -
    Variables
    -
    {"input": UserUpdateNpubInput}
     
    Response
    {
       "data": {
    -    "userUpdateNpub": {
    +    "userEmailDelete": {
           "errors": [Error],
    -      "user": User
    +      "me": User
         }
       }
     }
    @@ -5802,25 +6453,18 @@ 
    Response
    -
    +
    -

    - userUpdateUsername +

    + userEmailRegistrationInitiate

    -
    -
    -
    -
    Username will be moved to @Handle in Accounts. Also SetUsername naming should be used instead of UpdateUsername to reflect the idempotency of Handles
    -
    -
    -
    @@ -5835,7 +6479,7 @@
    Arguments
    - input - UserUpdateUsernameInput! + input - UserEmailRegistrationInitiateInput! @@ -5848,14 +6492,18 @@
    Arguments

    Example

    Query
    -
    mutation UserUpdateUsername($input: UserUpdateUsernameInput!) {
    -  userUpdateUsername(input: $input) {
    +                  
    mutation UserEmailRegistrationInitiate($input: UserEmailRegistrationInitiateInput!) {
    +  userEmailRegistrationInitiate(input: $input) {
    +    emailRegistrationId
         errors {
           code
           message
           path
         }
    -    user {
    +    me {
    +      bankAccounts {
    +        ...BankAccountFragment
    +      }
           contactByUsername {
             ...UserContactFragment
           }
    @@ -5885,16 +6533,17 @@ 
    Query
    Variables
    -
    {"input": UserUpdateUsernameInput}
    +                  
    {"input": UserEmailRegistrationInitiateInput}
     
    Response
    {
       "data": {
    -    "userUpdateUsername": {
    +    "userEmailRegistrationInitiate": {
    +      "emailRegistrationId": EmailRegistrationId,
           "errors": [Error],
    -      "user": User
    +      "me": User
         }
       }
     }
    @@ -5903,16 +6552,18 @@ 
    Response
    -

    Subscriptions

    -
    +
    +
    + Mutations +

    - lnInvoicePaymentStatus + userEmailRegistrationValidate

    @@ -5927,7 +6578,7 @@
    Arguments
    - input - LnInvoicePaymentStatusInput! + input - UserEmailRegistrationValidateInput! @@ -5940,30 +6591,56 @@
    Arguments

    Example

    Query
    -
    subscription LnInvoicePaymentStatus($input: LnInvoicePaymentStatusInput!) {
    -  lnInvoicePaymentStatus(input: $input) {
    +                  
    mutation UserEmailRegistrationValidate($input: UserEmailRegistrationValidateInput!) {
    +  userEmailRegistrationValidate(input: $input) {
         errors {
           code
           message
           path
         }
    -    status
    +    me {
    +      bankAccounts {
    +        ...BankAccountFragment
    +      }
    +      contactByUsername {
    +        ...UserContactFragment
    +      }
    +      contacts {
    +        ...UserContactFragment
    +      }
    +      createdAt
    +      defaultAccount {
    +        ...AccountFragment
    +      }
    +      email {
    +        ...EmailFragment
    +      }
    +      id
    +      language
    +      npub
    +      phone
    +      quizQuestions {
    +        ...UserQuizQuestionFragment
    +      }
    +      totpEnabled
    +      username
    +    }
       }
     }
     
    Variables
    -
    {"input": LnInvoicePaymentStatusInput}
    +                  
    {"input": UserEmailRegistrationValidateInput}
     
    Response
    {
       "data": {
    -    "lnInvoicePaymentStatus": {
    +    "userEmailRegistrationValidate": {
           "errors": [Error],
    -      "status": "EXPIRED"
    +      "me": User
         }
       }
     }
    @@ -5972,85 +6649,71 @@ 
    Response
    -
    +

    - myUpdates + userLogin

    Response
    -

    Returns a MyUpdatesPayload! +

    Returns an AuthTokenPayload!

    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - UserLoginInput! + +
    +

    Example

    Query
    -
    subscription MyUpdates {
    -  myUpdates {
    +                  
    mutation UserLogin($input: UserLoginInput!) {
    +  userLogin(input: $input) {
    +    authToken
         errors {
           code
           message
           path
         }
    -    me {
    -      contactByUsername {
    -        ...UserContactFragment
    -      }
    -      contacts {
    -        ...UserContactFragment
    -      }
    -      createdAt
    -      defaultAccount {
    -        ...AccountFragment
    -      }
    -      email {
    -        ...EmailFragment
    -      }
    -      id
    -      language
    -      npub
    -      phone
    -      quizQuestions {
    -        ...UserQuizQuestionFragment
    -      }
    -      totpEnabled
    -      username
    -    }
    -    update {
    -      ... on IntraLedgerUpdate {
    -        ...IntraLedgerUpdateFragment
    -      }
    -      ... on LnUpdate {
    -        ...LnUpdateFragment
    -      }
    -      ... on OnChainUpdate {
    -        ...OnChainUpdateFragment
    -      }
    -      ... on Price {
    -        ...PriceFragment
    -      }
    -      ... on RealtimePrice {
    -        ...RealtimePriceFragment
    -      }
    -    }
    +    totpRequired
       }
    -}
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": UserLoginInput}
     
    Response
    {
       "data": {
    -    "myUpdates": {
    +    "userLogin": {
    +      "authToken": AuthToken,
           "errors": [Error],
    -      "me": User,
    -      "update": IntraLedgerUpdate
    +      "totpRequired": false
         }
       }
     }
    @@ -6059,18 +6722,18 @@ 
    Response
    -
    +

    - price + userLoginUpgrade

    Response
    -

    Returns a PricePayload! +

    Returns an UpgradePayload!

    @@ -6085,7 +6748,7 @@
    Arguments
    - input - PriceInput! + input - UserLoginUpgradeInput! @@ -6098,35 +6761,32 @@
    Arguments

    Example

    Query
    -
    subscription Price($input: PriceInput!) {
    -  price(input: $input) {
    +                  
    mutation UserLoginUpgrade($input: UserLoginUpgradeInput!) {
    +  userLoginUpgrade(input: $input) {
    +    authToken
         errors {
           code
           message
           path
         }
    -    price {
    -      base
    -      currencyUnit
    -      formattedAmount
    -      offset
    -    }
    +    success
       }
     }
     
    Variables
    -
    {"input": PriceInput}
    +                  
    {"input": UserLoginUpgradeInput}
     
    Response
    {
       "data": {
    -    "price": {
    +    "userLoginUpgrade": {
    +      "authToken": AuthToken,
           "errors": [Error],
    -      "price": Price
    +      "success": false
         }
       }
     }
    @@ -6135,26 +6795,18 @@ 
    Response
    -
    +

    - realtimePrice + userLogout

    -
    -
    -
    -
    Description
    -

    Returns the price of 1 satoshi

    -
    -
    -
    Response
    -

    Returns a RealtimePricePayload! +

    Returns a SuccessPayload!

    @@ -6169,7 +6821,7 @@
    Arguments
    - input - RealtimePriceInput! + input - UserLogoutInput @@ -6182,41 +6834,28 @@
    Arguments

    Example

    Query
    -
    subscription RealtimePrice($input: RealtimePriceInput!) {
    -  realtimePrice(input: $input) {
    +                  
    mutation UserLogout($input: UserLogoutInput) {
    +  userLogout(input: $input) {
         errors {
           code
           message
           path
         }
    -    realtimePrice {
    -      btcSatPrice {
    -        ...PriceOfOneSatInMinorUnitFragment
    -      }
    -      denominatorCurrency
    -      id
    -      timestamp
    -      usdCentPrice {
    -        ...PriceOfOneUsdCentInMinorUnitFragment
    -      }
    -    }
    +    success
       }
    -}
    +}
     
    Variables
    -
    {"input": RealtimePriceInput}
    +                  
    {"input": UserLogoutInput}
     
    Response
    {
       "data": {
    -    "realtimePrice": {
    -      "errors": [Error],
    -      "realtimePrice": RealtimePrice
    -    }
    +    "userLogout": {"errors": [Error], "success": true}
       }
     }
     
    @@ -6224,12 +6863,3742 @@
    Response
    -

    Types

    -
    -

    Account

    +
    +
    + Mutations +
    +

    + userPhoneDelete +

    -
    +
    +
    Response
    +

    Returns a UserPhoneDeletePayload! +

    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    mutation UserPhoneDelete {
    +  userPhoneDelete {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    me {
    +      bankAccounts {
    +        ...BankAccountFragment
    +      }
    +      contactByUsername {
    +        ...UserContactFragment
    +      }
    +      contacts {
    +        ...UserContactFragment
    +      }
    +      createdAt
    +      defaultAccount {
    +        ...AccountFragment
    +      }
    +      email {
    +        ...EmailFragment
    +      }
    +      id
    +      language
    +      npub
    +      phone
    +      quizQuestions {
    +        ...UserQuizQuestionFragment
    +      }
    +      totpEnabled
    +      username
    +    }
    +  }
    +}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "userPhoneDelete": {
    +      "errors": [Error],
    +      "me": User
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Mutations +
    +

    + userPhoneRegistrationInitiate +

    +
    +
    +
    +
    Response
    +

    Returns a SuccessPayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - UserPhoneRegistrationInitiateInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    mutation UserPhoneRegistrationInitiate($input: UserPhoneRegistrationInitiateInput!) {
    +  userPhoneRegistrationInitiate(input: $input) {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    success
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": UserPhoneRegistrationInitiateInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "userPhoneRegistrationInitiate": {
    +      "errors": [Error],
    +      "success": true
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Mutations +
    +

    + userPhoneRegistrationValidate +

    +
    +
    +
    +
    Response
    +

    Returns a UserPhoneRegistrationValidatePayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - UserPhoneRegistrationValidateInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    mutation UserPhoneRegistrationValidate($input: UserPhoneRegistrationValidateInput!) {
    +  userPhoneRegistrationValidate(input: $input) {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    me {
    +      bankAccounts {
    +        ...BankAccountFragment
    +      }
    +      contactByUsername {
    +        ...UserContactFragment
    +      }
    +      contacts {
    +        ...UserContactFragment
    +      }
    +      createdAt
    +      defaultAccount {
    +        ...AccountFragment
    +      }
    +      email {
    +        ...EmailFragment
    +      }
    +      id
    +      language
    +      npub
    +      phone
    +      quizQuestions {
    +        ...UserQuizQuestionFragment
    +      }
    +      totpEnabled
    +      username
    +    }
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": UserPhoneRegistrationValidateInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "userPhoneRegistrationValidate": {
    +      "errors": [Error],
    +      "me": User
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Mutations +
    +

    + userQuizQuestionUpdateCompleted +

    +
    +
    +
    +
    Use QuizCompletedMutation instead
    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a UserQuizQuestionUpdateCompletedPayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - UserQuizQuestionUpdateCompletedInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    mutation UserQuizQuestionUpdateCompleted($input: UserQuizQuestionUpdateCompletedInput!) {
    +  userQuizQuestionUpdateCompleted(input: $input) {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    userQuizQuestion {
    +      completed
    +      question {
    +        ...QuizQuestionFragment
    +      }
    +    }
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": UserQuizQuestionUpdateCompletedInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "userQuizQuestionUpdateCompleted": {
    +      "errors": [Error],
    +      "userQuizQuestion": UserQuizQuestion
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Mutations +
    +

    + userTotpDelete +

    +
    +
    +
    +
    Response
    +

    Returns a UserTotpDeletePayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - UserTotpDeleteInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    mutation UserTotpDelete($input: UserTotpDeleteInput!) {
    +  userTotpDelete(input: $input) {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    me {
    +      bankAccounts {
    +        ...BankAccountFragment
    +      }
    +      contactByUsername {
    +        ...UserContactFragment
    +      }
    +      contacts {
    +        ...UserContactFragment
    +      }
    +      createdAt
    +      defaultAccount {
    +        ...AccountFragment
    +      }
    +      email {
    +        ...EmailFragment
    +      }
    +      id
    +      language
    +      npub
    +      phone
    +      quizQuestions {
    +        ...UserQuizQuestionFragment
    +      }
    +      totpEnabled
    +      username
    +    }
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": UserTotpDeleteInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "userTotpDelete": {
    +      "errors": [Error],
    +      "me": User
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Mutations +
    +

    + userTotpRegistrationInitiate +

    +
    +
    +
    +
    Response
    +

    Returns a UserTotpRegistrationInitiatePayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - UserTotpRegistrationInitiateInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    mutation UserTotpRegistrationInitiate($input: UserTotpRegistrationInitiateInput!) {
    +  userTotpRegistrationInitiate(input: $input) {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    totpRegistrationId
    +    totpSecret
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": UserTotpRegistrationInitiateInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "userTotpRegistrationInitiate": {
    +      "errors": [Error],
    +      "totpRegistrationId": TotpRegistrationId,
    +      "totpSecret": TotpSecret
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Mutations +
    +

    + userTotpRegistrationValidate +

    +
    +
    +
    +
    Response
    +

    Returns a UserTotpRegistrationValidatePayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - UserTotpRegistrationValidateInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    mutation UserTotpRegistrationValidate($input: UserTotpRegistrationValidateInput!) {
    +  userTotpRegistrationValidate(input: $input) {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    me {
    +      bankAccounts {
    +        ...BankAccountFragment
    +      }
    +      contactByUsername {
    +        ...UserContactFragment
    +      }
    +      contacts {
    +        ...UserContactFragment
    +      }
    +      createdAt
    +      defaultAccount {
    +        ...AccountFragment
    +      }
    +      email {
    +        ...EmailFragment
    +      }
    +      id
    +      language
    +      npub
    +      phone
    +      quizQuestions {
    +        ...UserQuizQuestionFragment
    +      }
    +      totpEnabled
    +      username
    +    }
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": UserTotpRegistrationValidateInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "userTotpRegistrationValidate": {
    +      "errors": [Error],
    +      "me": User
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Mutations +
    +

    + userUpdateLanguage +

    +
    +
    +
    +
    Response
    +

    Returns a UserUpdateLanguagePayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - UserUpdateLanguageInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    mutation UserUpdateLanguage($input: UserUpdateLanguageInput!) {
    +  userUpdateLanguage(input: $input) {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    user {
    +      bankAccounts {
    +        ...BankAccountFragment
    +      }
    +      contactByUsername {
    +        ...UserContactFragment
    +      }
    +      contacts {
    +        ...UserContactFragment
    +      }
    +      createdAt
    +      defaultAccount {
    +        ...AccountFragment
    +      }
    +      email {
    +        ...EmailFragment
    +      }
    +      id
    +      language
    +      npub
    +      phone
    +      quizQuestions {
    +        ...UserQuizQuestionFragment
    +      }
    +      totpEnabled
    +      username
    +    }
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": UserUpdateLanguageInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "userUpdateLanguage": {
    +      "errors": [Error],
    +      "user": User
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Mutations +
    +

    + userUpdateNpub +

    +
    +
    +
    +
    Response
    +

    Returns a UserUpdateNpubPayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - UserUpdateNpubInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    mutation UserUpdateNpub($input: UserUpdateNpubInput!) {
    +  userUpdateNpub(input: $input) {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    user {
    +      bankAccounts {
    +        ...BankAccountFragment
    +      }
    +      contactByUsername {
    +        ...UserContactFragment
    +      }
    +      contacts {
    +        ...UserContactFragment
    +      }
    +      createdAt
    +      defaultAccount {
    +        ...AccountFragment
    +      }
    +      email {
    +        ...EmailFragment
    +      }
    +      id
    +      language
    +      npub
    +      phone
    +      quizQuestions {
    +        ...UserQuizQuestionFragment
    +      }
    +      totpEnabled
    +      username
    +    }
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": UserUpdateNpubInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "userUpdateNpub": {
    +      "errors": [Error],
    +      "user": User
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Mutations +
    +

    + userUpdateUsername +

    +
    +
    +
    +
    Username will be moved to @Handle in Accounts. Also SetUsername naming should be used instead of UpdateUsername to reflect the idempotency of Handles
    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a UserUpdateUsernamePayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - UserUpdateUsernameInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    mutation UserUpdateUsername($input: UserUpdateUsernameInput!) {
    +  userUpdateUsername(input: $input) {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    user {
    +      bankAccounts {
    +        ...BankAccountFragment
    +      }
    +      contactByUsername {
    +        ...UserContactFragment
    +      }
    +      contacts {
    +        ...UserContactFragment
    +      }
    +      createdAt
    +      defaultAccount {
    +        ...AccountFragment
    +      }
    +      email {
    +        ...EmailFragment
    +      }
    +      id
    +      language
    +      npub
    +      phone
    +      quizQuestions {
    +        ...UserQuizQuestionFragment
    +      }
    +      totpEnabled
    +      username
    +    }
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": UserUpdateUsernameInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "userUpdateUsername": {
    +      "errors": [Error],
    +      "user": User
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +

    Subscriptions

    +
    +

    + lnInvoicePaymentStatus +

    +
    +
    +
    +
    Response
    +

    Returns a LnInvoicePaymentStatusPayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - LnInvoicePaymentStatusInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    subscription LnInvoicePaymentStatus($input: LnInvoicePaymentStatusInput!) {
    +  lnInvoicePaymentStatus(input: $input) {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    status
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": LnInvoicePaymentStatusInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "lnInvoicePaymentStatus": {
    +      "errors": [Error],
    +      "status": "EXPIRED"
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    + +

    + myUpdates +

    +
    +
    +
    +
    Response
    +

    Returns a MyUpdatesPayload! +

    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    subscription MyUpdates {
    +  myUpdates {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    me {
    +      bankAccounts {
    +        ...BankAccountFragment
    +      }
    +      contactByUsername {
    +        ...UserContactFragment
    +      }
    +      contacts {
    +        ...UserContactFragment
    +      }
    +      createdAt
    +      defaultAccount {
    +        ...AccountFragment
    +      }
    +      email {
    +        ...EmailFragment
    +      }
    +      id
    +      language
    +      npub
    +      phone
    +      quizQuestions {
    +        ...UserQuizQuestionFragment
    +      }
    +      totpEnabled
    +      username
    +    }
    +    update {
    +      ... on IntraLedgerUpdate {
    +        ...IntraLedgerUpdateFragment
    +      }
    +      ... on LnUpdate {
    +        ...LnUpdateFragment
    +      }
    +      ... on OnChainUpdate {
    +        ...OnChainUpdateFragment
    +      }
    +      ... on Price {
    +        ...PriceFragment
    +      }
    +      ... on RealtimePrice {
    +        ...RealtimePriceFragment
    +      }
    +    }
    +  }
    +}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "myUpdates": {
    +      "errors": [Error],
    +      "me": User,
    +      "update": IntraLedgerUpdate
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    + +

    + price +

    +
    +
    +
    +
    Response
    +

    Returns a PricePayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - PriceInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    subscription Price($input: PriceInput!) {
    +  price(input: $input) {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    price {
    +      base
    +      currencyUnit
    +      formattedAmount
    +      offset
    +    }
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": PriceInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "price": {
    +      "errors": [Error],
    +      "price": Price
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    + +

    + realtimePrice +

    +
    +
    +
    +
    Description
    +

    Returns the price of 1 satoshi

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a RealtimePricePayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - RealtimePriceInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    subscription RealtimePrice($input: RealtimePriceInput!) {
    +  realtimePrice(input: $input) {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    realtimePrice {
    +      btcSatPrice {
    +        ...PriceOfOneSatInMinorUnitFragment
    +      }
    +      denominatorCurrency
    +      id
    +      timestamp
    +      usdCentPrice {
    +        ...PriceOfOneUsdCentInMinorUnitFragment
    +      }
    +    }
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": RealtimePriceInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "realtimePrice": {
    +      "errors": [Error],
    +      "realtimePrice": RealtimePrice
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +

    Types

    +
    +

    Account

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    callbackEndpoints - [CallbackEndpoint!]! + +
    csvTransactions - String! + +
    +
    +
    Arguments
    +
    +
    +
    walletIds - [WalletId!]! +
    +
    +
    +
    +
    defaultWalletId - WalletId! + +
    displayCurrency - DisplayCurrency! + +
    id - ID! + +
    level - AccountLevel! + +
    limits - AccountLimits! + +
    notificationSettings - NotificationSettings! + +
    realtimePrice - RealtimePrice! + +
    transactions - TransactionConnection + +
    +
    +
    Arguments
    +
    +
    +
    after - String +
    +

    Returns the items in the list that come after the specified cursor.

    +
    +
    +
    before - String +
    +

    Returns the items in the list that come before the specified cursor.

    +
    +
    +
    first - Int +
    +

    Returns the first n items from the list.

    +
    +
    +
    last - Int +
    +

    Returns the last n items from the list.

    +
    +
    +
    walletIds - [WalletId] +
    +
    +
    +
    +
    wallets - [Wallet!]! + +
    +
    +
    +
    Possible Types
    + + + + + + + + + + + +
    Account Types
    +

    ConsumerAccount

    +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "callbackEndpoints": [CallbackEndpoint],
    +  "csvTransactions": "xyz789",
    +  "defaultWalletId": WalletId,
    +  "displayCurrency": DisplayCurrency,
    +  "id": 4,
    +  "level": "ONE",
    +  "limits": AccountLimits,
    +  "notificationSettings": NotificationSettings,
    +  "realtimePrice": RealtimePrice,
    +  "transactions": TransactionConnection,
    +  "wallets": [Wallet]
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountDeletePayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error!]! + +
    success - Boolean! + +
    +
    +
    +
    +
    +
    Example
    +
    {"errors": [Error], "success": true}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountDisableNotificationCategoryInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + category - NotificationCategory! + +
    + channel - NotificationChannel + +
    +
    +
    +
    +
    +
    Example
    +
    {"category": NotificationCategory, "channel": "PUSH"}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountDisableNotificationChannelInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + channel - NotificationChannel! + +
    +
    +
    +
    +
    +
    Example
    +
    {"channel": "PUSH"}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountEnableNotificationCategoryInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + category - NotificationCategory! + +
    + channel - NotificationChannel + +
    +
    +
    +
    +
    +
    Example
    +
    {"category": NotificationCategory, "channel": "PUSH"}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountEnableNotificationChannelInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + channel - NotificationChannel! + +
    +
    +
    +
    +
    +
    Example
    +
    {"channel": "PUSH"}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountLevel

    +
    +
    +
    +
    Values
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Enum ValueDescription
    +

    ONE

    +
    +
    +

    THREE

    +
    +
    +

    TWO

    +
    +
    +

    ZERO

    +
    +
    +
    +
    +
    +
    +
    Example
    +
    "ONE"
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountLimit

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    interval - Seconds + The rolling time interval in seconds that the limits would apply for.
    remainingLimit - CentAmount + The amount of cents remaining below the limit for the current 24 hour period.
    totalLimit - CentAmount! + The current maximum limit for a given 24 hour period.
    +
    +
    +
    Possible Types
    + + + + + + + + + + + +
    AccountLimit Types
    +

    OneDayAccountLimit

    +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "interval": Seconds,
    +  "remainingLimit": CentAmount,
    +  "totalLimit": CentAmount
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountLimits

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    convert - [AccountLimit!]! + Limits for converting between currencies among a account's own wallets.
    internalSend - [AccountLimit!]! + Limits for sending to other internal accounts.
    withdrawal - [AccountLimit!]! + Limits for withdrawing to external onchain or lightning destinations.
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "convert": [AccountLimit],
    +  "internalSend": [AccountLimit],
    +  "withdrawal": [AccountLimit]
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountNumber

    +
    +
    +
    +
    Description
    +

    Bank account number. Accepts String or Int and coerces to String.

    +
    +
    +
    +
    +
    Example
    +
    "000000012345"
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountUpdateDefaultWalletIdInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + walletId - WalletId! + +
    +
    +
    +
    +
    +
    Example
    +
    {"walletId": WalletId}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountUpdateDefaultWalletIdPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    account - ConsumerAccount + +
    errors - [Error!]! + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "account": ConsumerAccount,
    +  "errors": [Error]
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountUpdateDisplayCurrencyInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + currency - DisplayCurrency! + +
    +
    +
    +
    +
    +
    Example
    +
    {"currency": DisplayCurrency}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountUpdateDisplayCurrencyPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    account - ConsumerAccount + +
    errors - [Error!]! + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "account": ConsumerAccount,
    +  "errors": [Error]
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountUpdateNotificationSettingsPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    account - ConsumerAccount + +
    errors - [Error!]! + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "account": ConsumerAccount,
    +  "errors": [Error]
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountUpgradePayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error] + +
    id - String + +
    status - String + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "errors": [Error],
    +  "id": "xyz789",
    +  "status": "abc123"
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountUpgradeRequest

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    address - Address! + +
    bankAccount - BankAccount + +
    currentLevel - AccountLevel! + +
    email - String + +
    fullName - String! + +
    idDocument - Boolean! + +
    name - String! + ERPNext document name
    phoneNumber - String! + +
    requestedLevel - AccountLevel! + +
    status - String! + Status of the upgrade request
    terminalsRequested - Int! + +
    username - String! + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "address": Address,
    +  "bankAccount": BankAccount,
    +  "currentLevel": "ONE",
    +  "email": "xyz789",
    +  "fullName": "abc123",
    +  "idDocument": false,
    +  "name": "abc123",
    +  "phoneNumber": "xyz789",
    +  "requestedLevel": "ONE",
    +  "status": "xyz789",
    +  "terminalsRequested": 123,
    +  "username": "xyz789"
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountUpgradeRequestPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error] + +
    upgradeRequest - AccountUpgradeRequest + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "errors": [Error],
    +  "upgradeRequest": AccountUpgradeRequest
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    Address

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    city - String! + +
    country - String! + +
    line1 - String! + +
    line2 - String + +
    postalCode - String + +
    state - String! + +
    title - String! + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "city": "abc123",
    +  "country": "xyz789",
    +  "line1": "xyz789",
    +  "line2": "abc123",
    +  "postalCode": "xyz789",
    +  "state": "abc123",
    +  "title": "xyz789"
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AddressInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + city - String! + +
    + country - String! + +
    + line1 - String! + +
    + line2 - String + +
    + postalCode - String + +
    + state - String! + +
    + title - String! + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "city": "abc123",
    +  "country": "abc123",
    +  "line1": "abc123",
    +  "line2": "xyz789",
    +  "postalCode": "abc123",
    +  "state": "abc123",
    +  "title": "xyz789"
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AuthToken

    +
    +
    +
    +
    Description
    +

    An Opaque Bearer token

    +
    +
    +
    +
    +
    Example
    +
    AuthToken
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AuthTokenPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    authToken - AuthToken + +
    errors - [Error!]! + +
    totpRequired - Boolean + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "authToken": AuthToken,
    +  "errors": [Error],
    +  "totpRequired": true
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BTCWallet

    +
    +
    +
    +
    Description
    +

    A wallet belonging to an account which contains a BTC balance and a list of transactions.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    accountId - ID! + +
    balance - FractionalCentAmount + A balance stored in BTC.
    id - ID! + +
    isExternal - Boolean! + +
    lnurlp - Lnurl + +
    pendingIncomingBalance - SignedAmount! + An unconfirmed incoming onchain balance.
    transactions - TransactionConnection + A list of BTC transactions associated with this wallet.
    +
    +
    Arguments
    +
    +
    +
    after - String +
    +

    Returns the items in the list that come after the specified cursor.

    +
    +
    +
    before - String +
    +

    Returns the items in the list that come before the specified cursor.

    +
    +
    +
    first - Int +
    +

    Returns the first n items from the list.

    +
    +
    +
    last - Int +
    +

    Returns the last n items from the list.

    +
    +
    +
    +
    transactionsByAddress - TransactionConnection + +
    +
    +
    Arguments
    +
    +
    +
    address - OnChainAddress! +
    +

    Returns the items that include this address.

    +
    +
    +
    after - String +
    +

    Returns the items in the list that come after the specified cursor.

    +
    +
    +
    before - String +
    +

    Returns the items in the list that come before the specified cursor.

    +
    +
    +
    first - Int +
    +

    Returns the first n items from the list.

    +
    +
    +
    last - Int +
    +

    Returns the last n items from the list.

    +
    +
    +
    +
    walletCurrency - WalletCurrency! + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "accountId": "4",
    +  "balance": FractionalCentAmount,
    +  "id": 4,
    +  "isExternal": true,
    +  "lnurlp": Lnurl,
    +  "pendingIncomingBalance": SignedAmount,
    +  "transactions": TransactionConnection,
    +  "transactionsByAddress": TransactionConnection,
    +  "walletCurrency": "BTC"
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    Bank

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Field NameDescription
    name - String! + +
    +
    +
    +
    +
    +
    Example
    +
    {"name": "xyz789"}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BankAccount

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    accountName - String + +
    accountNumber - String! + +
    accountType - String! + +
    bankBranch - String! + +
    bankName - String! + +
    currency - String! + Account currency (e.g. JMD, USD)
    id - ID + ERPNext bank account identifier
    isDefault - Boolean! + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "accountName": "xyz789",
    +  "accountNumber": "xyz789",
    +  "accountType": "abc123",
    +  "bankBranch": "xyz789",
    +  "bankName": "xyz789",
    +  "currency": "xyz789",
    +  "id": "4",
    +  "isDefault": true
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BankAccountInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + accountNumber - AccountNumber! + +
    + accountType - String! + +
    + bankBranch - String! + +
    + bankName - String! + +
    + currency - String! + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "accountNumber": "000000012345",
    +  "accountType": "xyz789",
    +  "bankBranch": "xyz789",
    +  "bankName": "xyz789",
    +  "currency": "abc123"
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    Boolean

    +
    +
    +
    +
    Description
    +

    The Boolean scalar type represents true or false.

    +
    +
    +
    +
    +
    Example
    +
    true
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeAddExternalAccountPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error!]! + +
    externalAccount - BridgeExternalAccountLink + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "errors": [Error],
    +  "externalAccount": BridgeExternalAccountLink
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeCancelWithdrawalRequestInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + withdrawalId - ID! + +
    +
    +
    +
    +
    +
    Example
    +
    {"withdrawalId": "4"}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeCancelWithdrawalRequestPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error!]! + +
    withdrawal - BridgeWithdrawal + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "errors": [Error],
    +  "withdrawal": BridgeWithdrawal
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeCreateExternalAccountInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + accountNumber - String! + +
    + accountOwnerName - String! + +
    + bankName - String! + +
    + checkingOrSavings - String + +
    + city - String! + +
    + country - String! + +
    + postalCode - String! + +
    + routingNumber - String! + +
    + state - String! + +
    + streetLine1 - String! + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "accountNumber": "abc123",
    +  "accountOwnerName": "xyz789",
    +  "bankName": "abc123",
    +  "checkingOrSavings": "abc123",
    +  "city": "abc123",
    +  "country": "abc123",
    +  "postalCode": "xyz789",
    +  "routingNumber": "xyz789",
    +  "state": "xyz789",
    +  "streetLine1": "xyz789"
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeCreateExternalAccountPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error!]! + +
    externalAccount - BridgeExternalAccount + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "errors": [Error],
    +  "externalAccount": BridgeExternalAccount
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeCreateVirtualAccountPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error!]! + +
    virtualAccount - BridgeVirtualAccount + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "errors": [Error],
    +  "virtualAccount": BridgeVirtualAccount
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeDeleteExternalAccountInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + externalAccountId - ID! + +
    +
    +
    +
    +
    +
    Example
    +
    {"externalAccountId": 4}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeDeleteExternalAccountPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error!]! + +
    externalAccount - BridgeExternalAccount + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "errors": [Error],
    +  "externalAccount": BridgeExternalAccount
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeExternalAccount

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    accountNumberLast4 - String! + +
    bankName - String! + +
    id - ID! + +
    isDefault - Boolean! + +
    status - String! + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "accountNumberLast4": "abc123",
    +  "bankName": "xyz789",
    +  "id": 4,
    +  "isDefault": false,
    +  "status": "xyz789"
    +}
    +
    +
    +
    +
    +
    + +
    +
    + Types +
    +

    BridgeInitiateKycInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + email - String + +
    + full_name - String + +
    + type - String + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "email": "abc123",
    +  "full_name": "xyz789",
    +  "type": "abc123"
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeInitiateKycPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error!]! + +
    kycLink - BridgeKycLink + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "errors": [Error],
    +  "kycLink": BridgeKycLink
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeInitiateWithdrawalInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + withdrawalId - ID! + +
    +
    +
    +
    +
    +
    Example
    +
    {"withdrawalId": "4"}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeInitiateWithdrawalPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error!]! + +
    withdrawal - BridgeWithdrawal + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "errors": [Error],
    +  "withdrawal": BridgeWithdrawal
    +}
    +
    +
    +
    +
    +
    + +
    +
    + Types +
    +

    BridgeRequestWithdrawalInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + amount - String! + +
    + externalAccountId - ID! + +
    +
    +
    +
    +
    +
    Example
    +
    {"amount": "abc123", "externalAccountId": 4}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeRequestWithdrawalPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error!]! + +
    withdrawal - BridgeWithdrawal + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "errors": [Error],
    +  "withdrawal": BridgeWithdrawal
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeSetDefaultExternalAccountInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + externalAccountId - ID! + +
    +
    +
    +
    +
    +
    Example
    +
    {"externalAccountId": 4}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeSetDefaultExternalAccountPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error!]! + +
    externalAccount - BridgeExternalAccount + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "errors": [Error],
    +  "externalAccount": BridgeExternalAccount
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeVirtualAccount

    +
    +
    +
    Fields
    @@ -6240,113 +10609,402 @@
    Fields
    - - - + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    callbackEndpoints - [CallbackEndpoint!]! + accountNumber - String
    csvTransactions - String! +
    accountNumberLast4 - String
    -
    -
    Arguments
    -
    -
    -
    walletIds - [WalletId!]! -
    -
    -
    -
    +
    bankName - String + +
    id - ID + +
    kycLink - String + +
    message - String + +
    pending - Boolean + +
    routingNumber - String + +
    tosLink - String + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "accountNumber": "xyz789",
    +  "accountNumberLast4": "xyz789",
    +  "bankName": "abc123",
    +  "id": 4,
    +  "kycLink": "abc123",
    +  "message": "xyz789",
    +  "pending": false,
    +  "routingNumber": "abc123",
    +  "tosLink": "xyz789"
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeWithdrawal

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    amount - String! + +
    bridgeDeveloperFee - String + +
    bridgeExchangeFee - String + +
    bridgeTransferId - String + +
    createdAt - String! + +
    currency - String! + +
    estimatedBridgeFee - String + +
    estimatedBridgeFeePercent - String +
    estimatedCustomerFee - String + +
    estimatedGasBuffer - String + +
    externalAccountId - String + +
    failureReason - String + +
    finalAmount - String + +
    flashFee - String + +
    flashFeeIsEstimate - Boolean! + +
    flashFeeNotice - String + +
    flashFeePercent - String + +
    id - ID! + +
    status - String! + +
    subtotalAmount - String + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "amount": "abc123",
    +  "bridgeDeveloperFee": "abc123",
    +  "bridgeExchangeFee": "abc123",
    +  "bridgeTransferId": "xyz789",
    +  "createdAt": "xyz789",
    +  "currency": "abc123",
    +  "estimatedBridgeFee": "xyz789",
    +  "estimatedBridgeFeePercent": "xyz789",
    +  "estimatedCustomerFee": "abc123",
    +  "estimatedGasBuffer": "abc123",
    +  "externalAccountId": "xyz789",
    +  "failureReason": "xyz789",
    +  "finalAmount": "xyz789",
    +  "flashFee": "abc123",
    +  "flashFeeIsEstimate": false,
    +  "flashFeeNotice": "abc123",
    +  "flashFeePercent": "abc123",
    +  "id": "4",
    +  "status": "abc123",
    +  "subtotalAmount": "abc123"
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BuildInformation

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    commitHash - String + +
    helmRevision - Int + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "commitHash": "xyz789",
    +  "helmRevision": 123
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BusinessAccountUpgradeRequestInput

    +
    +
    +
    +
    Fields
    + + + + + + + - - - - - - + +
    Input FieldDescription
    defaultWalletId - WalletId! + + address - AddressInput!
    displayCurrency - DisplayCurrency! + + bankAccount - BankAccountInput
    id - ID! + + fullName - String!
    level - AccountLevel! + + idDocument - String
    limits - AccountLimits! + + level - AccountLevel!
    notificationSettings - NotificationSettings! + + terminalsRequested - Int
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "address": AddressInput,
    +  "bankAccount": BankAccountInput,
    +  "fullName": "abc123",
    +  "idDocument": "xyz789",
    +  "level": "ONE",
    +  "terminalsRequested": 987
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    CallbackEndpoint

    +
    +
    +
    +
    Fields
    + + - - + + - - + + + - - - - @@ -6354,19 +11012,41 @@
    walletIds
    realtimePrice - RealtimePrice! - - Field NameDescription
    transactions - TransactionConnection +
    id - EndpointId!
    -
    -
    Arguments
    -
    -
    -
    after - String -
    -

    Returns the items in the list that come after the specified cursor.

    -
    -
    -
    before - String -
    -

    Returns the items in the list that come before the specified cursor.

    -
    -
    -
    first - Int -
    -

    Returns the first n items from the list.

    -
    -
    -
    last - Int -
    -

    Returns the last n items from the list.

    -
    -
    -
    walletIds - [WalletId] -
    -
    -
    -
    -
    wallets - [Wallet!]! + url - EndpointUrl!
    -
    -
    Possible Types
    +
    +
    +
    +
    Example
    +
    {
    +  "id": EndpointId,
    +  "url": EndpointUrl
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    CallbackEndpointAddInput

    +
    +
    +
    +
    Fields
    - + + +
    Account TypesInput FieldDescription
    -

    ConsumerAccount

    + url - EndpointUrl!
    callback endpoint to be called
    @@ -6375,29 +11055,17 @@
    Possible Types
    Example
    -
    {
    -  "callbackEndpoints": [CallbackEndpoint],
    -  "csvTransactions": "abc123",
    -  "defaultWalletId": WalletId,
    -  "displayCurrency": DisplayCurrency,
    -  "id": "4",
    -  "level": "ONE",
    -  "limits": AccountLimits,
    -  "notificationSettings": NotificationSettings,
    -  "realtimePrice": RealtimePrice,
    -  "transactions": TransactionConnection,
    -  "wallets": [Wallet]
    -}
    +                  
    {"url": EndpointUrl}
     
    -
    +
    -

    AccountDeletePayload

    +

    CallbackEndpointAddPayload

    @@ -6417,7 +11085,7 @@
    Fields
    - success - Boolean! + id - EndpointId @@ -6429,17 +11097,20 @@
    Fields
    Example
    -
    {"errors": [Error], "success": false}
    +                  
    {
    +  "errors": [Error],
    +  "id": EndpointId
    +}
     
    -
    +
    -

    AccountDisableNotificationCategoryInput

    +

    CallbackEndpointDeleteInput

    @@ -6454,14 +11125,49 @@
    Fields
    - category - NotificationCategory! + id - EndpointId! + + +
    +
    +
    +
    +
    Example
    +
    {"id": EndpointId}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    CaptchaCreateChallengePayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + @@ -6473,17 +11179,20 @@
    Fields
    Example
    -
    {"category": NotificationCategory, "channel": "PUSH"}
    +                  
    {
    +  "errors": [Error],
    +  "result": CaptchaCreateChallengeResult
    +}
     
    -
    +
    -

    AccountDisableNotificationChannelInput

    +

    CaptchaCreateChallengeResult

    @@ -6491,14 +11200,31 @@
    Fields
    Field NameDescription
    errors - [Error!]! + - channel - NotificationChannel +
    result - CaptchaCreateChallengeResult
    - + + + + + + + + + + + + + @@ -6510,17 +11236,22 @@
    Fields
    Example
    -
    {"channel": "PUSH"}
    +                  
    {
    +  "challengeCode": "abc123",
    +  "failbackMode": false,
    +  "id": "abc123",
    +  "newCaptcha": true
    +}
     
    -
    +
    -

    AccountEnableNotificationCategoryInput

    +

    CaptchaRequestAuthCodeInput

    @@ -6535,14 +11266,35 @@
    Fields
    + + + + + + + + + + + + @@ -6554,17 +11306,23 @@
    Fields
    Example
    -
    {"category": NotificationCategory, "channel": "PUSH"}
    +                  
    {
    +  "challengeCode": "xyz789",
    +  "channel": "SMS",
    +  "phone": Phone,
    +  "secCode": "abc123",
    +  "validationCode": "abc123"
    +}
     
    -
    +
    -

    AccountEnableNotificationChannelInput

    +

    CashWalletCutover

    @@ -6572,14 +11330,67 @@
    Fields
    Input FieldField Name Description
    challengeCode - String! + - channel - NotificationChannel! +
    failbackMode - Boolean! + +
    id - String! + +
    newCaptcha - Boolean!
    - category - NotificationCategory! + challengeCode - String!
    - channel - NotificationChannel + channel - PhoneCodeChannelType + +
    + phone - Phone! + +
    + secCode - String! + +
    + validationCode - String!
    - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -6591,17 +11402,28 @@
    Fields
    Example
    -
    {"channel": "PUSH"}
    +                  
    {
    +  "completedAt": 1592577642,
    +  "cutoverVersion": 987,
    +  "pauseReason": "xyz789",
    +  "pausedAt": 1592577642,
    +  "runId": "xyz789",
    +  "scheduledAt": 1592577642,
    +  "startedAt": 1592577642,
    +  "state": "COMPLETE",
    +  "updatedAt": 1592577642,
    +  "updatedBy": "abc123"
    +}
     
    -
    +
    -

    AccountLevel

    +

    CashWalletCutoverState

    @@ -6616,21 +11438,28 @@
    Values
    + + + + @@ -6642,20 +11471,20 @@
    Values
    Example
    -
    "ONE"
    +                  
    "COMPLETE"
     
    -
    +
    -

    AccountLimit

    +

    CashoutOffer

    -
    +
    Fields
    Input FieldField Name Description
    completedAt - Timestamp + - channel - NotificationChannel! +
    cutoverVersion - Int! + +
    pauseReason - String + +
    pausedAt - Timestamp + +
    runId - String + +
    scheduledAt - Timestamp + +
    startedAt - Timestamp + +
    state - CashWalletCutoverState! + +
    updatedAt - Timestamp! + +
    updatedBy - String
    -

    ONE

    +

    COMPLETE

    -

    TWO

    +

    IN_PROGRESS

    -

    ZERO

    +

    PRE

    +
    +
    +

    ROLLED_BACK

    @@ -6666,36 +11495,44 @@
    Fields
    - - + - - + - - + - -
    interval - Seconds + exchangeRate - JMDCents The rolling time interval in seconds that the limits would apply for. The rate used when withdrawing to a JMD bank account
    remainingLimit - CentAmount + expiresAt - Timestamp! The amount of cents remaining below the limit for the current 24 hour period. The time at which this offer is no longer accepted by Flash
    totalLimit - CentAmount! + flashFee - USDCents! The current maximum limit for a given 24 hour period. The amount that Flash is charging for its services
    -
    -
    -
    Possible Types
    - - - + + - - - + + + + + + + + + + + + +
    AccountLimit TypesofferId - ID! + ID of the offer
    -

    OneDayAccountLimit

    +
    receiveJmd - JMDCents + The amount Flash owes to the user denominated in JMD cents (null for USD payouts)
    receiveUsd - USDCents + The amount Flash owes to the user denominated in USD cents (null for JMD payouts)
    send - USDCents! + The amount the user is sending to flash
    walletId - WalletId! ID for the users USD wallet to send from
    @@ -6705,69 +11542,46 @@
    Possible Types
    Example
    {
    -  "interval": Seconds,
    -  "remainingLimit": CentAmount,
    -  "totalLimit": CentAmount
    +  "exchangeRate": JMDCents,
    +  "expiresAt": 1592577642,
    +  "flashFee": USDCents,
    +  "offerId": 4,
    +  "receiveJmd": JMDCents,
    +  "receiveUsd": USDCents,
    +  "send": USDCents,
    +  "walletId": WalletId
     }
     
    -
    +
    -

    AccountLimits

    +

    CentAmount

    -
    -
    Fields
    - - - - - - - - - - - - - - - - - - - - - -
    Field NameDescription
    convert - [AccountLimit!]! - Limits for converting between currencies among a account's own wallets.
    internalSend - [AccountLimit!]! - Limits for sending to other internal accounts.
    withdrawal - [AccountLimit!]! - Limits for withdrawing to external onchain or lightning destinations.
    +
    +
    Description
    +

    (Positive) Cent amount (1/100 of a dollar)

    Example
    -
    {
    -  "convert": [AccountLimit],
    -  "internalSend": [AccountLimit],
    -  "withdrawal": [AccountLimit]
    -}
    +                  
    CentAmount
     
    -
    +
    -

    AccountUpdateDefaultWalletIdInput

    +

    CentAmountPayload

    @@ -6775,14 +11589,25 @@
    Fields
    - + + + + + + + + + @@ -6794,17 +11619,21 @@
    Fields
    Example
    -
    {"walletId": WalletId}
    +                  
    {
    +  "amount": USDCents,
    +  "errors": [Error],
    +  "invoiceAmount": USDCents
    +}
     
    -
    +
    -

    AccountUpdateDefaultWalletIdPayload

    +

    ConsumerAccount

    @@ -6818,13 +11647,116 @@
    Fields
    - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - @@ -6837,56 +11769,50 @@
    Fields
    Example
    {
    -  "account": ConsumerAccount,
    -  "errors": [Error]
    +  "callbackEndpoints": [CallbackEndpoint],
    +  "csvTransactions": "xyz789",
    +  "defaultWalletId": WalletId,
    +  "displayCurrency": DisplayCurrency,
    +  "id": 4,
    +  "level": "ONE",
    +  "limits": AccountLimits,
    +  "notificationSettings": NotificationSettings,
    +  "quiz": [Quiz],
    +  "realtimePrice": RealtimePrice,
    +  "transactions": TransactionConnection,
    +  "wallets": [Wallet]
     }
     
    -
    +
    -

    AccountUpdateDisplayCurrencyInput

    +

    ContactAlias

    -
    -
    Fields
    -
    Input FieldField Name Description
    amount - USDCents + +
    errors - [Error!]! + - walletId - WalletId! +
    invoiceAmount - USDCents
    account - ConsumerAccount + callbackEndpoints - [CallbackEndpoint!]! + +
    csvTransactions - String! + return CSV stream, base64 encoded, of the list of transactions in the wallet
    +
    +
    Arguments
    +
    +
    +
    walletIds - [WalletId!]! +
    +
    +
    +
    +
    defaultWalletId - WalletId! + +
    displayCurrency - DisplayCurrency! + +
    id - ID! + +
    level - AccountLevel! + +
    limits - AccountLimits! + +
    notificationSettings - NotificationSettings! + +
    quiz - [Quiz!]! + List the quiz questions of the consumer account
    realtimePrice - RealtimePrice!
    transactions - TransactionConnection + A list of all transactions associated with walletIds optionally passed.
    +
    +
    Arguments
    +
    +
    +
    after - String +
    +

    Returns the items in the list that come after the specified cursor.

    +
    +
    +
    before - String +
    +

    Returns the items in the list that come before the specified cursor.

    +
    +
    +
    first - Int +
    +

    Returns the first n items from the list.

    +
    +
    +
    last - Int +
    +

    Returns the last n items from the list.

    +
    +
    +
    walletIds - [WalletId] +
    +
    +
    +
    +
    errors - [Error!]! + wallets - [Wallet!]!
    - - - - - - - - - - - - -
    Input FieldDescription
    - currency - DisplayCurrency! - -
    +
    +
    Description
    +

    An alias name that a user can set for a wallet (with which they have transactions)

    Example
    -
    {"currency": DisplayCurrency}
    +                  
    ContactAlias
     
    -
    +
    -

    AccountUpdateDisplayCurrencyPayload

    +

    Coordinates

    @@ -6900,13 +11826,13 @@
    Fields
    - account - ConsumerAccount + latitude - Float! - errors - [Error!]! + longitude - Float! @@ -6918,20 +11844,17 @@
    Fields
    Example
    -
    {
    -  "account": ConsumerAccount,
    -  "errors": [Error]
    -}
    +                  
    {"latitude": 123.45, "longitude": 123.45}
     
    -
    +
    -

    AccountUpdateNotificationSettingsPayload

    +

    Country

    @@ -6945,13 +11868,13 @@
    Fields
    - account - ConsumerAccount + id - CountryCode! - errors - [Error!]! + supportedAuthChannels - [PhoneCodeChannelType!]! @@ -6964,40 +11887,40 @@
    Fields
    Example
    {
    -  "account": ConsumerAccount,
    -  "errors": [Error]
    +  "id": "US",
    +  "supportedAuthChannels": ["SMS"]
     }
     
    -
    +
    -

    AuthToken

    +

    CountryCode

    Description
    -

    An Opaque Bearer token

    +

    A CCA2 country code (ex US, FR, etc)

    Example
    -
    AuthToken
    +                  
    "US"
     
    -
    +
    -

    AuthTokenPayload

    +

    Currency

    @@ -7011,19 +11934,31 @@
    Fields
    - authToken - AuthToken + flag - String! - errors - [Error!]! + fractionDigits - Int! - totpRequired - Boolean + id - ID! + + + + + + name - String! + + + + + + symbol - String! @@ -7036,26 +11971,24 @@
    Fields
    Example
    {
    -  "authToken": AuthToken,
    -  "errors": [Error],
    -  "totpRequired": false
    +  "flag": "xyz789",
    +  "fractionDigits": 987,
    +  "id": "4",
    +  "name": "abc123",
    +  "symbol": "abc123"
     }
     
    -
    +
    -

    BTCWallet

    +

    DepositFeesInformation

    -
    -
    Description
    -

    A wallet belonging to an account which contains a BTC balance and a list of transactions.

    -
    Fields
    @@ -7067,109 +12000,58 @@
    Fields
    - - - + - - + + +
    accountId - ID! + minBankFee - String!
    balance - SignedAmount! + minBankFeeThreshold - String! A balance stored in BTC. below this amount minBankFee will be charged
    id - ID! - + ratio - String! ratio to charge as basis points above minBankFeeThreshold amount
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "minBankFee": "xyz789",
    +  "minBankFeeThreshold": "xyz789",
    +  "ratio": "xyz789"
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    DeviceNotificationTokenCreateInput

    +
    +
    +
    +
    Fields
    + + - - + + + + - - - - - - - - - - - - - - - - - - @@ -7181,42 +12063,38 @@
    last
    Example
    -
    {
    -  "accountId": 4,
    -  "balance": SignedAmount,
    -  "id": "4",
    -  "lnurlp": Lnurl,
    -  "pendingIncomingBalance": SignedAmount,
    -  "transactions": TransactionConnection,
    -  "transactionsByAddress": TransactionConnection,
    -  "walletCurrency": "BTC"
    -}
    +                  
    {"deviceToken": "abc123"}
     
    -
    +
    -

    Boolean

    +

    DisplayCurrency

    Description
    -

    The Boolean scalar type represents true or false.

    +

    Display currency of an account

    +
    +
    Example
    +
    DisplayCurrency
    +
    +
    -
    +
    -

    BuildInformation

    +

    Email

    @@ -7230,13 +12108,13 @@
    Fields
    - - @@ -7249,103 +12127,102 @@
    Fields
    Example
    {
    -  "commitHash": "xyz789",
    -  "helmRevision": 123
    +  "address": "test@test.com",
    +  "verified": false
     }
     
    -
    +
    -

    CallbackEndpoint

    +

    EmailAddress

    -
    -
    Fields
    -
    lnurlp - Lnurl - - Input FieldDescription
    pendingIncomingBalance - SignedAmount! - An unconfirmed incoming onchain balance.
    transactions - TransactionConnection - A list of BTC transactions associated with this wallet.
    -
    -
    Arguments
    -
    -
    -
    after - String -
    -

    Returns the items in the list that come after the specified cursor.

    -
    -
    -
    before - String -
    -

    Returns the items in the list that come before the specified cursor.

    -
    -
    -
    first - Int -
    -

    Returns the first n items from the list.

    -
    -
    -
    last - Int -
    -

    Returns the last n items from the list.

    -
    -
    -
    -
    transactionsByAddress - TransactionConnection - -
    -
    -
    Arguments
    -
    -
    -
    address - OnChainAddress! -
    -

    Returns the items that include this address.

    -
    -
    -
    after - String -
    -

    Returns the items in the list that come after the specified cursor.

    -
    -
    -
    before - String -
    -

    Returns the items in the list that come before the specified cursor.

    -
    -
    -
    first - Int -
    -

    Returns the first n items from the list.

    -
    -
    -
    last - Int -
    -

    Returns the last n items from the list.

    -
    -
    -
    -
    walletCurrency - WalletCurrency! + deviceToken - String!
    commitHash - String + address - EmailAddress
    helmRevision - Int + verified - Boolean
    - - - - - - - - - - - - - - - - -
    Field NameDescription
    id - EndpointId! - -
    url - EndpointUrl! - -
    +
    +
    Description
    +

    Email address

    Example
    -
    {
    -  "id": EndpointId,
    -  "url": EndpointUrl
    -}
    +                  
    "test@test.com"
     
    -
    +
    -

    CallbackEndpointAddInput

    +

    EmailRegistrationId

    -
    -
    Fields
    - - - - - - - - - - - - - -
    Input FieldDescription
    - url - EndpointUrl! - callback endpoint to be called
    +
    +
    Description
    +

    An id to be passed between registrationInitiate and registrationValidate for confirming email

    Example
    -
    {"url": EndpointUrl}
    +                  
    EmailRegistrationId
     
    -
    +
    -

    CallbackEndpointAddPayload

    +

    EndpointId

    -
    +
    +
    +
    +
    Example
    +
    EndpointId
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    EndpointUrl

    +
    +
    +
    +
    Description
    +

    Url that will be fetched on events for the account

    +
    +
    +
    +
    +
    Example
    +
    EndpointUrl
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    Error

    +
    +
    +
    Fields
    @@ -7356,13 +12233,19 @@
    Fields
    - - + + + + @@ -7370,41 +12253,18 @@
    Fields
    errors - [Error!]! + code - String
    id - EndpointId + message - String! + +
    path - [String]
    -
    -
    -
    -
    Example
    -
    {
    -  "errors": [Error],
    -  "id": EndpointId
    -}
    -
    -
    -
    -
    -
    -
    -
    - Types -
    -

    CallbackEndpointDeleteInput

    -
    -
    -
    -
    Fields
    +
    +
    Possible Types
    - - + - @@ -7414,37 +12274,43 @@
    Fields
    Example
    -
    {"id": EndpointId}
    +                  
    {
    +  "code": "abc123",
    +  "message": "abc123",
    +  "path": ["abc123"]
    +}
     
    -
    +
    -

    CaptchaCreateChallengePayload

    +

    ExchangeCurrencyUnit

    -
    Fields
    +
    Values
    Input FieldDescriptionError Types
    - id - EndpointId! - +

    GraphQLApplicationError

    - + - - @@ -7456,20 +12322,38 @@
    Fields
    Example
    -
    {
    -  "errors": [Error],
    -  "result": CaptchaCreateChallengeResult
    -}
    +                  
    "BTCSAT"
     
    -
    +
    -

    CaptchaCreateChallengeResult

    +

    Feedback

    +
    +
    +
    +
    Description
    +

    Feedback shared with our user

    +
    +
    +
    +
    +
    Example
    +
    Feedback
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    FeedbackSubmitInput

    @@ -7477,31 +12361,14 @@
    Fields
    Field NameEnum Value Description
    errors - [Error!]! + +

    BTCSAT

    result - CaptchaCreateChallengeResult + +

    USDCENT

    - + - - - - - - - - - - - - @@ -7511,24 +12378,19 @@
    Fields
    -
    -
    Example
    -
    {
    -  "challengeCode": "abc123",
    -  "failbackMode": false,
    -  "id": "xyz789",
    -  "newCaptcha": false
    -}
    +                
    +
    Example
    +
    {"feedback": Feedback}
     
    -
    +
    -

    CaptchaRequestAuthCodeInput

    +

    FeesInformation

    @@ -7536,42 +12398,13 @@
    Fields
    Field NameInput Field Description
    challengeCode - String! - -
    failbackMode - Boolean! - -
    id - String! - -
    newCaptcha - Boolean! + feedback - Feedback!
    - + - - - - - - - - - - - - - - - - - @@ -7583,91 +12416,65 @@
    Fields
    Example
    -
    {
    -  "challengeCode": "abc123",
    -  "channel": "SMS",
    -  "phone": Phone,
    -  "secCode": "xyz789",
    -  "validationCode": "abc123"
    -}
    +                  
    {"deposit": DepositFeesInformation}
     
    -
    +
    -

    CentAmount

    +

    Float

    Description
    -

    (Positive) Cent amount (1/100 of a dollar)

    +

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

    Example
    -
    CentAmount
    +                  
    987.65
     
    -
    +
    -

    CentAmountPayload

    +

    FractionalCentAmount

    -
    -
    Fields
    -
    Input FieldField Name Description
    - challengeCode - String! - -
    - channel - PhoneCodeChannelType - -
    - phone - Phone! - -
    - secCode - String! - -
    - validationCode - String! + deposit - DepositFeesInformation!
    - - - - - - - - - - - - - - - - -
    Field NameDescription
    amount - CentAmount - -
    errors - [Error!]! - -
    +
    +
    Description
    +

    Cent amount (1/100 of a dollar) as a float, can be positive or negative

    Example
    -
    {
    -  "amount": CentAmount,
    -  "errors": [Error]
    -}
    +                  
    FractionalCentAmount
     
    -
    +
    -

    ConsumerAccount

    +

    Globals

    +
    +
    Description
    +

    Provides global settings for the application which might have an impact for the user.

    +
    Fields
    @@ -7679,116 +12486,115 @@
    Fields
    - - + - - + - - - - - - + - - - + - - - + - - + + + + - - + + + +
    callbackEndpoints - [CallbackEndpoint!]! - + bridgeEnabled - Boolean! Whether Bridge (international bank transfer) entry points should be shown to the user. Controlled by the instance-wide bridge feature flag.
    csvTransactions - String! +
    buildInformation - BuildInformation! return CSV stream, base64 encoded, of the list of transactions in the wallet
    -
    -
    Arguments
    -
    -
    -
    walletIds - [WalletId!]! -
    -
    -
    -
    +
    defaultWalletId - WalletId! - + cashoutEnabled - Boolean! Whether cashout (settle to local bank account) entry points should be shown to the user. Controlled by the instance-wide cashout feature flag.
    displayCurrency - DisplayCurrency! + feesInformation - FeesInformation!
    id - ID! - + lightningAddressDomain - String! The domain name for lightning addresses accepted by this Galoy instance
    level - AccountLevel! + lightningAddressDomainAliases - [String!]!
    limits - AccountLimits! - + network - Network! Which network (mainnet, testnet, regtest, signet) this instance is running on.
    notificationSettings - NotificationSettings! + nodesIds - [String!]! + A list of public keys for the running lightning nodes. This can be used to know if an invoice belongs to one of our nodes.
    supportedCountries - [Country!]! A list of countries and their supported auth channels
    quiz - [Quiz!]! + topupEnabled - Boolean! List the quiz questions of the consumer account Whether wallet top-up entry points (card webview and bank-transfer-to-support) should be shown to the user. Controlled by the instance-wide topup feature flag.
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "bridgeEnabled": false,
    +  "buildInformation": BuildInformation,
    +  "cashoutEnabled": true,
    +  "feesInformation": FeesInformation,
    +  "lightningAddressDomain": "xyz789",
    +  "lightningAddressDomainAliases": [
    +    "xyz789"
    +  ],
    +  "network": "mainnet",
    +  "nodesIds": ["xyz789"],
    +  "supportedCountries": [Country],
    +  "topupEnabled": true
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    GraphQLApplicationError

    +
    +
    +
    +
    Fields
    + + + + + + + - - - + - - - - - @@ -7801,50 +12607,62 @@
    walletIds
    Example
    {
    -  "callbackEndpoints": [CallbackEndpoint],
    -  "csvTransactions": "abc123",
    -  "defaultWalletId": WalletId,
    -  "displayCurrency": DisplayCurrency,
    -  "id": 4,
    -  "level": "ONE",
    -  "limits": AccountLimits,
    -  "notificationSettings": NotificationSettings,
    -  "quiz": [Quiz],
    -  "realtimePrice": RealtimePrice,
    -  "transactions": TransactionConnection,
    -  "wallets": [Wallet]
    +  "code": "abc123",
    +  "message": "xyz789",
    +  "path": ["xyz789"]
     }
     
    -
    +
    +
    + Types +
    +

    Hex32Bytes

    +
    +
    +
    +
    Description
    +

    Hex-encoded string of 32 bytes

    +
    +
    +
    +
    +
    Example
    +
    Hex32Bytes
    +
    +
    +
    +
    +
    +
    -

    ContactAlias

    +

    ID

    Description
    -

    An alias name that a user can set for a wallet (with which they have transactions)

    +

    The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

    Example
    -
    ContactAlias
    +                  
    "4"
     
    -
    +
    -

    Coordinates

    +

    IdDocumentUploadUrlGenerateInput

    @@ -7852,22 +12670,22 @@
    Fields
    Field NameDescription
    realtimePrice - RealtimePrice! + code - String
    transactions - TransactionConnection +
    message - String! A list of all transactions associated with walletIds optionally passed.
    -
    -
    Arguments
    -
    -
    -
    after - String -
    -

    Returns the items in the list that come after the specified cursor.

    -
    -
    -
    before - String -
    -

    Returns the items in the list that come before the specified cursor.

    -
    -
    -
    first - Int -
    -

    Returns the first n items from the list.

    -
    -
    -
    last - Int -
    -

    Returns the last n items from the list.

    -
    -
    -
    walletIds - [WalletId] -
    -
    -
    -
    +
    wallets - [Wallet!]! + path - [String]
    - + - + - +
    Field NameInput Field Description
    latitude - Float! - + contentType - String! MIME type (image/jpeg, image/png, image/webp)
    longitude - Float! - + filename - String! Original filename
    @@ -7876,17 +12694,20 @@
    Fields
    Example
    -
    {"latitude": 987.65, "longitude": 987.65}
    +                  
    {
    +  "contentType": "xyz789",
    +  "filename": "xyz789"
    +}
     
    -
    +
    -

    Country

    +

    IdDocumentUploadUrlPayload

    @@ -7900,16 +12721,20 @@
    Fields
    - id - CountryCode! + errors - [Error!]! - supportedAuthChannels - [PhoneCodeChannelType!]! + fileKey - String - + Storage key for the uploaded file (use to generate read URLs) + + + uploadUrl - String + Pre-signed URL for uploading the ID document directly to storage @@ -7919,40 +12744,20 @@
    Fields
    Example
    {
    -  "id": "US",
    -  "supportedAuthChannels": ["SMS"]
    +  "errors": [Error],
    +  "fileKey": "xyz789",
    +  "uploadUrl": "xyz789"
     }
     
    -
    -
    - Types -
    -

    CountryCode

    -
    -
    -
    -
    Description
    -

    A CCA2 country code (ex US, FR, etc)

    -
    -
    -
    -
    -
    Example
    -
    "US"
    -
    -
    -
    -
    -
    -
    +
    -

    Currency

    +

    InitiateCashoutInput

    @@ -7960,37 +12765,20 @@
    Fields
    - + - - - - - - - - - + - - - - @@ -8003,22 +12791,19 @@
    Fields
    Example
    {
    -  "flag": "abc123",
    -  "fractionDigits": 123,
    -  "id": "4",
    -  "name": "abc123",
    -  "symbol": "abc123"
    +  "offerId": "4",
    +  "walletId": WalletId
     }
     
    -
    +
    -

    DepositFeesInformation

    +

    InitiatedCashoutResponse

    @@ -8032,20 +12817,16 @@
    Fields
    - - - - - - -
    Field NameInput Field Description
    flag - String! - -
    fractionDigits - Int! - -
    id - ID! - + offerId - ID! The id of the offer being executed.
    name - String! - -
    symbol - String! + walletId - WalletId!
    minBankFee - String! + errors - [Error!]!
    minBankFeeThreshold - String! + id - ID below this amount minBankFee will be charged
    ratio - String! + ratio to charge as basis points above minBankFeeThreshold amount
    @@ -8055,37 +12836,43 @@
    Fields
    Example
    {
    -  "minBankFee": "xyz789",
    -  "minBankFeeThreshold": "xyz789",
    -  "ratio": "xyz789"
    +  "errors": [Error],
    +  "id": "4"
     }
     
    -
    +
    -

    DeviceNotificationTokenCreateInput

    +

    InitiationVia

    -
    Fields
    +
    Types
    - - + + + + + + @@ -8095,38 +12882,17 @@
    Fields
    Example
    -
    {"deviceToken": "xyz789"}
    -
    -
    -
    - - -
    -
    - Types -
    -

    DisplayCurrency

    -
    -
    -
    -
    Description
    -

    Display currency of an account

    -
    -
    -
    -
    -
    Example
    -
    DisplayCurrency
    +                  
    InitiationViaIntraLedger
     
    -
    +
    -

    Email

    +

    InitiationViaIntraLedger

    @@ -8140,13 +12906,13 @@
    Fields
    - - @@ -8159,145 +12925,148 @@
    Fields
    Example
    {
    -  "address": "test@test.com",
    -  "verified": true
    +  "counterPartyUsername": Username,
    +  "counterPartyWalletId": WalletId
     }
     
    -
    +
    -

    EmailAddress

    +

    InitiationViaLn

    -
    -
    Description
    -

    Email address

    +
    +
    Fields
    +
    Input FieldDescriptionUnion Types
    - deviceToken - String! +

    InitiationViaIntraLedger

    +
    +

    InitiationViaLn

    +

    InitiationViaOnChain

    address - EmailAddress + counterPartyUsername - Username
    verified - Boolean + counterPartyWalletId - WalletId
    + + + + + + + + + + + + +
    Field NameDescription
    paymentHash - PaymentHash! + +
    Example
    -
    "test@test.com"
    +                  
    {"paymentHash": PaymentHash}
     
    -
    +
    -

    EmailRegistrationId

    +

    InitiationViaOnChain

    -
    -
    Description
    -

    An id to be passed between registrationInitiate and registrationValidate for confirming email

    -
    -
    -
    -
    -
    Example
    -
    EmailRegistrationId
    -
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Field NameDescription
    address - OnChainAddress! + +
    -
    -
    -
    -
    - Types -
    -

    EndpointId

    -
    -
    -
    Example
    -
    EndpointId
    +                  
    {"address": OnChainAddress}
     
    -
    +
    -

    EndpointUrl

    +

    Int

    Description
    -

    Url that will be fetched on events for the account

    +

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

    Example
    -
    EndpointUrl
    +                  
    987
     
    -
    +
    -

    Error

    +

    IntraLedgerPaymentSendInput

    -
    +
    Fields
    - + - + - + - + - -
    Field NameInput Field Description
    code - String - + amount - SatAmount! Amount in satoshis.
    message - String! - + memo - Memo Optional memo to be attached to the payment.
    path - [String] - + recipientWalletId - WalletId! +
    -
    -
    -
    Possible Types
    - - - - - - - +
    Error Types
    -

    GraphQLApplicationError

    + walletId - WalletId!
    The wallet ID of the sender.
    @@ -8307,42 +13076,60 @@
    Possible Types
    Example
    {
    -  "code": "abc123",
    -  "message": "xyz789",
    -  "path": ["xyz789"]
    +  "amount": SatAmount,
    +  "memo": Memo,
    +  "recipientWalletId": WalletId,
    +  "walletId": WalletId
     }
     
    -
    +
    -

    ExchangeCurrencyUnit

    +

    IntraLedgerUpdate

    -
    Values
    +
    Fields
    - + + + + + + + + + + + + + @@ -8354,38 +13141,23 @@
    Values
    Example
    -
    "BTCSAT"
    -
    -
    -
    - - -
    -
    - Types -
    -

    Feedback

    -
    -
    -
    -
    Description
    -

    Feedback shared with our user

    -
    -
    -
    -
    -
    Example
    -
    Feedback
    +                  
    {
    +  "amount": SatAmount,
    +  "displayCurrencyPerSat": 987.65,
    +  "txNotificationType": "IntraLedgerPayment",
    +  "usdPerSat": 987.65,
    +  "walletId": WalletId
    +}
     
    -
    +
    -

    FeedbackSubmitInput

    +

    IntraLedgerUsdPaymentSendInput

    @@ -8400,10 +13172,28 @@
    Fields
    + + + + + + + + + + + +
    Enum ValueField Name Description
    amount - SatAmount! + -

    BTCSAT

    +
    displayCurrencyPerSat - Float!
    txNotificationType - TxNotificationType! + -

    USDCENT

    +
    usdPerSat - Float! + + updated over displayCurrencyPerSat +
    walletId - WalletId!
    - feedback - Feedback! + amount - FractionalCentAmount! + Amount in cents.
    + memo - Memo + Optional memo to be attached to the payment.
    + recipientWalletId - WalletId! +
    + walletId - WalletId! The wallet ID of the sender.
    @@ -8412,31 +13202,51 @@
    Fields
    Example
    -
    {"feedback": Feedback}
    +                  
    {
    +  "amount": FractionalCentAmount,
    +  "memo": Memo,
    +  "recipientWalletId": WalletId,
    +  "walletId": WalletId
    +}
     
    -
    +
    -

    FeesInformation

    +

    InvoicePaymentStatus

    -
    Fields
    +
    Values
    - + - + + + + + + + + @@ -8448,113 +13258,36 @@
    Fields
    Example
    -
    {"deposit": DepositFeesInformation}
    -
    -
    -
    - - -
    -
    - Types -
    -

    Float

    -
    -
    -
    -
    Description
    -

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

    -
    -
    -
    -
    -
    Example
    -
    987.65
    -
    -
    -
    -
    -
    -
    -
    - Types -
    -

    FractionalCentAmount

    -
    -
    -
    -
    Description
    -

    (Positive) Cent amount (1/100 of a dollar) as a float

    -
    -
    -
    -
    -
    Example
    -
    FractionalCentAmount
    +                  
    "EXPIRED"
     
    -
    +
    -

    Globals

    +

    IsFlashNpubInput

    -
    -
    Description
    -

    Provides global settings for the application which might have an impact for the user.

    -
    Fields
    Field NameEnum Value Description
    deposit - DepositFeesInformation! + +

    EXPIRED

    +
    +
    +

    PAID

    +
    +
    +

    PENDING

    - + - - - - - - - - - - - - - - - - - - - - - - - -
    Field NameInput Field Description
    buildInformation - BuildInformation! - -
    feesInformation - FeesInformation! - -
    lightningAddressDomain - String! - The domain name for lightning addresses accepted by this Galoy instance
    lightningAddressDomainAliases - [String!]! + npub - npub!
    network - Network! - Which network (mainnet, testnet, regtest, signet) this instance is running on.
    nodesIds - [String!]! - A list of public keys for the running lightning nodes. This can be used to know if an invoice belongs to one of our nodes.
    supportedCountries - [Country!]! - A list of countries and their supported auth channels
    @@ -8562,27 +13295,17 @@
    Fields
    Example
    -
    {
    -  "buildInformation": BuildInformation,
    -  "feesInformation": FeesInformation,
    -  "lightningAddressDomain": "xyz789",
    -  "lightningAddressDomainAliases": [
    -    "abc123"
    -  ],
    -  "network": "mainnet",
    -  "nodesIds": ["abc123"],
    -  "supportedCountries": [Country]
    -}
    +                  
    {"npub": npub}
     
    -
    +
    -

    GraphQLApplicationError

    +

    IsFlashNpubPayload

    @@ -8596,19 +13319,13 @@
    Fields
    - code - String - - - - - - message - String! + errors - [Error!]! - path - [String] + isFlashNpub - Boolean @@ -8620,87 +13337,89 @@
    Fields
    Example
    -
    {
    -  "code": "xyz789",
    -  "message": "xyz789",
    -  "path": ["abc123"]
    -}
    +                  
    {"errors": [Error], "isFlashNpub": true}
     
    -
    +
    -

    Hex32Bytes

    +

    JMDCents

    Description
    -

    Hex-encoded string of 32 bytes

    +

    Amount in Jamaican cents

    Example
    -
    Hex32Bytes
    +                  
    JMDCents
     
    -
    +
    -

    ID

    +

    Language

    -
    -
    Description
    -

    The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

    -
    Example
    -
    4
    +                  
    Language
     
    -
    +
    -

    InitiationVia

    +

    LnInvoice

    -
    Types
    +
    Fields
    - + + + + + + + + + @@ -8710,17 +13429,22 @@
    Types
    Example
    -
    InitiationViaIntraLedger
    +                  
    {
    +  "paymentHash": PaymentHash,
    +  "paymentRequest": LnPaymentRequest,
    +  "paymentSecret": LnPaymentSecret,
    +  "satoshis": SatAmount
    +}
     
    -
    +
    -

    InitiationViaIntraLedger

    +

    LnInvoiceCreateInput

    @@ -8728,22 +13452,34 @@
    Fields
    Union TypesField NameDescription
    paymentHash - PaymentHash! + -

    InitiationViaIntraLedger

    paymentRequest - LnPaymentRequest! + +
    paymentSecret - LnPaymentSecret! + -

    InitiationViaLn

    satoshis - SatAmount + -

    InitiationViaOnChain

    - + - + + + + - + + + +
    Field NameInput Field Description
    counterPartyUsername - Username + + amount - SatAmount! Amount in satoshis.
    + expiresIn - Minutes Optional invoice expiration time in minutes.
    counterPartyWalletId - WalletId + + memo - Memo Optional memo for the lightning invoice.
    + walletId - WalletId! Wallet ID for a BTC wallet belonging to the current account.
    @@ -8753,19 +13489,21 @@
    Fields
    Example
    {
    -  "counterPartyUsername": Username,
    -  "counterPartyWalletId": WalletId
    +  "amount": SatAmount,
    +  "expiresIn": Minutes,
    +  "memo": Memo,
    +  "walletId": WalletId
     }
     
    -
    +
    -

    InitiationViaLn

    +

    LnInvoiceCreateOnBehalfOfRecipientInput

    @@ -8773,16 +13511,41 @@
    Fields
    - + - + + + + + + + + + + + + + + + +
    Field NameInput Field Description
    paymentHash - PaymentHash! + + amount - SatAmount! + Amount in satoshis.
    + descriptionHash - Hex32Bytes + +
    + expiresIn - Minutes Optional invoice expiration time in minutes.
    + memo - Memo + Optional memo for the lightning invoice.
    + recipientWalletId - WalletId! Wallet ID for a BTC wallet which belongs to any account.
    @@ -8791,17 +13554,23 @@
    Fields
    Example
    -
    {"paymentHash": PaymentHash}
    +                  
    {
    +  "amount": SatAmount,
    +  "descriptionHash": Hex32Bytes,
    +  "expiresIn": Minutes,
    +  "memo": Memo,
    +  "recipientWalletId": WalletId
    +}
     
    -
    +
    -

    InitiationViaOnChain

    +

    LnInvoiceFeeProbeInput

    @@ -8809,13 +13578,21 @@
    Fields
    - + - + + + + @@ -8827,38 +13604,65 @@
    Fields
    Example
    -
    {"address": OnChainAddress}
    +                  
    {
    +  "paymentRequest": LnPaymentRequest,
    +  "walletId": WalletId
    +}
     
    -
    +
    -

    Int

    +

    LnInvoicePayload

    -
    -
    Description
    -

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

    +
    +
    Fields
    +
    Field NameInput Field Description
    address - OnChainAddress! + + paymentRequest - LnPaymentRequest! + +
    + walletId - WalletId!
    + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error!]! + +
    invoice - LnInvoice + +
    Example
    -
    987
    +                  
    {
    +  "errors": [Error],
    +  "invoice": LnInvoice
    +}
     
    -
    +
    -

    IntraLedgerPaymentSendInput

    +

    LnInvoicePaymentInput

    @@ -8871,30 +13675,23 @@
    Fields
    - - - amount - SatAmount! - - Amount in satoshis. - memo - Memo - Optional memo to be attached to the payment. + Optional memo to associate with the lightning invoice. - recipientWalletId - WalletId! - - + paymentRequest - LnPaymentRequest! + Payment request representing the invoice which is being paid. walletId - WalletId! - The wallet ID of the sender. + Wallet ID with sufficient balance to cover amount of invoice. Must belong to the account of the current user. @@ -8904,9 +13701,8 @@
    Fields
    Example
    {
    -  "amount": SatAmount,
       "memo": Memo,
    -  "recipientWalletId": WalletId,
    +  "paymentRequest": LnPaymentRequest,
       "walletId": WalletId
     }
     
    @@ -8914,11 +13710,11 @@
    Example
    -
    +
    -

    IntraLedgerUpdate

    +

    LnInvoicePaymentStatusInput

    @@ -8926,38 +13722,56 @@
    Fields
    - + - - - - + +
    Field NameInput Field Description
    amount - SatAmount! - -
    displayCurrencyPerSat - Float! + paymentRequest - LnPaymentRequest!
    +
    +
    +
    +
    +
    Example
    +
    {"paymentRequest": LnPaymentRequest}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    LnInvoicePaymentStatusPayload

    +
    +
    +
    +
    Fields
    + + - - + + + + - - @@ -8969,23 +13783,17 @@
    Fields
    Example
    -
    {
    -  "amount": SatAmount,
    -  "displayCurrencyPerSat": 123.45,
    -  "txNotificationType": "IntraLedgerPayment",
    -  "usdPerSat": 987.65,
    -  "walletId": WalletId
    -}
    +                  
    {"errors": [Error], "status": "EXPIRED"}
     
    -
    +
    -

    IntraLedgerUsdPaymentSendInput

    +

    LnNoAmountInvoice

    @@ -8993,35 +13801,28 @@
    Fields
    txNotificationType - TxNotificationType! - - Field NameDescription
    usdPerSat - Float! + errors - [Error!]! - updated over displayCurrencyPerSat
    walletId - WalletId! + status - InvoicePaymentStatus
    - + - - - - - - + -
    Input FieldField Name Description
    - amount - FractionalCentAmount! + paymentHash - PaymentHash! Amount in cents.
    - memo - Memo Optional memo to be attached to the payment.
    - recipientWalletId - WalletId! + paymentRequest - LnPaymentRequest!
    paymentSecret - LnPaymentSecret! + - walletId - WalletId! The wallet ID of the sender.
    @@ -9031,53 +13832,49 @@
    Fields
    Example
    {
    -  "amount": FractionalCentAmount,
    -  "memo": Memo,
    -  "recipientWalletId": WalletId,
    -  "walletId": WalletId
    +  "paymentHash": PaymentHash,
    +  "paymentRequest": LnPaymentRequest,
    +  "paymentSecret": LnPaymentSecret
     }
     
    -
    +
    -

    InvoicePaymentStatus

    +

    LnNoAmountInvoiceCreateInput

    -
    Values
    +
    Fields
    - + - + - + - +
    Enum ValueInput Field Description
    -

    EXPIRED

    -
    + expiresIn - Minutes Optional invoice expiration time in minutes.
    -

    PAID

    -
    + memo - Memo Optional memo for the lightning invoice.
    -

    PENDING

    -
    + walletId - WalletId! ID for either a USD or BTC wallet belonging to the account of the current user.
    @@ -9086,17 +13883,21 @@
    Values
    Example
    -
    "EXPIRED"
    +                  
    {
    +  "expiresIn": Minutes,
    +  "memo": Memo,
    +  "walletId": WalletId
    +}
     
    -
    +
    -

    IsFlashNpubInput

    +

    LnNoAmountInvoiceCreateOnBehalfOfRecipientInput

    @@ -9111,10 +13912,21 @@
    Fields
    - npub - npub! + expiresIn - Minutes + + Optional invoice expiration time in minutes. + + + + memo - Memo + Optional memo for the lightning invoice. + + + recipientWalletId - WalletId! + ID for either a USD or BTC wallet which belongs to the account of any user. @@ -9123,17 +13935,21 @@
    Fields
    Example
    -
    {"npub": npub}
    +                  
    {
    +  "expiresIn": Minutes,
    +  "memo": Memo,
    +  "recipientWalletId": WalletId
    +}
     
    -
    +
    -

    IsFlashNpubPayload

    +

    LnNoAmountInvoiceFeeProbeInput

    @@ -9141,19 +13957,28 @@
    Fields
    - + - - + + + + @@ -9165,34 +13990,21 @@
    Fields
    Example
    -
    {"errors": [Error], "isFlashNpub": true}
    -
    -
    -
    - - -
    -
    - Types -
    -

    Language

    -
    -
    -
    -
    -
    -
    Example
    -
    Language
    +                  
    {
    +  "amount": SatAmount,
    +  "paymentRequest": LnPaymentRequest,
    +  "walletId": WalletId
    +}
     
    -
    +
    -

    LnInvoice

    +

    LnNoAmountInvoicePayload

    @@ -9206,25 +14018,13 @@
    Fields
    - - - - - - - - - - @@ -9237,21 +14037,19 @@
    Fields
    Example
    {
    -  "paymentHash": PaymentHash,
    -  "paymentRequest": LnPaymentRequest,
    -  "paymentSecret": LnPaymentSecret,
    -  "satoshis": SatAmount
    +  "errors": [Error],
    +  "invoice": LnNoAmountInvoice
     }
     
    -
    +
    -

    LnInvoiceCreateInput

    +

    LnNoAmountInvoicePaymentInput

    @@ -9268,25 +14066,25 @@
    Fields
    - + - + - + - +
    Field NameInput Field Description
    errors - [Error!]! + + amount - SatAmount!
    isFlashNpub - Boolean + + paymentRequest - LnPaymentRequest! + +
    + walletId - WalletId!
    paymentHash - PaymentHash! - -
    paymentRequest - LnPaymentRequest! - -
    paymentSecret - LnPaymentSecret! + errors - [Error!]!
    satoshis - SatAmount + invoice - LnNoAmountInvoice amount - SatAmount! Amount in satoshis. Amount to pay in satoshis.
    - expiresIn - Minutes + memo - Memo Optional invoice expiration time in minutes. Optional memo to associate with the lightning invoice.
    - memo - Memo + paymentRequest - LnPaymentRequest! Optional memo for the lightning invoice. Payment request representing the invoice which is being paid.
    walletId - WalletId! Wallet ID for a BTC wallet belonging to the current account. Wallet ID with sufficient balance to cover amount defined in mutation request. Must belong to the account of the current user.
    @@ -9297,8 +14095,8 @@
    Fields
    Example
    {
       "amount": SatAmount,
    -  "expiresIn": Minutes,
       "memo": Memo,
    +  "paymentRequest": LnPaymentRequest,
       "walletId": WalletId
     }
     
    @@ -9306,11 +14104,11 @@
    Example
    -
    +
    -

    LnInvoiceCreateOnBehalfOfRecipientInput

    +

    LnNoAmountUsdInvoiceFeeProbeInput

    @@ -9325,34 +14123,24 @@
    Fields
    - amount - SatAmount! - - Amount in satoshis. - - - - descriptionHash - Hex32Bytes + amount - FractionalCentAmount! - expiresIn - Minutes + paymentRequest - LnPaymentRequest! - Optional invoice expiration time in minutes. - - - memo - Memo - Optional memo for the lightning invoice. - recipientWalletId - WalletId! + walletId - WalletId! + + - Wallet ID for a BTC wallet which belongs to any account. @@ -9362,22 +14150,20 @@
    Fields
    Example
    {
    -  "amount": SatAmount,
    -  "descriptionHash": Hex32Bytes,
    -  "expiresIn": Minutes,
    -  "memo": Memo,
    -  "recipientWalletId": WalletId
    +  "amount": FractionalCentAmount,
    +  "paymentRequest": LnPaymentRequest,
    +  "walletId": WalletId
     }
     
    -
    +
    -

    LnInvoiceFeeProbeInput

    +

    LnNoAmountUsdInvoicePaymentInput

    @@ -9392,17 +14178,27 @@
    Fields
    - paymentRequest - LnPaymentRequest! + amount - FractionalCentAmount! + Amount to pay in USD cents. + + + memo - Memo + Optional memo to associate with the lightning invoice. - walletId - WalletId! + paymentRequest - LnPaymentRequest! + Payment request representing the invoice which is being paid. + + + walletId - WalletId! + Wallet ID with sufficient balance to cover amount defined in mutation request. Must belong to the account of the current user. @@ -9412,6 +14208,8 @@
    Fields
    Example
    {
    +  "amount": FractionalCentAmount,
    +  "memo": Memo,
       "paymentRequest": LnPaymentRequest,
       "walletId": WalletId
     }
    @@ -9420,11 +14218,66 @@ 
    Example
    -
    +
    -

    LnInvoicePayload

    +

    LnPaymentPreImage

    +
    +
    +
    +
    +
    +
    Example
    +
    LnPaymentPreImage
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    LnPaymentRequest

    +
    +
    +
    +
    Description
    +

    BOLT11 lightning invoice payment request with the amount included

    +
    +
    +
    +
    +
    Example
    +
    LnPaymentRequest
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    LnPaymentSecret

    +
    +
    +
    +
    +
    +
    Example
    +
    LnPaymentSecret
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    LnUpdate

    @@ -9438,13 +14291,19 @@
    Fields
    - errors - [Error!]! + paymentHash - PaymentHash! - invoice - LnInvoice + status - InvoicePaymentStatus! + + + + + + walletId - WalletId! @@ -9457,19 +14316,20 @@
    Fields
    Example
    {
    -  "errors": [Error],
    -  "invoice": LnInvoice
    +  "paymentHash": PaymentHash,
    +  "status": "EXPIRED",
    +  "walletId": WalletId
     }
     
    -
    +
    -

    LnInvoicePaymentInput

    +

    LnUsdInvoiceCreateInput

    @@ -9484,21 +14344,27 @@
    Fields
    - memo - Memo + amount - FractionalCentAmount! - Optional memo to associate with the lightning invoice. + Amount in USD cents. - paymentRequest - LnPaymentRequest! + expiresIn - Minutes - Payment request representing the invoice which is being paid. + Optional invoice expiration time in minutes. + + + + memo - Memo + + Optional memo for the lightning invoice. walletId - WalletId! - Wallet ID with sufficient balance to cover amount of invoice. Must belong to the account of the current user. + Wallet ID for a USD wallet belonging to the current user. @@ -9508,8 +14374,9 @@
    Fields
    Example
    {
    +  "amount": FractionalCentAmount,
    +  "expiresIn": Minutes,
       "memo": Memo,
    -  "paymentRequest": LnPaymentRequest,
       "walletId": WalletId
     }
     
    @@ -9517,11 +14384,11 @@
    Example
    -
    +
    -

    LnInvoicePaymentStatusInput

    +

    LnUsdInvoiceCreateOnBehalfOfRecipientInput

    @@ -9536,10 +14403,34 @@
    Fields
    - paymentRequest - LnPaymentRequest! + amount - FractionalCentAmount! + + Amount in USD cents. + + + + descriptionHash - Hex32Bytes + + + + + + + expiresIn - Minutes + + Optional invoice expiration time in minutes. + + + + memo - Memo + Optional memo for the lightning invoice. Acts as a note to the recipient. + + + recipientWalletId - WalletId! + Wallet ID for a USD wallet which belongs to the account of any user. @@ -9548,17 +14439,23 @@
    Fields
    Example
    -
    {"paymentRequest": LnPaymentRequest}
    +                  
    {
    +  "amount": FractionalCentAmount,
    +  "descriptionHash": Hex32Bytes,
    +  "expiresIn": Minutes,
    +  "memo": Memo,
    +  "recipientWalletId": WalletId
    +}
     
    -
    +
    -

    LnInvoicePaymentStatusPayload

    +

    LnUsdInvoiceFeeProbeInput

    @@ -9566,19 +14463,21 @@
    Fields
    - + - - @@ -9590,69 +14489,41 @@
    Fields
    Example
    -
    {"errors": [Error], "status": "EXPIRED"}
    +                  
    {
    +  "paymentRequest": LnPaymentRequest,
    +  "walletId": WalletId
    +}
     
    -
    +
    -

    LnNoAmountInvoice

    +

    Lnurl

    -
    -
    Fields
    -
    Field NameInput Field Description
    errors - [Error!]! + + paymentRequest - LnPaymentRequest!
    status - InvoicePaymentStatus + + walletId - WalletId!
    - - - - - - - - - - - - - - - - - - - - -
    Field NameDescription
    paymentHash - PaymentHash! - -
    paymentRequest - LnPaymentRequest! - -
    paymentSecret - LnPaymentSecret! - -
    +
    +
    Description
    +

    A bech32-encoded HTTPS/Onion URL that can be interacted with automatically by a WALLET in a standard way such that a SERVICE can provide extra services or a better experience for the user. Ref: https://github.com/lnurl/luds/blob/luds/01.md

    Example
    -
    {
    -  "paymentHash": PaymentHash,
    -  "paymentRequest": LnPaymentRequest,
    -  "paymentSecret": LnPaymentSecret
    -}
    +                  
    Lnurl
     
    -
    +
    -

    LnNoAmountInvoiceCreateInput

    +

    LnurlPaymentSendInput

    @@ -9667,21 +14538,27 @@
    Fields
    - expiresIn - Minutes + amount - FractionalCentAmount! - Optional invoice expiration time in minutes. + Amount to spend from the USD/USDT wallet, in USD cents. + + + + lnurl - Lnurl! + + LNURL-pay value to decode and pay. memo - Memo - Optional memo for the lightning invoice. + Optional memo for the Lightning payment. walletId - WalletId! - ID for either a USD or BTC wallet belonging to the account of the current user. + Wallet ID with sufficient balance. Must belong to the current user. @@ -9691,7 +14568,8 @@
    Fields
    Example
    {
    -  "expiresIn": Minutes,
    +  "amount": FractionalCentAmount,
    +  "lnurl": Lnurl,
       "memo": Memo,
       "walletId": WalletId
     }
    @@ -9700,11 +14578,11 @@ 
    Example
    -
    +
    -

    LnNoAmountInvoiceCreateOnBehalfOfRecipientInput

    +

    MapInfo

    @@ -9712,28 +14590,22 @@
    Fields
    - + - - - - - + -
    Input FieldField Name Description
    - expiresIn - Minutes + coordinates - Coordinates! Optional invoice expiration time in minutes.
    - memo - Memo Optional memo for the lightning invoice.
    title - String! + - recipientWalletId - WalletId! ID for either a USD or BTC wallet which belongs to the account of any user.
    @@ -9743,20 +14615,19 @@
    Fields
    Example
    {
    -  "expiresIn": Minutes,
    -  "memo": Memo,
    -  "recipientWalletId": WalletId
    +  "coordinates": Coordinates,
    +  "title": "abc123"
     }
     
    -
    +
    -

    LnNoAmountInvoiceFeeProbeInput

    +

    MapMarker

    @@ -9764,28 +14635,19 @@
    Fields
    - + - - - - - - @@ -9798,65 +14660,40 @@
    Fields
    Example
    {
    -  "amount": SatAmount,
    -  "paymentRequest": LnPaymentRequest,
    -  "walletId": WalletId
    +  "mapInfo": MapInfo,
    +  "username": Username
     }
     
    -
    +
    -

    LnNoAmountInvoicePayload

    +

    Memo

    -
    -
    Fields
    -
    Input FieldField Name Description
    - amount - SatAmount! - -
    - paymentRequest - LnPaymentRequest! + mapInfo - MapInfo!
    - walletId - WalletId! + username - Username
    - - - - - - - - - - - - - - - - -
    Field NameDescription
    errors - [Error!]! - -
    invoice - LnNoAmountInvoice - -
    +
    +
    Description
    +

    Text field in a lightning payment transaction

    Example
    -
    {
    -  "errors": [Error],
    -  "invoice": LnNoAmountInvoice
    -}
    +                  
    Memo
     
    -
    +
    -

    LnNoAmountInvoicePaymentInput

    +

    Merchant

    @@ -9864,34 +14701,43 @@
    Fields
    - + + + + + + + + + + - + - - - + - - +
    Input FieldField Name Description
    coordinates - Coordinates! + GPS coordinates for the merchant that can be used to place the related business on a map
    createdAt - Timestamp! + +
    id - ID! + - amount - SatAmount! Amount to pay in satoshis.
    title - String! + - memo - Memo Optional memo to associate with the lightning invoice.
    - paymentRequest - LnPaymentRequest! + username - Username! Payment request representing the invoice which is being paid. The username of the merchant
    - walletId - WalletId! + validated - Boolean! Wallet ID with sufficient balance to cover amount defined in mutation request. Must belong to the account of the current user. Whether the merchant has been validated
    @@ -9901,21 +14747,23 @@
    Fields
    Example
    {
    -  "amount": SatAmount,
    -  "memo": Memo,
    -  "paymentRequest": LnPaymentRequest,
    -  "walletId": WalletId
    +  "coordinates": Coordinates,
    +  "createdAt": 1592577642,
    +  "id": 4,
    +  "title": "xyz789",
    +  "username": Username,
    +  "validated": false
     }
     
    -
    +
    -

    LnNoAmountUsdInvoiceFeeProbeInput

    +

    MerchantMapSuggestInput

    @@ -9930,21 +14778,28 @@
    Fields
    - amount - FractionalCentAmount! + latitude - Float! - paymentRequest - LnPaymentRequest! + longitude - Float! - walletId - WalletId! + title - String! + + + + + + + username - Username! @@ -9957,20 +14812,21 @@
    Fields
    Example
    {
    -  "amount": FractionalCentAmount,
    -  "paymentRequest": LnPaymentRequest,
    -  "walletId": WalletId
    +  "latitude": 123.45,
    +  "longitude": 987.65,
    +  "title": "abc123",
    +  "username": Username
     }
     
    -
    +
    -

    LnNoAmountUsdInvoicePaymentInput

    +

    MerchantPayload

    @@ -9978,34 +14834,22 @@
    Fields
    - + - - - - - - - - - -
    Input FieldField Name Description
    - amount - FractionalCentAmount! + errors - [Error!]! Amount to pay in USD cents.
    - memo - Memo Optional memo to associate with the lightning invoice.
    - paymentRequest - LnPaymentRequest! + merchant - Merchant Payment request representing the invoice which is being paid.
    - walletId - WalletId! Wallet ID with sufficient balance to cover amount defined in mutation request. Must belong to the account of the current user.
    @@ -10015,76 +14859,92 @@
    Fields
    Example
    {
    -  "amount": FractionalCentAmount,
    -  "memo": Memo,
    -  "paymentRequest": LnPaymentRequest,
    -  "walletId": WalletId
    +  "errors": [Error],
    +  "merchant": Merchant
     }
     
    -
    -
    - Types -
    -

    LnPaymentPreImage

    -
    -
    -
    -
    -
    -
    Example
    -
    LnPaymentPreImage
    -
    -
    -
    -
    -
    -
    +
    -

    LnPaymentRequest

    +

    Minutes

    Description
    -

    BOLT11 lightning invoice payment request with the amount included

    +

    (Positive) amount of minutes

    Example
    -
    LnPaymentRequest
    +                  
    Minutes
     
    -
    +
    -

    LnPaymentSecret

    +

    MobileVersions

    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    currentSupported - Int! + +
    minSupported - Int! + +
    platform - String! + +
    +
    Example
    -
    LnPaymentSecret
    +                  
    {
    +  "currentSupported": 123,
    +  "minSupported": 123,
    +  "platform": "xyz789"
    +}
     
    -
    +
    -

    LnUpdate

    +

    MyUpdatesPayload

    @@ -10098,19 +14958,19 @@
    Fields
    - paymentHash - PaymentHash! + errors - [Error!]! - status - InvoicePaymentStatus! + me - User - walletId - WalletId! + update - UserUpdate @@ -10123,55 +14983,59 @@
    Fields
    Example
    {
    -  "paymentHash": PaymentHash,
    -  "status": "EXPIRED",
    -  "walletId": WalletId
    +  "errors": [Error],
    +  "me": User,
    +  "update": IntraLedgerUpdate
     }
     
    -
    +
    -

    LnUsdInvoiceCreateInput

    +

    Network

    -
    Fields
    +
    Values
    - + + - + - + - + -
    Input FieldEnum Value Description
    - amount - FractionalCentAmount! +

    mainnet

    +
    Amount in USD cents.
    - expiresIn - Minutes +

    regtest

    +
    Optional invoice expiration time in minutes.
    - memo - Memo +

    signet

    +
    Optional memo for the lightning invoice.
    - walletId - WalletId! +

    testnet

    +
    Wallet ID for a USD wallet belonging to the current user.
    @@ -10180,64 +15044,94 @@
    Fields
    Example
    -
    {
    -  "amount": FractionalCentAmount,
    -  "expiresIn": Minutes,
    -  "memo": Memo,
    -  "walletId": WalletId
    -}
    +                  
    "mainnet"
     
    -
    +
    -

    LnUsdInvoiceCreateOnBehalfOfRecipientInput

    +

    NotificationCategory

    +
    +
    +
    +
    +
    +
    Example
    +
    NotificationCategory
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    NotificationChannel

    -
    Fields
    +
    Values
    - + - - - - + +
    Input FieldEnum Value Description
    - amount - FractionalCentAmount! - Amount in USD cents.
    - descriptionHash - Hex32Bytes +

    PUSH

    +
    +
    +
    +
    +
    Example
    +
    "PUSH"
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    NotificationChannelSettings

    +
    +
    +
    +
    Fields
    + + - - + + + + + - + -
    - expiresIn - Minutes - Optional invoice expiration time in minutes. Field NameDescription
    disabledCategories - [NotificationCategory!]! + - memo - Memo Optional memo for the lightning invoice. Acts as a note to the recipient.
    enabled - Boolean! + - recipientWalletId - WalletId! Wallet ID for a USD wallet which belongs to the account of any user.
    @@ -10247,22 +15141,19 @@
    Fields
    Example
    {
    -  "amount": FractionalCentAmount,
    -  "descriptionHash": Hex32Bytes,
    -  "expiresIn": Minutes,
    -  "memo": Memo,
    -  "recipientWalletId": WalletId
    +  "disabledCategories": [NotificationCategory],
    +  "enabled": false
     }
     
    -
    +
    -

    LnUsdInvoiceFeeProbeInput

    +

    NotificationSettings

    @@ -10270,21 +15161,13 @@
    Fields
    - + - - - - - @@ -10296,41 +15179,38 @@
    Fields
    Example
    -
    {
    -  "paymentRequest": LnPaymentRequest,
    -  "walletId": WalletId
    -}
    +                  
    {"push": NotificationChannelSettings}
     
    -
    +
    -

    Lnurl

    +

    OnChainAddress

    Description
    -

    A bech32-encoded HTTPS/Onion URL that can be interacted with automatically by a WALLET in a standard way such that a SERVICE can provide extra services or a better experience for the user. Ref: https://github.com/lnurl/luds/blob/luds/01.md

    +

    An address for an on-chain bitcoin destination

    Example
    -
    Lnurl
    +                  
    OnChainAddress
     
    -
    +
    -

    MapInfo

    +

    OnChainAddressCreateInput

    @@ -10338,19 +15218,14 @@
    Fields
    Input FieldField Name Description
    - paymentRequest - LnPaymentRequest! - -
    - walletId - WalletId! + push - NotificationChannelSettings!
    - + - - - - @@ -10362,20 +15237,17 @@
    Fields
    Example
    -
    {
    -  "coordinates": Coordinates,
    -  "title": "abc123"
    -}
    +                  
    {"walletId": WalletId}
     
    -
    +
    -

    MapMarker

    +

    OnChainAddressCurrentInput

    @@ -10383,19 +15255,14 @@
    Fields
    Field NameInput Field Description
    coordinates - Coordinates! - -
    title - String! + walletId - WalletId!
    - + - - - - @@ -10407,41 +15274,62 @@
    Fields
    Example
    -
    {
    -  "mapInfo": MapInfo,
    -  "username": Username
    -}
    +                  
    {"walletId": WalletId}
     
    -
    +
    -

    Memo

    +

    OnChainAddressPayload

    -
    -
    Description
    -

    Text field in a lightning payment transaction

    +
    +
    Fields
    +
    Field NameInput Field Description
    mapInfo - MapInfo! - -
    username - Username + walletId - WalletId!
    + + + + + + + + + + + + + + + + +
    Field NameDescription
    address - OnChainAddress + +
    errors - [Error!]! + +
    Example
    -
    Memo
    +                  
    {
    +  "address": OnChainAddress,
    +  "errors": [Error]
    +}
     
    -
    +
    -

    Merchant

    +

    OnChainPaymentSendAllInput

    @@ -10449,43 +15337,38 @@
    Fields
    - + - - - - - - - - - - - - -
    Field NameInput Field Description
    coordinates - Coordinates! - GPS coordinates for the merchant that can be used to place the related business on a map
    createdAt - Timestamp! + + address - OnChainAddress!
    id - ID! + + memo - Memo
    title - String! + + speed - PayoutSpeed
    username - Username! + + walletId - WalletId! The username of the merchant
    validated - Boolean! + Whether the merchant has been validated
    @@ -10495,23 +15378,21 @@
    Fields
    Example
    {
    -  "coordinates": Coordinates,
    -  "createdAt": 1592577642,
    -  "id": 4,
    -  "title": "abc123",
    -  "username": Username,
    -  "validated": false
    +  "address": OnChainAddress,
    +  "memo": Memo,
    +  "speed": "FAST",
    +  "walletId": WalletId
     }
     
    -
    +
    -

    MerchantMapSuggestInput

    +

    OnChainPaymentSendInput

    @@ -10526,28 +15407,35 @@
    Fields
    - latitude - Float! + address - OnChainAddress! - longitude - Float! + amount - SatAmount! - title - String! + memo - Memo - username - Username! + speed - PayoutSpeed + + + + + + + walletId - WalletId! @@ -10560,21 +15448,22 @@
    Fields
    Example
    {
    -  "latitude": 987.65,
    -  "longitude": 987.65,
    -  "title": "abc123",
    -  "username": Username
    +  "address": OnChainAddress,
    +  "amount": SatAmount,
    +  "memo": Memo,
    +  "speed": "FAST",
    +  "walletId": WalletId
     }
     
    -
    +
    -

    MerchantPayload

    +

    OnChainTxFee

    @@ -10588,13 +15477,7 @@
    Fields
    - errors - [Error!]! - - - - - - merchant - Merchant + amount - SatAmount! @@ -10606,41 +15489,34 @@
    Fields
    Example
    -
    {
    -  "errors": [Error],
    -  "merchant": Merchant
    -}
    +                  
    {"amount": SatAmount}
     
    -
    +
    -

    Minutes

    +

    OnChainTxHash

    -
    -
    Description
    -

    (Positive) amount of minutes

    -
    Example
    -
    Minutes
    +                  
    OnChainTxHash
     
    -
    +
    -

    MobileVersions

    +

    OnChainUpdate

    @@ -10654,71 +15530,38 @@
    Fields
    - currentSupported - Int! + amount - SatAmount! - minSupported - Int! + displayCurrencyPerSat - Float! - platform - String! + txHash - OnChainTxHash! - - -
    -
    -
    -
    -
    Example
    -
    {
    -  "currentSupported": 123,
    -  "minSupported": 987,
    -  "platform": "abc123"
    -}
    -
    -
    -
    -
    -
    -
    -
    - Types -
    -

    MyUpdatesPayload

    -
    -
    -
    -
    Fields
    - - - - - - - - - - - @@ -10731,56 +15574,66 @@
    Fields
    Example
    {
    -  "errors": [Error],
    -  "me": User,
    -  "update": IntraLedgerUpdate
    +  "amount": SatAmount,
    +  "displayCurrencyPerSat": 987.65,
    +  "txHash": OnChainTxHash,
    +  "txNotificationType": "IntraLedgerPayment",
    +  "usdPerSat": 987.65,
    +  "walletId": WalletId
     }
     
    -
    +
    -

    Network

    +

    OnChainUsdPaymentSendAsBtcDenominatedInput

    -
    Values
    +
    Fields
    Field NameDescription
    errors - [Error!]! + txNotificationType - TxNotificationType!
    me - User + usdPerSat - Float! + updated over displayCurrencyPerSat
    update - UserUpdate + walletId - WalletId!
    - + + + + + @@ -10792,49 +15645,66 @@
    Values
    Example
    -
    "mainnet"
    -
    -
    -
    - - -
    -
    - Types -
    -

    NotificationCategory

    -
    -
    -
    -
    -
    -
    Example
    -
    NotificationCategory
    +                  
    {
    +  "address": OnChainAddress,
    +  "amount": SatAmount,
    +  "memo": Memo,
    +  "speed": "FAST",
    +  "walletId": WalletId
    +}
     
    -
    +
    -

    NotificationChannel

    +

    OnChainUsdPaymentSendInput

    -
    Values
    +
    Fields
    Enum ValueInput Field Description
    -

    mainnet

    + address - OnChainAddress!
    -

    regtest

    + amount - SatAmount!
    -

    signet

    + memo - Memo
    -

    testnet

    + speed - PayoutSpeed +
    +
    + walletId - WalletId!
    - + + + + + + + + + + + + + + + + + @@ -10846,17 +15716,23 @@
    Values
    Example
    -
    "PUSH"
    +                  
    {
    +  "address": OnChainAddress,
    +  "amount": FractionalCentAmount,
    +  "memo": Memo,
    +  "speed": "FAST",
    +  "walletId": WalletId
    +}
     
    -
    +
    -

    NotificationChannelSettings

    +

    OnChainUsdTxFee

    @@ -10870,13 +15746,7 @@
    Fields
    - - - - - @@ -10888,20 +15758,17 @@
    Fields
    Example
    -
    {
    -  "disabledCategories": [NotificationCategory],
    -  "enabled": true
    -}
    +                  
    {"amount": FractionalCentAmount}
     
    -
    +
    -

    NotificationSettings

    +

    OneDayAccountLimit

    @@ -10915,10 +15782,19 @@
    Fields
    - - + + + + + + + +
    Enum ValueInput Field Description
    -

    PUSH

    + address - OnChainAddress! +
    +
    + amount - FractionalCentAmount! + +
    + memo - Memo + +
    + speed - PayoutSpeed + +
    + walletId - WalletId!
    disabledCategories - [NotificationCategory!]! - -
    enabled - Boolean! + amount - FractionalCentAmount!
    push - NotificationChannelSettings! + interval - Seconds + The rolling time interval value in seconds for the current 24 hour period.
    remainingLimit - CentAmount + The amount of cents remaining below the limit for the current 24 hour period.
    totalLimit - CentAmount! The current maximum limit for a given 24 hour period.
    @@ -10927,93 +15803,77 @@
    Fields
    Example
    -
    {"push": NotificationChannelSettings}
    +                  
    {
    +  "interval": Seconds,
    +  "remainingLimit": CentAmount,
    +  "totalLimit": CentAmount
    +}
     
    -
    +
    -

    OnChainAddress

    +

    OneTimeAuthCode

    Description
    -

    An address for an on-chain bitcoin destination

    +

    An authentication code valid for a single use

    Example
    -
    OnChainAddress
    +                  
    OneTimeAuthCode
     
    -
    +
    -

    OnChainAddressCreateInput

    +

    PageInfo

    +
    +
    Description
    +

    Information about pagination in a connection.

    +
    Fields
    - + - - + - -
    Input FieldField Name Description
    - walletId - WalletId! - + endCursor - String When paginating forwards, the cursor to continue.
    -
    -
    -
    -
    -
    Example
    -
    {"walletId": WalletId}
    -
    -
    -
    -
    -
    -
    -
    - Types -
    -

    OnChainAddressCurrentInput

    -
    -
    -
    -
    Fields
    - - - - + + - - - - + + + +
    Input FieldDescriptionhasNextPage - Boolean! + When paginating forwards, are there more items?
    - walletId - WalletId! + hasPreviousPage - Boolean! + When paginating backwards, are there more items?
    startCursor - String When paginating backwards, the cursor to continue.
    @@ -11022,62 +15882,39 @@
    Fields
    Example
    -
    {"walletId": WalletId}
    +                  
    {
    +  "endCursor": "abc123",
    +  "hasNextPage": false,
    +  "hasPreviousPage": true,
    +  "startCursor": "abc123"
    +}
     
    -
    +
    -

    OnChainAddressPayload

    +

    PaymentHash

    -
    -
    Fields
    - - - - - - - - - - - - - - - - - -
    Field NameDescription
    address - OnChainAddress - -
    errors - [Error!]! - -
    -
    Example
    -
    {
    -  "address": OnChainAddress,
    -  "errors": [Error]
    -}
    +                  
    PaymentHash
     
    -
    +
    -

    OnChainPaymentSendAllInput

    +

    PaymentSendPayload

    @@ -11085,35 +15922,19 @@
    Fields
    - - - - - - - - - - - - + + + + - - @@ -11125,65 +15946,53 @@
    Fields
    Example
    -
    {
    -  "address": OnChainAddress,
    -  "memo": Memo,
    -  "speed": "FAST",
    -  "walletId": WalletId
    -}
    +                  
    {"errors": [Error], "status": "ALREADY_PAID"}
     
    -
    +
    -

    OnChainPaymentSendInput

    +

    PaymentSendResult

    -
    Fields
    +
    Values
    Input FieldDescription
    - address - OnChainAddress! - -
    - memo - Memo - - Field NameDescription
    - speed - PayoutSpeed + errors - [Error!]!
    - walletId - WalletId! + status - PaymentSendResult
    - + - - - - @@ -11195,37 +16004,32 @@
    Fields
    Example
    -
    {
    -  "address": OnChainAddress,
    -  "amount": SatAmount,
    -  "memo": Memo,
    -  "speed": "FAST",
    -  "walletId": WalletId
    -}
    +                  
    "ALREADY_PAID"
     
    -
    +
    -

    OnChainTxFee

    +

    PayoutSpeed

    -
    Fields
    +
    Values
    Input FieldEnum Value Description
    - address - OnChainAddress! - -
    - amount - SatAmount! +

    ALREADY_PAID

    - memo - Memo +

    FAILURE

    - speed - PayoutSpeed +

    PENDING

    - walletId - WalletId! +

    SUCCESS

    - + - @@ -11237,79 +16041,118 @@
    Fields
    Example
    -
    {"amount": SatAmount}
    +                  
    "FAST"
     
    -
    +
    -

    OnChainTxHash

    +

    Phone

    +
    +
    Description
    +

    Phone number which includes country code

    +
    Example
    -
    OnChainTxHash
    +                  
    Phone
     
    -
    +
    -

    OnChainUpdate

    +

    PhoneCodeChannelType

    -
    Fields
    +
    Values
    Field NameEnum Value Description
    amount - SatAmount! + +

    FAST

    - + - - + +
    Field NameEnum Value Description
    amount - SatAmount! + +

    SMS

    displayCurrencyPerSat - Float! + +

    WHATSAPP

    +
    +
    +
    +
    +
    Example
    +
    "SMS"
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    Price

    +
    +
    +
    +
    Description
    +

    Price amount expressed in base/offset. To calculate, use: base / 10^offset

    +
    +
    +
    Fields
    + + + + + + + + - - - - @@ -11322,66 +16165,68 @@
    Fields
    Example
    {
    -  "amount": SatAmount,
    -  "displayCurrencyPerSat": 987.65,
    -  "txHash": OnChainTxHash,
    -  "txNotificationType": "IntraLedgerPayment",
    -  "usdPerSat": 123.45,
    -  "walletId": WalletId
    +  "base": 9007199254740991,
    +  "currencyUnit": "xyz789",
    +  "formattedAmount": "abc123",
    +  "offset": 987
     }
     
    -
    +
    -

    OnChainUsdPaymentSendAsBtcDenominatedInput

    +

    PriceGraphRange

    +
    +
    Description
    +

    The range for the X axis in the BTC price graph

    +
    -
    Fields
    +
    Values
    Field NameDescription
    txHash - OnChainTxHash! + base - SafeInt!
    txNotificationType - TxNotificationType! + currencyUnit - String!
    usdPerSat - Float! + formattedAmount - String! - updated over displayCurrencyPerSat
    walletId - WalletId! + offset - Int!
    - + @@ -11393,23 +16238,17 @@
    Fields
    Example
    -
    {
    -  "address": OnChainAddress,
    -  "amount": SatAmount,
    -  "memo": Memo,
    -  "speed": "FAST",
    -  "walletId": WalletId
    -}
    +                  
    "FIVE_YEARS"
     
    -
    +
    -

    OnChainUsdPaymentSendInput

    +

    PriceInput

    @@ -11424,35 +16263,21 @@
    Fields
    - - - - - - - - @@ -11465,25 +16290,23 @@
    Fields
    Example
    {
    -  "address": OnChainAddress,
    -  "amount": FractionalCentAmount,
    -  "memo": Memo,
    -  "speed": "FAST",
    -  "walletId": WalletId
    +  "amount": SatAmount,
    +  "amountCurrencyUnit": "BTCSAT",
    +  "priceCurrencyUnit": "BTCSAT"
     }
     
    -
    +
    -

    OnChainUsdTxFee

    +

    PriceInterface

    -
    +
    Fields
    Input FieldEnum Value Description
    - address - OnChainAddress! +

    FIVE_YEARS

    - amount - SatAmount! +

    ONE_DAY

    - memo - Memo +

    ONE_MONTH

    - speed - PayoutSpeed +

    ONE_WEEK

    - walletId - WalletId! +

    ONE_YEAR

    - address - OnChainAddress! - -
    - amount - FractionalCentAmount! - -
    - memo - Memo + amount - SatAmount!
    - speed - PayoutSpeed + amountCurrencyUnit - ExchangeCurrencyUnit!
    - walletId - WalletId! + priceCurrencyUnit - ExchangeCurrencyUnit!
    @@ -11494,7 +16317,20 @@
    Fields
    - + + + + + + + + @@ -11502,47 +16338,29 @@
    Fields
    amount - CentAmount! + base - SafeInt! + +
    currencyUnit - String! + + Deprecated due to type renaming +
    offset - Int!
    -
    -
    -
    -
    Example
    -
    {"amount": CentAmount}
    -
    -
    -
    -
    -
    -
    -
    - Types -
    -

    OneDayAccountLimit

    -
    -
    -
    -
    Fields
    +
    +
    Possible Types
    - - + - - - - - -
    Field NameDescriptionPriceInterface Types
    interval - Seconds + +

    PriceOfOneSatInMinorUnit

    The rolling time interval value in seconds for the current 24 hour period.
    remainingLimit - CentAmount + +

    PriceOfOneSettlementMinorUnitInDisplayMinorUnit

    The amount of cents remaining below the limit for the current 24 hour period.
    totalLimit - CentAmount! + +

    PriceOfOneUsdCentInMinorUnit

    The current maximum limit for a given 24 hour period.
    @@ -11552,46 +16370,25 @@
    Fields
    Example
    {
    -  "interval": Seconds,
    -  "remainingLimit": CentAmount,
    -  "totalLimit": CentAmount
    +  "base": 9007199254740991,
    +  "currencyUnit": "xyz789",
    +  "offset": 987
     }
     
    -
    -
    - Types -
    -

    OneTimeAuthCode

    -
    -
    -
    -
    Description
    -

    An authentication code valid for a single use

    -
    -
    -
    -
    -
    Example
    -
    OneTimeAuthCode
    -
    -
    -
    -
    -
    -
    +
    -

    PageInfo

    +

    PriceOfOneSatInMinorUnit

    Description
    -

    Information about pagination in a connection.

    +

    Price of 1 sat in base/offset. To calculate, use: base / 10^offset

    Fields
    @@ -11604,24 +16401,23 @@
    Fields
    - endCursor - String + base - SafeInt! - When paginating forwards, the cursor to continue. - - - hasNextPage - Boolean! + - When paginating forwards, are there more items? - hasPreviousPage - Boolean! + currencyUnit - String! + + + Deprecated due to type renaming - When paginating backwards, are there more items? - startCursor - String + offset - Int! + + - When paginating backwards, the cursor to continue. @@ -11631,40 +16427,26 @@
    Fields
    Example
    {
    -  "endCursor": "abc123",
    -  "hasNextPage": true,
    -  "hasPreviousPage": true,
    -  "startCursor": "xyz789"
    +  "base": 9007199254740991,
    +  "currencyUnit": "xyz789",
    +  "offset": 123
     }
     
    -
    +
    -

    PaymentHash

    +

    PriceOfOneSettlementMinorUnitInDisplayMinorUnit

    -
    -
    -
    -
    Example
    -
    PaymentHash
    -
    +
    +
    Description
    +

    Price of 1 sat or 1 usd cent in base/offset. To calculate, use: base / 10^offset

    -
    -
    -
    -
    -
    - Types -
    -

    PaymentSendPayload

    -
    -
    Fields
    @@ -11676,13 +16458,27 @@
    Fields
    - - + + + + + + + + @@ -11694,53 +16490,53 @@
    Fields
    Example
    -
    {"errors": [Error], "status": "ALREADY_PAID"}
    +                  
    {
    +  "base": 9007199254740991,
    +  "currencyUnit": "xyz789",
    +  "formattedAmount": "abc123",
    +  "offset": 987
    +}
     
    -
    +
    -

    PaymentSendResult

    +

    PriceOfOneUsdCentInMinorUnit

    +
    +
    Description
    +

    Price of 1 usd cent in base/offset. To calculate, use: base / 10^offset

    +
    -
    Values
    +
    Fields
    errors - [Error!]! + base - SafeInt!
    status - PaymentSendResult + currencyUnit - String! + + Deprecated due to type renaming +
    formattedAmount - String! + + Deprecated please use base / 10^offset +
    offset - Int!
    - + - - - - - - - @@ -11752,32 +16548,41 @@
    Values
    Example
    -
    "ALREADY_PAID"
    +                  
    {
    +  "base": 9007199254740991,
    +  "currencyUnit": "xyz789",
    +  "offset": 123
    +}
     
    -
    +
    -

    PayoutSpeed

    +

    PricePayload

    -
    Values
    +
    Fields
    Enum ValueField Name Description
    -

    ALREADY_PAID

    -
    -
    -

    FAILURE

    +
    base - SafeInt!
    -

    PENDING

    +
    currencyUnit - String! + Deprecated due to type renaming
    -

    SUCCESS

    +
    offset - Int!
    - + + + + + @@ -11789,63 +16594,39 @@
    Values
    Example
    -
    "FAST"
    -
    -
    -
    - - -
    -
    - Types -
    -

    Phone

    -
    -
    -
    -
    Description
    -

    Phone number which includes country code

    -
    -
    -
    -
    -
    Example
    -
    Phone
    +                  
    {"errors": [Error], "price": Price}
     
    -
    +
    -

    PhoneCodeChannelType

    +

    PricePoint

    -
    Values
    +
    Fields
    Enum ValueField Name Description
    errors - [Error!]! + -

    FAST

    +
    price - Price
    - + - - - +
    Enum ValueField Name Description
    -

    SMS

    +
    price - Price!
    -

    WHATSAPP

    -
    + timestamp - Timestamp! Unix timestamp (number of seconds elapsed since January 1, 1970 00:00:00 UTC)
    @@ -11854,22 +16635,22 @@
    Values
    Example
    -
    "SMS"
    +                  
    {"price": Price, "timestamp": 1592577642}
     
    -
    +
    -

    Price

    +

    PublicWallet

    Description
    -

    Price amount expressed in base/offset. To calculate, use: base / 10^offset

    +

    A public view of a generic wallet which stores value in one of our supported currencies.

    Fields
    @@ -11882,25 +16663,19 @@
    Fields
    - base - SafeInt! - - - - - - currencyUnit - String! + id - ID! - formattedAmount - String! + lnurlp - Lnurl - offset - Int! + walletCurrency - WalletCurrency! @@ -11913,68 +16688,45 @@
    Fields
    Example
    {
    -  "base": 9007199254740991,
    -  "currencyUnit": "xyz789",
    -  "formattedAmount": "xyz789",
    -  "offset": 123
    +  "id": "4",
    +  "lnurlp": Lnurl,
    +  "walletCurrency": "BTC"
     }
     
    -
    +
    -

    PriceGraphRange

    +

    Quiz

    -
    -
    Description
    -

    The range for the X axis in the BTC price graph

    -
    -
    Values
    +
    Fields
    - + - - - - - - - - - - + - - @@ -11986,17 +16738,17 @@
    Values
    Example
    -
    "FIVE_YEARS"
    +                  
    {"amount": SatAmount, "completed": false, "id": 4}
     
    -
    +
    -

    PriceInput

    +

    QuizCompletedInput

    @@ -12011,21 +16763,7 @@
    Fields
    - - - - - - - - @@ -12037,24 +16775,20 @@
    Fields
    Example
    -
    {
    -  "amount": SatAmount,
    -  "amountCurrencyUnit": "BTCSAT",
    -  "priceCurrencyUnit": "BTCSAT"
    -}
    +                  
    {"id": "4"}
     
    -
    +
    -

    PriceInterface

    +

    QuizCompletedPayload

    -
    +
    Fields
    Enum ValueField Name Description
    -

    FIVE_YEARS

    -
    -
    -

    ONE_DAY

    -
    -
    -

    ONE_MONTH

    -
    + amount - SatAmount! The reward in Satoshis for the quiz question
    -

    ONE_WEEK

    +
    completed - Boolean!
    -

    ONE_YEAR

    +
    id - ID!
    - amount - SatAmount! - -
    - amountCurrencyUnit - ExchangeCurrencyUnit! - -
    - priceCurrencyUnit - ExchangeCurrencyUnit! + id - ID!
    @@ -12065,49 +16799,15 @@
    Fields
    - - - - - - - - - - - - -
    base - SafeInt! - -
    currencyUnit - String! - - Deprecated due to type renaming -
    offset - Int! - + errors - [Error!]!
    -
    -
    -
    Possible Types
    - - - - - - - - - - - @@ -12117,27 +16817,19 @@
    Possible Types
    Example
    -
    {
    -  "base": 9007199254740991,
    -  "currencyUnit": "xyz789",
    -  "offset": 123
    -}
    +                  
    {"errors": [Error], "quiz": Quiz}
     
    -
    +
    -

    PriceOfOneSatInMinorUnit

    +

    QuizQuestion

    -
    -
    Description
    -

    Price of 1 sat in base/offset. To calculate, use: base / 10^offset

    -
    Fields
    PriceInterface Types
    -

    PriceOfOneSatInMinorUnit

    -

    PriceOfOneSettlementMinorUnitInDisplayMinorUnit

    +
    quiz - Quiz
    -

    PriceOfOneUsdCentInMinorUnit

    @@ -12149,20 +16841,12 @@
    Fields
    - - - - - - + - @@ -12174,27 +16858,19 @@
    Fields
    Example
    -
    {
    -  "base": 9007199254740991,
    -  "currencyUnit": "xyz789",
    -  "offset": 123
    -}
    +                  
    {"earnAmount": SatAmount, "id": 4}
     
    -
    +
    -

    PriceOfOneSettlementMinorUnitInDisplayMinorUnit

    +

    RealtimePrice

    -
    -
    Description
    -

    Price of 1 sat or 1 usd cent in base/offset. To calculate, use: base / 10^offset

    -
    Fields
    base - SafeInt! - -
    currencyUnit - String! - - Deprecated due to type renaming + earnAmount - SatAmount! The earn reward in Satoshis for the quiz question
    offset - Int! + id - ID!
    @@ -12206,27 +16882,30 @@
    Fields
    - - - - + + + + @@ -12239,52 +16918,37 @@
    Fields
    Example
    {
    -  "base": 9007199254740991,
    -  "currencyUnit": "abc123",
    -  "formattedAmount": "abc123",
    -  "offset": 123
    +  "btcSatPrice": PriceOfOneSatInMinorUnit,
    +  "denominatorCurrency": DisplayCurrency,
    +  "id": "4",
    +  "timestamp": 1592577642,
    +  "usdCentPrice": PriceOfOneUsdCentInMinorUnit
     }
     
    -
    +
    -

    PriceOfOneUsdCentInMinorUnit

    +

    RealtimePriceInput

    -
    -
    Description
    -

    Price of 1 usd cent in base/offset. To calculate, use: base / 10^offset

    -
    Fields
    base - SafeInt! + btcSatPrice - PriceOfOneSatInMinorUnit!
    currencyUnit - String! + denominatorCurrency - DisplayCurrency! - Deprecated due to type renaming
    formattedAmount - String! + id - ID! - Deprecated please use base / 10^offset
    offset - Int! + timestamp - Timestamp! + Unix timestamp (number of seconds elapsed since January 1, 1970 00:00:00 UTC)
    usdCentPrice - PriceOfOneUsdCentInMinorUnit!
    - + - - - - - - - - @@ -12296,21 +16960,17 @@
    Fields
    Example
    -
    {
    -  "base": 9007199254740991,
    -  "currencyUnit": "xyz789",
    -  "offset": 987
    -}
    +                  
    {"currency": DisplayCurrency}
     
    -
    +
    -

    PricePayload

    +

    RealtimePricePayload

    @@ -12330,7 +16990,7 @@
    Fields
    - @@ -12342,17 +17002,20 @@
    Fields
    Example
    -
    {"errors": [Error], "price": Price}
    +                  
    {
    +  "errors": [Error],
    +  "realtimePrice": RealtimePrice
    +}
     
    -
    +
    -

    PricePoint

    +

    RequestCashoutInput

    @@ -12360,21 +17023,28 @@
    Fields
    Field NameInput Field Description
    base - SafeInt! - -
    currencyUnit - String! - - Deprecated due to type renaming -
    offset - Int! + currency - DisplayCurrency
    price - Price + realtimePrice - RealtimePrice
    - + - + + + + - - +
    Field NameInput Field Description
    price - Price! + + amount - USDCents! Amount in USD cents.
    + bankAccountId - ID! ERPNext bank account identifier to receive the cashout.
    timestamp - Timestamp! + + walletId - WalletId! Unix timestamp (number of seconds elapsed since January 1, 1970 00:00:00 UTC) ID for a USD wallet belonging to the current user.
    @@ -12383,23 +17053,23 @@
    Fields
    Example
    -
    {"price": Price, "timestamp": 1592577642}
    +                  
    {
    +  "amount": USDCents,
    +  "bankAccountId": "4",
    +  "walletId": WalletId
    +}
     
    -
    +
    -

    PublicWallet

    +

    RequestCashoutResponse

    -
    -
    Description
    -

    A public view of a generic wallet which stores value in one of our supported currencies.

    -
    Fields
    @@ -12411,19 +17081,13 @@
    Fields
    - - - - - - @@ -12435,21 +17099,62 @@
    Fields
    Example
    -
    {
    -  "id": "4",
    -  "lnurlp": Lnurl,
    -  "walletCurrency": "BTC"
    -}
    +                  
    {
    +  "errors": [Error],
    +  "offer": CashoutOffer
    +}
    +
    +
    +
    + + +
    +
    + Types +
    +

    SafeInt

    +
    +
    +
    +
    Description
    +

    Non-fractional signed whole numeric value between -(2^53) + 1 and 2^53 - 1

    +
    +
    +
    +
    +
    Example
    +
    9007199254740991
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    SatAmount

    +
    +
    +
    +
    Description
    +

    (Positive) Satoshi amount

    +
    +
    +
    +
    +
    Example
    +
    SatAmount
     
    -
    +
    -

    Quiz

    +

    SatAmountPayload

    @@ -12463,18 +17168,13 @@
    Fields
    - - - - - - @@ -12486,76 +17186,65 @@
    Fields
    Example
    -
    {"amount": SatAmount, "completed": true, "id": 4}
    +                  
    {
    +  "amount": SatAmount,
    +  "errors": [Error]
    +}
     
    -
    +
    -

    QuizCompletedInput

    +

    Seconds

    -
    -
    Fields
    -
    id - ID! - -
    lnurlp - Lnurl + errors - [Error!]!
    walletCurrency - WalletCurrency! + offer - CashoutOffer
    amount - SatAmount! - The reward in Satoshis for the quiz question
    completed - Boolean! + amount - SatAmount
    id - ID! + errors - [Error!]!
    - - - - - - - - - - - - -
    Input FieldDescription
    - id - ID! - -
    +
    +
    Description
    +

    (Positive) amount of seconds

    Example
    -
    {"id": "4"}
    +                  
    Seconds
     
    -
    +
    -

    QuizCompletedPayload

    +

    SettlementVia

    -
    Fields
    +
    Types
    - - + - - + + @@ -12565,17 +17254,17 @@
    Fields
    Example
    -
    {"errors": [Error], "quiz": Quiz}
    +                  
    SettlementViaIntraLedger
     
    -
    +
    -

    QuizQuestion

    +

    SettlementViaIntraLedger

    @@ -12589,12 +17278,12 @@
    Fields
    - - + - @@ -12606,17 +17295,20 @@
    Fields
    Example
    -
    {"earnAmount": SatAmount, "id": 4}
    +                  
    {
    +  "counterPartyUsername": Username,
    +  "counterPartyWalletId": WalletId
    +}
     
    -
    +
    -

    RealtimePrice

    +

    SettlementViaLn

    @@ -12630,30 +17322,14 @@
    Fields
    - - - - - - - - - - - - - - @@ -12666,22 +17342,19 @@
    Fields
    Example
    {
    -  "btcSatPrice": PriceOfOneSatInMinorUnit,
    -  "denominatorCurrency": DisplayCurrency,
    -  "id": 4,
    -  "timestamp": 1592577642,
    -  "usdCentPrice": PriceOfOneUsdCentInMinorUnit
    +  "paymentSecret": LnPaymentSecret,
    +  "preImage": LnPaymentPreImage
     }
     
    -
    +
    -

    RealtimePriceInput

    +

    SettlementViaOnChain

    @@ -12689,14 +17362,19 @@
    Fields
    Field NameDescriptionUnion Types
    errors - [Error!]! - +

    SettlementViaIntraLedger

    quiz - Quiz + +

    SettlementViaLn

    +

    SettlementViaOnChain

    earnAmount - SatAmount! + counterPartyUsername - Username The earn reward in Satoshis for the quiz question Settlement destination: Could be null if the payee does not have a username
    id - ID! + counterPartyWalletId - WalletId
    btcSatPrice - PriceOfOneSatInMinorUnit! - -
    denominatorCurrency - DisplayCurrency! - -
    id - ID! + paymentSecret - LnPaymentSecret + Shifting property to 'preImage' to improve granularity of the LnPaymentSecret type
    timestamp - Timestamp! - Unix timestamp (number of seconds elapsed since January 1, 1970 00:00:00 UTC)
    usdCentPrice - PriceOfOneUsdCentInMinorUnit! + preImage - LnPaymentPreImage
    - + + + + + @@ -12708,17 +17386,80 @@
    Fields
    Example
    -
    {"currency": DisplayCurrency}
    +                  
    {"transactionHash": OnChainTxHash, "vout": 987}
     
    -
    +
    -

    RealtimePricePayload

    +

    SignedAmount

    +
    +
    +
    +
    Description
    +

    An amount (of a currency) that can be negative (e.g. in a transaction)

    +
    +
    +
    +
    +
    Example
    +
    SignedAmount
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    SignedDisplayMajorAmount

    +
    +
    +
    +
    Description
    +

    A string amount (of a currency) that can be negative (e.g. in a transaction)

    +
    +
    +
    +
    +
    Example
    +
    SignedDisplayMajorAmount
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    String

    +
    +
    +
    +
    Description
    +

    The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

    +
    +
    +
    +
    +
    Example
    +
    "abc123"
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    SuccessPayload

    @@ -12738,7 +17479,7 @@
    Fields
    - @@ -12750,152 +17491,194 @@
    Fields
    Example
    -
    {
    -  "errors": [Error],
    -  "realtimePrice": RealtimePrice
    -}
    +                  
    {"errors": [Error], "success": true}
     
    -
    +
    -

    SafeInt

    +

    Timestamp

    Description
    -

    Non-fractional signed whole numeric value between -(2^53) + 1 and 2^53 - 1

    +

    Timestamp field, serialized as Unix time (the number of seconds since the Unix epoch)

    Example
    -
    9007199254740991
    +                  
    1592577642
     
    -
    +
    -

    SatAmount

    +

    TotpCode

    Description
    -

    (Positive) Satoshi amount

    +

    A time-based one-time password

    Example
    -
    SatAmount
    +                  
    TotpCode
     
    -
    +
    -

    SatAmountPayload

    +

    TotpRegistrationId

    -
    -
    Fields
    -
    Input FieldField Name Description
    transactionHash - OnChainTxHash + - currency - DisplayCurrency +
    vout - Int
    realtimePrice - RealtimePrice + success - Boolean
    - - - - - - - - - - - - - - - - -
    Field NameDescription
    amount - SatAmount - -
    errors - [Error!]! - -
    +
    +
    Description
    +

    An id to be passed between set and verify for confirming totp

    Example
    -
    {
    -  "amount": SatAmount,
    -  "errors": [Error]
    -}
    +                  
    TotpRegistrationId
     
    -
    +
    -

    Seconds

    +

    TotpSecret

    Description
    -

    (Positive) amount of seconds

    +

    A secret to generate time-based one-time password

    Example
    -
    Seconds
    +                  
    TotpSecret
     
    -
    +
    -

    SettlementVia

    +

    Transaction

    +
    +
    Description
    +

    Give details about an individual transaction. Galoy have a smart routing system which is automatically settling intraledger when both the payer and payee use the same wallet therefore it's possible the transactions is being initiated onchain or with lightning but settled intraledger.

    +
    -
    Types
    +
    Fields
    - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -12905,19 +17688,38 @@
    Types
    Example
    -
    SettlementViaIntraLedger
    +                  
    {
    +  "createdAt": 1592577642,
    +  "direction": "RECEIVE",
    +  "id": 4,
    +  "initiationVia": InitiationViaIntraLedger,
    +  "memo": Memo,
    +  "settlementAmount": SignedAmount,
    +  "settlementCurrency": "BTC",
    +  "settlementDisplayAmount": SignedDisplayMajorAmount,
    +  "settlementDisplayCurrency": DisplayCurrency,
    +  "settlementDisplayFee": SignedDisplayMajorAmount,
    +  "settlementFee": SignedAmount,
    +  "settlementPrice": PriceOfOneSettlementMinorUnitInDisplayMinorUnit,
    +  "settlementVia": SettlementViaIntraLedger,
    +  "status": "FAILURE"
    +}
     
    -
    +
    -

    SettlementViaIntraLedger

    +

    TransactionConnection

    +
    +
    Description
    +

    A connection to a list of items.

    +
    Fields
    Union TypesField NameDescription
    createdAt - Timestamp! + +
    direction - TxDirection! + -

    SettlementViaIntraLedger

    id - ID! + -

    SettlementViaLn

    initiationVia - InitiationVia! + From which protocol the payment has been initiated.
    memo - Memo + +
    settlementAmount - SignedAmount! + Amount of the settlement currency sent or received.
    settlementCurrency - WalletCurrency! + Wallet currency for transaction.
    settlementDisplayAmount - SignedDisplayMajorAmount! + +
    settlementDisplayCurrency - DisplayCurrency! + +
    settlementDisplayFee - SignedDisplayMajorAmount! + +
    settlementFee - SignedAmount! + +
    settlementPrice - PriceOfOneSettlementMinorUnitInDisplayMinorUnit! + Price in WALLETCURRENCY/SETTLEMENTUNIT at time of settlement.
    settlementVia - SettlementVia! + To which protocol the payment has settled on.
    status - TxStatus! + -

    SettlementViaOnChain

    @@ -12929,15 +17731,14 @@
    Fields
    - - + - - +
    counterPartyUsername - Username + edges - [TransactionEdge!] Settlement destination: Could be null if the payee does not have a username A list of edges.
    counterPartyWalletId - WalletId - + pageInfo - PageInfo! Information to aid in pagination.
    @@ -12947,19 +17748,19 @@
    Fields
    Example
    {
    -  "counterPartyUsername": Username,
    -  "counterPartyWalletId": WalletId
    +  "edges": [TransactionEdge],
    +  "pageInfo": PageInfo
     }
     
    -
    +
    -

    SettlementViaLn

    +

    TransactionDetails

    @@ -12973,17 +17774,89 @@
    Fields
    - paymentSecret - LnPaymentSecret + accountId - String - - Shifting property to 'preImage' to improve granularity of the LnPaymentSecret type + Account ID associated with the transaction + + + address - String + Bitcoin address for onchain transactions - preImage - LnPaymentPreImage + amount - Float - + Transaction amount + + + confirmations - Int + + Number of confirmations for onchain transactions + + + createdAt - String + + Transaction creation timestamp + + + currency - String + + Transaction currency + + + fee - Float + + Transaction fee + + + id - String! + Transaction ID + + + invoice - String + + Lightning invoice (bolt11) + + + memo - String + + Transaction memo/description + + + paymentHash - String + + Lightning payment hash + + + paymentPreimage - String + + Lightning payment preimage + + + status - String + + Transaction status + + + txid - String + + Bitcoin transaction ID for onchain transactions + + + type - String + + Transaction type (lightning/onchain) + + + updatedAt - String + + Transaction last update timestamp + + + vout - Int + + Output index for onchain transactions @@ -12993,19 +17866,34 @@
    Fields
    Example
    {
    -  "paymentSecret": LnPaymentSecret,
    -  "preImage": LnPaymentPreImage
    +  "accountId": "abc123",
    +  "address": "abc123",
    +  "amount": 123.45,
    +  "confirmations": 987,
    +  "createdAt": "xyz789",
    +  "currency": "abc123",
    +  "fee": 987.65,
    +  "id": "abc123",
    +  "invoice": "xyz789",
    +  "memo": "abc123",
    +  "paymentHash": "abc123",
    +  "paymentPreimage": "abc123",
    +  "status": "xyz789",
    +  "txid": "abc123",
    +  "type": "abc123",
    +  "updatedAt": "abc123",
    +  "vout": 987
     }
     
    -
    +
    -

    SettlementViaOnChain

    +

    TransactionDetailsError

    @@ -13019,13 +17907,7 @@
    Fields
    - transactionHash - OnChainTxHash - - - - - - vout - Int + message - String! @@ -13037,80 +17919,53 @@
    Fields
    Example
    -
    {"transactionHash": OnChainTxHash, "vout": 987}
    -
    -
    -
    -
    -
    -
    -
    - Types -
    -

    SignedAmount

    -
    -
    -
    -
    Description
    -

    An amount (of a currency) that can be negative (e.g. in a transaction)

    -
    -
    -
    -
    -
    Example
    -
    SignedAmount
    -
    -
    -
    -
    -
    -
    -
    - Types -
    -

    SignedDisplayMajorAmount

    -
    -
    -
    -
    Description
    -

    A string amount (of a currency) that can be negative (e.g. in a transaction)

    -
    -
    -
    -
    -
    Example
    -
    SignedDisplayMajorAmount
    +                  
    {"message": "abc123"}
     
    -
    +
    -

    String

    +

    TransactionDetailsInput

    -
    -
    Description
    -

    The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + transactionId - String! + Transaction ID to fetch details for
    Example
    -
    "abc123"
    +                  
    {"transactionId": "abc123"}
     
    -
    +
    -

    SuccessPayload

    +

    TransactionDetailsPayload

    @@ -13124,13 +17979,13 @@
    Fields
    - errors - [Error!]! + errors - [TransactionDetailsError!]! - success - Boolean + transactionDetails - TransactionDetails @@ -13142,192 +17997,161 @@
    Fields
    Example
    -
    {"errors": [Error], "success": true}
    -
    -
    -
    -
    -
    -
    -
    - Types -
    -

    Timestamp

    -
    -
    -
    -
    Description
    -

    Timestamp field, serialized as Unix time (the number of seconds since the Unix epoch)

    -
    -
    -
    -
    -
    Example
    -
    1592577642
    +                  
    {
    +  "errors": [TransactionDetailsError],
    +  "transactionDetails": TransactionDetails
    +}
     
    -
    +
    -

    TotpCode

    +

    TransactionEdge

    Description
    -

    A time-based one-time password

    -
    -
    -
    -
    -
    Example
    -
    TotpCode
    -
    +

    An edge in a connection.

    -
    -
    -
    -
    -
    - Types -
    -

    TotpRegistrationId

    -
    -
    -
    -
    Description
    -

    An id to be passed between set and verify for confirming totp

    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    cursor - String! + A cursor for use in pagination
    node - Transaction! + The item at the end of the edge
    Example
    -
    TotpRegistrationId
    +                  
    {
    +  "cursor": "xyz789",
    +  "node": Transaction
    +}
     
    -
    +
    -

    TotpSecret

    +

    TxDirection

    -
    -
    Description
    -

    A secret to generate time-based one-time password

    +
    +
    Values
    + + + + + + + + + + + + + + + + + +
    Enum ValueDescription
    +

    RECEIVE

    +
    +
    +

    SEND

    +
    +
    Example
    -
    TotpSecret
    +                  
    "RECEIVE"
     
    -
    +
    -

    Transaction

    +

    TxNotificationType

    -
    -
    Description
    -

    Give details about an individual transaction. Galoy have a smart routing system which is automatically settling intraledger when both the payer and payee use the same wallet therefore it's possible the transactions is being initiated onchain or with lightning but settled intraledger.

    -
    -
    Fields
    +
    Values
    - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -13339,57 +18163,49 @@
    Fields
    Example
    -
    {
    -  "createdAt": 1592577642,
    -  "direction": "RECEIVE",
    -  "id": "4",
    -  "initiationVia": InitiationViaIntraLedger,
    -  "memo": Memo,
    -  "settlementAmount": SignedAmount,
    -  "settlementCurrency": "BTC",
    -  "settlementDisplayAmount": SignedDisplayMajorAmount,
    -  "settlementDisplayCurrency": DisplayCurrency,
    -  "settlementDisplayFee": SignedDisplayMajorAmount,
    -  "settlementFee": SignedAmount,
    -  "settlementPrice": PriceOfOneSettlementMinorUnitInDisplayMinorUnit,
    -  "settlementVia": SettlementViaIntraLedger,
    -  "status": "FAILURE"
    -}
    +                  
    "IntraLedgerPayment"
     
    -
    +
    -

    TransactionConnection

    +

    TxStatus

    -
    -
    Description
    -

    A connection to a list of items.

    -
    -
    Fields
    +
    Values
    Field NameEnum Value Description
    createdAt - Timestamp! - -
    direction - TxDirection! +

    IntraLedgerPayment

    id - ID! - -
    initiationVia - InitiationVia! - From which protocol the payment has been initiated.
    memo - Memo +

    IntraLedgerReceipt

    settlementAmount - SignedAmount! - Amount of the settlement currency sent or received.
    settlementCurrency - WalletCurrency! - Wallet currency for transaction.
    settlementDisplayAmount - SignedDisplayMajorAmount! - -
    settlementDisplayCurrency - DisplayCurrency! +

    LnInvoicePaid

    settlementDisplayFee - SignedDisplayMajorAmount! - -
    settlementFee - SignedAmount! +

    OnchainPayment

    settlementPrice - PriceOfOneSettlementMinorUnitInDisplayMinorUnit! + +

    OnchainReceipt

    Price in WALLETCURRENCY/SETTLEMENTUNIT at time of settlement.
    settlementVia - SettlementVia! + To which protocol the payment has settled on.
    status - TxStatus! + +

    OnchainReceiptPending

    - + - + - - + + + + + -
    Field NameEnum Value Description
    edges - [TransactionEdge!] + +

    FAILURE

    +
    A list of edges.
    pageInfo - PageInfo! + +

    PENDING

    +
    +
    +

    SUCCESS

    +
    Information to aid in pagination.
    @@ -13398,45 +18214,56 @@
    Fields
    Example
    -
    {
    -  "edges": [TransactionEdge],
    -  "pageInfo": PageInfo
    -}
    +                  
    "FAILURE"
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    USDCents

    +
    +
    +
    +
    Description
    +

    Amount in USD cents

    +
    +
    +
    +
    +
    Example
    +
    USDCents
     
    -
    +
    -

    TransactionEdge

    +

    UpdateExternalWalletInput

    -
    -
    Description
    -

    An edge in a connection.

    -
    Fields
    - + - - - - - -
    Field NameInput Field Description
    cursor - String! + + lnurlp - Lnurl! A cursor for use in pagination
    node - Transaction! + The item at the end of the edge
    @@ -13445,42 +18272,37 @@
    Fields
    Example
    -
    {
    -  "cursor": "abc123",
    -  "node": Transaction
    -}
    +                  
    {"lnurlp": Lnurl}
     
    -
    +
    -

    TxDirection

    +

    UpdateExternalWalletPayload

    -
    Values
    +
    Fields
    - + - - @@ -13492,67 +18314,46 @@
    Values
    Example
    -
    "RECEIVE"
    +                  
    {
    +  "errors": [Error],
    +  "walletId": WalletId
    +}
     
    -
    +
    -

    TxNotificationType

    +

    UpgradePayload

    -
    Values
    +
    Fields
    Enum ValueField Name Description
    -

    RECEIVE

    +
    errors - [Error!]!
    -

    SEND

    +
    walletId - WalletId
    - + - - - - - - - - - - - - - - - @@ -13564,94 +18365,149 @@
    Values
    Example
    -
    "IntraLedgerPayment"
    +                  
    {
    +  "authToken": AuthToken,
    +  "errors": [Error],
    +  "success": true
    +}
     
    -
    +
    -

    TxStatus

    +

    UsdWallet

    +
    +
    Description
    +

    A wallet belonging to an account which contains a USD balance and a list of transactions.

    +
    -
    Values
    +
    Fields
    Enum ValueField Name Description
    -

    IntraLedgerPayment

    -
    -
    -

    IntraLedgerReceipt

    -
    -
    -

    LnInvoicePaid

    -
    -
    -

    OnchainPayment

    +
    authToken - AuthToken
    -

    OnchainReceipt

    +
    errors - [Error!]!
    -

    OnchainReceiptPending

    +
    success - Boolean!
    - + - - - - -
    Enum ValueField Name Description
    -

    FAILURE

    +
    accountId - ID!
    -

    PENDING

    +
    balance - FractionalCentAmount
    -

    SUCCESS

    +
    id - ID!
    -
    -
    -
    -
    -
    Example
    -
    "FAILURE"
    -
    -
    -
    -
    -
    -
    -
    - Types -
    -

    UpgradePayload

    -
    -
    -
    -
    Fields
    - - - - + + - - - - + + + + + + + + + + + + + + - @@ -13664,25 +18520,31 @@
    Fields
    Example
    {
    -  "authToken": AuthToken,
    -  "errors": [Error],
    -  "success": false
    +  "accountId": 4,
    +  "balance": FractionalCentAmount,
    +  "id": "4",
    +  "isExternal": true,
    +  "lnurlp": Lnurl,
    +  "pendingIncomingBalance": SignedAmount,
    +  "transactions": TransactionConnection,
    +  "transactionsByAddress": TransactionConnection,
    +  "walletCurrency": "BTC"
     }
     
    -
    +
    -

    UsdWallet

    +

    UsdtWallet

    Description
    -

    A wallet belonging to an account which contains a USD balance and a list of transactions.

    +

    A wallet belonging to an account which contains a USDT balance and a list of transactions.

    Fields
    @@ -13701,7 +18563,7 @@
    Fields
    - @@ -13712,6 +18574,12 @@
    Fields
    + + + + @@ -13812,9 +18680,10 @@
    last
    Example
    {
    -  "accountId": 4,
    -  "balance": SignedAmount,
    +  "accountId": "4",
    +  "balance": FractionalCentAmount,
       "id": "4",
    +  "isExternal": true,
       "lnurlp": Lnurl,
       "pendingIncomingBalance": SignedAmount,
       "transactions": TransactionConnection,
    @@ -13843,6 +18712,11 @@ 
    Fields
    + + + + @@ -13931,12 +18805,13 @@
    username
    Example
    {
    +  "bankAccounts": [BankAccount],
       "contactByUsername": UserContact,
       "contacts": [UserContact],
       "createdAt": 1592577642,
       "defaultAccount": Account,
       "email": Email,
    -  "id": "4",
    +  "id": 4,
       "language": Language,
       "npub": npub,
       "phone": Phone,
    @@ -14033,7 +18908,7 @@ 
    Example
    "alias": ContactAlias, "id": Username, "transactions": TransactionConnection, - "transactionsCount": 987, + "transactionsCount": 123, "username": Username }
    @@ -14732,7 +19607,7 @@
    Fields
    Example
    -
    {"id": 4}
    +                  
    {"id": "4"}
     
    @@ -15388,7 +20263,7 @@
    Fields
    - @@ -15399,6 +20274,12 @@
    Fields
    + + + + @@ -15507,6 +20388,11 @@
    Possible Types

    BTCWallet

    + + + + + + +
    Field NameDescriptionisExternal - Boolean! + +
    authToken - AuthToken + lnurlp - Lnurl
    errors - [Error!]! + pendingIncomingBalance - SignedAmount! + An unconfirmed incoming onchain balance.
    transactions - TransactionConnection + +
    +
    +
    Arguments
    +
    +
    +
    after - String +
    +

    Returns the items in the list that come after the specified cursor.

    +
    +
    +
    before - String +
    +

    Returns the items in the list that come before the specified cursor.

    +
    +
    +
    first - Int +
    +

    Returns the first n items from the list.

    +
    +
    +
    last - Int +
    +

    Returns the last n items from the list.

    +
    +
    +
    +
    transactionsByAddress - TransactionConnection
    +
    +
    Arguments
    +
    +
    +
    address - OnChainAddress! +
    +

    Returns the items that include this address.

    +
    +
    +
    after - String +
    +

    Returns the items in the list that come after the specified cursor.

    +
    +
    +
    before - String +
    +

    Returns the items in the list that come before the specified cursor.

    +
    +
    +
    first - Int +
    +

    Returns the first n items from the list.

    +
    +
    +
    last - Int +
    +

    Returns the last n items from the list.

    +
    +
    +
    +
    success - Boolean! + walletCurrency - WalletCurrency!
    balance - SignedAmount! + balance - FractionalCentAmount
    isExternal - Boolean! + +
    lnurlp - Lnurl
    bankAccounts - [BankAccount!]! + Bank accounts available for cashout
    contactByUsername - UserContact!
    balance - SignedAmount! + balance - FractionalCentAmount
    isExternal - Boolean! + +
    lnurlp - Lnurl
    +

    UsdtWallet

    +

    UsdWallet

    @@ -15520,9 +20406,10 @@
    Possible Types
    Example
    {
    -  "accountId": "4",
    -  "balance": SignedAmount,
    +  "accountId": 4,
    +  "balance": FractionalCentAmount,
       "id": "4",
    +  "isExternal": false,
       "lnurlp": Lnurl,
       "pendingIncomingBalance": SignedAmount,
       "transactions": TransactionConnection,
    @@ -15565,6 +20452,13 @@ 
    Values
    +

    USDT

    +
    +
    diff --git a/package-lock.json b/package-lock.json index 93b3055..99201cb 100644 --- a/package-lock.json +++ b/package-lock.json @@ -13,7 +13,7 @@ "get-graphql-schema": "^2.1.2", "graphql": "^16.11.0", "node-fetch": "^2.7.0", - "spectaql": "^3.0.4" + "spectaql": "^3.0.9" }, "devDependencies": { "serve": "^14.2.4" @@ -3742,31 +3742,12 @@ "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", "license": "MIT" }, - "node_modules/lodash.defaults": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/lodash.defaults/-/lodash.defaults-4.2.0.tgz", - "integrity": "sha512-qjxPLHd3r5DnsdGacqOMU6pb/avJzdh9tFX2ymgoZE27BmjXrNy/y4LoaiTeAb+O3gL8AfpJGtqfX/ae2leYYQ==", - "license": "MIT" - }, - "node_modules/lodash.get": { - "version": "4.4.2", - "resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz", - "integrity": "sha512-z+Uw/vLuy6gQe8cfaFWD7p0wVv8fJl3mbzXh33RS+0oW2wvUqiRXiQ69gLWSLpgB5/6sU+r6BlQR0MBILadqTQ==", - "deprecated": "This package is deprecated. Use the optional chaining (?.) operator instead.", - "license": "MIT" - }, "node_modules/lodash.isfinite": { "version": "3.3.2", "resolved": "https://registry.npmjs.org/lodash.isfinite/-/lodash.isfinite-3.3.2.tgz", "integrity": "sha512-7FGG40uhC8Mm633uKW1r58aElFlBlxCrg9JfSi3P6aYiWmfiWF0PgMd86ZUsxE5GwWPdHoS2+48bwTh2VPkIQA==", "license": "MIT" }, - "node_modules/lodash.unset": { - "version": "4.5.2", - "resolved": "https://registry.npmjs.org/lodash.unset/-/lodash.unset-4.5.2.tgz", - "integrity": "sha512-bwKX88k2JhCV9D1vtE8+naDKlLiGrSmf8zi/Y9ivFHwbmRfA8RxS/aVJ+sIht2XOwqoNr4xUPUkGZpc1sHFEKg==", - "license": "MIT" - }, "node_modules/lru-cache": { "version": "10.4.3", "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.4.3.tgz", @@ -3911,19 +3892,23 @@ } }, "node_modules/microfiber": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/microfiber/-/microfiber-2.1.1.tgz", - "integrity": "sha512-lLHfeAXpPQZIU7/UMwtNtNXpb3PphaNZJSVwEntkRl9ir+lgJr534dTXfbILE1hksNMggOYwAZhAGFrgiySc5A==", + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/microfiber/-/microfiber-2.1.2.tgz", + "integrity": "sha512-2V8EeYHnoIEmElINgCfq7CQwokUYeVF6wBs1JBGuYj7pXPKWeNUjJNXkXaWSbsoSKr8yat5Lc6q+IBZpfajK7Q==", "license": "MIT", "dependencies": { - "lodash.defaults": "^4.2.0", - "lodash.get": "^4.4.2", - "lodash.unset": "^4.5.2" + "lodash": "^4.17.23" }, "engines": { "node": ">=14" } }, + "node_modules/microfiber/node_modules/lodash": { + "version": "4.18.1", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.18.1.tgz", + "integrity": "sha512-dMInicTPVE8d1e5otfwmmjlxkZoUpiVLwyeTdUsi/Caj/gfzzblBcCE5sRHV/AsjuCmxWrte2TNGSYuCeCq+0Q==", + "license": "MIT" + }, "node_modules/micromatch": { "version": "4.0.8", "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", @@ -5283,9 +5268,9 @@ } }, "node_modules/spectaql": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/spectaql/-/spectaql-3.0.4.tgz", - "integrity": "sha512-I/afdQ3gMRd7Z+R/Au1D6jU/+Nh0pD3NraLBh5QpaLno4Vy/VIwhDZAkLBMrnleuQhhiPiO/GTIZy7TngCZRWQ==", + "version": "3.0.9", + "resolved": "https://registry.npmjs.org/spectaql/-/spectaql-3.0.9.tgz", + "integrity": "sha512-SlPY/TjXL8FqWddcvGenoKJpS0N7LLk0tVUxzblIzY/f8ZrwnCq90gmkMXVMbvN1J/005UXJyepV9d1WifjdVQ==", "license": "MIT", "dependencies": { "@anvilco/apollo-server-plugin-introspection-metadata": "^2.2.3", @@ -5318,11 +5303,11 @@ "json5": "^2.2.0", "lodash": "^4.17.21", "marked": "^4.0.12", - "microfiber": "^2.0.1", + "microfiber": "^2.1.2", "postcss": "^8.4.19", "sass": "^1.32.13", "sync-request": "^6.1.0", - "tmp": "0.2.1" + "tmp": "0.2.4" }, "bin": { "spectaql": "bin/spectaql.js" @@ -5655,31 +5640,12 @@ "license": "MIT" }, "node_modules/tmp": { - "version": "0.2.1", - "resolved": "https://registry.npmjs.org/tmp/-/tmp-0.2.1.tgz", - "integrity": "sha512-76SUhtfqR2Ijn+xllcI5P1oyannHNHByD80W1q447gU3mp9G9PSpGdWmjUOHRDPiHYacIk66W7ubDTuPF3BEtQ==", + "version": "0.2.4", + "resolved": "https://registry.npmjs.org/tmp/-/tmp-0.2.4.tgz", + "integrity": "sha512-UdiSoX6ypifLmrfQ/XfiawN6hkjSBpCjhKxxZcWlUUmoXLaCKQU0bx4HF/tdDK2uzRuchf1txGvrWBzYREssoQ==", "license": "MIT", - "dependencies": { - "rimraf": "^3.0.0" - }, "engines": { - "node": ">=8.17.0" - } - }, - "node_modules/tmp/node_modules/rimraf": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", - "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", - "deprecated": "Rimraf versions prior to v4 are no longer supported", - "license": "ISC", - "dependencies": { - "glob": "^7.1.3" - }, - "bin": { - "rimraf": "bin.js" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" + "node": ">=14.14" } }, "node_modules/to-regex-range": { diff --git a/package.json b/package.json index 668110b..54a16e0 100644 --- a/package.json +++ b/package.json @@ -11,7 +11,7 @@ "generate-docs": "spectaql spectaql-config.yml", "patch-spec": "node src/spec-patch.js", "copy-assets": "cp -r src/css public/css && cp -r src/js public/js && cp -r src/images public/images && cp -f src/index.html public/index.html && cp -f src/stylesheets/* public/stylesheets/", - "build": "npm run fetch-schema && npm run generate-docs && cp -r docs/* public/ && npm run copy-assets && npm run patch-spec", + "build": "npm run fetch-schema && npm run generate-docs && cp -r docs/* public/ && cp docs/index.html public/spec.html && npm run copy-assets && npm run patch-spec", "build:versions": "npm run build && node build-versions.js", "start": "serve public", "dev": "serve public --cors -l 3000" @@ -31,7 +31,7 @@ "get-graphql-schema": "^2.1.2", "graphql": "^16.11.0", "node-fetch": "^2.7.0", - "spectaql": "^3.0.4" + "spectaql": "^3.0.9" }, "devDependencies": { "serve": "^14.2.4" diff --git a/public/index.html b/public/index.html index ba079f6..810a928 100644 --- a/public/index.html +++ b/public/index.html @@ -267,9 +267,6 @@

    Endpoints

    -
    - ⚠️ Development Notice: The Flash API is currently under active development. All endpoints, parameters, and responses are subject to change and improvement. This documentation will be updated as the API evolves. -

    Flash GraphQL API

    This API provides access to Flash's Bitcoin and Lightning Network payment services for the Caribbean region.

    @@ -454,73 +451,7 @@

    Error Handling

    +
    - ← Back to Overview -
    - ⚠️ Development Notice: The Flash API is currently under active development. All endpoints, parameters, and responses are subject to change and improvement. This documentation will be updated as the API evolves. -
    - - ← Back to Overview -
    - ⚠️ Development Notice: The Flash API is currently under active development. All endpoints, parameters, and responses are subject to change and improvement. This documentation will be updated as the API evolves. -
    - - ← Back to Overview -
    - ⚠️ Development Notice: The Flash API is currently under active development. All endpoints, parameters, and responses are subject to change and improvement. This documentation will be updated as the API evolves. -
    - - ← Back to Overview - ← Back to Overview - ← Back to Overview - ← Back to Overview - ← Back to Overview - ← Back to Overview - ← Back to Overview - ← Back to Overview - ← Back to Overview - ← Back to Overview ← Back to Overview
    +
    +
    +
    +
    + Queries +
    +

    + bridgeExternalAccounts +

    +
    +
    +
    +
    Response
    +

    Returns [BridgeExternalAccount] +

    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    query BridgeExternalAccounts {
    +  bridgeExternalAccounts {
    +    accountNumberLast4
    +    bankName
    +    id
    +    isDefault
    +    status
    +  }
    +}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "bridgeExternalAccounts": [
    +      {
    +        "accountNumberLast4": "abc123",
    +        "bankName": "abc123",
    +        "id": "4",
    +        "isDefault": false,
    +        "status": "xyz789"
    +      }
    +    ]
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Queries +
    +

    + bridgeKycStatus +

    +
    +
    +
    +
    Response
    +

    Returns a String +

    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    query BridgeKycStatus {
    +  bridgeKycStatus
    +}
    +
    +
    +
    +
    Response
    +
    {"data": {"bridgeKycStatus": "abc123"}}
    +
    +
    +
    +
    +
    +
    +
    + Queries +
    +

    + bridgeVirtualAccount +

    +
    +
    +
    +
    Response
    +

    Returns a BridgeVirtualAccount +

    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    query BridgeVirtualAccount {
    +  bridgeVirtualAccount {
    +    accountNumber
    +    accountNumberLast4
    +    bankName
    +    id
    +    kycLink
    +    message
    +    pending
    +    routingNumber
    +    tosLink
    +  }
    +}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "bridgeVirtualAccount": {
    +      "accountNumber": "xyz789",
    +      "accountNumberLast4": "abc123",
    +      "bankName": "xyz789",
    +      "id": "4",
    +      "kycLink": "xyz789",
    +      "message": "abc123",
    +      "pending": true,
    +      "routingNumber": "abc123",
    +      "tosLink": "xyz789"
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Queries +
    +

    + bridgeWithdrawalRequest +

    +
    +
    +
    +
    Response
    +

    Returns a BridgeWithdrawal +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + id - ID! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    query BridgeWithdrawalRequest($id: ID!) {
    +  bridgeWithdrawalRequest(id: $id) {
    +    amount
    +    bridgeDeveloperFee
    +    bridgeExchangeFee
    +    bridgeTransferId
    +    createdAt
    +    currency
    +    estimatedBridgeFee
    +    estimatedBridgeFeePercent
    +    estimatedCustomerFee
    +    estimatedGasBuffer
    +    externalAccountId
    +    failureReason
    +    finalAmount
    +    flashFee
    +    flashFeeIsEstimate
    +    flashFeeNotice
    +    flashFeePercent
    +    id
    +    status
    +    subtotalAmount
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"id": "4"}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "bridgeWithdrawalRequest": {
    +      "amount": "xyz789",
    +      "bridgeDeveloperFee": "xyz789",
    +      "bridgeExchangeFee": "abc123",
    +      "bridgeTransferId": "abc123",
    +      "createdAt": "xyz789",
    +      "currency": "abc123",
    +      "estimatedBridgeFee": "xyz789",
    +      "estimatedBridgeFeePercent": "xyz789",
    +      "estimatedCustomerFee": "xyz789",
    +      "estimatedGasBuffer": "abc123",
    +      "externalAccountId": "abc123",
    +      "failureReason": "abc123",
    +      "finalAmount": "abc123",
    +      "flashFee": "xyz789",
    +      "flashFeeIsEstimate": false,
    +      "flashFeeNotice": "xyz789",
    +      "flashFeePercent": "xyz789",
    +      "id": 4,
    +      "status": "abc123",
    +      "subtotalAmount": "abc123"
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Queries +
    +

    + bridgeWithdrawals +

    +
    +
    +
    +
    Response
    +

    Returns [BridgeWithdrawal] +

    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    query BridgeWithdrawals {
    +  bridgeWithdrawals {
    +    amount
    +    bridgeDeveloperFee
    +    bridgeExchangeFee
    +    bridgeTransferId
    +    createdAt
    +    currency
    +    estimatedBridgeFee
    +    estimatedBridgeFeePercent
    +    estimatedCustomerFee
    +    estimatedGasBuffer
    +    externalAccountId
    +    failureReason
    +    finalAmount
    +    flashFee
    +    flashFeeIsEstimate
    +    flashFeeNotice
    +    flashFeePercent
    +    id
    +    status
    +    subtotalAmount
    +  }
    +}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "bridgeWithdrawals": [
    +      {
    +        "amount": "xyz789",
    +        "bridgeDeveloperFee": "abc123",
    +        "bridgeExchangeFee": "abc123",
    +        "bridgeTransferId": "abc123",
    +        "createdAt": "xyz789",
    +        "currency": "xyz789",
    +        "estimatedBridgeFee": "xyz789",
    +        "estimatedBridgeFeePercent": "abc123",
    +        "estimatedCustomerFee": "xyz789",
    +        "estimatedGasBuffer": "abc123",
    +        "externalAccountId": "xyz789",
    +        "failureReason": "xyz789",
    +        "finalAmount": "abc123",
    +        "flashFee": "abc123",
    +        "flashFeeIsEstimate": true,
    +        "flashFeeNotice": "xyz789",
    +        "flashFeePercent": "abc123",
    +        "id": 4,
    +        "status": "xyz789",
    +        "subtotalAmount": "xyz789"
    +      }
    +    ]
    +  }
    +}
     
    @@ -678,9 +923,9 @@
    Response
    "data": { "btcPrice": { "base": 9007199254740991, - "currencyUnit": "abc123", + "currencyUnit": "xyz789", "formattedAmount": "xyz789", - "offset": 123 + "offset": 987 } } } @@ -804,6 +1049,64 @@
    Response
    ] } } +
    +
    + + +
    +
    +
    + Queries +
    +

    + cashWalletCutover +

    +
    +
    +
    +
    Response
    +

    Returns a CashWalletCutover! +

    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    query CashWalletCutover {
    +  cashWalletCutover {
    +    completedAt
    +    cutoverVersion
    +    pauseReason
    +    pausedAt
    +    runId
    +    scheduledAt
    +    startedAt
    +    state
    +    updatedAt
    +    updatedBy
    +  }
    +}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "cashWalletCutover": {
    +      "completedAt": 1592577642,
    +      "cutoverVersion": 987,
    +      "pauseReason": "xyz789",
    +      "pausedAt": 1592577642,
    +      "runId": "abc123",
    +      "scheduledAt": 1592577642,
    +      "startedAt": 1592577642,
    +      "state": "COMPLETE",
    +      "updatedAt": 1592577642,
    +      "updatedBy": "xyz789"
    +    }
    +  }
    +}
     
    @@ -846,9 +1149,9 @@
    Response
    "currencyList": [ { "flag": "abc123", - "fractionDigits": 987, + "fractionDigits": 123, "id": "4", - "name": "xyz789", + "name": "abc123", "symbol": "xyz789" } ] @@ -880,10 +1183,12 @@

    Example

    Query
    query Globals {
       globals {
    +    bridgeEnabled
         buildInformation {
           commitHash
           helmRevision
         }
    +    cashoutEnabled
         feesInformation {
           deposit {
             ...DepositFeesInformationFragment
    @@ -897,6 +1202,7 @@ 
    Query
    id supportedAuthChannels }
    + topupEnabled }
    }
    @@ -906,15 +1212,18 @@
    Response
    {
       "data": {
         "globals": {
    +      "bridgeEnabled": true,
           "buildInformation": BuildInformation,
    +      "cashoutEnabled": false,
           "feesInformation": FeesInformation,
    -      "lightningAddressDomain": "xyz789",
    +      "lightningAddressDomain": "abc123",
           "lightningAddressDomainAliases": [
    -        "xyz789"
    +        "abc123"
           ],
           "network": "mainnet",
           "nodesIds": ["xyz789"],
    -      "supportedCountries": [Country]
    +      "supportedCountries": [Country],
    +      "topupEnabled": true
         }
       }
     }
    @@ -985,7 +1294,70 @@ 
    Response
    "data": { "isFlashNpub": { "errors": [Error], - "isFlashNpub": false + "isFlashNpub": true + } + } +} +
    +
    + + +
    +
    +
    + Queries +
    +

    + latestAccountUpgradeRequest +

    +
    +
    +
    +
    Response
    +

    Returns an AccountUpgradeRequestPayload! +

    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    query LatestAccountUpgradeRequest {
    +  latestAccountUpgradeRequest {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    upgradeRequest {
    +      address {
    +        ...AddressFragment
    +      }
    +      bankAccount {
    +        ...BankAccountFragment
    +      }
    +      currentLevel
    +      email
    +      fullName
    +      idDocument
    +      name
    +      phoneNumber
    +      requestedLevel
    +      status
    +      terminalsRequested
    +      username
    +    }
    +  }
    +}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "latestAccountUpgradeRequest": {
    +      "errors": [Error],
    +      "upgradeRequest": AccountUpgradeRequest
         }
       }
     }
    @@ -1086,6 +1458,16 @@ 

    Example

    Query
    query Me {
       me {
    +    bankAccounts {
    +      accountName
    +      accountNumber
    +      accountType
    +      bankBranch
    +      bankName
    +      currency
    +      id
    +      isDefault
    +    }
         contactByUsername {
           alias
           id
    @@ -1155,17 +1537,18 @@ 
    Response
    {
       "data": {
         "me": {
    +      "bankAccounts": [BankAccount],
           "contactByUsername": UserContact,
           "contacts": [UserContact],
           "createdAt": 1592577642,
           "defaultAccount": Account,
           "email": Email,
    -      "id": "4",
    +      "id": 4,
           "language": Language,
           "npub": npub,
           "phone": Phone,
           "quizQuestions": [UserQuizQuestion],
    -      "totpEnabled": false,
    +      "totpEnabled": true,
           "username": Username
         }
       }
    @@ -1209,8 +1592,8 @@ 
    Response
    "data": { "mobileVersions": [ { - "currentSupported": 987, - "minSupported": 987, + "currentSupported": 123, + "minSupported": 123, "platform": "abc123" } ] @@ -1415,7 +1798,7 @@
    Arguments
    - amount - CentAmount! + amount - FractionalCentAmount! @@ -1443,7 +1826,7 @@

    Example

    Query
    query OnChainUsdTxFee(
       $address: OnChainAddress!,
    -  $amount: CentAmount!,
    +  $amount: FractionalCentAmount!,
       $speed: PayoutSpeed,
       $walletId: WalletId!
     ) {
    @@ -1462,7 +1845,7 @@ 
    Query
    Variables
    {
       "address": OnChainAddress,
    -  "amount": CentAmount,
    +  "amount": FractionalCentAmount,
       "speed": "FAST",
       "walletId": WalletId
     }
    @@ -1470,7 +1853,11 @@ 
    Variables
    Response
    -
    {"data": {"onChainUsdTxFee": {"amount": CentAmount}}}
    +                  
    {
    +  "data": {
    +    "onChainUsdTxFee": {"amount": FractionalCentAmount}
    +  }
    +}
     
    @@ -1567,7 +1954,7 @@
    Response
    {
       "data": {
         "onChainUsdTxFeeAsBtcDenominated": {
    -      "amount": CentAmount
    +      "amount": FractionalCentAmount
         }
       }
     }
    @@ -1710,6 +2097,131 @@ 
    Response
    } } } +
    +
    + + +
    +
    +
    + Queries +
    +

    + supportedBanks +

    +
    +
    +
    +
    Response
    +

    Returns [Bank!]! +

    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    query SupportedBanks {
    +  supportedBanks {
    +    name
    +  }
    +}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "supportedBanks": [{"name": "xyz789"}]
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Queries +
    +

    + transactionDetails +

    +
    +
    +
    +
    Response
    +

    Returns a TransactionDetailsPayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - TransactionDetailsInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    query TransactionDetails($input: TransactionDetailsInput!) {
    +  transactionDetails(input: $input) {
    +    errors {
    +      message
    +    }
    +    transactionDetails {
    +      accountId
    +      address
    +      amount
    +      confirmations
    +      createdAt
    +      currency
    +      fee
    +      id
    +      invoice
    +      memo
    +      paymentHash
    +      paymentPreimage
    +      status
    +      txid
    +      type
    +      updatedAt
    +      vout
    +    }
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": TransactionDetailsInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "transactionDetails": {
    +      "errors": [TransactionDetailsError],
    +      "transactionDetails": TransactionDetails
    +    }
    +  }
    +}
     
    @@ -1869,7 +2381,7 @@
    Query
    Response
    {
       "data": {
    -    "accountDelete": {"errors": [Error], "success": true}
    +    "accountDelete": {"errors": [Error], "success": false}
       }
     }
     
    @@ -2465,18 +2977,67 @@
    Response
    -
    +

    - callbackEndpointAdd + bridgeAddExternalAccount

    Response
    -

    Returns a CallbackEndpointAddPayload! +

    Returns a BridgeAddExternalAccountPayload! +

    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    mutation BridgeAddExternalAccount {
    +  bridgeAddExternalAccount {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    externalAccount {
    +      expiresAt
    +      linkUrl
    +    }
    +  }
    +}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "bridgeAddExternalAccount": {
    +      "errors": [Error],
    +      "externalAccount": BridgeExternalAccountLink
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Mutations +
    +

    + bridgeCancelWithdrawalRequest +

    +
    +
    +
    +
    Response
    +

    Returns a BridgeCancelWithdrawalRequestPayload!

    @@ -2491,7 +3052,7 @@
    Arguments
    - input - CallbackEndpointAddInput! + input - BridgeCancelWithdrawalRequestInput! @@ -2504,30 +3065,51 @@
    Arguments

    Example

    Query
    -
    mutation CallbackEndpointAdd($input: CallbackEndpointAddInput!) {
    -  callbackEndpointAdd(input: $input) {
    +                  
    mutation BridgeCancelWithdrawalRequest($input: BridgeCancelWithdrawalRequestInput!) {
    +  bridgeCancelWithdrawalRequest(input: $input) {
         errors {
           code
           message
           path
         }
    -    id
    +    withdrawal {
    +      amount
    +      bridgeDeveloperFee
    +      bridgeExchangeFee
    +      bridgeTransferId
    +      createdAt
    +      currency
    +      estimatedBridgeFee
    +      estimatedBridgeFeePercent
    +      estimatedCustomerFee
    +      estimatedGasBuffer
    +      externalAccountId
    +      failureReason
    +      finalAmount
    +      flashFee
    +      flashFeeIsEstimate
    +      flashFeeNotice
    +      flashFeePercent
    +      id
    +      status
    +      subtotalAmount
    +    }
       }
     }
     
    Variables
    -
    {"input": CallbackEndpointAddInput}
    +                  
    {"input": BridgeCancelWithdrawalRequestInput}
     
    Response
    {
       "data": {
    -    "callbackEndpointAdd": {
    +    "bridgeCancelWithdrawalRequest": {
           "errors": [Error],
    -      "id": EndpointId
    +      "withdrawal": BridgeWithdrawal
         }
       }
     }
    @@ -2536,18 +3118,18 @@ 
    Response
    -
    +

    - callbackEndpointDelete + bridgeCreateExternalAccount

    Response
    -

    Returns a SuccessPayload! +

    Returns a BridgeCreateExternalAccountPayload!

    @@ -2562,7 +3144,7 @@
    Arguments
    - input - CallbackEndpointDeleteInput! + input - BridgeCreateExternalAccountInput! @@ -2575,30 +3157,36 @@
    Arguments

    Example

    Query
    -
    mutation CallbackEndpointDelete($input: CallbackEndpointDeleteInput!) {
    -  callbackEndpointDelete(input: $input) {
    +                  
    mutation BridgeCreateExternalAccount($input: BridgeCreateExternalAccountInput!) {
    +  bridgeCreateExternalAccount(input: $input) {
         errors {
           code
           message
           path
         }
    -    success
    +    externalAccount {
    +      accountNumberLast4
    +      bankName
    +      id
    +      isDefault
    +      status
    +    }
       }
     }
     
    Variables
    -
    {"input": CallbackEndpointDeleteInput}
    +                  
    {"input": BridgeCreateExternalAccountInput}
     
    Response
    {
       "data": {
    -    "callbackEndpointDelete": {
    +    "bridgeCreateExternalAccount": {
           "errors": [Error],
    -      "success": true
    +      "externalAccount": BridgeExternalAccount
         }
       }
     }
    @@ -2607,18 +3195,18 @@ 
    Response
    -
    +

    - captchaCreateChallenge + bridgeCreateVirtualAccount

    @@ -2626,18 +3214,23 @@
    Response

    Example

    Query
    -
    mutation CaptchaCreateChallenge {
    -  captchaCreateChallenge {
    +                  
    mutation BridgeCreateVirtualAccount {
    +  bridgeCreateVirtualAccount {
         errors {
           code
           message
           path
         }
    -    result {
    -      challengeCode
    -      failbackMode
    +    virtualAccount {
    +      accountNumber
    +      accountNumberLast4
    +      bankName
           id
    -      newCaptcha
    +      kycLink
    +      message
    +      pending
    +      routingNumber
    +      tosLink
         }
       }
     }
    @@ -2647,9 +3240,9 @@ 
    Query
    Response
    {
       "data": {
    -    "captchaCreateChallenge": {
    +    "bridgeCreateVirtualAccount": {
           "errors": [Error],
    -      "result": CaptchaCreateChallengeResult
    +      "virtualAccount": BridgeVirtualAccount
         }
       }
     }
    @@ -2658,18 +3251,18 @@ 
    Response
    -
    +

    - captchaRequestAuthCode + bridgeDeleteExternalAccount

    Response
    -

    Returns a SuccessPayload! +

    Returns a BridgeDeleteExternalAccountPayload!

    @@ -2684,7 +3277,7 @@
    Arguments
    - input - CaptchaRequestAuthCodeInput! + input - BridgeDeleteExternalAccountInput! @@ -2697,30 +3290,36 @@
    Arguments

    Example

    Query
    -
    mutation CaptchaRequestAuthCode($input: CaptchaRequestAuthCodeInput!) {
    -  captchaRequestAuthCode(input: $input) {
    +                  
    mutation BridgeDeleteExternalAccount($input: BridgeDeleteExternalAccountInput!) {
    +  bridgeDeleteExternalAccount(input: $input) {
         errors {
           code
           message
           path
         }
    -    success
    +    externalAccount {
    +      accountNumberLast4
    +      bankName
    +      id
    +      isDefault
    +      status
    +    }
       }
     }
     
    Variables
    -
    {"input": CaptchaRequestAuthCodeInput}
    +                  
    {"input": BridgeDeleteExternalAccountInput}
     
    Response
    {
       "data": {
    -    "captchaRequestAuthCode": {
    +    "bridgeDeleteExternalAccount": {
           "errors": [Error],
    -      "success": false
    +      "externalAccount": BridgeExternalAccount
         }
       }
     }
    @@ -2729,18 +3328,18 @@ 
    Response
    -
    +

    - deviceNotificationTokenCreate + bridgeInitiateKyc

    Response
    -

    Returns a SuccessPayload! +

    Returns a BridgeInitiateKycPayload!

    @@ -2755,7 +3354,7 @@
    Arguments
    - input - DeviceNotificationTokenCreateInput! + input - BridgeInitiateKycInput! @@ -2768,30 +3367,33 @@
    Arguments

    Example

    Query
    -
    mutation DeviceNotificationTokenCreate($input: DeviceNotificationTokenCreateInput!) {
    -  deviceNotificationTokenCreate(input: $input) {
    +                  
    mutation BridgeInitiateKyc($input: BridgeInitiateKycInput!) {
    +  bridgeInitiateKyc(input: $input) {
         errors {
           code
           message
           path
         }
    -    success
    +    kycLink {
    +      kycLink
    +      tosLink
    +    }
       }
     }
     
    Variables
    -
    {"input": DeviceNotificationTokenCreateInput}
    +                  
    {"input": BridgeInitiateKycInput}
     
    Response
    {
       "data": {
    -    "deviceNotificationTokenCreate": {
    +    "bridgeInitiateKyc": {
           "errors": [Error],
    -      "success": true
    +      "kycLink": BridgeKycLink
         }
       }
     }
    @@ -2800,18 +3402,18 @@ 
    Response
    -
    +

    - feedbackSubmit + bridgeInitiateWithdrawal

    Response
    -

    Returns a SuccessPayload! +

    Returns a BridgeInitiateWithdrawalPayload!

    @@ -2826,7 +3428,7 @@
    Arguments
    - input - FeedbackSubmitInput! + input - BridgeInitiateWithdrawalInput! @@ -2839,30 +3441,51 @@
    Arguments

    Example

    Query
    -
    mutation FeedbackSubmit($input: FeedbackSubmitInput!) {
    -  feedbackSubmit(input: $input) {
    +                  
    mutation BridgeInitiateWithdrawal($input: BridgeInitiateWithdrawalInput!) {
    +  bridgeInitiateWithdrawal(input: $input) {
         errors {
           code
           message
           path
         }
    -    success
    +    withdrawal {
    +      amount
    +      bridgeDeveloperFee
    +      bridgeExchangeFee
    +      bridgeTransferId
    +      createdAt
    +      currency
    +      estimatedBridgeFee
    +      estimatedBridgeFeePercent
    +      estimatedCustomerFee
    +      estimatedGasBuffer
    +      externalAccountId
    +      failureReason
    +      finalAmount
    +      flashFee
    +      flashFeeIsEstimate
    +      flashFeeNotice
    +      flashFeePercent
    +      id
    +      status
    +      subtotalAmount
    +    }
       }
     }
     
    Variables
    -
    {"input": FeedbackSubmitInput}
    +                  
    {"input": BridgeInitiateWithdrawalInput}
     
    Response
    {
       "data": {
    -    "feedbackSubmit": {
    +    "bridgeInitiateWithdrawal": {
           "errors": [Error],
    -      "success": false
    +      "withdrawal": BridgeWithdrawal
         }
       }
     }
    @@ -2871,26 +3494,18 @@ 
    Response
    -
    +

    - intraLedgerPaymentSend + bridgeRequestWithdrawal

    -
    -
    -
    -
    Description
    -

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

    -
    -
    -
    Response
    -

    Returns a PaymentSendPayload! +

    Returns a BridgeRequestWithdrawalPayload!

    @@ -2905,7 +3520,7 @@
    Arguments
    - input - IntraLedgerPaymentSendInput! + input - BridgeRequestWithdrawalInput! @@ -2918,30 +3533,51 @@
    Arguments

    Example

    Query
    -
    mutation IntraLedgerPaymentSend($input: IntraLedgerPaymentSendInput!) {
    -  intraLedgerPaymentSend(input: $input) {
    +                  
    mutation BridgeRequestWithdrawal($input: BridgeRequestWithdrawalInput!) {
    +  bridgeRequestWithdrawal(input: $input) {
         errors {
           code
           message
           path
         }
    -    status
    +    withdrawal {
    +      amount
    +      bridgeDeveloperFee
    +      bridgeExchangeFee
    +      bridgeTransferId
    +      createdAt
    +      currency
    +      estimatedBridgeFee
    +      estimatedBridgeFeePercent
    +      estimatedCustomerFee
    +      estimatedGasBuffer
    +      externalAccountId
    +      failureReason
    +      finalAmount
    +      flashFee
    +      flashFeeIsEstimate
    +      flashFeeNotice
    +      flashFeePercent
    +      id
    +      status
    +      subtotalAmount
    +    }
       }
     }
     
    Variables
    -
    {"input": IntraLedgerPaymentSendInput}
    +                  
    {"input": BridgeRequestWithdrawalInput}
     
    Response
    {
       "data": {
    -    "intraLedgerPaymentSend": {
    +    "bridgeRequestWithdrawal": {
           "errors": [Error],
    -      "status": "ALREADY_PAID"
    +      "withdrawal": BridgeWithdrawal
         }
       }
     }
    @@ -2950,27 +3586,18 @@ 
    Response
    -
    +

    - intraLedgerUsdPaymentSend + bridgeSetDefaultExternalAccount

    -
    -
    -
    -
    Description
    -

    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.

    -
    -
    -
    @@ -2985,7 +3612,7 @@
    Arguments
    - input - IntraLedgerUsdPaymentSendInput! + input - BridgeSetDefaultExternalAccountInput! @@ -2998,30 +3625,36 @@
    Arguments

    Example

    Query
    -
    mutation IntraLedgerUsdPaymentSend($input: IntraLedgerUsdPaymentSendInput!) {
    -  intraLedgerUsdPaymentSend(input: $input) {
    +                  
    mutation BridgeSetDefaultExternalAccount($input: BridgeSetDefaultExternalAccountInput!) {
    +  bridgeSetDefaultExternalAccount(input: $input) {
         errors {
           code
           message
           path
         }
    -    status
    +    externalAccount {
    +      accountNumberLast4
    +      bankName
    +      id
    +      isDefault
    +      status
    +    }
       }
     }
     
    Variables
    -
    {"input": IntraLedgerUsdPaymentSendInput}
    +                  
    {"input": BridgeSetDefaultExternalAccountInput}
     
    Response
    {
       "data": {
    -    "intraLedgerUsdPaymentSend": {
    +    "bridgeSetDefaultExternalAccount": {
           "errors": [Error],
    -      "status": "ALREADY_PAID"
    +      "externalAccount": BridgeExternalAccount
         }
       }
     }
    @@ -3030,26 +3663,18 @@ 
    Response
    -
    +

    - lnInvoiceCreate + businessAccountUpgradeRequest

    -
    -
    -
    -
    Description
    -

    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.

    -
    -
    -
    Response
    -

    Returns a LnInvoicePayload! +

    Returns an AccountUpgradePayload!

    @@ -3064,7 +3689,7 @@
    Arguments
    - input - LnInvoiceCreateInput! + input - BusinessAccountUpgradeRequestInput! @@ -3077,35 +3702,32 @@
    Arguments

    Example

    Query
    -
    mutation LnInvoiceCreate($input: LnInvoiceCreateInput!) {
    -  lnInvoiceCreate(input: $input) {
    +                  
    mutation BusinessAccountUpgradeRequest($input: BusinessAccountUpgradeRequestInput!) {
    +  businessAccountUpgradeRequest(input: $input) {
         errors {
           code
           message
           path
         }
    -    invoice {
    -      paymentHash
    -      paymentRequest
    -      paymentSecret
    -      satoshis
    -    }
    +    id
    +    status
       }
     }
     
    Variables
    -
    {"input": LnInvoiceCreateInput}
    +                  
    {"input": BusinessAccountUpgradeRequestInput}
     
    Response
    {
       "data": {
    -    "lnInvoiceCreate": {
    +    "businessAccountUpgradeRequest": {
           "errors": [Error],
    -      "invoice": LnInvoice
    +      "id": "abc123",
    +      "status": "abc123"
         }
       }
     }
    @@ -3114,26 +3736,18 @@ 
    Response
    -
    +

    - lnInvoiceCreateOnBehalfOfRecipient + callbackEndpointAdd

    -
    -
    -
    -
    Description
    -

    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.

    -
    -
    -
    Response
    -

    Returns a LnInvoicePayload! +

    Returns a CallbackEndpointAddPayload!

    @@ -3148,7 +3762,7 @@
    Arguments
    - input - LnInvoiceCreateOnBehalfOfRecipientInput! + input - CallbackEndpointAddInput! @@ -3161,35 +3775,30 @@
    Arguments

    Example

    Query
    -
    mutation LnInvoiceCreateOnBehalfOfRecipient($input: LnInvoiceCreateOnBehalfOfRecipientInput!) {
    -  lnInvoiceCreateOnBehalfOfRecipient(input: $input) {
    +                  
    mutation CallbackEndpointAdd($input: CallbackEndpointAddInput!) {
    +  callbackEndpointAdd(input: $input) {
         errors {
           code
           message
           path
         }
    -    invoice {
    -      paymentHash
    -      paymentRequest
    -      paymentSecret
    -      satoshis
    -    }
    +    id
       }
     }
     
    Variables
    -
    {"input": LnInvoiceCreateOnBehalfOfRecipientInput}
    +                  
    {"input": CallbackEndpointAddInput}
     
    Response
    {
       "data": {
    -    "lnInvoiceCreateOnBehalfOfRecipient": {
    +    "callbackEndpointAdd": {
           "errors": [Error],
    -      "invoice": LnInvoice
    +      "id": EndpointId
         }
       }
     }
    @@ -3198,18 +3807,18 @@ 
    Response
    -
    +

    - lnInvoiceFeeProbe + callbackEndpointDelete

    Response
    -

    Returns a SatAmountPayload! +

    Returns a SuccessPayload!

    @@ -3224,7 +3833,7 @@
    Arguments
    - input - LnInvoiceFeeProbeInput! + input - CallbackEndpointDeleteInput! @@ -3237,30 +3846,30 @@
    Arguments

    Example

    Query
    -
    mutation LnInvoiceFeeProbe($input: LnInvoiceFeeProbeInput!) {
    -  lnInvoiceFeeProbe(input: $input) {
    -    amount
    +                  
    mutation CallbackEndpointDelete($input: CallbackEndpointDeleteInput!) {
    +  callbackEndpointDelete(input: $input) {
         errors {
           code
           message
           path
         }
    +    success
       }
     }
     
    Variables
    -
    {"input": LnInvoiceFeeProbeInput}
    +                  
    {"input": CallbackEndpointDeleteInput}
     
    Response
    {
       "data": {
    -    "lnInvoiceFeeProbe": {
    -      "amount": SatAmount,
    -      "errors": [Error]
    +    "callbackEndpointDelete": {
    +      "errors": [Error],
    +      "success": false
         }
       }
     }
    @@ -3269,26 +3878,69 @@ 
    Response
    -
    +

    - lnInvoicePaymentSend + captchaCreateChallenge

    -
    -
    Description
    -

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

    +
    +
    Response
    +

    Returns a CaptchaCreateChallengePayload! +

    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    mutation CaptchaCreateChallenge {
    +  captchaCreateChallenge {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    result {
    +      challengeCode
    +      failbackMode
    +      id
    +      newCaptcha
    +    }
    +  }
    +}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "captchaCreateChallenge": {
    +      "errors": [Error],
    +      "result": CaptchaCreateChallengeResult
    +    }
    +  }
    +}
    +
    +
    +
    +
    + Mutations +
    +

    + captchaRequestAuthCode +

    Response
    -

    Returns a PaymentSendPayload! +

    Returns a SuccessPayload!

    @@ -3303,7 +3955,7 @@
    Arguments
    - input - LnInvoicePaymentInput! + input - CaptchaRequestAuthCodeInput! @@ -3316,30 +3968,30 @@
    Arguments

    Example

    Query
    -
    mutation LnInvoicePaymentSend($input: LnInvoicePaymentInput!) {
    -  lnInvoicePaymentSend(input: $input) {
    +                  
    mutation CaptchaRequestAuthCode($input: CaptchaRequestAuthCodeInput!) {
    +  captchaRequestAuthCode(input: $input) {
         errors {
           code
           message
           path
         }
    -    status
    +    success
       }
     }
     
    Variables
    -
    {"input": LnInvoicePaymentInput}
    +                  
    {"input": CaptchaRequestAuthCodeInput}
     
    Response
    {
       "data": {
    -    "lnInvoicePaymentSend": {
    +    "captchaRequestAuthCode": {
           "errors": [Error],
    -      "status": "ALREADY_PAID"
    +      "success": true
         }
       }
     }
    @@ -3348,26 +4000,18 @@ 
    Response
    -
    +

    - lnNoAmountInvoiceCreate + deviceNotificationTokenCreate

    -
    -
    -
    -
    Description
    -

    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.

    -
    -
    -
    Response
    -

    Returns a LnNoAmountInvoicePayload! +

    Returns a SuccessPayload!

    @@ -3382,7 +4026,7 @@
    Arguments
    - input - LnNoAmountInvoiceCreateInput! + input - DeviceNotificationTokenCreateInput! @@ -3395,34 +4039,30 @@
    Arguments

    Example

    Query
    -
    mutation LnNoAmountInvoiceCreate($input: LnNoAmountInvoiceCreateInput!) {
    -  lnNoAmountInvoiceCreate(input: $input) {
    +                  
    mutation DeviceNotificationTokenCreate($input: DeviceNotificationTokenCreateInput!) {
    +  deviceNotificationTokenCreate(input: $input) {
         errors {
           code
           message
           path
         }
    -    invoice {
    -      paymentHash
    -      paymentRequest
    -      paymentSecret
    -    }
    +    success
       }
     }
     
    Variables
    -
    {"input": LnNoAmountInvoiceCreateInput}
    +                  
    {"input": DeviceNotificationTokenCreateInput}
     
    Response
    {
       "data": {
    -    "lnNoAmountInvoiceCreate": {
    +    "deviceNotificationTokenCreate": {
           "errors": [Error],
    -      "invoice": LnNoAmountInvoice
    +      "success": false
         }
       }
     }
    @@ -3431,26 +4071,18 @@ 
    Response
    -
    +

    - lnNoAmountInvoiceCreateOnBehalfOfRecipient + feedbackSubmit

    -
    -
    -
    -
    Description
    -

    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.

    -
    -
    -
    Response
    -

    Returns a LnNoAmountInvoicePayload! +

    Returns a SuccessPayload!

    @@ -3465,7 +4097,7 @@
    Arguments
    - input - LnNoAmountInvoiceCreateOnBehalfOfRecipientInput! + input - FeedbackSubmitInput! @@ -3478,34 +4110,30 @@
    Arguments

    Example

    Query
    -
    mutation LnNoAmountInvoiceCreateOnBehalfOfRecipient($input: LnNoAmountInvoiceCreateOnBehalfOfRecipientInput!) {
    -  lnNoAmountInvoiceCreateOnBehalfOfRecipient(input: $input) {
    +                  
    mutation FeedbackSubmit($input: FeedbackSubmitInput!) {
    +  feedbackSubmit(input: $input) {
         errors {
           code
           message
           path
         }
    -    invoice {
    -      paymentHash
    -      paymentRequest
    -      paymentSecret
    -    }
    +    success
       }
     }
     
    Variables
    -
    {"input": LnNoAmountInvoiceCreateOnBehalfOfRecipientInput}
    +                  
    {"input": FeedbackSubmitInput}
     
    Response
    {
       "data": {
    -    "lnNoAmountInvoiceCreateOnBehalfOfRecipient": {
    +    "feedbackSubmit": {
           "errors": [Error],
    -      "invoice": LnNoAmountInvoice
    +      "success": false
         }
       }
     }
    @@ -3514,18 +4142,18 @@ 
    Response
    -
    +

    - lnNoAmountInvoiceFeeProbe + idDocumentUploadUrlGenerate

    Response
    -

    Returns a SatAmountPayload! +

    Returns an IdDocumentUploadUrlPayload!

    @@ -3540,7 +4168,7 @@
    Arguments
    - input - LnNoAmountInvoiceFeeProbeInput! + input - IdDocumentUploadUrlGenerateInput! @@ -3553,30 +4181,32 @@
    Arguments

    Example

    Query
    -
    mutation LnNoAmountInvoiceFeeProbe($input: LnNoAmountInvoiceFeeProbeInput!) {
    -  lnNoAmountInvoiceFeeProbe(input: $input) {
    -    amount
    +                  
    mutation IdDocumentUploadUrlGenerate($input: IdDocumentUploadUrlGenerateInput!) {
    +  idDocumentUploadUrlGenerate(input: $input) {
         errors {
           code
           message
           path
         }
    +    fileKey
    +    uploadUrl
       }
     }
     
    Variables
    -
    {"input": LnNoAmountInvoiceFeeProbeInput}
    +                  
    {"input": IdDocumentUploadUrlGenerateInput}
     
    Response
    {
       "data": {
    -    "lnNoAmountInvoiceFeeProbe": {
    -      "amount": SatAmount,
    -      "errors": [Error]
    +    "idDocumentUploadUrlGenerate": {
    +      "errors": [Error],
    +      "fileKey": "xyz789",
    +      "uploadUrl": "xyz789"
         }
       }
     }
    @@ -3585,18 +4215,18 @@ 
    Response
    -
    +

    - lnNoAmountInvoicePaymentSend + initiateCashout

    Description
    -

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

    +

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

    @@ -3604,7 +4234,7 @@
    Description
    Response
    -

    Returns a PaymentSendPayload! +

    Returns an InitiatedCashoutResponse!

    @@ -3619,7 +4249,7 @@
    Arguments
    - input - LnNoAmountInvoicePaymentInput! + input - InitiateCashoutInput! @@ -3632,30 +4262,30 @@
    Arguments

    Example

    Query
    -
    mutation LnNoAmountInvoicePaymentSend($input: LnNoAmountInvoicePaymentInput!) {
    -  lnNoAmountInvoicePaymentSend(input: $input) {
    +                  
    mutation InitiateCashout($input: InitiateCashoutInput!) {
    +  initiateCashout(input: $input) {
         errors {
           code
           message
           path
         }
    -    status
    +    id
       }
     }
     
    Variables
    -
    {"input": LnNoAmountInvoicePaymentInput}
    +                  
    {"input": InitiateCashoutInput}
     
    Response
    {
       "data": {
    -    "lnNoAmountInvoicePaymentSend": {
    +    "initiateCashout": {
           "errors": [Error],
    -      "status": "ALREADY_PAID"
    +      "id": "4"
         }
       }
     }
    @@ -3664,18 +4294,26 @@ 
    Response
    -
    +

    - lnNoAmountUsdInvoiceFeeProbe + intraLedgerPaymentSend

    +
    +
    +
    +
    Description
    +

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

    +
    +
    +
    Response
    -

    Returns a CentAmountPayload! +

    Returns a PaymentSendPayload!

    @@ -3690,7 +4328,7 @@
    Arguments
    - input - LnNoAmountUsdInvoiceFeeProbeInput! + input - IntraLedgerPaymentSendInput! @@ -3703,30 +4341,30 @@
    Arguments

    Example

    Query
    -
    mutation LnNoAmountUsdInvoiceFeeProbe($input: LnNoAmountUsdInvoiceFeeProbeInput!) {
    -  lnNoAmountUsdInvoiceFeeProbe(input: $input) {
    -    amount
    +                  
    mutation IntraLedgerPaymentSend($input: IntraLedgerPaymentSendInput!) {
    +  intraLedgerPaymentSend(input: $input) {
         errors {
           code
           message
           path
         }
    +    status
       }
     }
     
    Variables
    -
    {"input": LnNoAmountUsdInvoiceFeeProbeInput}
    +                  
    {"input": IntraLedgerPaymentSendInput}
     
    Response
    {
       "data": {
    -    "lnNoAmountUsdInvoiceFeeProbe": {
    -      "amount": CentAmount,
    -      "errors": [Error]
    +    "intraLedgerPaymentSend": {
    +      "errors": [Error],
    +      "status": "ALREADY_PAID"
         }
       }
     }
    @@ -3735,18 +4373,19 @@ 
    Response
    -
    +

    - lnNoAmountUsdInvoicePaymentSend + intraLedgerUsdPaymentSend

    Description
    -

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

    +

    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.

    @@ -3769,7 +4408,7 @@
    Arguments
    - input - LnNoAmountUsdInvoicePaymentInput! + input - IntraLedgerUsdPaymentSendInput! @@ -3782,8 +4421,8 @@
    Arguments

    Example

    Query
    -
    mutation LnNoAmountUsdInvoicePaymentSend($input: LnNoAmountUsdInvoicePaymentInput!) {
    -  lnNoAmountUsdInvoicePaymentSend(input: $input) {
    +                  
    mutation IntraLedgerUsdPaymentSend($input: IntraLedgerUsdPaymentSendInput!) {
    +  intraLedgerUsdPaymentSend(input: $input) {
         errors {
           code
           message
    @@ -3796,14 +4435,14 @@ 
    Query
    Variables
    -
    {"input": LnNoAmountUsdInvoicePaymentInput}
    +                  
    {"input": IntraLedgerUsdPaymentSendInput}
     
    Response
    {
       "data": {
    -    "lnNoAmountUsdInvoicePaymentSend": {
    +    "intraLedgerUsdPaymentSend": {
           "errors": [Error],
           "status": "ALREADY_PAID"
         }
    @@ -3814,18 +4453,18 @@ 
    Response
    -
    +

    - lnUsdInvoiceCreate + lnInvoiceCreate

    Description
    -

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

    +

    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.

    @@ -3848,7 +4487,7 @@
    Arguments
    - input - LnUsdInvoiceCreateInput! + input - LnInvoiceCreateInput! @@ -3861,8 +4500,8 @@
    Arguments

    Example

    Query
    -
    mutation LnUsdInvoiceCreate($input: LnUsdInvoiceCreateInput!) {
    -  lnUsdInvoiceCreate(input: $input) {
    +                  
    mutation LnInvoiceCreate($input: LnInvoiceCreateInput!) {
    +  lnInvoiceCreate(input: $input) {
         errors {
           code
           message
    @@ -3880,14 +4519,14 @@ 
    Query
    Variables
    -
    {"input": LnUsdInvoiceCreateInput}
    +                  
    {"input": LnInvoiceCreateInput}
     
    Response
    {
       "data": {
    -    "lnUsdInvoiceCreate": {
    +    "lnInvoiceCreate": {
           "errors": [Error],
           "invoice": LnInvoice
         }
    @@ -3898,18 +4537,18 @@ 
    Response
    -
    +

    - lnUsdInvoiceCreateOnBehalfOfRecipient + lnInvoiceCreateOnBehalfOfRecipient

    Description
    -

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

    +

    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.

    @@ -3932,7 +4571,7 @@
    Arguments
    - input - LnUsdInvoiceCreateOnBehalfOfRecipientInput! + input - LnInvoiceCreateOnBehalfOfRecipientInput! @@ -3945,8 +4584,8 @@
    Arguments

    Example

    Query
    -
    mutation LnUsdInvoiceCreateOnBehalfOfRecipient($input: LnUsdInvoiceCreateOnBehalfOfRecipientInput!) {
    -  lnUsdInvoiceCreateOnBehalfOfRecipient(input: $input) {
    +                  
    mutation LnInvoiceCreateOnBehalfOfRecipient($input: LnInvoiceCreateOnBehalfOfRecipientInput!) {
    +  lnInvoiceCreateOnBehalfOfRecipient(input: $input) {
         errors {
           code
           message
    @@ -3964,14 +4603,14 @@ 
    Query
    Variables
    -
    {"input": LnUsdInvoiceCreateOnBehalfOfRecipientInput}
    +                  
    {"input": LnInvoiceCreateOnBehalfOfRecipientInput}
     
    Response
    {
       "data": {
    -    "lnUsdInvoiceCreateOnBehalfOfRecipient": {
    +    "lnInvoiceCreateOnBehalfOfRecipient": {
           "errors": [Error],
           "invoice": LnInvoice
         }
    @@ -3982,18 +4621,18 @@ 
    Response
    -
    +

    - lnUsdInvoiceFeeProbe + lnInvoiceFeeProbe

    Response
    -

    Returns a CentAmountPayload! +

    Returns a SatAmountPayload!

    @@ -4008,7 +4647,7 @@
    Arguments
    - input - LnUsdInvoiceFeeProbeInput! + input - LnInvoiceFeeProbeInput! @@ -4021,8 +4660,8 @@
    Arguments

    Example

    Query
    -
    mutation LnUsdInvoiceFeeProbe($input: LnUsdInvoiceFeeProbeInput!) {
    -  lnUsdInvoiceFeeProbe(input: $input) {
    +                  
    mutation LnInvoiceFeeProbe($input: LnInvoiceFeeProbeInput!) {
    +  lnInvoiceFeeProbe(input: $input) {
         amount
         errors {
           code
    @@ -4035,15 +4674,15 @@ 
    Query
    Variables
    -
    {"input": LnUsdInvoiceFeeProbeInput}
    +                  
    {"input": LnInvoiceFeeProbeInput}
     
    Response
    {
       "data": {
    -    "lnUsdInvoiceFeeProbe": {
    -      "amount": CentAmount,
    +    "lnInvoiceFeeProbe": {
    +      "amount": SatAmount,
           "errors": [Error]
         }
       }
    @@ -4053,18 +4692,26 @@ 
    Response
    -
    +

    - merchantMapSuggest + lnInvoicePaymentSend

    +
    +
    +
    +
    Description
    +

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

    +
    +
    +
    Response
    -

    Returns a MerchantPayload! +

    Returns a PaymentSendPayload!

    @@ -4079,7 +4726,7 @@
    Arguments
    - input - MerchantMapSuggestInput! + input - LnInvoicePaymentInput! @@ -4092,39 +4739,30 @@
    Arguments

    Example

    Query
    -
    mutation MerchantMapSuggest($input: MerchantMapSuggestInput!) {
    -  merchantMapSuggest(input: $input) {
    +                  
    mutation LnInvoicePaymentSend($input: LnInvoicePaymentInput!) {
    +  lnInvoicePaymentSend(input: $input) {
         errors {
           code
           message
           path
         }
    -    merchant {
    -      coordinates {
    -        ...CoordinatesFragment
    -      }
    -      createdAt
    -      id
    -      title
    -      username
    -      validated
    -    }
    +    status
       }
     }
     
    Variables
    -
    {"input": MerchantMapSuggestInput}
    +                  
    {"input": LnInvoicePaymentInput}
     
    Response
    {
       "data": {
    -    "merchantMapSuggest": {
    +    "lnInvoicePaymentSend": {
           "errors": [Error],
    -      "merchant": Merchant
    +      "status": "ALREADY_PAID"
         }
       }
     }
    @@ -4133,18 +4771,26 @@ 
    Response
    -
    +

    - onChainAddressCreate + lnNoAmountInvoiceCreate

    +
    +
    +
    +
    Description
    +

    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.

    +
    +
    +
    Response
    -

    Returns an OnChainAddressPayload! +

    Returns a LnNoAmountInvoicePayload!

    @@ -4159,7 +4805,7 @@
    Arguments
    - input - OnChainAddressCreateInput! + input - LnNoAmountInvoiceCreateInput! @@ -4172,30 +4818,34 @@
    Arguments

    Example

    Query
    -
    mutation OnChainAddressCreate($input: OnChainAddressCreateInput!) {
    -  onChainAddressCreate(input: $input) {
    -    address
    +                  
    mutation LnNoAmountInvoiceCreate($input: LnNoAmountInvoiceCreateInput!) {
    +  lnNoAmountInvoiceCreate(input: $input) {
         errors {
           code
           message
           path
         }
    +    invoice {
    +      paymentHash
    +      paymentRequest
    +      paymentSecret
    +    }
       }
     }
     
    Variables
    -
    {"input": OnChainAddressCreateInput}
    +                  
    {"input": LnNoAmountInvoiceCreateInput}
     
    Response
    {
       "data": {
    -    "onChainAddressCreate": {
    -      "address": OnChainAddress,
    -      "errors": [Error]
    +    "lnNoAmountInvoiceCreate": {
    +      "errors": [Error],
    +      "invoice": LnNoAmountInvoice
         }
       }
     }
    @@ -4204,18 +4854,26 @@ 
    Response
    -
    +

    - onChainAddressCurrent + lnNoAmountInvoiceCreateOnBehalfOfRecipient

    +
    +
    +
    +
    Description
    +

    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.

    +
    +
    +
    Response
    -

    Returns an OnChainAddressPayload! +

    Returns a LnNoAmountInvoicePayload!

    @@ -4230,7 +4888,7 @@
    Arguments
    - input - OnChainAddressCurrentInput! + input - LnNoAmountInvoiceCreateOnBehalfOfRecipientInput! @@ -4243,30 +4901,34 @@
    Arguments

    Example

    Query
    -
    mutation OnChainAddressCurrent($input: OnChainAddressCurrentInput!) {
    -  onChainAddressCurrent(input: $input) {
    -    address
    +                  
    mutation LnNoAmountInvoiceCreateOnBehalfOfRecipient($input: LnNoAmountInvoiceCreateOnBehalfOfRecipientInput!) {
    +  lnNoAmountInvoiceCreateOnBehalfOfRecipient(input: $input) {
         errors {
           code
           message
           path
         }
    +    invoice {
    +      paymentHash
    +      paymentRequest
    +      paymentSecret
    +    }
       }
     }
     
    Variables
    -
    {"input": OnChainAddressCurrentInput}
    +                  
    {"input": LnNoAmountInvoiceCreateOnBehalfOfRecipientInput}
     
    Response
    {
       "data": {
    -    "onChainAddressCurrent": {
    -      "address": OnChainAddress,
    -      "errors": [Error]
    +    "lnNoAmountInvoiceCreateOnBehalfOfRecipient": {
    +      "errors": [Error],
    +      "invoice": LnNoAmountInvoice
         }
       }
     }
    @@ -4275,18 +4937,18 @@ 
    Response
    -
    +

    - onChainPaymentSend + lnNoAmountInvoiceFeeProbe

    Response
    -

    Returns a PaymentSendPayload! +

    Returns a SatAmountPayload!

    @@ -4301,7 +4963,7 @@
    Arguments
    - input - OnChainPaymentSendInput! + input - LnNoAmountInvoiceFeeProbeInput! @@ -4314,30 +4976,30 @@
    Arguments

    Example

    Query
    -
    mutation OnChainPaymentSend($input: OnChainPaymentSendInput!) {
    -  onChainPaymentSend(input: $input) {
    +                  
    mutation LnNoAmountInvoiceFeeProbe($input: LnNoAmountInvoiceFeeProbeInput!) {
    +  lnNoAmountInvoiceFeeProbe(input: $input) {
    +    amount
         errors {
           code
           message
           path
         }
    -    status
       }
     }
     
    Variables
    -
    {"input": OnChainPaymentSendInput}
    +                  
    {"input": LnNoAmountInvoiceFeeProbeInput}
     
    Response
    {
       "data": {
    -    "onChainPaymentSend": {
    -      "errors": [Error],
    -      "status": "ALREADY_PAID"
    +    "lnNoAmountInvoiceFeeProbe": {
    +      "amount": SatAmount,
    +      "errors": [Error]
         }
       }
     }
    @@ -4346,13 +5008,21 @@ 
    Response
    -
    +

    - onChainPaymentSendAll + lnNoAmountInvoicePaymentSend

    +
    +
    +
    +
    Description
    +

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

    +
    +
    +
    @@ -4372,7 +5042,7 @@
    Arguments
    - input - OnChainPaymentSendAllInput! + input - LnNoAmountInvoicePaymentInput! @@ -4385,8 +5055,8 @@
    Arguments

    Example

    Query
    -
    mutation OnChainPaymentSendAll($input: OnChainPaymentSendAllInput!) {
    -  onChainPaymentSendAll(input: $input) {
    +                  
    mutation LnNoAmountInvoicePaymentSend($input: LnNoAmountInvoicePaymentInput!) {
    +  lnNoAmountInvoicePaymentSend(input: $input) {
         errors {
           code
           message
    @@ -4399,14 +5069,14 @@ 
    Query
    Variables
    -
    {"input": OnChainPaymentSendAllInput}
    +                  
    {"input": LnNoAmountInvoicePaymentInput}
     
    Response
    {
       "data": {
    -    "onChainPaymentSendAll": {
    +    "lnNoAmountInvoicePaymentSend": {
           "errors": [Error],
           "status": "ALREADY_PAID"
         }
    @@ -4417,18 +5087,18 @@ 
    Response
    -
    +

    - onChainUsdPaymentSend + lnNoAmountUsdInvoiceFeeProbe

    Response
    -

    Returns a PaymentSendPayload! +

    Returns a CentAmountPayload!

    @@ -4443,7 +5113,7 @@
    Arguments
    - input - OnChainUsdPaymentSendInput! + input - LnNoAmountUsdInvoiceFeeProbeInput! @@ -4456,30 +5126,32 @@
    Arguments

    Example

    Query
    -
    mutation OnChainUsdPaymentSend($input: OnChainUsdPaymentSendInput!) {
    -  onChainUsdPaymentSend(input: $input) {
    +                  
    mutation LnNoAmountUsdInvoiceFeeProbe($input: LnNoAmountUsdInvoiceFeeProbeInput!) {
    +  lnNoAmountUsdInvoiceFeeProbe(input: $input) {
    +    amount
         errors {
           code
           message
           path
         }
    -    status
    +    invoiceAmount
       }
     }
     
    Variables
    -
    {"input": OnChainUsdPaymentSendInput}
    +                  
    {"input": LnNoAmountUsdInvoiceFeeProbeInput}
     
    Response
    {
       "data": {
    -    "onChainUsdPaymentSend": {
    +    "lnNoAmountUsdInvoiceFeeProbe": {
    +      "amount": USDCents,
           "errors": [Error],
    -      "status": "ALREADY_PAID"
    +      "invoiceAmount": USDCents
         }
       }
     }
    @@ -4488,13 +5160,21 @@ 
    Response
    -
    +

    - onChainUsdPaymentSendAsBtcDenominated + lnNoAmountUsdInvoicePaymentSend

    +
    +
    +
    +
    Description
    +

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

    +
    +
    +
    @@ -4514,7 +5194,7 @@
    Arguments
    - input - OnChainUsdPaymentSendAsBtcDenominatedInput! + input - LnNoAmountUsdInvoicePaymentInput! @@ -4527,8 +5207,8 @@
    Arguments

    Example

    Query
    -
    mutation OnChainUsdPaymentSendAsBtcDenominated($input: OnChainUsdPaymentSendAsBtcDenominatedInput!) {
    -  onChainUsdPaymentSendAsBtcDenominated(input: $input) {
    +                  
    mutation LnNoAmountUsdInvoicePaymentSend($input: LnNoAmountUsdInvoicePaymentInput!) {
    +  lnNoAmountUsdInvoicePaymentSend(input: $input) {
         errors {
           code
           message
    @@ -4541,14 +5221,14 @@ 
    Query
    Variables
    -
    {"input": OnChainUsdPaymentSendAsBtcDenominatedInput}
    +                  
    {"input": LnNoAmountUsdInvoicePaymentInput}
     
    Response
    {
       "data": {
    -    "onChainUsdPaymentSendAsBtcDenominated": {
    +    "lnNoAmountUsdInvoicePaymentSend": {
           "errors": [Error],
           "status": "ALREADY_PAID"
         }
    @@ -4559,18 +5239,26 @@ 
    Response
    -
    +

    - quizCompleted + lnUsdInvoiceCreate

    +
    +
    +
    +
    Description
    +

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

    +
    +
    +
    Response
    -

    Returns a QuizCompletedPayload! +

    Returns a LnInvoicePayload!

    @@ -4585,7 +5273,7 @@
    Arguments
    - input - QuizCompletedInput! + input - LnUsdInvoiceCreateInput! @@ -4598,17 +5286,18 @@
    Arguments

    Example

    Query
    -
    mutation QuizCompleted($input: QuizCompletedInput!) {
    -  quizCompleted(input: $input) {
    +                  
    mutation LnUsdInvoiceCreate($input: LnUsdInvoiceCreateInput!) {
    +  lnUsdInvoiceCreate(input: $input) {
         errors {
           code
           message
           path
         }
    -    quiz {
    -      amount
    -      completed
    -      id
    +    invoice {
    +      paymentHash
    +      paymentRequest
    +      paymentSecret
    +      satoshis
         }
       }
     }
    @@ -4616,16 +5305,16 @@ 
    Query
    Variables
    -
    {"input": QuizCompletedInput}
    +                  
    {"input": LnUsdInvoiceCreateInput}
     
    Response
    {
       "data": {
    -    "quizCompleted": {
    +    "lnUsdInvoiceCreate": {
           "errors": [Error],
    -      "quiz": Quiz
    +      "invoice": LnInvoice
         }
       }
     }
    @@ -4634,17 +5323,18 @@ 
    Response
    -
    +
    -

    - userContactUpdateAlias +

    + lnUsdInvoiceCreateOnBehalfOfRecipient

    -
    -
    will be moved to AccountContact
    +
    +
    Description
    +

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

    @@ -4652,7 +5342,7 @@

    Response
    -

    Returns a UserContactUpdateAliasPayload! +

    Returns a LnInvoicePayload!

    @@ -4667,7 +5357,7 @@
    Arguments
    - input - UserContactUpdateAliasInput! + input - LnUsdInvoiceCreateOnBehalfOfRecipientInput! @@ -4680,38 +5370,35 @@
    Arguments

    Example

    Query
    -
    mutation UserContactUpdateAlias($input: UserContactUpdateAliasInput!) {
    -  userContactUpdateAlias(input: $input) {
    -    contact {
    -      alias
    -      id
    -      transactions {
    -        ...TransactionConnectionFragment
    -      }
    -      transactionsCount
    -      username
    -    }
    +                  
    mutation LnUsdInvoiceCreateOnBehalfOfRecipient($input: LnUsdInvoiceCreateOnBehalfOfRecipientInput!) {
    +  lnUsdInvoiceCreateOnBehalfOfRecipient(input: $input) {
         errors {
           code
           message
           path
         }
    +    invoice {
    +      paymentHash
    +      paymentRequest
    +      paymentSecret
    +      satoshis
    +    }
       }
     }
     
    Variables
    -
    {"input": UserContactUpdateAliasInput}
    +                  
    {"input": LnUsdInvoiceCreateOnBehalfOfRecipientInput}
     
    Response
    {
       "data": {
    -    "userContactUpdateAlias": {
    -      "contact": UserContact,
    -      "errors": [Error]
    +    "lnUsdInvoiceCreateOnBehalfOfRecipient": {
    +      "errors": [Error],
    +      "invoice": LnInvoice
         }
       }
     }
    @@ -4720,67 +5407,71 @@ 
    Response

    -
    +

    - userEmailDelete + lnUsdInvoiceFeeProbe

    Response
    -

    Returns a UserEmailDeletePayload! +

    Returns a CentAmountPayload!

    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - LnUsdInvoiceFeeProbeInput! + +
    +

    Example

    Query
    -
    mutation UserEmailDelete {
    -  userEmailDelete {
    +                  
    mutation LnUsdInvoiceFeeProbe($input: LnUsdInvoiceFeeProbeInput!) {
    +  lnUsdInvoiceFeeProbe(input: $input) {
    +    amount
         errors {
           code
           message
           path
         }
    -    me {
    -      contactByUsername {
    -        ...UserContactFragment
    -      }
    -      contacts {
    -        ...UserContactFragment
    -      }
    -      createdAt
    -      defaultAccount {
    -        ...AccountFragment
    -      }
    -      email {
    -        ...EmailFragment
    -      }
    -      id
    -      language
    -      npub
    -      phone
    -      quizQuestions {
    -        ...UserQuizQuestionFragment
    -      }
    -      totpEnabled
    -      username
    -    }
    +    invoiceAmount
       }
     }
    +
    +
    +
    +
    Variables
    +
    {"input": LnUsdInvoiceFeeProbeInput}
     
    Response
    {
       "data": {
    -    "userEmailDelete": {
    +    "lnUsdInvoiceFeeProbe": {
    +      "amount": USDCents,
           "errors": [Error],
    -      "me": User
    +      "invoiceAmount": USDCents
         }
       }
     }
    @@ -4789,18 +5480,26 @@ 
    Response
    -
    +

    - userEmailRegistrationInitiate + lnurlPaymentSend

    +
    +
    +
    +
    Description
    +

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

    +
    +
    +
    @@ -4815,7 +5514,7 @@
    Arguments
    - input - UserEmailRegistrationInitiateInput! + input - LnurlPaymentSendInput! @@ -4828,55 +5527,30 @@
    Arguments

    Example

    Query
    -
    mutation UserEmailRegistrationInitiate($input: UserEmailRegistrationInitiateInput!) {
    -  userEmailRegistrationInitiate(input: $input) {
    -    emailRegistrationId
    +                  
    mutation LnurlPaymentSend($input: LnurlPaymentSendInput!) {
    +  lnurlPaymentSend(input: $input) {
         errors {
           code
           message
           path
         }
    -    me {
    -      contactByUsername {
    -        ...UserContactFragment
    -      }
    -      contacts {
    -        ...UserContactFragment
    -      }
    -      createdAt
    -      defaultAccount {
    -        ...AccountFragment
    -      }
    -      email {
    -        ...EmailFragment
    -      }
    -      id
    -      language
    -      npub
    -      phone
    -      quizQuestions {
    -        ...UserQuizQuestionFragment
    -      }
    -      totpEnabled
    -      username
    -    }
    +    status
       }
     }
     
    Variables
    -
    {"input": UserEmailRegistrationInitiateInput}
    +                  
    {"input": LnurlPaymentSendInput}
     
    Response
    {
       "data": {
    -    "userEmailRegistrationInitiate": {
    -      "emailRegistrationId": EmailRegistrationId,
    +    "lnurlPaymentSend": {
           "errors": [Error],
    -      "me": User
    +      "status": "ALREADY_PAID"
         }
       }
     }
    @@ -4885,18 +5559,18 @@ 
    Response
    -
    +

    - userEmailRegistrationValidate + merchantMapSuggest

    Response
    -

    Returns a UserEmailRegistrationValidatePayload! +

    Returns a MerchantPayload!

    @@ -4911,7 +5585,7 @@
    Arguments
    - input - UserEmailRegistrationValidateInput! + input - MerchantMapSuggestInput! @@ -4924,36 +5598,22 @@
    Arguments

    Example

    Query
    -
    mutation UserEmailRegistrationValidate($input: UserEmailRegistrationValidateInput!) {
    -  userEmailRegistrationValidate(input: $input) {
    +                  
    mutation MerchantMapSuggest($input: MerchantMapSuggestInput!) {
    +  merchantMapSuggest(input: $input) {
         errors {
           code
           message
           path
         }
    -    me {
    -      contactByUsername {
    -        ...UserContactFragment
    -      }
    -      contacts {
    -        ...UserContactFragment
    +    merchant {
    +      coordinates {
    +        ...CoordinatesFragment
           }
           createdAt
    -      defaultAccount {
    -        ...AccountFragment
    -      }
    -      email {
    -        ...EmailFragment
    -      }
           id
    -      language
    -      npub
    -      phone
    -      quizQuestions {
    -        ...UserQuizQuestionFragment
    -      }
    -      totpEnabled
    +      title
           username
    +      validated
         }
       }
     }
    @@ -4961,16 +5621,16 @@ 
    Query
    Variables
    -
    {"input": UserEmailRegistrationValidateInput}
    +                  
    {"input": MerchantMapSuggestInput}
     
    Response
    {
       "data": {
    -    "userEmailRegistrationValidate": {
    +    "merchantMapSuggest": {
           "errors": [Error],
    -      "me": User
    +      "merchant": Merchant
         }
       }
     }
    @@ -4979,18 +5639,18 @@ 
    Response
    -
    +

    - userLogin + onChainAddressCreate

    Response
    -

    Returns an AuthTokenPayload! +

    Returns an OnChainAddressPayload!

    @@ -5005,7 +5665,7 @@
    Arguments
    - input - UserLoginInput! + input - OnChainAddressCreateInput! @@ -5018,32 +5678,30 @@
    Arguments

    Example

    Query
    -
    mutation UserLogin($input: UserLoginInput!) {
    -  userLogin(input: $input) {
    -    authToken
    +                  
    mutation OnChainAddressCreate($input: OnChainAddressCreateInput!) {
    +  onChainAddressCreate(input: $input) {
    +    address
         errors {
           code
           message
           path
         }
    -    totpRequired
       }
     }
     
    Variables
    -
    {"input": UserLoginInput}
    +                  
    {"input": OnChainAddressCreateInput}
     
    Response
    {
       "data": {
    -    "userLogin": {
    -      "authToken": AuthToken,
    -      "errors": [Error],
    -      "totpRequired": false
    +    "onChainAddressCreate": {
    +      "address": OnChainAddress,
    +      "errors": [Error]
         }
       }
     }
    @@ -5052,18 +5710,18 @@ 
    Response
    -
    +

    - userLoginUpgrade + onChainAddressCurrent

    Response
    -

    Returns an UpgradePayload! +

    Returns an OnChainAddressPayload!

    @@ -5078,7 +5736,7 @@
    Arguments
    - input - UserLoginUpgradeInput! + input - OnChainAddressCurrentInput! @@ -5091,32 +5749,30 @@
    Arguments

    Example

    Query
    -
    mutation UserLoginUpgrade($input: UserLoginUpgradeInput!) {
    -  userLoginUpgrade(input: $input) {
    -    authToken
    +                  
    mutation OnChainAddressCurrent($input: OnChainAddressCurrentInput!) {
    +  onChainAddressCurrent(input: $input) {
    +    address
         errors {
           code
           message
           path
         }
    -    success
       }
     }
     
    Variables
    -
    {"input": UserLoginUpgradeInput}
    +                  
    {"input": OnChainAddressCurrentInput}
     
    Response
    {
       "data": {
    -    "userLoginUpgrade": {
    -      "authToken": AuthToken,
    -      "errors": [Error],
    -      "success": false
    +    "onChainAddressCurrent": {
    +      "address": OnChainAddress,
    +      "errors": [Error]
         }
       }
     }
    @@ -5125,18 +5781,18 @@ 
    Response
    -
    +

    - userLogout + onChainPaymentSend

    Response
    -

    Returns a SuccessPayload! +

    Returns a PaymentSendPayload!

    @@ -5151,7 +5807,7 @@
    Arguments
    - input - UserLogoutInput + input - OnChainPaymentSendInput! @@ -5164,28 +5820,31 @@
    Arguments

    Example

    Query
    -
    mutation UserLogout($input: UserLogoutInput) {
    -  userLogout(input: $input) {
    +                  
    mutation OnChainPaymentSend($input: OnChainPaymentSendInput!) {
    +  onChainPaymentSend(input: $input) {
         errors {
           code
           message
           path
         }
    -    success
    +    status
       }
    -}
    +}
     
    Variables
    -
    {"input": UserLogoutInput}
    +                  
    {"input": OnChainPaymentSendInput}
     
    Response
    {
       "data": {
    -    "userLogout": {"errors": [Error], "success": false}
    +    "onChainPaymentSend": {
    +      "errors": [Error],
    +      "status": "ALREADY_PAID"
    +    }
       }
     }
     
    @@ -5193,67 +5852,69 @@
    Response
    -
    +

    - userPhoneDelete + onChainPaymentSendAll

    Response
    -

    Returns a UserPhoneDeletePayload! +

    Returns a PaymentSendPayload!

    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - OnChainPaymentSendAllInput! + +
    +

    Example

    Query
    -
    mutation UserPhoneDelete {
    -  userPhoneDelete {
    +                  
    mutation OnChainPaymentSendAll($input: OnChainPaymentSendAllInput!) {
    +  onChainPaymentSendAll(input: $input) {
         errors {
           code
           message
           path
         }
    -    me {
    -      contactByUsername {
    -        ...UserContactFragment
    -      }
    -      contacts {
    -        ...UserContactFragment
    -      }
    -      createdAt
    -      defaultAccount {
    -        ...AccountFragment
    -      }
    -      email {
    -        ...EmailFragment
    -      }
    -      id
    -      language
    -      npub
    -      phone
    -      quizQuestions {
    -        ...UserQuizQuestionFragment
    -      }
    -      totpEnabled
    -      username
    -    }
    +    status
       }
     }
    +
    +
    +
    +
    Variables
    +
    {"input": OnChainPaymentSendAllInput}
     
    Response
    {
       "data": {
    -    "userPhoneDelete": {
    +    "onChainPaymentSendAll": {
           "errors": [Error],
    -      "me": User
    +      "status": "ALREADY_PAID"
         }
       }
     }
    @@ -5262,18 +5923,18 @@ 
    Response
    -
    +

    - userPhoneRegistrationInitiate + onChainUsdPaymentSend

    Response
    -

    Returns a SuccessPayload! +

    Returns a PaymentSendPayload!

    @@ -5288,7 +5949,7 @@
    Arguments
    - input - UserPhoneRegistrationInitiateInput! + input - OnChainUsdPaymentSendInput! @@ -5301,30 +5962,30 @@
    Arguments

    Example

    Query
    -
    mutation UserPhoneRegistrationInitiate($input: UserPhoneRegistrationInitiateInput!) {
    -  userPhoneRegistrationInitiate(input: $input) {
    +                  
    mutation OnChainUsdPaymentSend($input: OnChainUsdPaymentSendInput!) {
    +  onChainUsdPaymentSend(input: $input) {
         errors {
           code
           message
           path
         }
    -    success
    +    status
       }
     }
     
    Variables
    -
    {"input": UserPhoneRegistrationInitiateInput}
    +                  
    {"input": OnChainUsdPaymentSendInput}
     
    Response
    {
       "data": {
    -    "userPhoneRegistrationInitiate": {
    +    "onChainUsdPaymentSend": {
           "errors": [Error],
    -      "success": true
    +      "status": "ALREADY_PAID"
         }
       }
     }
    @@ -5333,18 +5994,18 @@ 
    Response
    -
    +

    - userPhoneRegistrationValidate + onChainUsdPaymentSendAsBtcDenominated

    @@ -5359,7 +6020,7 @@
    Arguments
    - input - UserPhoneRegistrationValidateInput! + input - OnChainUsdPaymentSendAsBtcDenominatedInput! @@ -5372,53 +6033,30 @@
    Arguments

    Example

    Query
    -
    mutation UserPhoneRegistrationValidate($input: UserPhoneRegistrationValidateInput!) {
    -  userPhoneRegistrationValidate(input: $input) {
    +                  
    mutation OnChainUsdPaymentSendAsBtcDenominated($input: OnChainUsdPaymentSendAsBtcDenominatedInput!) {
    +  onChainUsdPaymentSendAsBtcDenominated(input: $input) {
         errors {
           code
           message
           path
         }
    -    me {
    -      contactByUsername {
    -        ...UserContactFragment
    -      }
    -      contacts {
    -        ...UserContactFragment
    -      }
    -      createdAt
    -      defaultAccount {
    -        ...AccountFragment
    -      }
    -      email {
    -        ...EmailFragment
    -      }
    -      id
    -      language
    -      npub
    -      phone
    -      quizQuestions {
    -        ...UserQuizQuestionFragment
    -      }
    -      totpEnabled
    -      username
    -    }
    +    status
       }
     }
     
    Variables
    -
    {"input": UserPhoneRegistrationValidateInput}
    +                  
    {"input": OnChainUsdPaymentSendAsBtcDenominatedInput}
     
    Response
    {
       "data": {
    -    "userPhoneRegistrationValidate": {
    +    "onChainUsdPaymentSendAsBtcDenominated": {
           "errors": [Error],
    -      "me": User
    +      "status": "ALREADY_PAID"
         }
       }
     }
    @@ -5427,25 +6065,18 @@ 
    Response
    -
    +
    -

    - userQuizQuestionUpdateCompleted +

    + quizCompleted

    -
    -
    -
    -
    Use QuizCompletedMutation instead
    -
    -
    -
    @@ -5460,7 +6091,7 @@
    Arguments
    - input - UserQuizQuestionUpdateCompletedInput! + input - QuizCompletedInput! @@ -5473,18 +6104,17 @@
    Arguments

    Example

    Query
    -
    mutation UserQuizQuestionUpdateCompleted($input: UserQuizQuestionUpdateCompletedInput!) {
    -  userQuizQuestionUpdateCompleted(input: $input) {
    +                  
    mutation QuizCompleted($input: QuizCompletedInput!) {
    +  quizCompleted(input: $input) {
         errors {
           code
           message
           path
         }
    -    userQuizQuestion {
    +    quiz {
    +      amount
           completed
    -      question {
    -        ...QuizQuestionFragment
    -      }
    +      id
         }
       }
     }
    @@ -5492,16 +6122,16 @@ 
    Query
    Variables
    -
    {"input": UserQuizQuestionUpdateCompletedInput}
    +                  
    {"input": QuizCompletedInput}
     
    Response
    {
       "data": {
    -    "userQuizQuestionUpdateCompleted": {
    +    "quizCompleted": {
           "errors": [Error],
    -      "userQuizQuestion": UserQuizQuestion
    +      "quiz": Quiz
         }
       }
     }
    @@ -5510,18 +6140,26 @@ 
    Response
    -
    +

    - userTotpDelete + requestCashout

    +
    +
    +
    +
    Description
    +

    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.

    +
    +
    +
    Response
    -

    Returns a UserTotpDeletePayload! +

    Returns a RequestCashoutResponse!

    @@ -5536,7 +6174,7 @@
    Arguments
    - input - UserTotpDeleteInput! + input - RequestCashoutInput! @@ -5549,36 +6187,22 @@
    Arguments

    Example

    Query
    -
    mutation UserTotpDelete($input: UserTotpDeleteInput!) {
    -  userTotpDelete(input: $input) {
    +                  
    mutation RequestCashout($input: RequestCashoutInput!) {
    +  requestCashout(input: $input) {
         errors {
           code
           message
           path
         }
    -    me {
    -      contactByUsername {
    -        ...UserContactFragment
    -      }
    -      contacts {
    -        ...UserContactFragment
    -      }
    -      createdAt
    -      defaultAccount {
    -        ...AccountFragment
    -      }
    -      email {
    -        ...EmailFragment
    -      }
    -      id
    -      language
    -      npub
    -      phone
    -      quizQuestions {
    -        ...UserQuizQuestionFragment
    -      }
    -      totpEnabled
    -      username
    +    offer {
    +      exchangeRate
    +      expiresAt
    +      flashFee
    +      offerId
    +      receiveJmd
    +      receiveUsd
    +      send
    +      walletId
         }
       }
     }
    @@ -5586,16 +6210,16 @@ 
    Query
    Variables
    -
    {"input": UserTotpDeleteInput}
    +                  
    {"input": RequestCashoutInput}
     
    Response
    {
       "data": {
    -    "userTotpDelete": {
    +    "requestCashout": {
           "errors": [Error],
    -      "me": User
    +      "offer": CashoutOffer
         }
       }
     }
    @@ -5604,18 +6228,18 @@ 
    Response
    -
    +

    - userTotpRegistrationInitiate + updateExternalWallet

    @@ -5630,7 +6254,7 @@
    Arguments
    - input - UserTotpRegistrationInitiateInput! + input - UpdateExternalWalletInput! @@ -5643,32 +6267,30 @@
    Arguments

    Example

    Query
    -
    mutation UserTotpRegistrationInitiate($input: UserTotpRegistrationInitiateInput!) {
    -  userTotpRegistrationInitiate(input: $input) {
    +                  
    mutation UpdateExternalWallet($input: UpdateExternalWalletInput!) {
    +  updateExternalWallet(input: $input) {
         errors {
           code
           message
           path
         }
    -    totpRegistrationId
    -    totpSecret
    +    walletId
       }
     }
     
    Variables
    -
    {"input": UserTotpRegistrationInitiateInput}
    +                  
    {"input": UpdateExternalWalletInput}
     
    Response
    {
       "data": {
    -    "userTotpRegistrationInitiate": {
    +    "updateExternalWallet": {
           "errors": [Error],
    -      "totpRegistrationId": TotpRegistrationId,
    -      "totpSecret": TotpSecret
    +      "walletId": WalletId
         }
       }
     }
    @@ -5677,18 +6299,25 @@ 
    Response
    -
    +
    -

    - userTotpRegistrationValidate +

    + userContactUpdateAlias

    +
    +
    +
    +
    will be moved to AccountContact
    +
    +
    +
    @@ -5703,7 +6332,7 @@
    Arguments
    - input - UserTotpRegistrationValidateInput! + input - UserContactUpdateAliasInput! @@ -5716,53 +6345,38 @@
    Arguments

    Example

    Query
    -
    mutation UserTotpRegistrationValidate($input: UserTotpRegistrationValidateInput!) {
    -  userTotpRegistrationValidate(input: $input) {
    +                  
    mutation UserContactUpdateAlias($input: UserContactUpdateAliasInput!) {
    +  userContactUpdateAlias(input: $input) {
    +    contact {
    +      alias
    +      id
    +      transactions {
    +        ...TransactionConnectionFragment
    +      }
    +      transactionsCount
    +      username
    +    }
         errors {
           code
           message
           path
         }
    -    me {
    -      contactByUsername {
    -        ...UserContactFragment
    -      }
    -      contacts {
    -        ...UserContactFragment
    -      }
    -      createdAt
    -      defaultAccount {
    -        ...AccountFragment
    -      }
    -      email {
    -        ...EmailFragment
    -      }
    -      id
    -      language
    -      npub
    -      phone
    -      quizQuestions {
    -        ...UserQuizQuestionFragment
    -      }
    -      totpEnabled
    -      username
    -    }
       }
     }
     
    Variables
    -
    {"input": UserTotpRegistrationValidateInput}
    +                  
    {"input": UserContactUpdateAliasInput}
     
    Response
    {
       "data": {
    -    "userTotpRegistrationValidate": {
    -      "errors": [Error],
    -      "me": User
    +    "userContactUpdateAlias": {
    +      "contact": UserContact,
    +      "errors": [Error]
         }
       }
     }
    @@ -5771,53 +6385,36 @@ 
    Response
    -
    +

    - userUpdateLanguage + userEmailDelete

    Response
    -

    Returns a UserUpdateLanguagePayload! +

    Returns a UserEmailDeletePayload!

    -
    -
    Arguments
    - - - - - - - - - - - - - -
    NameDescription
    - input - UserUpdateLanguageInput! - -
    -

    Example

    Query
    -
    mutation UserUpdateLanguage($input: UserUpdateLanguageInput!) {
    -  userUpdateLanguage(input: $input) {
    +                  
    mutation UserEmailDelete {
    +  userEmailDelete {
         errors {
           code
           message
           path
         }
    -    user {
    +    me {
    +      bankAccounts {
    +        ...BankAccountFragment
    +      }
           contactByUsername {
             ...UserContactFragment
           }
    @@ -5843,20 +6440,15 @@ 
    Query
    }
    }
    }
    -
    -
    -
    -
    Variables
    -
    {"input": UserUpdateLanguageInput}
     
    Response
    {
       "data": {
    -    "userUpdateLanguage": {
    +    "userEmailDelete": {
           "errors": [Error],
    -      "user": User
    +      "me": User
         }
       }
     }
    @@ -5865,18 +6457,18 @@ 
    Response
    -
    +

    - userUpdateNpub + userEmailRegistrationInitiate

    @@ -5891,7 +6483,7 @@
    Arguments
    - input - UserUpdateNpubInput! + input - UserEmailRegistrationInitiateInput! @@ -5904,14 +6496,18 @@
    Arguments

    Example

    Query
    -
    mutation UserUpdateNpub($input: UserUpdateNpubInput!) {
    -  userUpdateNpub(input: $input) {
    +                  
    mutation UserEmailRegistrationInitiate($input: UserEmailRegistrationInitiateInput!) {
    +  userEmailRegistrationInitiate(input: $input) {
    +    emailRegistrationId
         errors {
           code
           message
           path
         }
    -    user {
    +    me {
    +      bankAccounts {
    +        ...BankAccountFragment
    +      }
           contactByUsername {
             ...UserContactFragment
           }
    @@ -5941,16 +6537,17 @@ 
    Query
    Variables
    -
    {"input": UserUpdateNpubInput}
    +                  
    {"input": UserEmailRegistrationInitiateInput}
     
    Response
    {
       "data": {
    -    "userUpdateNpub": {
    +    "userEmailRegistrationInitiate": {
    +      "emailRegistrationId": EmailRegistrationId,
           "errors": [Error],
    -      "user": User
    +      "me": User
         }
       }
     }
    @@ -5959,25 +6556,18 @@ 
    Response
    -
    +
    -

    - userUpdateUsername +

    + userEmailRegistrationValidate

    -
    -
    -
    -
    Username will be moved to @Handle in Accounts. Also SetUsername naming should be used instead of UpdateUsername to reflect the idempotency of Handles
    -
    -
    -
    @@ -5992,7 +6582,7 @@
    Arguments
    - input - UserUpdateUsernameInput! + input - UserEmailRegistrationValidateInput! @@ -6005,14 +6595,17 @@
    Arguments

    Example

    Query
    -
    mutation UserUpdateUsername($input: UserUpdateUsernameInput!) {
    -  userUpdateUsername(input: $input) {
    +                  
    mutation UserEmailRegistrationValidate($input: UserEmailRegistrationValidateInput!) {
    +  userEmailRegistrationValidate(input: $input) {
         errors {
           code
           message
           path
         }
    -    user {
    +    me {
    +      bankAccounts {
    +        ...BankAccountFragment
    +      }
           contactByUsername {
             ...UserContactFragment
           }
    @@ -6042,16 +6635,16 @@ 
    Query
    Variables
    -
    {"input": UserUpdateUsernameInput}
    +                  
    {"input": UserEmailRegistrationValidateInput}
     
    Response
    {
       "data": {
    -    "userUpdateUsername": {
    +    "userEmailRegistrationValidate": {
           "errors": [Error],
    -      "user": User
    +      "me": User
         }
       }
     }
    @@ -6060,16 +6653,18 @@ 
    Response
    -

    Subscriptions

    -
    +
    +
    + Mutations +

    - lnInvoicePaymentStatus + userLogin

    Response
    -

    Returns a LnInvoicePaymentStatusPayload! +

    Returns an AuthTokenPayload!

    @@ -6084,7 +6679,7 @@
    Arguments
    - input - LnInvoicePaymentStatusInput! + input - UserLoginInput! @@ -6097,30 +6692,32 @@
    Arguments

    Example

    Query
    -
    subscription LnInvoicePaymentStatus($input: LnInvoicePaymentStatusInput!) {
    -  lnInvoicePaymentStatus(input: $input) {
    +                  
    mutation UserLogin($input: UserLoginInput!) {
    +  userLogin(input: $input) {
    +    authToken
         errors {
           code
           message
           path
         }
    -    status
    +    totpRequired
       }
     }
     
    Variables
    -
    {"input": LnInvoicePaymentStatusInput}
    +                  
    {"input": UserLoginInput}
     
    Response
    {
       "data": {
    -    "lnInvoicePaymentStatus": {
    +    "userLogin": {
    +      "authToken": AuthToken,
           "errors": [Error],
    -      "status": "EXPIRED"
    +      "totpRequired": false
         }
       }
     }
    @@ -6129,85 +6726,71 @@ 
    Response
    -
    +

    - myUpdates + userLoginUpgrade

    Response
    -

    Returns a MyUpdatesPayload! +

    Returns an UpgradePayload!

    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - UserLoginUpgradeInput! + +
    +

    Example

    Query
    -
    subscription MyUpdates {
    -  myUpdates {
    +                  
    mutation UserLoginUpgrade($input: UserLoginUpgradeInput!) {
    +  userLoginUpgrade(input: $input) {
    +    authToken
         errors {
           code
           message
           path
         }
    -    me {
    -      contactByUsername {
    -        ...UserContactFragment
    -      }
    -      contacts {
    -        ...UserContactFragment
    -      }
    -      createdAt
    -      defaultAccount {
    -        ...AccountFragment
    -      }
    -      email {
    -        ...EmailFragment
    -      }
    -      id
    -      language
    -      npub
    -      phone
    -      quizQuestions {
    -        ...UserQuizQuestionFragment
    -      }
    -      totpEnabled
    -      username
    -    }
    -    update {
    -      ... on IntraLedgerUpdate {
    -        ...IntraLedgerUpdateFragment
    -      }
    -      ... on LnUpdate {
    -        ...LnUpdateFragment
    -      }
    -      ... on OnChainUpdate {
    -        ...OnChainUpdateFragment
    -      }
    -      ... on Price {
    -        ...PriceFragment
    -      }
    -      ... on RealtimePrice {
    -        ...RealtimePriceFragment
    -      }
    -    }
    +    success
       }
    -}
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": UserLoginUpgradeInput}
     
    Response
    {
       "data": {
    -    "myUpdates": {
    +    "userLoginUpgrade": {
    +      "authToken": AuthToken,
           "errors": [Error],
    -      "me": User,
    -      "update": IntraLedgerUpdate
    +      "success": false
         }
       }
     }
    @@ -6216,18 +6799,18 @@ 
    Response
    -
    +

    - price + userLogout

    Response
    -

    Returns a PricePayload! +

    Returns a SuccessPayload!

    @@ -6242,7 +6825,7 @@
    Arguments
    - input - PriceInput! + input - UserLogoutInput @@ -6255,36 +6838,28 @@
    Arguments

    Example

    Query
    -
    subscription Price($input: PriceInput!) {
    -  price(input: $input) {
    +                  
    mutation UserLogout($input: UserLogoutInput) {
    +  userLogout(input: $input) {
         errors {
           code
           message
           path
         }
    -    price {
    -      base
    -      currencyUnit
    -      formattedAmount
    -      offset
    -    }
    +    success
       }
    -}
    +}
     
    Variables
    -
    {"input": PriceInput}
    +                  
    {"input": UserLogoutInput}
     
    Response
    {
       "data": {
    -    "price": {
    -      "errors": [Error],
    -      "price": Price
    -    }
    +    "userLogout": {"errors": [Error], "success": true}
       }
     }
     
    @@ -6292,26 +6867,90 @@
    Response
    -
    +

    - realtimePrice + userPhoneDelete

    -
    -
    Description
    -

    Returns the price of 1 satoshi

    +
    +
    Response
    +

    Returns a UserPhoneDeletePayload! +

    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    mutation UserPhoneDelete {
    +  userPhoneDelete {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    me {
    +      bankAccounts {
    +        ...BankAccountFragment
    +      }
    +      contactByUsername {
    +        ...UserContactFragment
    +      }
    +      contacts {
    +        ...UserContactFragment
    +      }
    +      createdAt
    +      defaultAccount {
    +        ...AccountFragment
    +      }
    +      email {
    +        ...EmailFragment
    +      }
    +      id
    +      language
    +      npub
    +      phone
    +      quizQuestions {
    +        ...UserQuizQuestionFragment
    +      }
    +      totpEnabled
    +      username
    +    }
    +  }
    +}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "userPhoneDelete": {
    +      "errors": [Error],
    +      "me": User
    +    }
    +  }
    +}
    +
    +
    +
    +
    + Mutations +
    +

    + userPhoneRegistrationInitiate +

    Response
    -

    Returns a RealtimePricePayload! +

    Returns a SuccessPayload!

    @@ -6326,7 +6965,7 @@
    Arguments
    - input - RealtimePriceInput! + input - UserPhoneRegistrationInitiateInput! @@ -6339,40 +6978,30 @@
    Arguments

    Example

    Query
    -
    subscription RealtimePrice($input: RealtimePriceInput!) {
    -  realtimePrice(input: $input) {
    +                  
    mutation UserPhoneRegistrationInitiate($input: UserPhoneRegistrationInitiateInput!) {
    +  userPhoneRegistrationInitiate(input: $input) {
         errors {
           code
           message
           path
         }
    -    realtimePrice {
    -      btcSatPrice {
    -        ...PriceOfOneSatInMinorUnitFragment
    -      }
    -      denominatorCurrency
    -      id
    -      timestamp
    -      usdCentPrice {
    -        ...PriceOfOneUsdCentInMinorUnitFragment
    -      }
    -    }
    +    success
       }
     }
     
    Variables
    -
    {"input": RealtimePriceInput}
    +                  
    {"input": UserPhoneRegistrationInitiateInput}
     
    Response
    {
       "data": {
    -    "realtimePrice": {
    +    "userPhoneRegistrationInitiate": {
           "errors": [Error],
    -      "realtimePrice": RealtimePrice
    +      "success": true
         }
       }
     }
    @@ -6381,148 +7010,3820 @@ 
    Response
    -

    Types

    -
    -

    Account

    +
    +
    + Mutations +
    +

    + userPhoneRegistrationValidate +

    -
    -
    Fields
    +
    +
    Response
    +

    Returns a UserPhoneRegistrationValidatePayload! +

    +
    +
    +
    Arguments
    - + - + +
    Field NameName Description
    callbackEndpoints - [CallbackEndpoint!]! + + input - UserPhoneRegistrationValidateInput!
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    mutation UserPhoneRegistrationValidate($input: UserPhoneRegistrationValidateInput!) {
    +  userPhoneRegistrationValidate(input: $input) {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    me {
    +      bankAccounts {
    +        ...BankAccountFragment
    +      }
    +      contactByUsername {
    +        ...UserContactFragment
    +      }
    +      contacts {
    +        ...UserContactFragment
    +      }
    +      createdAt
    +      defaultAccount {
    +        ...AccountFragment
    +      }
    +      email {
    +        ...EmailFragment
    +      }
    +      id
    +      language
    +      npub
    +      phone
    +      quizQuestions {
    +        ...UserQuizQuestionFragment
    +      }
    +      totpEnabled
    +      username
    +    }
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": UserPhoneRegistrationValidateInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "userPhoneRegistrationValidate": {
    +      "errors": [Error],
    +      "me": User
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Mutations +
    +

    + userQuizQuestionUpdateCompleted +

    +
    +
    +
    +
    Use QuizCompletedMutation instead
    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a UserQuizQuestionUpdateCompletedPayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - UserQuizQuestionUpdateCompletedInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    mutation UserQuizQuestionUpdateCompleted($input: UserQuizQuestionUpdateCompletedInput!) {
    +  userQuizQuestionUpdateCompleted(input: $input) {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    userQuizQuestion {
    +      completed
    +      question {
    +        ...QuizQuestionFragment
    +      }
    +    }
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": UserQuizQuestionUpdateCompletedInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "userQuizQuestionUpdateCompleted": {
    +      "errors": [Error],
    +      "userQuizQuestion": UserQuizQuestion
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Mutations +
    +

    + userTotpDelete +

    +
    +
    +
    +
    Response
    +

    Returns a UserTotpDeletePayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - UserTotpDeleteInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    mutation UserTotpDelete($input: UserTotpDeleteInput!) {
    +  userTotpDelete(input: $input) {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    me {
    +      bankAccounts {
    +        ...BankAccountFragment
    +      }
    +      contactByUsername {
    +        ...UserContactFragment
    +      }
    +      contacts {
    +        ...UserContactFragment
    +      }
    +      createdAt
    +      defaultAccount {
    +        ...AccountFragment
    +      }
    +      email {
    +        ...EmailFragment
    +      }
    +      id
    +      language
    +      npub
    +      phone
    +      quizQuestions {
    +        ...UserQuizQuestionFragment
    +      }
    +      totpEnabled
    +      username
    +    }
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": UserTotpDeleteInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "userTotpDelete": {
    +      "errors": [Error],
    +      "me": User
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Mutations +
    +

    + userTotpRegistrationInitiate +

    +
    +
    +
    +
    Response
    +

    Returns a UserTotpRegistrationInitiatePayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - UserTotpRegistrationInitiateInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    mutation UserTotpRegistrationInitiate($input: UserTotpRegistrationInitiateInput!) {
    +  userTotpRegistrationInitiate(input: $input) {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    totpRegistrationId
    +    totpSecret
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": UserTotpRegistrationInitiateInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "userTotpRegistrationInitiate": {
    +      "errors": [Error],
    +      "totpRegistrationId": TotpRegistrationId,
    +      "totpSecret": TotpSecret
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Mutations +
    +

    + userTotpRegistrationValidate +

    +
    +
    +
    +
    Response
    +

    Returns a UserTotpRegistrationValidatePayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - UserTotpRegistrationValidateInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    mutation UserTotpRegistrationValidate($input: UserTotpRegistrationValidateInput!) {
    +  userTotpRegistrationValidate(input: $input) {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    me {
    +      bankAccounts {
    +        ...BankAccountFragment
    +      }
    +      contactByUsername {
    +        ...UserContactFragment
    +      }
    +      contacts {
    +        ...UserContactFragment
    +      }
    +      createdAt
    +      defaultAccount {
    +        ...AccountFragment
    +      }
    +      email {
    +        ...EmailFragment
    +      }
    +      id
    +      language
    +      npub
    +      phone
    +      quizQuestions {
    +        ...UserQuizQuestionFragment
    +      }
    +      totpEnabled
    +      username
    +    }
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": UserTotpRegistrationValidateInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "userTotpRegistrationValidate": {
    +      "errors": [Error],
    +      "me": User
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Mutations +
    +

    + userUpdateLanguage +

    +
    +
    +
    +
    Response
    +

    Returns a UserUpdateLanguagePayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - UserUpdateLanguageInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    mutation UserUpdateLanguage($input: UserUpdateLanguageInput!) {
    +  userUpdateLanguage(input: $input) {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    user {
    +      bankAccounts {
    +        ...BankAccountFragment
    +      }
    +      contactByUsername {
    +        ...UserContactFragment
    +      }
    +      contacts {
    +        ...UserContactFragment
    +      }
    +      createdAt
    +      defaultAccount {
    +        ...AccountFragment
    +      }
    +      email {
    +        ...EmailFragment
    +      }
    +      id
    +      language
    +      npub
    +      phone
    +      quizQuestions {
    +        ...UserQuizQuestionFragment
    +      }
    +      totpEnabled
    +      username
    +    }
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": UserUpdateLanguageInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "userUpdateLanguage": {
    +      "errors": [Error],
    +      "user": User
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Mutations +
    +

    + userUpdateNpub +

    +
    +
    +
    +
    Response
    +

    Returns a UserUpdateNpubPayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - UserUpdateNpubInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    mutation UserUpdateNpub($input: UserUpdateNpubInput!) {
    +  userUpdateNpub(input: $input) {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    user {
    +      bankAccounts {
    +        ...BankAccountFragment
    +      }
    +      contactByUsername {
    +        ...UserContactFragment
    +      }
    +      contacts {
    +        ...UserContactFragment
    +      }
    +      createdAt
    +      defaultAccount {
    +        ...AccountFragment
    +      }
    +      email {
    +        ...EmailFragment
    +      }
    +      id
    +      language
    +      npub
    +      phone
    +      quizQuestions {
    +        ...UserQuizQuestionFragment
    +      }
    +      totpEnabled
    +      username
    +    }
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": UserUpdateNpubInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "userUpdateNpub": {
    +      "errors": [Error],
    +      "user": User
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    +
    + Mutations +
    +

    + userUpdateUsername +

    +
    +
    +
    +
    Username will be moved to @Handle in Accounts. Also SetUsername naming should be used instead of UpdateUsername to reflect the idempotency of Handles
    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a UserUpdateUsernamePayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - UserUpdateUsernameInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    mutation UserUpdateUsername($input: UserUpdateUsernameInput!) {
    +  userUpdateUsername(input: $input) {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    user {
    +      bankAccounts {
    +        ...BankAccountFragment
    +      }
    +      contactByUsername {
    +        ...UserContactFragment
    +      }
    +      contacts {
    +        ...UserContactFragment
    +      }
    +      createdAt
    +      defaultAccount {
    +        ...AccountFragment
    +      }
    +      email {
    +        ...EmailFragment
    +      }
    +      id
    +      language
    +      npub
    +      phone
    +      quizQuestions {
    +        ...UserQuizQuestionFragment
    +      }
    +      totpEnabled
    +      username
    +    }
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": UserUpdateUsernameInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "userUpdateUsername": {
    +      "errors": [Error],
    +      "user": User
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +

    Subscriptions

    +
    +

    + lnInvoicePaymentStatus +

    +
    +
    +
    +
    Response
    +

    Returns a LnInvoicePaymentStatusPayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - LnInvoicePaymentStatusInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    subscription LnInvoicePaymentStatus($input: LnInvoicePaymentStatusInput!) {
    +  lnInvoicePaymentStatus(input: $input) {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    status
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": LnInvoicePaymentStatusInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "lnInvoicePaymentStatus": {
    +      "errors": [Error],
    +      "status": "EXPIRED"
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    + +

    + myUpdates +

    +
    +
    +
    +
    Response
    +

    Returns a MyUpdatesPayload! +

    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    subscription MyUpdates {
    +  myUpdates {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    me {
    +      bankAccounts {
    +        ...BankAccountFragment
    +      }
    +      contactByUsername {
    +        ...UserContactFragment
    +      }
    +      contacts {
    +        ...UserContactFragment
    +      }
    +      createdAt
    +      defaultAccount {
    +        ...AccountFragment
    +      }
    +      email {
    +        ...EmailFragment
    +      }
    +      id
    +      language
    +      npub
    +      phone
    +      quizQuestions {
    +        ...UserQuizQuestionFragment
    +      }
    +      totpEnabled
    +      username
    +    }
    +    update {
    +      ... on IntraLedgerUpdate {
    +        ...IntraLedgerUpdateFragment
    +      }
    +      ... on LnUpdate {
    +        ...LnUpdateFragment
    +      }
    +      ... on OnChainUpdate {
    +        ...OnChainUpdateFragment
    +      }
    +      ... on Price {
    +        ...PriceFragment
    +      }
    +      ... on RealtimePrice {
    +        ...RealtimePriceFragment
    +      }
    +    }
    +  }
    +}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "myUpdates": {
    +      "errors": [Error],
    +      "me": User,
    +      "update": IntraLedgerUpdate
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    + +

    + price +

    +
    +
    +
    +
    Response
    +

    Returns a PricePayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - PriceInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    subscription Price($input: PriceInput!) {
    +  price(input: $input) {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    price {
    +      base
    +      currencyUnit
    +      formattedAmount
    +      offset
    +    }
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": PriceInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "price": {
    +      "errors": [Error],
    +      "price": Price
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +
    + +

    + realtimePrice +

    +
    +
    +
    +
    Description
    +

    Returns the price of 1 satoshi

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a RealtimePricePayload! +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - RealtimePriceInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    +
    subscription RealtimePrice($input: RealtimePriceInput!) {
    +  realtimePrice(input: $input) {
    +    errors {
    +      code
    +      message
    +      path
    +    }
    +    realtimePrice {
    +      btcSatPrice {
    +        ...PriceOfOneSatInMinorUnitFragment
    +      }
    +      denominatorCurrency
    +      id
    +      timestamp
    +      usdCentPrice {
    +        ...PriceOfOneUsdCentInMinorUnitFragment
    +      }
    +    }
    +  }
    +}
    +
    +
    +
    +
    Variables
    +
    {"input": RealtimePriceInput}
    +
    +
    +
    +
    Response
    +
    {
    +  "data": {
    +    "realtimePrice": {
    +      "errors": [Error],
    +      "realtimePrice": RealtimePrice
    +    }
    +  }
    +}
    +
    +
    +
    +
    +
    +

    Types

    +
    +

    Account

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    callbackEndpoints - [CallbackEndpoint!]! + +
    csvTransactions - String! + +
    +
    +
    Arguments
    +
    +
    +
    walletIds - [WalletId!]! +
    +
    +
    +
    +
    defaultWalletId - WalletId! + +
    displayCurrency - DisplayCurrency! + +
    id - ID! + +
    level - AccountLevel! + +
    limits - AccountLimits! + +
    notificationSettings - NotificationSettings! + +
    realtimePrice - RealtimePrice! + +
    transactions - TransactionConnection + +
    +
    +
    Arguments
    +
    +
    +
    after - String +
    +

    Returns the items in the list that come after the specified cursor.

    +
    +
    +
    before - String +
    +

    Returns the items in the list that come before the specified cursor.

    +
    +
    +
    first - Int +
    +

    Returns the first n items from the list.

    +
    +
    +
    last - Int +
    +

    Returns the last n items from the list.

    +
    +
    +
    walletIds - [WalletId] +
    +
    +
    +
    +
    wallets - [Wallet!]! + +
    +
    +
    +
    Possible Types
    + + + + + + + + + + + +
    Account Types
    +

    ConsumerAccount

    +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "callbackEndpoints": [CallbackEndpoint],
    +  "csvTransactions": "xyz789",
    +  "defaultWalletId": WalletId,
    +  "displayCurrency": DisplayCurrency,
    +  "id": 4,
    +  "level": "ONE",
    +  "limits": AccountLimits,
    +  "notificationSettings": NotificationSettings,
    +  "realtimePrice": RealtimePrice,
    +  "transactions": TransactionConnection,
    +  "wallets": [Wallet]
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountDeletePayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error!]! + +
    success - Boolean! + +
    +
    +
    +
    +
    +
    Example
    +
    {"errors": [Error], "success": true}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountDisableNotificationCategoryInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + category - NotificationCategory! + +
    + channel - NotificationChannel + +
    +
    +
    +
    +
    +
    Example
    +
    {"category": NotificationCategory, "channel": "PUSH"}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountDisableNotificationChannelInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + channel - NotificationChannel! + +
    +
    +
    +
    +
    +
    Example
    +
    {"channel": "PUSH"}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountEnableNotificationCategoryInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + category - NotificationCategory! + +
    + channel - NotificationChannel + +
    +
    +
    +
    +
    +
    Example
    +
    {"category": NotificationCategory, "channel": "PUSH"}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountEnableNotificationChannelInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + channel - NotificationChannel! + +
    +
    +
    +
    +
    +
    Example
    +
    {"channel": "PUSH"}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountLevel

    +
    +
    +
    +
    Values
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Enum ValueDescription
    +

    ONE

    +
    +
    +

    THREE

    +
    +
    +

    TWO

    +
    +
    +

    ZERO

    +
    +
    +
    +
    +
    +
    +
    Example
    +
    "ONE"
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountLimit

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    interval - Seconds + The rolling time interval in seconds that the limits would apply for.
    remainingLimit - CentAmount + The amount of cents remaining below the limit for the current 24 hour period.
    totalLimit - CentAmount! + The current maximum limit for a given 24 hour period.
    +
    +
    +
    Possible Types
    + + + + + + + + + + + +
    AccountLimit Types
    +

    OneDayAccountLimit

    +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "interval": Seconds,
    +  "remainingLimit": CentAmount,
    +  "totalLimit": CentAmount
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountLimits

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    convert - [AccountLimit!]! + Limits for converting between currencies among a account's own wallets.
    internalSend - [AccountLimit!]! + Limits for sending to other internal accounts.
    withdrawal - [AccountLimit!]! + Limits for withdrawing to external onchain or lightning destinations.
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "convert": [AccountLimit],
    +  "internalSend": [AccountLimit],
    +  "withdrawal": [AccountLimit]
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountNumber

    +
    +
    +
    +
    Description
    +

    Bank account number. Accepts String or Int and coerces to String.

    +
    +
    +
    +
    +
    Example
    +
    "000000012345"
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountUpdateDefaultWalletIdInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + walletId - WalletId! + +
    +
    +
    +
    +
    +
    Example
    +
    {"walletId": WalletId}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountUpdateDefaultWalletIdPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    account - ConsumerAccount + +
    errors - [Error!]! + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "account": ConsumerAccount,
    +  "errors": [Error]
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountUpdateDisplayCurrencyInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + currency - DisplayCurrency! + +
    +
    +
    +
    +
    +
    Example
    +
    {"currency": DisplayCurrency}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountUpdateDisplayCurrencyPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    account - ConsumerAccount + +
    errors - [Error!]! + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "account": ConsumerAccount,
    +  "errors": [Error]
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountUpdateNotificationSettingsPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    account - ConsumerAccount + +
    errors - [Error!]! + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "account": ConsumerAccount,
    +  "errors": [Error]
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountUpgradePayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error] + +
    id - String + +
    status - String + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "errors": [Error],
    +  "id": "xyz789",
    +  "status": "abc123"
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountUpgradeRequest

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    address - Address! + +
    bankAccount - BankAccount + +
    currentLevel - AccountLevel! + +
    email - String + +
    fullName - String! + +
    idDocument - Boolean! + +
    name - String! + ERPNext document name
    phoneNumber - String! + +
    requestedLevel - AccountLevel! + +
    status - String! + Status of the upgrade request
    terminalsRequested - Int! + +
    username - String! + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "address": Address,
    +  "bankAccount": BankAccount,
    +  "currentLevel": "ONE",
    +  "email": "xyz789",
    +  "fullName": "abc123",
    +  "idDocument": false,
    +  "name": "abc123",
    +  "phoneNumber": "xyz789",
    +  "requestedLevel": "ONE",
    +  "status": "xyz789",
    +  "terminalsRequested": 123,
    +  "username": "xyz789"
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AccountUpgradeRequestPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error] + +
    upgradeRequest - AccountUpgradeRequest + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "errors": [Error],
    +  "upgradeRequest": AccountUpgradeRequest
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    Address

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    city - String! + +
    country - String! + +
    line1 - String! + +
    line2 - String + +
    postalCode - String + +
    state - String! + +
    title - String! + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "city": "abc123",
    +  "country": "xyz789",
    +  "line1": "xyz789",
    +  "line2": "abc123",
    +  "postalCode": "xyz789",
    +  "state": "abc123",
    +  "title": "xyz789"
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AddressInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + city - String! + +
    + country - String! + +
    + line1 - String! + +
    + line2 - String + +
    + postalCode - String + +
    + state - String! + +
    + title - String! + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "city": "abc123",
    +  "country": "abc123",
    +  "line1": "abc123",
    +  "line2": "xyz789",
    +  "postalCode": "abc123",
    +  "state": "abc123",
    +  "title": "xyz789"
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AuthToken

    +
    +
    +
    +
    Description
    +

    An Opaque Bearer token

    +
    +
    +
    +
    +
    Example
    +
    AuthToken
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    AuthTokenPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    authToken - AuthToken + +
    errors - [Error!]! + +
    totpRequired - Boolean + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "authToken": AuthToken,
    +  "errors": [Error],
    +  "totpRequired": true
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BTCWallet

    +
    +
    +
    +
    Description
    +

    A wallet belonging to an account which contains a BTC balance and a list of transactions.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + +
    Field NameDescription
    accountId - ID! + +
    balance - FractionalCentAmount + A balance stored in BTC.
    id - ID! + +
    isExternal - Boolean! + +
    lnurlp - Lnurl + +
    pendingIncomingBalance - SignedAmount! + An unconfirmed incoming onchain balance.
    csvTransactions - String! + transactions - TransactionConnection + A list of BTC transactions associated with this wallet.
    +
    +
    Arguments
    +
    +
    +
    after - String +
    +

    Returns the items in the list that come after the specified cursor.

    +
    +
    +
    before - String +
    +

    Returns the items in the list that come before the specified cursor.

    +
    +
    +
    first - Int +
    +

    Returns the first n items from the list.

    +
    +
    +
    last - Int +
    +

    Returns the last n items from the list.

    +
    +
    +
    +
    transactionsByAddress - TransactionConnection + +
    +
    +
    Arguments
    +
    +
    +
    address - OnChainAddress! +
    +

    Returns the items that include this address.

    +
    +
    +
    after - String +
    +

    Returns the items in the list that come after the specified cursor.

    +
    +
    +
    before - String +
    +

    Returns the items in the list that come before the specified cursor.

    +
    +
    +
    first - Int +
    +

    Returns the first n items from the list.

    +
    +
    +
    last - Int +
    +

    Returns the last n items from the list.

    +
    +
    +
    +
    walletCurrency - WalletCurrency! + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "accountId": "4",
    +  "balance": FractionalCentAmount,
    +  "id": 4,
    +  "isExternal": true,
    +  "lnurlp": Lnurl,
    +  "pendingIncomingBalance": SignedAmount,
    +  "transactions": TransactionConnection,
    +  "transactionsByAddress": TransactionConnection,
    +  "walletCurrency": "BTC"
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    Bank

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Field NameDescription
    name - String! + +
    +
    +
    +
    +
    +
    Example
    +
    {"name": "xyz789"}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BankAccount

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    accountName - String + +
    accountNumber - String! + +
    accountType - String! + +
    bankBranch - String! + +
    bankName - String! + +
    currency - String! + Account currency (e.g. JMD, USD)
    id - ID + ERPNext bank account identifier
    isDefault - Boolean! + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "accountName": "xyz789",
    +  "accountNumber": "xyz789",
    +  "accountType": "abc123",
    +  "bankBranch": "xyz789",
    +  "bankName": "xyz789",
    +  "currency": "xyz789",
    +  "id": "4",
    +  "isDefault": true
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BankAccountInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + accountNumber - AccountNumber! + +
    + accountType - String! + +
    + bankBranch - String! + +
    + bankName - String! + +
    + currency - String! + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "accountNumber": "000000012345",
    +  "accountType": "xyz789",
    +  "bankBranch": "xyz789",
    +  "bankName": "xyz789",
    +  "currency": "abc123"
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    Boolean

    +
    +
    +
    +
    Description
    +

    The Boolean scalar type represents true or false.

    +
    +
    +
    +
    +
    Example
    +
    true
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeAddExternalAccountPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error!]! + +
    externalAccount - BridgeExternalAccountLink + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "errors": [Error],
    +  "externalAccount": BridgeExternalAccountLink
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeCancelWithdrawalRequestInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + withdrawalId - ID! + +
    +
    +
    +
    +
    +
    Example
    +
    {"withdrawalId": "4"}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeCancelWithdrawalRequestPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error!]! + +
    withdrawal - BridgeWithdrawal + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "errors": [Error],
    +  "withdrawal": BridgeWithdrawal
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeCreateExternalAccountInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + accountNumber - String! + +
    + accountOwnerName - String! + +
    + bankName - String! + +
    + checkingOrSavings - String + +
    + city - String! + +
    + country - String! + +
    + postalCode - String! + +
    + routingNumber - String! + +
    + state - String! + +
    + streetLine1 - String! + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "accountNumber": "abc123",
    +  "accountOwnerName": "xyz789",
    +  "bankName": "abc123",
    +  "checkingOrSavings": "abc123",
    +  "city": "abc123",
    +  "country": "abc123",
    +  "postalCode": "xyz789",
    +  "routingNumber": "xyz789",
    +  "state": "xyz789",
    +  "streetLine1": "xyz789"
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeCreateExternalAccountPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error!]! + +
    externalAccount - BridgeExternalAccount + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "errors": [Error],
    +  "externalAccount": BridgeExternalAccount
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeCreateVirtualAccountPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error!]! + +
    virtualAccount - BridgeVirtualAccount + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "errors": [Error],
    +  "virtualAccount": BridgeVirtualAccount
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeDeleteExternalAccountInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + externalAccountId - ID! + +
    +
    +
    +
    +
    +
    Example
    +
    {"externalAccountId": 4}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeDeleteExternalAccountPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error!]! + +
    externalAccount - BridgeExternalAccount + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "errors": [Error],
    +  "externalAccount": BridgeExternalAccount
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeExternalAccount

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    accountNumberLast4 - String! + +
    bankName - String! + +
    id - ID! + +
    isDefault - Boolean! + +
    status - String! + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "accountNumberLast4": "abc123",
    +  "bankName": "xyz789",
    +  "id": 4,
    +  "isDefault": false,
    +  "status": "xyz789"
    +}
    +
    +
    +
    +
    +
    + +
    +
    + Types +
    +

    BridgeInitiateKycInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + email - String + +
    + full_name - String + +
    + type - String + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "email": "abc123",
    +  "full_name": "xyz789",
    +  "type": "abc123"
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeInitiateKycPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error!]! + +
    kycLink - BridgeKycLink + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "errors": [Error],
    +  "kycLink": BridgeKycLink
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeInitiateWithdrawalInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + withdrawalId - ID! + +
    +
    +
    +
    +
    +
    Example
    +
    {"withdrawalId": "4"}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeInitiateWithdrawalPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error!]! + +
    withdrawal - BridgeWithdrawal + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "errors": [Error],
    +  "withdrawal": BridgeWithdrawal
    +}
    +
    +
    +
    +
    +
    + +
    +
    + Types +
    +

    BridgeRequestWithdrawalInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + amount - String! + +
    + externalAccountId - ID! + +
    +
    +
    +
    +
    +
    Example
    +
    {"amount": "abc123", "externalAccountId": 4}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeRequestWithdrawalPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + - - + + + + +
    Field NameDescription
    errors - [Error!]!
    -
    -
    Arguments
    -
    -
    -
    walletIds - [WalletId!]! -
    -
    -
    -
    +
    withdrawal - BridgeWithdrawal + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "errors": [Error],
    +  "withdrawal": BridgeWithdrawal
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeSetDefaultExternalAccountInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + externalAccountId - ID! + +
    +
    +
    +
    +
    +
    Example
    +
    {"externalAccountId": 4}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeSetDefaultExternalAccountPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error!]! + +
    externalAccount - BridgeExternalAccount + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "errors": [Error],
    +  "externalAccount": BridgeExternalAccount
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeVirtualAccount

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    accountNumber - String + +
    accountNumberLast4 - String + +
    bankName - String + +
    id - ID + +
    kycLink - String + +
    message - String + +
    pending - Boolean + +
    routingNumber - String + +
    tosLink - String + +
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "accountNumber": "xyz789",
    +  "accountNumberLast4": "xyz789",
    +  "bankName": "abc123",
    +  "id": 4,
    +  "kycLink": "abc123",
    +  "message": "xyz789",
    +  "pending": false,
    +  "routingNumber": "abc123",
    +  "tosLink": "xyz789"
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    BridgeWithdrawal

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - + - - + + - - -
    Field NameDescription
    amount - String! + +
    bridgeDeveloperFee - String + +
    bridgeExchangeFee - String + +
    bridgeTransferId - String + +
    createdAt - String! + +
    currency - String! + +
    estimatedBridgeFee - String + +
    estimatedBridgeFeePercent - String +
    defaultWalletId - WalletId! + estimatedCustomerFee - String
    displayCurrency - DisplayCurrency! + estimatedGasBuffer - String
    id - ID! + externalAccountId - String
    level - AccountLevel! + failureReason - String
    limits - AccountLimits! + finalAmount - String
    notificationSettings - NotificationSettings! + flashFee - String
    realtimePrice - RealtimePrice! + flashFeeIsEstimate - Boolean!
    transactions - TransactionConnection +
    flashFeeNotice - String
    -
    -
    Arguments
    -
    -
    -
    after - String -
    -

    Returns the items in the list that come after the specified cursor.

    -
    -
    -
    before - String -
    -

    Returns the items in the list that come before the specified cursor.

    -
    -
    -
    first - Int -
    -

    Returns the first n items from the list.

    -
    -
    -
    last - Int -
    -

    Returns the last n items from the list.

    -
    -
    -
    walletIds - [WalletId] -
    -
    -
    -
    +
    flashFeePercent - String +
    wallets - [Wallet!]! + id - ID!
    -
    -
    -
    Possible Types
    - - - + + - - + @@ -6533,28 +10834,37 @@
    Possible Types
    Example
    {
    -  "callbackEndpoints": [CallbackEndpoint],
    -  "csvTransactions": "abc123",
    -  "defaultWalletId": WalletId,
    -  "displayCurrency": DisplayCurrency,
    -  "id": 4,
    -  "level": "ONE",
    -  "limits": AccountLimits,
    -  "notificationSettings": NotificationSettings,
    -  "realtimePrice": RealtimePrice,
    -  "transactions": TransactionConnection,
    -  "wallets": [Wallet]
    +  "amount": "abc123",
    +  "bridgeDeveloperFee": "abc123",
    +  "bridgeExchangeFee": "abc123",
    +  "bridgeTransferId": "xyz789",
    +  "createdAt": "xyz789",
    +  "currency": "abc123",
    +  "estimatedBridgeFee": "xyz789",
    +  "estimatedBridgeFeePercent": "xyz789",
    +  "estimatedCustomerFee": "abc123",
    +  "estimatedGasBuffer": "abc123",
    +  "externalAccountId": "xyz789",
    +  "failureReason": "xyz789",
    +  "finalAmount": "xyz789",
    +  "flashFee": "abc123",
    +  "flashFeeIsEstimate": false,
    +  "flashFeeNotice": "abc123",
    +  "flashFeePercent": "abc123",
    +  "id": "4",
    +  "status": "abc123",
    +  "subtotalAmount": "abc123"
     }
     
    -
    +
    -

    AccountDeletePayload

    +

    BuildInformation

    @@ -6568,13 +10878,13 @@
    Fields
    - - @@ -6586,17 +10896,20 @@
    Fields
    Example
    -
    {"errors": [Error], "success": true}
    +                  
    {
    +  "commitHash": "xyz789",
    +  "helmRevision": 123
    +}
     
    -
    +
    -

    AccountDisableNotificationCategoryInput

    +

    BusinessAccountUpgradeRequestInput

    @@ -6611,14 +10924,42 @@
    Fields
    + + + + + + + + + + + + + + + + @@ -6630,17 +10971,24 @@
    Fields
    Example
    -
    {"category": NotificationCategory, "channel": "PUSH"}
    +                  
    {
    +  "address": AddressInput,
    +  "bankAccount": BankAccountInput,
    +  "fullName": "abc123",
    +  "idDocument": "xyz789",
    +  "level": "ONE",
    +  "terminalsRequested": 987
    +}
     
    -
    +
    -

    AccountDisableNotificationChannelInput

    +

    CallbackEndpoint

    @@ -6648,14 +10996,19 @@
    Fields
    Account Typesstatus - String! + +
    subtotalAmount - String + -

    ConsumerAccount

    errors - [Error!]! + commitHash - String
    success - Boolean! + helmRevision - Int
    - category - NotificationCategory! + address - AddressInput!
    - channel - NotificationChannel + bankAccount - BankAccountInput + +
    + fullName - String! + +
    + idDocument - String + +
    + level - AccountLevel! + +
    + terminalsRequested - Int
    - + + + + + @@ -6667,17 +11020,20 @@
    Fields
    Example
    -
    {"channel": "PUSH"}
    +                  
    {
    +  "id": EndpointId,
    +  "url": EndpointUrl
    +}
     
    -
    +
    -

    AccountEnableNotificationCategoryInput

    +

    CallbackEndpointAddInput

    @@ -6692,14 +11048,48 @@
    Fields
    + + + +
    Input FieldField Name Description
    id - EndpointId! + - channel - NotificationChannel! +
    url - EndpointUrl!
    - category - NotificationCategory! + url - EndpointUrl! + callback endpoint to be called
    +
    +
    +
    +
    +
    Example
    +
    {"url": EndpointUrl}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    CallbackEndpointAddPayload

    +
    +
    +
    +
    Fields
    + + + + + + + + + + - @@ -6711,17 +11101,20 @@
    Fields
    Example
    -
    {"category": NotificationCategory, "channel": "PUSH"}
    +                  
    {
    +  "errors": [Error],
    +  "id": EndpointId
    +}
     
    -
    +
    -

    AccountEnableNotificationChannelInput

    +

    CallbackEndpointDeleteInput

    @@ -6736,7 +11129,7 @@
    Fields
    @@ -6748,46 +11141,94 @@
    Fields
    Example
    -
    {"channel": "PUSH"}
    +                  
    {"id": EndpointId}
     
    -
    +
    -

    AccountLevel

    +

    CaptchaCreateChallengePayload

    -
    Values
    +
    Fields
    Field NameDescription
    errors - [Error!]!
    - channel - NotificationChannel + id - EndpointId
    - channel - NotificationChannel! + id - EndpointId!
    - + + + + + + +
    Enum ValueField Name Description
    errors - [Error!]! + -

    ONE

    +
    result - CaptchaCreateChallengeResult
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "errors": [Error],
    +  "result": CaptchaCreateChallengeResult
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    CaptchaCreateChallengeResult

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + @@ -6799,59 +11240,67 @@
    Values
    Example
    -
    "ONE"
    +                  
    {
    +  "challengeCode": "abc123",
    +  "failbackMode": false,
    +  "id": "abc123",
    +  "newCaptcha": true
    +}
     
    -
    +
    -

    AccountLimit

    +

    CaptchaRequestAuthCodeInput

    -
    +
    Fields
    Field NameDescription
    challengeCode - String! + -

    TWO

    +
    failbackMode - Boolean!
    id - String! + -

    ZERO

    +
    newCaptcha - Boolean!
    - + - + - - + - - + - - -
    Field NameInput Field Description
    interval - Seconds + + challengeCode - String! + The rolling time interval in seconds that the limits would apply for.
    remainingLimit - CentAmount + + channel - PhoneCodeChannelType + The amount of cents remaining below the limit for the current 24 hour period.
    totalLimit - CentAmount! + + phone - Phone! + The current maximum limit for a given 24 hour period.
    -
    -
    -
    Possible Types
    - - - + + - - + @@ -6862,20 +11311,22 @@
    Possible Types
    Example
    {
    -  "interval": Seconds,
    -  "remainingLimit": CentAmount,
    -  "totalLimit": CentAmount
    +  "challengeCode": "xyz789",
    +  "channel": "SMS",
    +  "phone": Phone,
    +  "secCode": "abc123",
    +  "validationCode": "abc123"
     }
     
    -
    +
    -

    AccountLimits

    +

    CashWalletCutover

    @@ -6889,19 +11340,64 @@
    Fields
    - + - - + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -
    AccountLimit Types + secCode - String! + +
    -

    OneDayAccountLimit

    + validationCode - String! +
    convert - [AccountLimit!]! + completedAt - Timestamp + Limits for converting between currencies among a account's own wallets.
    internalSend - [AccountLimit!]! + cutoverVersion - Int! + Limits for sending to other internal accounts.
    withdrawal - [AccountLimit!]! + pauseReason - String + +
    pausedAt - Timestamp + +
    runId - String + +
    scheduledAt - Timestamp + +
    startedAt - Timestamp + +
    state - CashWalletCutoverState! + +
    updatedAt - Timestamp! + +
    updatedBy - String + Limits for withdrawing to external onchain or lightning destinations.
    @@ -6911,35 +11407,63 @@
    Fields
    Example
    {
    -  "convert": [AccountLimit],
    -  "internalSend": [AccountLimit],
    -  "withdrawal": [AccountLimit]
    +  "completedAt": 1592577642,
    +  "cutoverVersion": 987,
    +  "pauseReason": "xyz789",
    +  "pausedAt": 1592577642,
    +  "runId": "xyz789",
    +  "scheduledAt": 1592577642,
    +  "startedAt": 1592577642,
    +  "state": "COMPLETE",
    +  "updatedAt": 1592577642,
    +  "updatedBy": "abc123"
     }
     
    -
    +
    -

    AccountUpdateDefaultWalletIdInput

    +

    CashWalletCutoverState

    -
    Fields
    +
    Values
    - + + + + + + + + + + + + + @@ -6951,17 +11475,17 @@
    Fields
    Example
    -
    {"walletId": WalletId}
    +                  
    "COMPLETE"
     
    -
    +
    -

    AccountUpdateDefaultWalletIdPayload

    +

    CashoutOffer

    @@ -6975,16 +11499,44 @@
    Fields
    - - + + + + - - + + + + + + + + + + + + + + + + + + + +
    Input FieldEnum Value Description
    - walletId - WalletId! +

    COMPLETE

    +
    +
    +

    IN_PROGRESS

    +
    +
    +

    PRE

    +
    +
    +

    ROLLED_BACK

    account - ConsumerAccount + exchangeRate - JMDCents + The rate used when withdrawing to a JMD bank account
    expiresAt - Timestamp! The time at which this offer is no longer accepted by Flash
    errors - [Error!]! + flashFee - USDCents! + The amount that Flash is charging for its services
    offerId - ID! + ID of the offer
    receiveJmd - JMDCents + The amount Flash owes to the user denominated in JMD cents (null for USD payouts)
    receiveUsd - USDCents + The amount Flash owes to the user denominated in USD cents (null for JMD payouts)
    send - USDCents! The amount the user is sending to flash
    walletId - WalletId! + ID for the users USD wallet to send from
    @@ -6994,56 +11546,46 @@
    Fields
    Example
    {
    -  "account": ConsumerAccount,
    -  "errors": [Error]
    +  "exchangeRate": JMDCents,
    +  "expiresAt": 1592577642,
    +  "flashFee": USDCents,
    +  "offerId": 4,
    +  "receiveJmd": JMDCents,
    +  "receiveUsd": USDCents,
    +  "send": USDCents,
    +  "walletId": WalletId
     }
     
    -
    +
    -

    AccountUpdateDisplayCurrencyInput

    +

    CentAmount

    -
    -
    Fields
    - - - - - - - - - - - - - -
    Input FieldDescription
    - currency - DisplayCurrency! - -
    +
    +
    Description
    +

    (Positive) Cent amount (1/100 of a dollar)

    Example
    -
    {"currency": DisplayCurrency}
    +                  
    CentAmount
     
    -
    +
    -

    AccountUpdateDisplayCurrencyPayload

    +

    CentAmountPayload

    @@ -7057,7 +11599,7 @@
    Fields
    - account - ConsumerAccount + amount - USDCents @@ -7068,6 +11610,12 @@
    Fields
    + + invoiceAmount - USDCents + + + +
    @@ -7076,19 +11624,20 @@
    Fields
    Example
    {
    -  "account": ConsumerAccount,
    -  "errors": [Error]
    +  "amount": USDCents,
    +  "errors": [Error],
    +  "invoiceAmount": USDCents
     }
     
    -
    +
    -

    AccountUpdateNotificationSettingsPayload

    +

    ConsumerAccount

    @@ -7096,19 +11645,122 @@
    Fields
    - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - + + + + + + + + + + + + + + + @@ -7121,40 +11773,50 @@
    Fields
    Example
    {
    -  "account": ConsumerAccount,
    -  "errors": [Error]
    +  "callbackEndpoints": [CallbackEndpoint],
    +  "csvTransactions": "xyz789",
    +  "defaultWalletId": WalletId,
    +  "displayCurrency": DisplayCurrency,
    +  "id": 4,
    +  "level": "ONE",
    +  "limits": AccountLimits,
    +  "notificationSettings": NotificationSettings,
    +  "quiz": [Quiz],
    +  "realtimePrice": RealtimePrice,
    +  "transactions": TransactionConnection,
    +  "wallets": [Wallet]
     }
     
    -
    +
    -

    AuthToken

    +

    ContactAlias

    Description
    -

    An Opaque Bearer token

    +

    An alias name that a user can set for a wallet (with which they have transactions)

    Example
    -
    AuthToken
    +                  
    ContactAlias
     
    -
    +
    -

    AuthTokenPayload

    +

    Coordinates

    @@ -7168,19 +11830,13 @@
    Fields
    - - - - - - @@ -7192,27 +11848,19 @@
    Fields
    Example
    -
    {
    -  "authToken": AuthToken,
    -  "errors": [Error],
    -  "totpRequired": false
    -}
    +                  
    {"latitude": 123.45, "longitude": 123.45}
     
    -
    +
    -

    BTCWallet

    +

    Country

    -
    -
    Description
    -

    A wallet belonging to an account which contains a BTC balance and a list of transactions.

    -
    Fields
    Field NameDescriptionField NameDescription
    callbackEndpoints - [CallbackEndpoint!]! + +
    csvTransactions - String! + return CSV stream, base64 encoded, of the list of transactions in the wallet
    +
    +
    Arguments
    +
    +
    +
    walletIds - [WalletId!]! +
    +
    +
    +
    +
    defaultWalletId - WalletId! + +
    displayCurrency - DisplayCurrency! + +
    id - ID! + +
    level - AccountLevel! + +
    limits - AccountLimits! + +
    account - ConsumerAccount + notificationSettings - NotificationSettings!
    errors - [Error!]! + quiz - [Quiz!]! + List the quiz questions of the consumer account
    realtimePrice - RealtimePrice! + +
    transactions - TransactionConnection + A list of all transactions associated with walletIds optionally passed.
    +
    +
    Arguments
    +
    +
    +
    after - String +
    +

    Returns the items in the list that come after the specified cursor.

    +
    +
    +
    before - String +
    +

    Returns the items in the list that come before the specified cursor.

    +
    +
    +
    first - Int +
    +

    Returns the first n items from the list.

    +
    +
    +
    last - Int +
    +

    Returns the last n items from the list.

    +
    +
    +
    walletIds - [WalletId] +
    +
    +
    +
    +
    wallets - [Wallet!]!
    authToken - AuthToken - -
    errors - [Error!]! + latitude - Float!
    totpRequired - Boolean + longitude - Float!
    @@ -7224,109 +11872,13 @@
    Fields
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -7339,41 +11891,40 @@
    last
    Example
    {
    -  "accountId": 4,
    -  "balance": SignedAmount,
    -  "id": "4",
    -  "lnurlp": Lnurl,
    -  "pendingIncomingBalance": SignedAmount,
    -  "transactions": TransactionConnection,
    -  "transactionsByAddress": TransactionConnection,
    -  "walletCurrency": "BTC"
    +  "id": "US",
    +  "supportedAuthChannels": ["SMS"]
     }
     
    -
    +
    -

    Boolean

    +

    CountryCode

    Description
    -

    The Boolean scalar type represents true or false.

    +

    A CCA2 country code (ex US, FR, etc)

    +
    +
    Example
    +
    "US"
    +
    +
    -
    +
    -

    BuildInformation

    +

    Currency

    @@ -7387,13 +11938,31 @@
    Fields
    - - + + + + + + + + + + + + @@ -7406,19 +11975,22 @@
    Fields
    Example
    {
    -  "commitHash": "abc123",
    -  "helmRevision": 987
    +  "flag": "xyz789",
    +  "fractionDigits": 987,
    +  "id": "4",
    +  "name": "abc123",
    +  "symbol": "abc123"
     }
     
    -
    +
    -

    CallbackEndpoint

    +

    DepositFeesInformation

    @@ -7432,16 +12004,20 @@
    Fields
    - - - + + + +
    accountId - ID! - -
    balance - SignedAmount! - A balance stored in BTC.
    id - ID! - -
    lnurlp - Lnurl - -
    pendingIncomingBalance - SignedAmount! - An unconfirmed incoming onchain balance.
    transactions - TransactionConnection - A list of BTC transactions associated with this wallet.
    -
    -
    Arguments
    -
    -
    -
    after - String -
    -

    Returns the items in the list that come after the specified cursor.

    -
    -
    -
    before - String -
    -

    Returns the items in the list that come before the specified cursor.

    -
    -
    -
    first - Int -
    -

    Returns the first n items from the list.

    -
    -
    -
    last - Int -
    -

    Returns the last n items from the list.

    -
    -
    -
    -
    transactionsByAddress - TransactionConnection + id - CountryCode!
    -
    -
    Arguments
    -
    -
    -
    address - OnChainAddress! -
    -

    Returns the items that include this address.

    -
    -
    -
    after - String -
    -

    Returns the items in the list that come after the specified cursor.

    -
    -
    -
    before - String -
    -

    Returns the items in the list that come before the specified cursor.

    -
    -
    -
    first - Int -
    -

    Returns the first n items from the list.

    -
    -
    -
    last - Int -
    -

    Returns the last n items from the list.

    -
    -
    -
    -
    walletCurrency - WalletCurrency! + supportedAuthChannels - [PhoneCodeChannelType!]!
    commitHash - String + flag - String!
    helmRevision - Int + fractionDigits - Int! + +
    id - ID! + +
    name - String! + +
    symbol - String!
    id - EndpointId! + minBankFee - String!
    url - EndpointUrl! + minBankFeeThreshold - String! + below this amount minBankFee will be charged
    ratio - String! ratio to charge as basis points above minBankFeeThreshold amount
    @@ -7451,19 +12027,20 @@
    Fields
    Example
    {
    -  "id": EndpointId,
    -  "url": EndpointUrl
    +  "minBankFee": "xyz789",
    +  "minBankFeeThreshold": "xyz789",
    +  "ratio": "xyz789"
     }
     
    -
    +
    -

    CallbackEndpointAddInput

    +

    DeviceNotificationTokenCreateInput

    @@ -7478,9 +12055,10 @@
    Fields
    - url - EndpointUrl! + deviceToken - String! + + - callback endpoint to be called @@ -7489,17 +12067,38 @@
    Fields
    Example
    -
    {"url": EndpointUrl}
    +                  
    {"deviceToken": "abc123"}
     
    -
    +
    -

    CallbackEndpointAddPayload

    +

    DisplayCurrency

    +
    +
    +
    +
    Description
    +

    Display currency of an account

    +
    +
    +
    +
    +
    Example
    +
    DisplayCurrency
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    Email

    @@ -7513,13 +12112,13 @@
    Fields
    - errors - [Error!]! + address - EmailAddress - id - EndpointId + verified - Boolean @@ -7532,36 +12131,144 @@
    Fields
    Example
    {
    -  "errors": [Error],
    -  "id": EndpointId
    +  "address": "test@test.com",
    +  "verified": false
     }
     
    -
    +
    -

    CallbackEndpointDeleteInput

    +

    EmailAddress

    -
    +
    +
    Description
    +

    Email address

    +
    +
    +
    +
    +
    Example
    +
    "test@test.com"
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    EmailRegistrationId

    +
    +
    +
    +
    Description
    +

    An id to be passed between registrationInitiate and registrationValidate for confirming email

    +
    +
    +
    +
    +
    Example
    +
    EmailRegistrationId
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    EndpointId

    +
    +
    +
    +
    +
    +
    Example
    +
    EndpointId
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    EndpointUrl

    +
    +
    +
    +
    Description
    +

    Url that will be fetched on events for the account

    +
    +
    +
    +
    +
    Example
    +
    EndpointUrl
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    Error

    +
    +
    +
    Fields
    - + + + + + + + + + + + + +
    Input FieldField Name Description
    code - String + +
    message - String! + +
    path - [String] + - id - EndpointId!
    +
    +
    +
    Possible Types
    + + + + + + + + @@ -7571,37 +12278,43 @@
    Fields
    Example
    -
    {"id": EndpointId}
    +                  
    {
    +  "code": "abc123",
    +  "message": "abc123",
    +  "path": ["abc123"]
    +}
     
    -
    +
    -

    CaptchaCreateChallengePayload

    +

    ExchangeCurrencyUnit

    -
    Fields
    +
    Values
    Error Types
    +

    GraphQLApplicationError

    - + - - @@ -7613,20 +12326,38 @@
    Fields
    Example
    -
    {
    -  "errors": [Error],
    -  "result": CaptchaCreateChallengeResult
    -}
    +                  
    "BTCSAT"
     
    -
    +
    -

    CaptchaCreateChallengeResult

    +

    Feedback

    +
    +
    +
    +
    Description
    +

    Feedback shared with our user

    +
    +
    +
    +
    +
    Example
    +
    Feedback
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    FeedbackSubmitInput

    @@ -7634,31 +12365,14 @@
    Fields
    Field NameEnum Value Description
    errors - [Error!]! + +

    BTCSAT

    result - CaptchaCreateChallengeResult + +

    USDCENT

    - + - - - - - - - - - - - - @@ -7670,22 +12384,17 @@
    Fields
    Example
    -
    {
    -  "challengeCode": "xyz789",
    -  "failbackMode": true,
    -  "id": "abc123",
    -  "newCaptcha": false
    -}
    +                  
    {"feedback": Feedback}
     
    -
    +
    -

    CaptchaRequestAuthCodeInput

    +

    FeesInformation

    @@ -7693,42 +12402,13 @@
    Fields
    Field NameInput Field Description
    challengeCode - String! - -
    failbackMode - Boolean! - -
    id - String! - -
    newCaptcha - Boolean! + feedback - Feedback!
    - + - - - - - - - - - - - - - - - - - @@ -7740,91 +12420,65 @@
    Fields
    Example
    -
    {
    -  "challengeCode": "abc123",
    -  "channel": "SMS",
    -  "phone": Phone,
    -  "secCode": "abc123",
    -  "validationCode": "xyz789"
    -}
    +                  
    {"deposit": DepositFeesInformation}
     
    -
    +
    -

    CentAmount

    +

    Float

    Description
    -

    (Positive) Cent amount (1/100 of a dollar)

    +

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

    Example
    -
    CentAmount
    +                  
    987.65
     
    -
    +
    -

    CentAmountPayload

    +

    FractionalCentAmount

    -
    -
    Fields
    -
    Input FieldField Name Description
    - challengeCode - String! - -
    - channel - PhoneCodeChannelType - -
    - phone - Phone! - -
    - secCode - String! - -
    - validationCode - String! + deposit - DepositFeesInformation!
    - - - - - - - - - - - - - - - - -
    Field NameDescription
    amount - CentAmount - -
    errors - [Error!]! - -
    +
    +
    Description
    +

    Cent amount (1/100 of a dollar) as a float, can be positive or negative

    Example
    -
    {
    -  "amount": CentAmount,
    -  "errors": [Error]
    -}
    +                  
    FractionalCentAmount
     
    -
    +
    -

    ConsumerAccount

    +

    Globals

    +
    +
    Description
    +

    Provides global settings for the application which might have an impact for the user.

    +
    Fields
    @@ -7836,116 +12490,115 @@
    Fields
    - - + - - + - - - - - - + - - - + - - - + - - + + + + - - + + + +
    callbackEndpoints - [CallbackEndpoint!]! - + bridgeEnabled - Boolean! Whether Bridge (international bank transfer) entry points should be shown to the user. Controlled by the instance-wide bridge feature flag.
    csvTransactions - String! +
    buildInformation - BuildInformation! return CSV stream, base64 encoded, of the list of transactions in the wallet
    -
    -
    Arguments
    -
    -
    -
    walletIds - [WalletId!]! -
    -
    -
    -
    +
    defaultWalletId - WalletId! - + cashoutEnabled - Boolean! Whether cashout (settle to local bank account) entry points should be shown to the user. Controlled by the instance-wide cashout feature flag.
    displayCurrency - DisplayCurrency! + feesInformation - FeesInformation!
    id - ID! - + lightningAddressDomain - String! The domain name for lightning addresses accepted by this Galoy instance
    level - AccountLevel! + lightningAddressDomainAliases - [String!]!
    limits - AccountLimits! - + network - Network! Which network (mainnet, testnet, regtest, signet) this instance is running on.
    notificationSettings - NotificationSettings! + nodesIds - [String!]! + A list of public keys for the running lightning nodes. This can be used to know if an invoice belongs to one of our nodes.
    supportedCountries - [Country!]! A list of countries and their supported auth channels
    quiz - [Quiz!]! + topupEnabled - Boolean! List the quiz questions of the consumer account Whether wallet top-up entry points (card webview and bank-transfer-to-support) should be shown to the user. Controlled by the instance-wide topup feature flag.
    +
    +
    +
    +
    +
    Example
    +
    {
    +  "bridgeEnabled": false,
    +  "buildInformation": BuildInformation,
    +  "cashoutEnabled": true,
    +  "feesInformation": FeesInformation,
    +  "lightningAddressDomain": "xyz789",
    +  "lightningAddressDomainAliases": [
    +    "xyz789"
    +  ],
    +  "network": "mainnet",
    +  "nodesIds": ["xyz789"],
    +  "supportedCountries": [Country],
    +  "topupEnabled": true
    +}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    GraphQLApplicationError

    +
    +
    +
    +
    Fields
    + + + + + + + - - - + - - - - - @@ -7958,50 +12611,62 @@
    walletIds
    Example
    {
    -  "callbackEndpoints": [CallbackEndpoint],
    -  "csvTransactions": "abc123",
    -  "defaultWalletId": WalletId,
    -  "displayCurrency": DisplayCurrency,
    -  "id": 4,
    -  "level": "ONE",
    -  "limits": AccountLimits,
    -  "notificationSettings": NotificationSettings,
    -  "quiz": [Quiz],
    -  "realtimePrice": RealtimePrice,
    -  "transactions": TransactionConnection,
    -  "wallets": [Wallet]
    +  "code": "abc123",
    +  "message": "xyz789",
    +  "path": ["xyz789"]
     }
     
    -
    +
    +
    + Types +
    +

    Hex32Bytes

    +
    +
    +
    +
    Description
    +

    Hex-encoded string of 32 bytes

    +
    +
    +
    +
    +
    Example
    +
    Hex32Bytes
    +
    +
    +
    +
    +
    +
    -

    ContactAlias

    +

    ID

    Description
    -

    An alias name that a user can set for a wallet (with which they have transactions)

    +

    The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

    Example
    -
    ContactAlias
    +                  
    "4"
     
    -
    +
    -

    Coordinates

    +

    IdDocumentUploadUrlGenerateInput

    @@ -8009,22 +12674,22 @@
    Fields
    Field NameDescription
    realtimePrice - RealtimePrice! + code - String
    transactions - TransactionConnection +
    message - String! A list of all transactions associated with walletIds optionally passed.
    -
    -
    Arguments
    -
    -
    -
    after - String -
    -

    Returns the items in the list that come after the specified cursor.

    -
    -
    -
    before - String -
    -

    Returns the items in the list that come before the specified cursor.

    -
    -
    -
    first - Int -
    -

    Returns the first n items from the list.

    -
    -
    -
    last - Int -
    -

    Returns the last n items from the list.

    -
    -
    -
    walletIds - [WalletId] -
    -
    -
    -
    +
    wallets - [Wallet!]! + path - [String]
    - + - + - +
    Field NameInput Field Description
    latitude - Float! - + contentType - String! MIME type (image/jpeg, image/png, image/webp)
    longitude - Float! - + filename - String! Original filename
    @@ -8033,17 +12698,20 @@
    Fields
    Example
    -
    {"latitude": 123.45, "longitude": 123.45}
    +                  
    {
    +  "contentType": "xyz789",
    +  "filename": "xyz789"
    +}
     
    -
    +
    -

    Country

    +

    IdDocumentUploadUrlPayload

    @@ -8057,16 +12725,20 @@
    Fields
    - id - CountryCode! + errors - [Error!]! - supportedAuthChannels - [PhoneCodeChannelType!]! + fileKey - String - + Storage key for the uploaded file (use to generate read URLs) + + + uploadUrl - String + Pre-signed URL for uploading the ID document directly to storage @@ -8076,40 +12748,20 @@
    Fields
    Example
    {
    -  "id": "US",
    -  "supportedAuthChannels": ["SMS"]
    +  "errors": [Error],
    +  "fileKey": "xyz789",
    +  "uploadUrl": "xyz789"
     }
     
    -
    -
    - Types -
    -

    CountryCode

    -
    -
    -
    -
    Description
    -

    A CCA2 country code (ex US, FR, etc)

    -
    -
    -
    -
    -
    Example
    -
    "US"
    -
    -
    -
    -
    -
    -
    +
    -

    Currency

    +

    InitiateCashoutInput

    @@ -8117,37 +12769,20 @@
    Fields
    - + - - - - - - - - - + - - - - @@ -8160,22 +12795,19 @@
    Fields
    Example
    {
    -  "flag": "abc123",
    -  "fractionDigits": 987,
    -  "id": "4",
    -  "name": "xyz789",
    -  "symbol": "xyz789"
    +  "offerId": "4",
    +  "walletId": WalletId
     }
     
    -
    +
    -

    DepositFeesInformation

    +

    InitiatedCashoutResponse

    @@ -8189,20 +12821,16 @@
    Fields
    - - - - - - -
    Field NameInput Field Description
    flag - String! - -
    fractionDigits - Int! - -
    id - ID! - + offerId - ID! The id of the offer being executed.
    name - String! - -
    symbol - String! + walletId - WalletId!
    minBankFee - String! + errors - [Error!]!
    minBankFeeThreshold - String! + id - ID below this amount minBankFee will be charged
    ratio - String! + ratio to charge as basis points above minBankFeeThreshold amount
    @@ -8212,37 +12840,43 @@
    Fields
    Example
    {
    -  "minBankFee": "abc123",
    -  "minBankFeeThreshold": "xyz789",
    -  "ratio": "xyz789"
    +  "errors": [Error],
    +  "id": "4"
     }
     
    -
    +
    -

    DeviceNotificationTokenCreateInput

    +

    InitiationVia

    -
    Fields
    +
    Types
    - - + + + + + + @@ -8252,38 +12886,17 @@
    Fields
    Example
    -
    {"deviceToken": "xyz789"}
    -
    -
    -
    - - -
    -
    - Types -
    -

    DisplayCurrency

    -
    -
    -
    -
    Description
    -

    Display currency of an account

    -
    -
    -
    -
    -
    Example
    -
    DisplayCurrency
    +                  
    InitiationViaIntraLedger
     
    -
    +
    -

    Email

    +

    InitiationViaIntraLedger

    @@ -8297,13 +12910,13 @@
    Fields
    - - @@ -8316,145 +12929,148 @@
    Fields
    Example
    {
    -  "address": "test@test.com",
    -  "verified": true
    +  "counterPartyUsername": Username,
    +  "counterPartyWalletId": WalletId
     }
     
    -
    +
    -

    EmailAddress

    +

    InitiationViaLn

    -
    -
    Description
    -

    Email address

    +
    +
    Fields
    +
    Input FieldDescriptionUnion Types
    - deviceToken - String! +

    InitiationViaIntraLedger

    +

    InitiationViaLn

    +
    +

    InitiationViaOnChain

    address - EmailAddress + counterPartyUsername - Username
    verified - Boolean + counterPartyWalletId - WalletId
    + + + + + + + + + + + + +
    Field NameDescription
    paymentHash - PaymentHash! + +
    Example
    -
    "test@test.com"
    +                  
    {"paymentHash": PaymentHash}
     
    -
    +
    -

    EmailRegistrationId

    +

    InitiationViaOnChain

    -
    -
    Description
    -

    An id to be passed between registrationInitiate and registrationValidate for confirming email

    -
    -
    -
    -
    -
    Example
    -
    EmailRegistrationId
    -
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Field NameDescription
    address - OnChainAddress! + +
    -
    -
    -
    -
    - Types -
    -

    EndpointId

    -
    -
    -
    Example
    -
    EndpointId
    +                  
    {"address": OnChainAddress}
     
    -
    +
    -

    EndpointUrl

    +

    Int

    Description
    -

    Url that will be fetched on events for the account

    +

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

    Example
    -
    EndpointUrl
    +                  
    987
     
    -
    +
    -

    Error

    +

    IntraLedgerPaymentSendInput

    -
    +
    Fields
    - + - + - + - - - -
    Field NameInput Field Description
    code - String - + amount - SatAmount! Amount in satoshis.
    message - String! - + memo - Memo Optional memo to be attached to the payment.
    path - [String] + + recipientWalletId - WalletId!
    -
    -
    -
    Possible Types
    - - - - - - - + +
    Error Types
    -

    GraphQLApplicationError

    + walletId - WalletId!
    The wallet ID of the sender.
    @@ -8464,42 +13080,60 @@
    Possible Types
    Example
    {
    -  "code": "xyz789",
    -  "message": "abc123",
    -  "path": ["abc123"]
    +  "amount": SatAmount,
    +  "memo": Memo,
    +  "recipientWalletId": WalletId,
    +  "walletId": WalletId
     }
     
    -
    +
    -

    ExchangeCurrencyUnit

    +

    IntraLedgerUpdate

    -
    Values
    +
    Fields
    - + + + + + + + + + + + + + @@ -8511,38 +13145,23 @@
    Values
    Example
    -
    "BTCSAT"
    -
    -
    -
    - - -
    -
    - Types -
    -

    Feedback

    -
    -
    -
    -
    Description
    -

    Feedback shared with our user

    -
    -
    -
    -
    -
    Example
    -
    Feedback
    +                  
    {
    +  "amount": SatAmount,
    +  "displayCurrencyPerSat": 987.65,
    +  "txNotificationType": "IntraLedgerPayment",
    +  "usdPerSat": 987.65,
    +  "walletId": WalletId
    +}
     
    -
    +
    -

    FeedbackSubmitInput

    +

    IntraLedgerUsdPaymentSendInput

    @@ -8557,10 +13176,28 @@
    Fields
    + + + + + + + + + + + +
    Enum ValueField Name Description
    amount - SatAmount! + -

    BTCSAT

    +
    displayCurrencyPerSat - Float!
    txNotificationType - TxNotificationType! + -

    USDCENT

    +
    usdPerSat - Float! + + updated over displayCurrencyPerSat +
    walletId - WalletId!
    - feedback - Feedback! + amount - FractionalCentAmount! + Amount in cents.
    + memo - Memo Optional memo to be attached to the payment.
    + recipientWalletId - WalletId! + +
    + walletId - WalletId! The wallet ID of the sender.
    @@ -8569,31 +13206,51 @@
    Fields
    Example
    -
    {"feedback": Feedback}
    +                  
    {
    +  "amount": FractionalCentAmount,
    +  "memo": Memo,
    +  "recipientWalletId": WalletId,
    +  "walletId": WalletId
    +}
     
    -
    +
    -

    FeesInformation

    +

    InvoicePaymentStatus

    -
    Fields
    +
    Values
    - + - + + + + + + + + @@ -8605,113 +13262,36 @@
    Fields
    Example
    -
    {"deposit": DepositFeesInformation}
    -
    -
    -
    - - -
    -
    - Types -
    -

    Float

    -
    -
    -
    -
    Description
    -

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

    -
    -
    -
    -
    -
    Example
    -
    987.65
    -
    -
    -
    -
    -
    -
    -
    - Types -
    -

    FractionalCentAmount

    -
    -
    -
    -
    Description
    -

    (Positive) Cent amount (1/100 of a dollar) as a float

    -
    -
    -
    -
    -
    Example
    -
    FractionalCentAmount
    +                  
    "EXPIRED"
     
    -
    +
    -

    Globals

    +

    IsFlashNpubInput

    -
    -
    Description
    -

    Provides global settings for the application which might have an impact for the user.

    -
    Fields
    Field NameEnum Value Description
    deposit - DepositFeesInformation! + +

    EXPIRED

    +
    +
    +

    PAID

    +
    +
    +

    PENDING

    - + - - - - - - - - - - - - - - - - - - - - - - - -
    Field NameInput Field Description
    buildInformation - BuildInformation! - -
    feesInformation - FeesInformation! - -
    lightningAddressDomain - String! - The domain name for lightning addresses accepted by this Galoy instance
    lightningAddressDomainAliases - [String!]! + npub - npub!
    network - Network! - Which network (mainnet, testnet, regtest, signet) this instance is running on.
    nodesIds - [String!]! - A list of public keys for the running lightning nodes. This can be used to know if an invoice belongs to one of our nodes.
    supportedCountries - [Country!]! - A list of countries and their supported auth channels
    @@ -8719,27 +13299,17 @@
    Fields
    Example
    -
    {
    -  "buildInformation": BuildInformation,
    -  "feesInformation": FeesInformation,
    -  "lightningAddressDomain": "xyz789",
    -  "lightningAddressDomainAliases": [
    -    "xyz789"
    -  ],
    -  "network": "mainnet",
    -  "nodesIds": ["abc123"],
    -  "supportedCountries": [Country]
    -}
    +                  
    {"npub": npub}
     
    -
    +
    -

    GraphQLApplicationError

    +

    IsFlashNpubPayload

    @@ -8753,19 +13323,13 @@
    Fields
    - code - String - - - - - - message - String! + errors - [Error!]! - path - [String] + isFlashNpub - Boolean @@ -8777,87 +13341,89 @@
    Fields
    Example
    -
    {
    -  "code": "abc123",
    -  "message": "abc123",
    -  "path": ["xyz789"]
    -}
    +                  
    {"errors": [Error], "isFlashNpub": true}
     
    -
    +
    -

    Hex32Bytes

    +

    JMDCents

    Description
    -

    Hex-encoded string of 32 bytes

    +

    Amount in Jamaican cents

    Example
    -
    Hex32Bytes
    +                  
    JMDCents
     
    -
    +
    -

    ID

    +

    Language

    -
    -
    Description
    -

    The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

    -
    Example
    -
    "4"
    +                  
    Language
     
    -
    +
    -

    InitiationVia

    +

    LnInvoice

    -
    Types
    +
    Fields
    - + + + + + + + + + @@ -8867,17 +13433,22 @@
    Types
    Example
    -
    InitiationViaIntraLedger
    +                  
    {
    +  "paymentHash": PaymentHash,
    +  "paymentRequest": LnPaymentRequest,
    +  "paymentSecret": LnPaymentSecret,
    +  "satoshis": SatAmount
    +}
     
    -
    +
    -

    InitiationViaIntraLedger

    +

    LnInvoiceCreateInput

    @@ -8885,22 +13456,34 @@
    Fields
    Union TypesField NameDescription
    paymentHash - PaymentHash! + -

    InitiationViaIntraLedger

    paymentRequest - LnPaymentRequest! + -

    InitiationViaLn

    paymentSecret - LnPaymentSecret! + +
    satoshis - SatAmount + -

    InitiationViaOnChain

    - + - + + + + - + + + +
    Field NameInput Field Description
    counterPartyUsername - Username + + amount - SatAmount! Amount in satoshis.
    + expiresIn - Minutes Optional invoice expiration time in minutes.
    counterPartyWalletId - WalletId + + memo - Memo Optional memo for the lightning invoice.
    + walletId - WalletId! Wallet ID for a BTC wallet belonging to the current account.
    @@ -8910,19 +13493,21 @@
    Fields
    Example
    {
    -  "counterPartyUsername": Username,
    -  "counterPartyWalletId": WalletId
    +  "amount": SatAmount,
    +  "expiresIn": Minutes,
    +  "memo": Memo,
    +  "walletId": WalletId
     }
     
    -
    +
    -

    InitiationViaLn

    +

    LnInvoiceCreateOnBehalfOfRecipientInput

    @@ -8930,16 +13515,41 @@
    Fields
    - + - + + + + + + + + + + + + + + + +
    Field NameInput Field Description
    paymentHash - PaymentHash! + + amount - SatAmount! + Amount in satoshis.
    + descriptionHash - Hex32Bytes + +
    + expiresIn - Minutes + Optional invoice expiration time in minutes.
    + memo - Memo Optional memo for the lightning invoice.
    + recipientWalletId - WalletId! Wallet ID for a BTC wallet which belongs to any account.
    @@ -8948,17 +13558,23 @@
    Fields
    Example
    -
    {"paymentHash": PaymentHash}
    +                  
    {
    +  "amount": SatAmount,
    +  "descriptionHash": Hex32Bytes,
    +  "expiresIn": Minutes,
    +  "memo": Memo,
    +  "recipientWalletId": WalletId
    +}
     
    -
    +
    -

    InitiationViaOnChain

    +

    LnInvoiceFeeProbeInput

    @@ -8966,13 +13582,21 @@
    Fields
    - + - + + + + @@ -8984,38 +13608,65 @@
    Fields
    Example
    -
    {"address": OnChainAddress}
    +                  
    {
    +  "paymentRequest": LnPaymentRequest,
    +  "walletId": WalletId
    +}
     
    -
    +
    -

    Int

    +

    LnInvoicePayload

    -
    -
    Description
    -

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

    +
    +
    Fields
    +
    Field NameInput Field Description
    address - OnChainAddress! + + paymentRequest - LnPaymentRequest! + +
    + walletId - WalletId!
    + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [Error!]! + +
    invoice - LnInvoice + +
    Example
    -
    123
    +                  
    {
    +  "errors": [Error],
    +  "invoice": LnInvoice
    +}
     
    -
    +
    -

    IntraLedgerPaymentSendInput

    +

    LnInvoicePaymentInput

    @@ -9028,30 +13679,23 @@
    Fields
    - - - amount - SatAmount! - - Amount in satoshis. - memo - Memo - Optional memo to be attached to the payment. + Optional memo to associate with the lightning invoice. - recipientWalletId - WalletId! - - + paymentRequest - LnPaymentRequest! + Payment request representing the invoice which is being paid. walletId - WalletId! - The wallet ID of the sender. + Wallet ID with sufficient balance to cover amount of invoice. Must belong to the account of the current user. @@ -9061,9 +13705,8 @@
    Fields
    Example
    {
    -  "amount": SatAmount,
       "memo": Memo,
    -  "recipientWalletId": WalletId,
    +  "paymentRequest": LnPaymentRequest,
       "walletId": WalletId
     }
     
    @@ -9071,11 +13714,11 @@
    Example
    -
    +
    -

    IntraLedgerUpdate

    +

    LnInvoicePaymentStatusInput

    @@ -9083,38 +13726,14 @@
    Fields
    - + - - - - - - - - - - - - - - - - @@ -9126,23 +13745,17 @@
    Fields
    Example
    -
    {
    -  "amount": SatAmount,
    -  "displayCurrencyPerSat": 987.65,
    -  "txNotificationType": "IntraLedgerPayment",
    -  "usdPerSat": 987.65,
    -  "walletId": WalletId
    -}
    +                  
    {"paymentRequest": LnPaymentRequest}
     
    -
    +
    -

    IntraLedgerUsdPaymentSendInput

    +

    LnInvoicePaymentStatusPayload

    @@ -9150,35 +13763,22 @@
    Fields
    Field NameInput Field Description
    amount - SatAmount! - -
    displayCurrencyPerSat - Float! - -
    txNotificationType - TxNotificationType! - -
    usdPerSat - Float! - - updated over displayCurrencyPerSat -
    walletId - WalletId! + paymentRequest - LnPaymentRequest!
    - + - - - - - - - - - -
    Input FieldField Name Description
    - amount - FractionalCentAmount! + errors - [Error!]! Amount in cents.
    - memo - Memo Optional memo to be attached to the payment.
    - recipientWalletId - WalletId! - + status - InvoicePaymentStatus
    - walletId - WalletId! The wallet ID of the sender.
    @@ -9187,51 +13787,43 @@
    Fields
    Example
    -
    {
    -  "amount": FractionalCentAmount,
    -  "memo": Memo,
    -  "recipientWalletId": WalletId,
    -  "walletId": WalletId
    -}
    +                  
    {"errors": [Error], "status": "EXPIRED"}
     
    -
    +
    -

    InvoicePaymentStatus

    +

    LnNoAmountInvoice

    -
    Values
    +
    Fields
    - + - - + - - @@ -9243,17 +13835,21 @@
    Values
    Example
    -
    "EXPIRED"
    +                  
    {
    +  "paymentHash": PaymentHash,
    +  "paymentRequest": LnPaymentRequest,
    +  "paymentSecret": LnPaymentSecret
    +}
     
    -
    +
    -

    IsFlashNpubInput

    +

    LnNoAmountInvoiceCreateInput

    @@ -9268,10 +13864,21 @@
    Fields
    + + + + + + + +
    Enum ValueField Name Description
    -

    EXPIRED

    +
    paymentHash - PaymentHash!
    -

    PAID

    +
    paymentRequest - LnPaymentRequest!
    -

    PENDING

    +
    paymentSecret - LnPaymentSecret!
    - npub - npub! + expiresIn - Minutes + Optional invoice expiration time in minutes.
    + memo - Memo Optional memo for the lightning invoice.
    + walletId - WalletId! ID for either a USD or BTC wallet belonging to the account of the current user.
    @@ -9280,17 +13887,21 @@
    Fields
    Example
    -
    {"npub": npub}
    +                  
    {
    +  "expiresIn": Minutes,
    +  "memo": Memo,
    +  "walletId": WalletId
    +}
     
    -
    +
    -

    IsFlashNpubPayload

    +

    LnNoAmountInvoiceCreateOnBehalfOfRecipientInput

    @@ -9298,22 +13909,28 @@
    Fields
    - + - + - + + + +
    Field NameInput Field Description
    errors - [Error!]! - + expiresIn - Minutes Optional invoice expiration time in minutes.
    isFlashNpub - Boolean + + memo - Memo Optional memo for the lightning invoice.
    + recipientWalletId - WalletId! ID for either a USD or BTC wallet which belongs to the account of any user.
    @@ -9322,34 +13939,21 @@
    Fields
    Example
    -
    {"errors": [Error], "isFlashNpub": false}
    -
    -
    -
    -
    -
    -
    -
    - Types -
    -

    Language

    -
    -
    -
    -
    -
    -
    Example
    -
    Language
    +                  
    {
    +  "expiresIn": Minutes,
    +  "memo": Memo,
    +  "recipientWalletId": WalletId
    +}
     
    -
    +
    -

    LnInvoice

    +

    LnNoAmountInvoiceFeeProbeInput

    @@ -9357,31 +13961,28 @@
    Fields
    - + - - - - - - @@ -9394,21 +13995,20 @@
    Fields
    Example
    {
    -  "paymentHash": PaymentHash,
    +  "amount": SatAmount,
       "paymentRequest": LnPaymentRequest,
    -  "paymentSecret": LnPaymentSecret,
    -  "satoshis": SatAmount
    +  "walletId": WalletId
     }
     
    -
    +
    -

    LnInvoiceCreateInput

    +

    LnNoAmountInvoicePayload

    @@ -9416,34 +14016,22 @@
    Fields
    Field NameInput Field Description
    paymentHash - PaymentHash! - -
    paymentRequest - LnPaymentRequest! + amount - SatAmount!
    paymentSecret - LnPaymentSecret! + + paymentRequest - LnPaymentRequest!
    satoshis - SatAmount + + walletId - WalletId!
    - + - - - - - - - - - -
    Input FieldField Name Description
    - amount - SatAmount! + errors - [Error!]! Amount in satoshis.
    - expiresIn - Minutes Optional invoice expiration time in minutes.
    - memo - Memo + invoice - LnNoAmountInvoice Optional memo for the lightning invoice.
    - walletId - WalletId! Wallet ID for a BTC wallet belonging to the current account.
    @@ -9453,21 +14041,19 @@
    Fields
    Example
    {
    -  "amount": SatAmount,
    -  "expiresIn": Minutes,
    -  "memo": Memo,
    -  "walletId": WalletId
    +  "errors": [Error],
    +  "invoice": LnNoAmountInvoice
     }
     
    -
    +
    -

    LnInvoiceCreateOnBehalfOfRecipientInput

    +

    LnNoAmountInvoicePaymentInput

    @@ -9484,32 +14070,25 @@
    Fields
    amount - SatAmount! - Amount in satoshis. - - - - descriptionHash - Hex32Bytes - - - + Amount to pay in satoshis. - expiresIn - Minutes + memo - Memo - Optional invoice expiration time in minutes. + Optional memo to associate with the lightning invoice. - memo - Memo + paymentRequest - LnPaymentRequest! - Optional memo for the lightning invoice. + Payment request representing the invoice which is being paid. - recipientWalletId - WalletId! + walletId - WalletId! - Wallet ID for a BTC wallet which belongs to any account. + Wallet ID with sufficient balance to cover amount defined in mutation request. Must belong to the account of the current user. @@ -9520,21 +14099,20 @@
    Fields
    Example
    {
       "amount": SatAmount,
    -  "descriptionHash": Hex32Bytes,
    -  "expiresIn": Minutes,
       "memo": Memo,
    -  "recipientWalletId": WalletId
    +  "paymentRequest": LnPaymentRequest,
    +  "walletId": WalletId
     }
     
    -
    +
    -

    LnInvoiceFeeProbeInput

    +

    LnNoAmountUsdInvoiceFeeProbeInput

    @@ -9547,6 +14125,13 @@
    Fields
    + + + amount - FractionalCentAmount! + + + + paymentRequest - LnPaymentRequest! @@ -9569,6 +14154,7 @@
    Fields
    Example
    {
    +  "amount": FractionalCentAmount,
       "paymentRequest": LnPaymentRequest,
       "walletId": WalletId
     }
    @@ -9577,11 +14163,11 @@ 
    Example
    -
    +
    -

    LnInvoicePayload

    +

    LnNoAmountUsdInvoicePaymentInput

    @@ -9589,22 +14175,34 @@
    Fields
    - + - + + + + - + + + +
    Field NameInput Field Description
    errors - [Error!]! + + amount - FractionalCentAmount! Amount to pay in USD cents.
    + memo - Memo Optional memo to associate with the lightning invoice.
    invoice - LnInvoice + + paymentRequest - LnPaymentRequest! Payment request representing the invoice which is being paid.
    + walletId - WalletId! Wallet ID with sufficient balance to cover amount defined in mutation request. Must belong to the account of the current user.
    @@ -9614,19 +14212,76 @@
    Fields
    Example
    {
    -  "errors": [Error],
    -  "invoice": LnInvoice
    +  "amount": FractionalCentAmount,
    +  "memo": Memo,
    +  "paymentRequest": LnPaymentRequest,
    +  "walletId": WalletId
     }
     
    -
    +
    +
    + Types +
    +

    LnPaymentPreImage

    +
    +
    +
    +
    +
    +
    Example
    +
    LnPaymentPreImage
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    LnPaymentRequest

    +
    +
    +
    +
    Description
    +

    BOLT11 lightning invoice payment request with the amount included

    +
    +
    +
    +
    +
    Example
    +
    LnPaymentRequest
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    LnPaymentSecret

    +
    +
    +
    +
    +
    +
    Example
    +
    LnPaymentSecret
    +
    +
    +
    +
    +
    +
    -

    LnInvoicePaymentInput

    +

    LnUpdate

    @@ -9634,28 +14289,28 @@
    Fields
    - + + - + - + -
    Input FieldField Name Description
    paymentHash - PaymentHash! + - memo - Memo Optional memo to associate with the lightning invoice.
    status - InvoicePaymentStatus! + - paymentRequest - LnPaymentRequest! Payment request representing the invoice which is being paid.
    walletId - WalletId! + - walletId - WalletId! Wallet ID with sufficient balance to cover amount of invoice. Must belong to the account of the current user.
    @@ -9665,8 +14320,8 @@
    Fields
    Example
    {
    -  "memo": Memo,
    -  "paymentRequest": LnPaymentRequest,
    +  "paymentHash": PaymentHash,
    +  "status": "EXPIRED",
       "walletId": WalletId
     }
     
    @@ -9674,11 +14329,11 @@
    Example
    -
    +
    -

    LnInvoicePaymentStatusInput

    +

    LnUsdInvoiceCreateInput

    @@ -9693,52 +14348,27 @@
    Fields
    - paymentRequest - LnPaymentRequest! - - + amount - FractionalCentAmount! + Amount in USD cents. - - -
    -
    -
    -
    -
    Example
    -
    {"paymentRequest": LnPaymentRequest}
    -
    -
    -
    -
    -
    -
    -
    - Types -
    -

    LnInvoicePaymentStatusPayload

    -
    -
    -
    -
    Fields
    - - - - + + - - - + - +
    Field NameDescription + expiresIn - Minutes + Optional invoice expiration time in minutes.
    errors - [Error!]! - + memo - Memo Optional memo for the lightning invoice.
    status - InvoicePaymentStatus - + walletId - WalletId! Wallet ID for a USD wallet belonging to the current user.
    @@ -9747,17 +14377,22 @@
    Fields
    Example
    -
    {"errors": [Error], "status": "EXPIRED"}
    +                  
    {
    +  "amount": FractionalCentAmount,
    +  "expiresIn": Minutes,
    +  "memo": Memo,
    +  "walletId": WalletId
    +}
     
    -
    +
    -

    LnNoAmountInvoice

    +

    LnUsdInvoiceCreateOnBehalfOfRecipientInput

    @@ -9765,28 +14400,41 @@
    Fields
    - + - + - - + + + + + + + +
    Field NameInput Field Description
    paymentHash - PaymentHash! - + amount - FractionalCentAmount! Amount in USD cents.
    paymentRequest - LnPaymentRequest! + + descriptionHash - Hex32Bytes
    paymentSecret - LnPaymentSecret! + + expiresIn - Minutes + Optional invoice expiration time in minutes.
    + memo - Memo Optional memo for the lightning invoice. Acts as a note to the recipient.
    + recipientWalletId - WalletId! Wallet ID for a USD wallet which belongs to the account of any user.
    @@ -9796,20 +14444,22 @@
    Fields
    Example
    {
    -  "paymentHash": PaymentHash,
    -  "paymentRequest": LnPaymentRequest,
    -  "paymentSecret": LnPaymentSecret
    +  "amount": FractionalCentAmount,
    +  "descriptionHash": Hex32Bytes,
    +  "expiresIn": Minutes,
    +  "memo": Memo,
    +  "recipientWalletId": WalletId
     }
     
    -
    +
    -

    LnNoAmountInvoiceCreateInput

    +

    LnUsdInvoiceFeeProbeInput

    @@ -9824,21 +14474,17 @@
    Fields
    - expiresIn - Minutes + paymentRequest - LnPaymentRequest! - Optional invoice expiration time in minutes. - - - memo - Memo - Optional memo for the lightning invoice. walletId - WalletId! - ID for either a USD or BTC wallet belonging to the account of the current user. + + @@ -9848,8 +14494,7 @@
    Fields
    Example
    {
    -  "expiresIn": Minutes,
    -  "memo": Memo,
    +  "paymentRequest": LnPaymentRequest,
       "walletId": WalletId
     }
     
    @@ -9857,11 +14502,32 @@
    Example
    -
    +
    -

    LnNoAmountInvoiceCreateOnBehalfOfRecipientInput

    +

    Lnurl

    +
    +
    +
    +
    Description
    +

    A bech32-encoded HTTPS/Onion URL that can be interacted with automatically by a WALLET in a standard way such that a SERVICE can provide extra services or a better experience for the user. Ref: https://github.com/lnurl/luds/blob/luds/01.md

    +
    +
    +
    +
    +
    Example
    +
    Lnurl
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    LnurlPaymentSendInput

    @@ -9876,21 +14542,27 @@
    Fields
    - expiresIn - Minutes + amount - FractionalCentAmount! - Optional invoice expiration time in minutes. + Amount to spend from the USD/USDT wallet, in USD cents. + + + + lnurl - Lnurl! + + LNURL-pay value to decode and pay. memo - Memo - Optional memo for the lightning invoice. + Optional memo for the Lightning payment. - recipientWalletId - WalletId! + walletId - WalletId! - ID for either a USD or BTC wallet which belongs to the account of any user. + Wallet ID with sufficient balance. Must belong to the current user. @@ -9900,20 +14572,21 @@
    Fields
    Example
    {
    -  "expiresIn": Minutes,
    +  "amount": FractionalCentAmount,
    +  "lnurl": Lnurl,
       "memo": Memo,
    -  "recipientWalletId": WalletId
    +  "walletId": WalletId
     }
     
    -
    +
    -

    LnNoAmountInvoiceFeeProbeInput

    +

    MapInfo

    @@ -9921,28 +14594,19 @@
    Fields
    - + - - - - - - @@ -9955,20 +14619,19 @@
    Fields
    Example
    {
    -  "amount": SatAmount,
    -  "paymentRequest": LnPaymentRequest,
    -  "walletId": WalletId
    +  "coordinates": Coordinates,
    +  "title": "abc123"
     }
     
    -
    +
    -

    LnNoAmountInvoicePayload

    +

    MapMarker

    @@ -9982,13 +14645,13 @@
    Fields
    - - @@ -10001,19 +14664,40 @@
    Fields
    Example
    {
    -  "errors": [Error],
    -  "invoice": LnNoAmountInvoice
    +  "mapInfo": MapInfo,
    +  "username": Username
     }
     
    -
    +
    -

    LnNoAmountInvoicePaymentInput

    +

    Memo

    +
    +
    +
    +
    Description
    +

    Text field in a lightning payment transaction

    +
    +
    +
    +
    +
    Example
    +
    Memo
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    Merchant

    @@ -10021,34 +14705,43 @@
    Fields
    Input FieldField Name Description
    - amount - SatAmount! - -
    - paymentRequest - LnPaymentRequest! + coordinates - Coordinates!
    - walletId - WalletId! + title - String!
    errors - [Error!]! + mapInfo - MapInfo!
    invoice - LnNoAmountInvoice + username - Username
    - + - - + + - + - + - + + + + + + + +
    Input FieldField Name Description
    - amount - SatAmount! + coordinates - Coordinates! Amount to pay in satoshis. GPS coordinates for the merchant that can be used to place the related business on a map
    createdAt - Timestamp! + - memo - Memo Optional memo to associate with the lightning invoice.
    id - ID! + - paymentRequest - LnPaymentRequest! Payment request representing the invoice which is being paid.
    title - String! + - walletId - WalletId! Wallet ID with sufficient balance to cover amount defined in mutation request. Must belong to the account of the current user.
    username - Username! + The username of the merchant
    validated - Boolean! + Whether the merchant has been validated
    @@ -10058,21 +14751,23 @@
    Fields
    Example
    {
    -  "amount": SatAmount,
    -  "memo": Memo,
    -  "paymentRequest": LnPaymentRequest,
    -  "walletId": WalletId
    +  "coordinates": Coordinates,
    +  "createdAt": 1592577642,
    +  "id": 4,
    +  "title": "xyz789",
    +  "username": Username,
    +  "validated": false
     }
     
    -
    +
    -

    LnNoAmountUsdInvoiceFeeProbeInput

    +

    MerchantMapSuggestInput

    @@ -10087,21 +14782,28 @@
    Fields
    - amount - FractionalCentAmount! + latitude - Float! - paymentRequest - LnPaymentRequest! + longitude - Float! - walletId - WalletId! + title - String! + + + + + + + username - Username! @@ -10114,20 +14816,21 @@
    Fields
    Example
    {
    -  "amount": FractionalCentAmount,
    -  "paymentRequest": LnPaymentRequest,
    -  "walletId": WalletId
    +  "latitude": 123.45,
    +  "longitude": 987.65,
    +  "title": "abc123",
    +  "username": Username
     }
     
    -
    +
    -

    LnNoAmountUsdInvoicePaymentInput

    +

    MerchantPayload

    @@ -10135,34 +14838,22 @@
    Fields
    - + - - - - - - - - - -
    Input FieldField Name Description
    - amount - FractionalCentAmount! + errors - [Error!]! Amount to pay in USD cents.
    - memo - Memo Optional memo to associate with the lightning invoice.
    - paymentRequest - LnPaymentRequest! + merchant - Merchant Payment request representing the invoice which is being paid.
    - walletId - WalletId! Wallet ID with sufficient balance to cover amount defined in mutation request. Must belong to the account of the current user.
    @@ -10172,76 +14863,92 @@
    Fields
    Example
    {
    -  "amount": FractionalCentAmount,
    -  "memo": Memo,
    -  "paymentRequest": LnPaymentRequest,
    -  "walletId": WalletId
    +  "errors": [Error],
    +  "merchant": Merchant
     }
     
    -
    -
    - Types -
    -

    LnPaymentPreImage

    -
    -
    -
    -
    -
    -
    Example
    -
    LnPaymentPreImage
    -
    -
    -
    -
    -
    -
    +
    -

    LnPaymentRequest

    +

    Minutes

    Description
    -

    BOLT11 lightning invoice payment request with the amount included

    +

    (Positive) amount of minutes

    Example
    -
    LnPaymentRequest
    +                  
    Minutes
     
    -
    +
    -

    LnPaymentSecret

    +

    MobileVersions

    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    currentSupported - Int! + +
    minSupported - Int! + +
    platform - String! + +
    +
    Example
    -
    LnPaymentSecret
    +                  
    {
    +  "currentSupported": 123,
    +  "minSupported": 123,
    +  "platform": "xyz789"
    +}
     
    -
    +
    -

    LnUpdate

    +

    MyUpdatesPayload

    @@ -10255,19 +14962,19 @@
    Fields
    - paymentHash - PaymentHash! + errors - [Error!]! - status - InvoicePaymentStatus! + me - User - walletId - WalletId! + update - UserUpdate @@ -10280,55 +14987,59 @@
    Fields
    Example
    {
    -  "paymentHash": PaymentHash,
    -  "status": "EXPIRED",
    -  "walletId": WalletId
    +  "errors": [Error],
    +  "me": User,
    +  "update": IntraLedgerUpdate
     }
     
    -
    +
    -

    LnUsdInvoiceCreateInput

    +

    Network

    -
    Fields
    +
    Values
    - + + - + - + - + -
    Input FieldEnum Value Description
    - amount - FractionalCentAmount! +

    mainnet

    +
    Amount in USD cents.
    - expiresIn - Minutes +

    regtest

    +
    Optional invoice expiration time in minutes.
    - memo - Memo +

    signet

    +
    Optional memo for the lightning invoice.
    - walletId - WalletId! +

    testnet

    +
    Wallet ID for a USD wallet belonging to the current user.
    @@ -10337,64 +15048,94 @@
    Fields
    Example
    -
    {
    -  "amount": FractionalCentAmount,
    -  "expiresIn": Minutes,
    -  "memo": Memo,
    -  "walletId": WalletId
    -}
    +                  
    "mainnet"
     
    -
    +
    -

    LnUsdInvoiceCreateOnBehalfOfRecipientInput

    +

    NotificationCategory

    +
    +
    +
    +
    +
    +
    Example
    +
    NotificationCategory
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    NotificationChannel

    -
    Fields
    +
    Values
    - + - - - - + +
    Input FieldEnum Value Description
    - amount - FractionalCentAmount! - Amount in USD cents.
    - descriptionHash - Hex32Bytes +

    PUSH

    +
    +
    +
    +
    +
    Example
    +
    "PUSH"
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    NotificationChannelSettings

    +
    +
    +
    +
    Fields
    + + - - + + + + + - + -
    - expiresIn - Minutes - Optional invoice expiration time in minutes. Field NameDescription
    disabledCategories - [NotificationCategory!]! + - memo - Memo Optional memo for the lightning invoice. Acts as a note to the recipient.
    enabled - Boolean! + - recipientWalletId - WalletId! Wallet ID for a USD wallet which belongs to the account of any user.
    @@ -10404,22 +15145,19 @@
    Fields
    Example
    {
    -  "amount": FractionalCentAmount,
    -  "descriptionHash": Hex32Bytes,
    -  "expiresIn": Minutes,
    -  "memo": Memo,
    -  "recipientWalletId": WalletId
    +  "disabledCategories": [NotificationCategory],
    +  "enabled": false
     }
     
    -
    +
    -

    LnUsdInvoiceFeeProbeInput

    +

    NotificationSettings

    @@ -10427,21 +15165,13 @@
    Fields
    - + - - - - - @@ -10453,41 +15183,38 @@
    Fields
    Example
    -
    {
    -  "paymentRequest": LnPaymentRequest,
    -  "walletId": WalletId
    -}
    +                  
    {"push": NotificationChannelSettings}
     
    -
    +
    -

    Lnurl

    +

    OnChainAddress

    Description
    -

    A bech32-encoded HTTPS/Onion URL that can be interacted with automatically by a WALLET in a standard way such that a SERVICE can provide extra services or a better experience for the user. Ref: https://github.com/lnurl/luds/blob/luds/01.md

    +

    An address for an on-chain bitcoin destination

    Example
    -
    Lnurl
    +                  
    OnChainAddress
     
    -
    +
    -

    MapInfo

    +

    OnChainAddressCreateInput

    @@ -10495,19 +15222,14 @@
    Fields
    Input FieldField Name Description
    - paymentRequest - LnPaymentRequest! - -
    - walletId - WalletId! + push - NotificationChannelSettings!
    - + - - - - @@ -10519,20 +15241,17 @@
    Fields
    Example
    -
    {
    -  "coordinates": Coordinates,
    -  "title": "abc123"
    -}
    +                  
    {"walletId": WalletId}
     
    -
    +
    -

    MapMarker

    +

    OnChainAddressCurrentInput

    @@ -10540,19 +15259,14 @@
    Fields
    Field NameInput Field Description
    coordinates - Coordinates! - -
    title - String! + walletId - WalletId!
    - + - - - - @@ -10564,41 +15278,62 @@
    Fields
    Example
    -
    {
    -  "mapInfo": MapInfo,
    -  "username": Username
    -}
    +                  
    {"walletId": WalletId}
     
    -
    +
    -

    Memo

    +

    OnChainAddressPayload

    -
    -
    Description
    -

    Text field in a lightning payment transaction

    +
    +
    Fields
    +
    Field NameInput Field Description
    mapInfo - MapInfo! - -
    username - Username + walletId - WalletId!
    + + + + + + + + + + + + + + + + +
    Field NameDescription
    address - OnChainAddress + +
    errors - [Error!]! + +
    Example
    -
    Memo
    +                  
    {
    +  "address": OnChainAddress,
    +  "errors": [Error]
    +}
     
    -
    +
    -

    Merchant

    +

    OnChainPaymentSendAllInput

    @@ -10606,43 +15341,38 @@
    Fields
    - + - - - - - - - - - - - - -
    Field NameInput Field Description
    coordinates - Coordinates! - GPS coordinates for the merchant that can be used to place the related business on a map
    createdAt - Timestamp! + + address - OnChainAddress!
    id - ID! + + memo - Memo
    title - String! + + speed - PayoutSpeed
    username - Username! + + walletId - WalletId! The username of the merchant
    validated - Boolean! + Whether the merchant has been validated
    @@ -10652,23 +15382,21 @@
    Fields
    Example
    {
    -  "coordinates": Coordinates,
    -  "createdAt": 1592577642,
    -  "id": "4",
    -  "title": "abc123",
    -  "username": Username,
    -  "validated": true
    +  "address": OnChainAddress,
    +  "memo": Memo,
    +  "speed": "FAST",
    +  "walletId": WalletId
     }
     
    -
    +
    -

    MerchantMapSuggestInput

    +

    OnChainPaymentSendInput

    @@ -10683,28 +15411,35 @@
    Fields
    - latitude - Float! + address - OnChainAddress! - longitude - Float! + amount - SatAmount! - title - String! + memo - Memo - username - Username! + speed - PayoutSpeed + + + + + + + walletId - WalletId! @@ -10717,21 +15452,22 @@
    Fields
    Example
    {
    -  "latitude": 123.45,
    -  "longitude": 123.45,
    -  "title": "xyz789",
    -  "username": Username
    +  "address": OnChainAddress,
    +  "amount": SatAmount,
    +  "memo": Memo,
    +  "speed": "FAST",
    +  "walletId": WalletId
     }
     
    -
    +
    -

    MerchantPayload

    +

    OnChainTxFee

    @@ -10745,13 +15481,7 @@
    Fields
    - errors - [Error!]! - - - - - - merchant - Merchant + amount - SatAmount! @@ -10763,41 +15493,34 @@
    Fields
    Example
    -
    {
    -  "errors": [Error],
    -  "merchant": Merchant
    -}
    +                  
    {"amount": SatAmount}
     
    -
    +
    -

    Minutes

    +

    OnChainTxHash

    -
    -
    Description
    -

    (Positive) amount of minutes

    -
    Example
    -
    Minutes
    +                  
    OnChainTxHash
     
    -
    +
    -

    MobileVersions

    +

    OnChainUpdate

    @@ -10811,19 +15534,38 @@
    Fields
    - currentSupported - Int! + amount - SatAmount! - minSupported - Int! + displayCurrencyPerSat - Float! - platform - String! + txHash - OnChainTxHash! + + + + + + txNotificationType - TxNotificationType! + + + + + + usdPerSat - Float! + + + updated over displayCurrencyPerSat + + + + walletId - WalletId! @@ -10836,20 +15578,23 @@
    Fields
    Example
    {
    -  "currentSupported": 987,
    -  "minSupported": 123,
    -  "platform": "abc123"
    +  "amount": SatAmount,
    +  "displayCurrencyPerSat": 987.65,
    +  "txHash": OnChainTxHash,
    +  "txNotificationType": "IntraLedgerPayment",
    +  "usdPerSat": 987.65,
    +  "walletId": WalletId
     }
     
    -
    +
    -

    MyUpdatesPayload

    +

    OnChainUsdPaymentSendAsBtcDenominatedInput

    @@ -10857,25 +15602,42 @@
    Fields
    - + - - - + + + + + + + + @@ -10888,110 +15650,65 @@
    Fields
    Example
    {
    -  "errors": [Error],
    -  "me": User,
    -  "update": IntraLedgerUpdate
    +  "address": OnChainAddress,
    +  "amount": SatAmount,
    +  "memo": Memo,
    +  "speed": "FAST",
    +  "walletId": WalletId
     }
     
    -
    +
    -

    Network

    +

    OnChainUsdPaymentSendInput

    -
    Values
    +
    Fields
    Field NameInput Field Description
    errors - [Error!]! + + address - OnChainAddress!
    me - User + + amount - SatAmount!
    update - UserUpdate + + memo - Memo + +
    + speed - PayoutSpeed + +
    + walletId - WalletId!
    - + - -
    Enum ValueInput Field Description
    -

    mainnet

    + address - OnChainAddress!
    -

    regtest

    + amount - FractionalCentAmount!
    -

    signet

    + memo - Memo
    -

    testnet

    + speed - PayoutSpeed
    -
    -
    -
    -
    -
    Example
    -
    "mainnet"
    -
    -
    -
    -
    -
    -
    -
    - Types -
    -

    NotificationCategory

    -
    -
    -
    -
    -
    -
    Example
    -
    NotificationCategory
    -
    -
    -
    -
    -
    -
    -
    - Types -
    -

    NotificationChannel

    -
    -
    -
    -
    Values
    - - - - - - - - @@ -11003,17 +15720,23 @@
    Values
    Example
    -
    "PUSH"
    +                  
    {
    +  "address": OnChainAddress,
    +  "amount": FractionalCentAmount,
    +  "memo": Memo,
    +  "speed": "FAST",
    +  "walletId": WalletId
    +}
     
    -
    +
    -

    NotificationChannelSettings

    +

    OnChainUsdTxFee

    @@ -11027,13 +15750,7 @@
    Fields
    - - - - - @@ -11045,20 +15762,17 @@
    Fields
    Example
    -
    {
    -  "disabledCategories": [NotificationCategory],
    -  "enabled": false
    -}
    +                  
    {"amount": FractionalCentAmount}
     
    -
    +
    -

    NotificationSettings

    +

    OneDayAccountLimit

    @@ -11072,10 +15786,19 @@
    Fields
    - - + + + + + + + +
    Enum ValueDescription
    -

    PUSH

    + walletId - WalletId!
    disabledCategories - [NotificationCategory!]! - -
    enabled - Boolean! + amount - FractionalCentAmount!
    push - NotificationChannelSettings! + interval - Seconds + The rolling time interval value in seconds for the current 24 hour period.
    remainingLimit - CentAmount + The amount of cents remaining below the limit for the current 24 hour period.
    totalLimit - CentAmount! The current maximum limit for a given 24 hour period.
    @@ -11084,93 +15807,77 @@
    Fields
    Example
    -
    {"push": NotificationChannelSettings}
    +                  
    {
    +  "interval": Seconds,
    +  "remainingLimit": CentAmount,
    +  "totalLimit": CentAmount
    +}
     
    -
    +
    -

    OnChainAddress

    +

    OneTimeAuthCode

    Description
    -

    An address for an on-chain bitcoin destination

    +

    An authentication code valid for a single use

    Example
    -
    OnChainAddress
    +                  
    OneTimeAuthCode
     
    -
    +
    -

    OnChainAddressCreateInput

    +

    PageInfo

    +
    +
    Description
    +

    Information about pagination in a connection.

    +
    Fields
    - + - - + - -
    Input FieldField Name Description
    - walletId - WalletId! - + endCursor - String When paginating forwards, the cursor to continue.
    -
    -
    -
    -
    -
    Example
    -
    {"walletId": WalletId}
    -
    -
    -
    -
    -
    -
    -
    - Types -
    -

    OnChainAddressCurrentInput

    -
    -
    -
    -
    Fields
    - - - - + + - - - - + + + +
    Input FieldDescriptionhasNextPage - Boolean! + When paginating forwards, are there more items?
    - walletId - WalletId! + hasPreviousPage - Boolean! + When paginating backwards, are there more items?
    startCursor - String When paginating backwards, the cursor to continue.
    @@ -11179,62 +15886,39 @@
    Fields
    Example
    -
    {"walletId": WalletId}
    +                  
    {
    +  "endCursor": "abc123",
    +  "hasNextPage": false,
    +  "hasPreviousPage": true,
    +  "startCursor": "abc123"
    +}
     
    -
    +
    -

    OnChainAddressPayload

    +

    PaymentHash

    -
    -
    Fields
    - - - - - - - - - - - - - - - - - -
    Field NameDescription
    address - OnChainAddress - -
    errors - [Error!]! - -
    -
    Example
    -
    {
    -  "address": OnChainAddress,
    -  "errors": [Error]
    -}
    +                  
    PaymentHash
     
    -
    +
    -

    OnChainPaymentSendAllInput

    +

    PaymentSendPayload

    @@ -11242,35 +15926,19 @@
    Fields
    - + - - - - - - - - - - @@ -11280,67 +15948,55 @@
    Fields
    -
    -
    Example
    -
    {
    -  "address": OnChainAddress,
    -  "memo": Memo,
    -  "speed": "FAST",
    -  "walletId": WalletId
    -}
    +                
    +
    Example
    +
    {"errors": [Error], "status": "ALREADY_PAID"}
     
    -
    +
    -

    OnChainPaymentSendInput

    +

    PaymentSendResult

    -
    Fields
    +
    Values
    Input FieldField Name Description
    - address - OnChainAddress! - -
    - memo - Memo - -
    - speed - PayoutSpeed + errors - [Error!]!
    - walletId - WalletId! + status - PaymentSendResult
    - + - - - - @@ -11352,37 +16008,32 @@
    Fields
    Example
    -
    {
    -  "address": OnChainAddress,
    -  "amount": SatAmount,
    -  "memo": Memo,
    -  "speed": "FAST",
    -  "walletId": WalletId
    -}
    +                  
    "ALREADY_PAID"
     
    -
    +
    -

    OnChainTxFee

    +

    PayoutSpeed

    -
    Fields
    +
    Values
    Input FieldEnum Value Description
    - address - OnChainAddress! - -
    - amount - SatAmount! +

    ALREADY_PAID

    - memo - Memo +

    FAILURE

    - speed - PayoutSpeed +

    PENDING

    - walletId - WalletId! +

    SUCCESS

    - + - @@ -11394,79 +16045,60 @@
    Fields
    Example
    -
    {"amount": SatAmount}
    +                  
    "FAST"
     
    -
    +
    -

    OnChainTxHash

    +

    Phone

    +
    +
    Description
    +

    Phone number which includes country code

    +
    Example
    -
    OnChainTxHash
    +                  
    Phone
     
    -
    +
    -

    OnChainUpdate

    +

    PhoneCodeChannelType

    -
    Fields
    +
    Values
    Field NameEnum Value Description
    amount - SatAmount! + +

    FAST

    - + - - - - - - - - - - - - - - - - @@ -11478,67 +16110,53 @@
    Fields
    Example
    -
    {
    -  "amount": SatAmount,
    -  "displayCurrencyPerSat": 123.45,
    -  "txHash": OnChainTxHash,
    -  "txNotificationType": "IntraLedgerPayment",
    -  "usdPerSat": 123.45,
    -  "walletId": WalletId
    -}
    +                  
    "SMS"
     
    -
    +
    -

    OnChainUsdPaymentSendAsBtcDenominatedInput

    +

    Price

    +
    +
    Description
    +

    Price amount expressed in base/offset. To calculate, use: base / 10^offset

    +
    Fields
    Field NameEnum Value Description
    amount - SatAmount! - -
    displayCurrencyPerSat - Float! - -
    txHash - OnChainTxHash! - -
    txNotificationType - TxNotificationType! +

    SMS

    usdPerSat - Float! - - updated over displayCurrencyPerSat -
    walletId - WalletId! +

    WHATSAPP

    - + - - - - - - - - @@ -11551,65 +16169,68 @@
    Fields
    Example
    {
    -  "address": OnChainAddress,
    -  "amount": SatAmount,
    -  "memo": Memo,
    -  "speed": "FAST",
    -  "walletId": WalletId
    +  "base": 9007199254740991,
    +  "currencyUnit": "xyz789",
    +  "formattedAmount": "abc123",
    +  "offset": 987
     }
     
    -
    +
    -

    OnChainUsdPaymentSendInput

    +

    PriceGraphRange

    +
    +
    Description
    +

    The range for the X axis in the BTC price graph

    +
    -
    Fields
    +
    Values
    Input FieldField Name Description
    - address - OnChainAddress! - -
    - amount - SatAmount! + base - SafeInt!
    - memo - Memo + currencyUnit - String!
    - speed - PayoutSpeed + formattedAmount - String!
    - walletId - WalletId! + offset - Int!
    - + @@ -11621,23 +16242,17 @@
    Fields
    Example
    -
    {
    -  "address": OnChainAddress,
    -  "amount": FractionalCentAmount,
    -  "memo": Memo,
    -  "speed": "FAST",
    -  "walletId": WalletId
    -}
    +                  
    "FIVE_YEARS"
     
    -
    +
    -

    OnChainUsdTxFee

    +

    PriceInput

    @@ -11645,61 +16260,31 @@
    Fields
    Input FieldEnum Value Description
    - address - OnChainAddress! +

    FIVE_YEARS

    - amount - FractionalCentAmount! +

    ONE_DAY

    - memo - Memo +

    ONE_MONTH

    - speed - PayoutSpeed +

    ONE_WEEK

    - walletId - WalletId! +

    ONE_YEAR

    - + - - -
    Field NameInput Field Description
    amount - CentAmount! + + amount - SatAmount!
    -
    -
    -
    -
    -
    Example
    -
    {"amount": CentAmount}
    -
    -
    -
    -
    -
    -
    -
    - Types -
    -

    OneDayAccountLimit

    -
    -
    -
    -
    Fields
    - - - - - - - - - - - - - - - + -
    Field NameDescription
    interval - Seconds + + amountCurrencyUnit - ExchangeCurrencyUnit! The rolling time interval value in seconds for the current 24 hour period.
    remainingLimit - CentAmount + The amount of cents remaining below the limit for the current 24 hour period.
    totalLimit - CentAmount! + + priceCurrencyUnit - ExchangeCurrencyUnit! + The current maximum limit for a given 24 hour period.
    @@ -11709,48 +16294,23 @@
    Fields
    Example
    {
    -  "interval": Seconds,
    -  "remainingLimit": CentAmount,
    -  "totalLimit": CentAmount
    +  "amount": SatAmount,
    +  "amountCurrencyUnit": "BTCSAT",
    +  "priceCurrencyUnit": "BTCSAT"
     }
     
    -
    -
    - Types -
    -

    OneTimeAuthCode

    -
    -
    -
    -
    Description
    -

    An authentication code valid for a single use

    -
    -
    -
    -
    -
    Example
    -
    OneTimeAuthCode
    -
    -
    -
    -
    -
    -
    +
    -

    PageInfo

    +

    PriceInterface

    -
    -
    -
    Description
    -

    Information about pagination in a connection.

    -
    -
    +
    +
    Fields
    @@ -11761,24 +16321,50 @@
    Fields
    - + - - + - - - + + + +
    endCursor - String + base - SafeInt! + When paginating forwards, the cursor to continue.
    hasNextPage - Boolean! + currencyUnit - String! + + Deprecated due to type renaming When paginating forwards, are there more items?
    hasPreviousPage - Boolean! + offset - Int! When paginating backwards, are there more items? +
    +
    +
    +
    Possible Types
    + + + + + + - + + + + + + -
    PriceInterface Types
    startCursor - String + +

    PriceOfOneSatInMinorUnit

    +
    +

    PriceOfOneSettlementMinorUnitInDisplayMinorUnit

    +
    +

    PriceOfOneUsdCentInMinorUnit

    When paginating backwards, the cursor to continue.
    @@ -11788,40 +16374,26 @@
    Fields
    Example
    {
    -  "endCursor": "xyz789",
    -  "hasNextPage": false,
    -  "hasPreviousPage": false,
    -  "startCursor": "xyz789"
    +  "base": 9007199254740991,
    +  "currencyUnit": "xyz789",
    +  "offset": 987
     }
     
    -
    +
    -

    PaymentHash

    +

    PriceOfOneSatInMinorUnit

    -
    -
    -
    -
    Example
    -
    PaymentHash
    -
    +
    +
    Description
    +

    Price of 1 sat in base/offset. To calculate, use: base / 10^offset

    -
    -
    -
    -
    -
    - Types -
    -

    PaymentSendPayload

    -
    -
    Fields
    @@ -11833,13 +16405,20 @@
    Fields
    - - + + + + @@ -11851,53 +16430,59 @@
    Fields
    Example
    -
    {"errors": [Error], "status": "ALREADY_PAID"}
    +                  
    {
    +  "base": 9007199254740991,
    +  "currencyUnit": "xyz789",
    +  "offset": 123
    +}
     
    -
    +
    -

    PaymentSendResult

    +

    PriceOfOneSettlementMinorUnitInDisplayMinorUnit

    +
    +
    Description
    +

    Price of 1 sat or 1 usd cent in base/offset. To calculate, use: base / 10^offset

    +
    -
    Values
    +
    Fields
    errors - [Error!]! + base - SafeInt!
    status - PaymentSendResult + currencyUnit - String! + + Deprecated due to type renaming +
    offset - Int!
    - + - - - - @@ -11909,32 +16494,53 @@
    Values
    Example
    -
    "ALREADY_PAID"
    +                  
    {
    +  "base": 9007199254740991,
    +  "currencyUnit": "xyz789",
    +  "formattedAmount": "abc123",
    +  "offset": 987
    +}
     
    -
    +
    -

    PayoutSpeed

    +

    PriceOfOneUsdCentInMinorUnit

    +
    +
    Description
    +

    Price of 1 usd cent in base/offset. To calculate, use: base / 10^offset

    +
    -
    Values
    +
    Fields
    Enum ValueField Name Description
    -

    ALREADY_PAID

    +
    base - SafeInt!
    -

    FAILURE

    +
    currencyUnit - String! + Deprecated due to type renaming
    -

    PENDING

    +
    formattedAmount - String! + Deprecated please use base / 10^offset
    -

    SUCCESS

    +
    offset - Int!
    - + + + + + + + + + @@ -11946,60 +16552,41 @@
    Values
    Example
    -
    "FAST"
    -
    -
    -
    - - -
    -
    - Types -
    -

    Phone

    -
    -
    -
    -
    Description
    -

    Phone number which includes country code

    -
    -
    -
    -
    -
    Example
    -
    Phone
    +                  
    {
    +  "base": 9007199254740991,
    +  "currencyUnit": "xyz789",
    +  "offset": 123
    +}
     
    -
    +
    -

    PhoneCodeChannelType

    +

    PricePayload

    -
    Values
    +
    Fields
    Enum ValueField Name Description
    base - SafeInt! + -

    FAST

    +
    currencyUnit - String! + + Deprecated due to type renaming +
    offset - Int!
    - + - - @@ -12011,23 +16598,19 @@
    Values
    Example
    -
    "SMS"
    +                  
    {"errors": [Error], "price": Price}
     
    -
    +
    -

    Price

    +

    PricePoint

    -
    -
    Description
    -

    Price amount expressed in base/offset. To calculate, use: base / 10^offset

    -
    Fields
    Enum ValueField Name Description
    -

    SMS

    +
    errors - [Error!]!
    -

    WHATSAPP

    +
    price - Price
    @@ -12039,28 +16622,15 @@
    Fields
    - - - - - - - - - - - +
    base - SafeInt! - -
    currencyUnit - String! - -
    formattedAmount - String! + price - Price!
    offset - Int! - + timestamp - Timestamp! Unix timestamp (number of seconds elapsed since January 1, 1970 00:00:00 UTC)
    @@ -12069,69 +16639,47 @@
    Fields
    Example
    -
    {
    -  "base": 9007199254740991,
    -  "currencyUnit": "abc123",
    -  "formattedAmount": "abc123",
    -  "offset": 123
    -}
    +                  
    {"price": Price, "timestamp": 1592577642}
     
    -
    +
    -

    PriceGraphRange

    +

    PublicWallet

    Description
    -

    The range for the X axis in the BTC price graph

    +

    A public view of a generic wallet which stores value in one of our supported currencies.

    -
    Values
    +
    Fields
    - + - - - - - - - - - - - - + @@ -12143,17 +16691,21 @@
    Values
    Example
    -
    "FIVE_YEARS"
    +                  
    {
    +  "id": "4",
    +  "lnurlp": Lnurl,
    +  "walletCurrency": "BTC"
    +}
     
    -
    +
    -

    PriceInput

    +

    Quiz

    @@ -12161,28 +16713,24 @@
    Fields
    Enum ValueField Name Description
    -

    FIVE_YEARS

    -
    -
    -

    ONE_DAY

    -
    -
    -

    ONE_MONTH

    +
    id - ID!
    -

    ONE_WEEK

    +
    lnurlp - Lnurl
    -

    ONE_YEAR

    +
    walletCurrency - WalletCurrency!
    - + - - + - - @@ -12194,48 +16742,32 @@
    Fields
    Example
    -
    {
    -  "amount": SatAmount,
    -  "amountCurrencyUnit": "BTCSAT",
    -  "priceCurrencyUnit": "BTCSAT"
    -}
    +                  
    {"amount": SatAmount, "completed": false, "id": 4}
     
    -
    +
    -

    PriceInterface

    +

    QuizCompletedInput

    -
    +
    Fields
    Input FieldField Name Description
    - amount - SatAmount! - + amount - SatAmount! The reward in Satoshis for the quiz question
    - amountCurrencyUnit - ExchangeCurrencyUnit! + completed - Boolean!
    - priceCurrencyUnit - ExchangeCurrencyUnit! + id - ID!
    - + - - - - - - - - @@ -12243,28 +16775,43 @@
    Fields
    Field NameInput Field Description
    base - SafeInt! - -
    currencyUnit - String! - - Deprecated due to type renaming -
    offset - Int! + id - ID!
    -
    -
    Possible Types
    +
    +
    +
    +
    Example
    +
    {"id": "4"}
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    QuizCompletedPayload

    +
    +
    +
    +
    Fields
    - + + - - - + @@ -12274,27 +16821,19 @@
    Possible Types
    Example
    -
    {
    -  "base": 9007199254740991,
    -  "currencyUnit": "xyz789",
    -  "offset": 123
    -}
    +                  
    {"errors": [Error], "quiz": Quiz}
     
    -
    +
    -

    PriceOfOneSatInMinorUnit

    +

    QuizQuestion

    -
    -
    Description
    -

    Price of 1 sat in base/offset. To calculate, use: base / 10^offset

    -
    Fields
    PriceInterface TypesField NameDescription
    -

    PriceOfOneSatInMinorUnit

    +
    errors - [Error!]!
    -

    PriceOfOneSettlementMinorUnitInDisplayMinorUnit

    quiz - Quiz + -

    PriceOfOneUsdCentInMinorUnit

    @@ -12306,20 +16845,12 @@
    Fields
    - - - - - - + - @@ -12331,27 +16862,19 @@
    Fields
    Example
    -
    {
    -  "base": 9007199254740991,
    -  "currencyUnit": "abc123",
    -  "offset": 987
    -}
    +                  
    {"earnAmount": SatAmount, "id": 4}
     
    -
    +
    -

    PriceOfOneSettlementMinorUnitInDisplayMinorUnit

    +

    RealtimePrice

    -
    -
    Description
    -

    Price of 1 sat or 1 usd cent in base/offset. To calculate, use: base / 10^offset

    -
    Fields
    base - SafeInt! - -
    currencyUnit - String! - - Deprecated due to type renaming + earnAmount - SatAmount! The earn reward in Satoshis for the quiz question
    offset - Int! + id - ID!
    @@ -12363,27 +16886,30 @@
    Fields
    - - - - + + + + @@ -12396,52 +16922,37 @@
    Fields
    Example
    {
    -  "base": 9007199254740991,
    -  "currencyUnit": "xyz789",
    -  "formattedAmount": "abc123",
    -  "offset": 987
    +  "btcSatPrice": PriceOfOneSatInMinorUnit,
    +  "denominatorCurrency": DisplayCurrency,
    +  "id": "4",
    +  "timestamp": 1592577642,
    +  "usdCentPrice": PriceOfOneUsdCentInMinorUnit
     }
     
    -
    +
    -

    PriceOfOneUsdCentInMinorUnit

    +

    RealtimePriceInput

    -
    -
    Description
    -

    Price of 1 usd cent in base/offset. To calculate, use: base / 10^offset

    -
    Fields
    base - SafeInt! + btcSatPrice - PriceOfOneSatInMinorUnit!
    currencyUnit - String! + denominatorCurrency - DisplayCurrency! - Deprecated due to type renaming
    formattedAmount - String! + id - ID! - Deprecated please use base / 10^offset
    offset - Int! + timestamp - Timestamp! + Unix timestamp (number of seconds elapsed since January 1, 1970 00:00:00 UTC)
    usdCentPrice - PriceOfOneUsdCentInMinorUnit!
    - + - - - - - - - - @@ -12453,21 +16964,17 @@
    Fields
    Example
    -
    {
    -  "base": 9007199254740991,
    -  "currencyUnit": "abc123",
    -  "offset": 123
    -}
    +                  
    {"currency": DisplayCurrency}
     
    -
    +
    -

    PricePayload

    +

    RealtimePricePayload

    @@ -12487,7 +16994,7 @@
    Fields
    - @@ -12499,17 +17006,20 @@
    Fields
    Example
    -
    {"errors": [Error], "price": Price}
    +                  
    {
    +  "errors": [Error],
    +  "realtimePrice": RealtimePrice
    +}
     
    -
    +
    -

    PricePoint

    +

    RequestCashoutInput

    @@ -12517,21 +17027,28 @@
    Fields
    Field NameInput Field Description
    base - SafeInt! - -
    currencyUnit - String! - - Deprecated due to type renaming -
    offset - Int! + currency - DisplayCurrency
    price - Price + realtimePrice - RealtimePrice
    - + - + + + + - - +
    Field NameInput Field Description
    price - Price! + + amount - USDCents! Amount in USD cents.
    + bankAccountId - ID! ERPNext bank account identifier to receive the cashout.
    timestamp - Timestamp! + + walletId - WalletId! Unix timestamp (number of seconds elapsed since January 1, 1970 00:00:00 UTC) ID for a USD wallet belonging to the current user.
    @@ -12540,23 +17057,23 @@
    Fields
    Example
    -
    {"price": Price, "timestamp": 1592577642}
    +                  
    {
    +  "amount": USDCents,
    +  "bankAccountId": "4",
    +  "walletId": WalletId
    +}
     
    -
    +
    -

    PublicWallet

    +

    RequestCashoutResponse

    -
    -
    Description
    -

    A public view of a generic wallet which stores value in one of our supported currencies.

    -
    Fields
    @@ -12568,19 +17085,13 @@
    Fields
    - - - - - - @@ -12592,17 +17103,62 @@
    Fields
    Example
    -
    {"id": 4, "lnurlp": Lnurl, "walletCurrency": "BTC"}
    +                  
    {
    +  "errors": [Error],
    +  "offer": CashoutOffer
    +}
    +
    +
    +
    + + +
    +
    + Types +
    +

    SafeInt

    +
    +
    +
    +
    Description
    +

    Non-fractional signed whole numeric value between -(2^53) + 1 and 2^53 - 1

    +
    +
    +
    +
    +
    Example
    +
    9007199254740991
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    SatAmount

    +
    +
    +
    +
    Description
    +

    (Positive) Satoshi amount

    +
    +
    +
    +
    +
    Example
    +
    SatAmount
     
    -
    +
    -

    Quiz

    +

    SatAmountPayload

    @@ -12616,18 +17172,13 @@
    Fields
    - - - - - - @@ -12641,78 +17192,63 @@
    Fields
    Example
    {
       "amount": SatAmount,
    -  "completed": false,
    -  "id": "4"
    +  "errors": [Error]
     }
     
    -
    +
    -

    QuizCompletedInput

    +

    Seconds

    -
    -
    Fields
    -
    id - ID! - -
    lnurlp - Lnurl + errors - [Error!]!
    walletCurrency - WalletCurrency! + offer - CashoutOffer
    amount - SatAmount! - The reward in Satoshis for the quiz question
    completed - Boolean! + amount - SatAmount
    id - ID! + errors - [Error!]!
    - - - - - - - - - - - - -
    Input FieldDescription
    - id - ID! - -
    +
    +
    Description
    +

    (Positive) amount of seconds

    Example
    -
    {"id": "4"}
    +                  
    Seconds
     
    -
    +
    -

    QuizCompletedPayload

    +

    SettlementVia

    -
    Fields
    +
    Types
    - - + - - + + @@ -12722,17 +17258,17 @@
    Fields
    Example
    -
    {"errors": [Error], "quiz": Quiz}
    +                  
    SettlementViaIntraLedger
     
    -
    +
    -

    QuizQuestion

    +

    SettlementViaIntraLedger

    @@ -12746,12 +17282,12 @@
    Fields
    - - + - @@ -12763,17 +17299,20 @@
    Fields
    Example
    -
    {"earnAmount": SatAmount, "id": 4}
    +                  
    {
    +  "counterPartyUsername": Username,
    +  "counterPartyWalletId": WalletId
    +}
     
    -
    +
    -

    RealtimePrice

    +

    SettlementViaLn

    @@ -12787,30 +17326,14 @@
    Fields
    - - - - - - - - - - - - - - @@ -12823,22 +17346,19 @@
    Fields
    Example
    {
    -  "btcSatPrice": PriceOfOneSatInMinorUnit,
    -  "denominatorCurrency": DisplayCurrency,
    -  "id": 4,
    -  "timestamp": 1592577642,
    -  "usdCentPrice": PriceOfOneUsdCentInMinorUnit
    +  "paymentSecret": LnPaymentSecret,
    +  "preImage": LnPaymentPreImage
     }
     
    -
    +
    -

    RealtimePriceInput

    +

    SettlementViaOnChain

    @@ -12846,14 +17366,19 @@
    Fields
    Field NameDescriptionUnion Types
    errors - [Error!]! - +

    SettlementViaIntraLedger

    quiz - Quiz + +

    SettlementViaLn

    +

    SettlementViaOnChain

    earnAmount - SatAmount! + counterPartyUsername - Username The earn reward in Satoshis for the quiz question Settlement destination: Could be null if the payee does not have a username
    id - ID! + counterPartyWalletId - WalletId
    btcSatPrice - PriceOfOneSatInMinorUnit! - -
    denominatorCurrency - DisplayCurrency! - -
    id - ID! + paymentSecret - LnPaymentSecret + Shifting property to 'preImage' to improve granularity of the LnPaymentSecret type
    timestamp - Timestamp! - Unix timestamp (number of seconds elapsed since January 1, 1970 00:00:00 UTC)
    usdCentPrice - PriceOfOneUsdCentInMinorUnit! + preImage - LnPaymentPreImage
    - + + + + + @@ -12865,17 +17390,80 @@
    Fields
    Example
    -
    {"currency": DisplayCurrency}
    +                  
    {"transactionHash": OnChainTxHash, "vout": 987}
     
    -
    +
    -

    RealtimePricePayload

    +

    SignedAmount

    +
    +
    +
    +
    Description
    +

    An amount (of a currency) that can be negative (e.g. in a transaction)

    +
    +
    +
    +
    +
    Example
    +
    SignedAmount
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    SignedDisplayMajorAmount

    +
    +
    +
    +
    Description
    +

    A string amount (of a currency) that can be negative (e.g. in a transaction)

    +
    +
    +
    +
    +
    Example
    +
    SignedDisplayMajorAmount
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    String

    +
    +
    +
    +
    Description
    +

    The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

    +
    +
    +
    +
    +
    Example
    +
    "abc123"
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    SuccessPayload

    @@ -12895,7 +17483,7 @@
    Fields
    - @@ -12907,152 +17495,194 @@
    Fields
    Example
    -
    {
    -  "errors": [Error],
    -  "realtimePrice": RealtimePrice
    -}
    +                  
    {"errors": [Error], "success": true}
     
    -
    +
    -

    SafeInt

    +

    Timestamp

    Description
    -

    Non-fractional signed whole numeric value between -(2^53) + 1 and 2^53 - 1

    +

    Timestamp field, serialized as Unix time (the number of seconds since the Unix epoch)

    Example
    -
    9007199254740991
    +                  
    1592577642
     
    -
    +
    -

    SatAmount

    +

    TotpCode

    Description
    -

    (Positive) Satoshi amount

    +

    A time-based one-time password

    Example
    -
    SatAmount
    +                  
    TotpCode
     
    -
    +
    -

    SatAmountPayload

    +

    TotpRegistrationId

    -
    -
    Fields
    -
    Input FieldField Name Description
    transactionHash - OnChainTxHash + - currency - DisplayCurrency +
    vout - Int
    realtimePrice - RealtimePrice + success - Boolean
    - - - - - - - - - - - - - - - - -
    Field NameDescription
    amount - SatAmount - -
    errors - [Error!]! - -
    +
    +
    Description
    +

    An id to be passed between set and verify for confirming totp

    Example
    -
    {
    -  "amount": SatAmount,
    -  "errors": [Error]
    -}
    +                  
    TotpRegistrationId
     
    -
    +
    -

    Seconds

    +

    TotpSecret

    Description
    -

    (Positive) amount of seconds

    +

    A secret to generate time-based one-time password

    Example
    -
    Seconds
    +                  
    TotpSecret
     
    -
    +
    -

    SettlementVia

    +

    Transaction

    +
    +
    Description
    +

    Give details about an individual transaction. Galoy have a smart routing system which is automatically settling intraledger when both the payer and payee use the same wallet therefore it's possible the transactions is being initiated onchain or with lightning but settled intraledger.

    +
    -
    Types
    +
    Fields
    - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -13062,19 +17692,38 @@
    Types
    Example
    -
    SettlementViaIntraLedger
    +                  
    {
    +  "createdAt": 1592577642,
    +  "direction": "RECEIVE",
    +  "id": 4,
    +  "initiationVia": InitiationViaIntraLedger,
    +  "memo": Memo,
    +  "settlementAmount": SignedAmount,
    +  "settlementCurrency": "BTC",
    +  "settlementDisplayAmount": SignedDisplayMajorAmount,
    +  "settlementDisplayCurrency": DisplayCurrency,
    +  "settlementDisplayFee": SignedDisplayMajorAmount,
    +  "settlementFee": SignedAmount,
    +  "settlementPrice": PriceOfOneSettlementMinorUnitInDisplayMinorUnit,
    +  "settlementVia": SettlementViaIntraLedger,
    +  "status": "FAILURE"
    +}
     
    -
    +
    -

    SettlementViaIntraLedger

    +

    TransactionConnection

    +
    +
    Description
    +

    A connection to a list of items.

    +
    Fields
    Union TypesField NameDescription
    createdAt - Timestamp! + +
    direction - TxDirection! + -

    SettlementViaIntraLedger

    id - ID! + -

    SettlementViaLn

    initiationVia - InitiationVia! + From which protocol the payment has been initiated.
    memo - Memo + +
    settlementAmount - SignedAmount! + Amount of the settlement currency sent or received.
    settlementCurrency - WalletCurrency! + Wallet currency for transaction.
    settlementDisplayAmount - SignedDisplayMajorAmount! + +
    settlementDisplayCurrency - DisplayCurrency! + +
    settlementDisplayFee - SignedDisplayMajorAmount! + +
    settlementFee - SignedAmount! + +
    settlementPrice - PriceOfOneSettlementMinorUnitInDisplayMinorUnit! + Price in WALLETCURRENCY/SETTLEMENTUNIT at time of settlement.
    settlementVia - SettlementVia! + To which protocol the payment has settled on.
    status - TxStatus! + -

    SettlementViaOnChain

    @@ -13086,15 +17735,14 @@
    Fields
    - - + - - +
    counterPartyUsername - Username + edges - [TransactionEdge!] Settlement destination: Could be null if the payee does not have a username A list of edges.
    counterPartyWalletId - WalletId - + pageInfo - PageInfo! Information to aid in pagination.
    @@ -13104,19 +17752,19 @@
    Fields
    Example
    {
    -  "counterPartyUsername": Username,
    -  "counterPartyWalletId": WalletId
    +  "edges": [TransactionEdge],
    +  "pageInfo": PageInfo
     }
     
    -
    +
    -

    SettlementViaLn

    +

    TransactionDetails

    @@ -13130,17 +17778,89 @@
    Fields
    - paymentSecret - LnPaymentSecret + accountId - String - - Shifting property to 'preImage' to improve granularity of the LnPaymentSecret type + Account ID associated with the transaction + + + address - String + Bitcoin address for onchain transactions - preImage - LnPaymentPreImage + amount - Float - + Transaction amount + + + confirmations - Int + + Number of confirmations for onchain transactions + + + createdAt - String + + Transaction creation timestamp + + + currency - String + + Transaction currency + + + fee - Float + + Transaction fee + + + id - String! + Transaction ID + + + invoice - String + + Lightning invoice (bolt11) + + + memo - String + + Transaction memo/description + + + paymentHash - String + + Lightning payment hash + + + paymentPreimage - String + + Lightning payment preimage + + + status - String + + Transaction status + + + txid - String + + Bitcoin transaction ID for onchain transactions + + + type - String + + Transaction type (lightning/onchain) + + + updatedAt - String + + Transaction last update timestamp + + + vout - Int + + Output index for onchain transactions @@ -13150,19 +17870,34 @@
    Fields
    Example
    {
    -  "paymentSecret": LnPaymentSecret,
    -  "preImage": LnPaymentPreImage
    +  "accountId": "abc123",
    +  "address": "abc123",
    +  "amount": 123.45,
    +  "confirmations": 987,
    +  "createdAt": "xyz789",
    +  "currency": "abc123",
    +  "fee": 987.65,
    +  "id": "abc123",
    +  "invoice": "xyz789",
    +  "memo": "abc123",
    +  "paymentHash": "abc123",
    +  "paymentPreimage": "abc123",
    +  "status": "xyz789",
    +  "txid": "abc123",
    +  "type": "abc123",
    +  "updatedAt": "abc123",
    +  "vout": 987
     }
     
    -
    +
    -

    SettlementViaOnChain

    +

    TransactionDetailsError

    @@ -13176,13 +17911,7 @@
    Fields
    - transactionHash - OnChainTxHash - - - - - - vout - Int + message - String! @@ -13194,80 +17923,53 @@
    Fields
    Example
    -
    {"transactionHash": OnChainTxHash, "vout": 987}
    -
    -
    -
    -
    -
    -
    -
    - Types -
    -

    SignedAmount

    -
    -
    -
    -
    Description
    -

    An amount (of a currency) that can be negative (e.g. in a transaction)

    -
    -
    -
    -
    -
    Example
    -
    SignedAmount
    -
    -
    -
    -
    -
    -
    -
    - Types -
    -

    SignedDisplayMajorAmount

    -
    -
    -
    -
    Description
    -

    A string amount (of a currency) that can be negative (e.g. in a transaction)

    -
    -
    -
    -
    -
    Example
    -
    SignedDisplayMajorAmount
    +                  
    {"message": "abc123"}
     
    -
    +
    -

    String

    +

    TransactionDetailsInput

    -
    -
    Description
    -

    The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + transactionId - String! + Transaction ID to fetch details for
    Example
    -
    "xyz789"
    +                  
    {"transactionId": "abc123"}
     
    -
    +
    -

    SuccessPayload

    +

    TransactionDetailsPayload

    @@ -13281,13 +17983,13 @@
    Fields
    - errors - [Error!]! + errors - [TransactionDetailsError!]! - success - Boolean + transactionDetails - TransactionDetails @@ -13299,192 +18001,161 @@
    Fields
    Example
    -
    {"errors": [Error], "success": false}
    -
    -
    -
    -
    -
    -
    -
    - Types -
    -

    Timestamp

    -
    -
    -
    -
    Description
    -

    Timestamp field, serialized as Unix time (the number of seconds since the Unix epoch)

    -
    -
    -
    -
    -
    Example
    -
    1592577642
    +                  
    {
    +  "errors": [TransactionDetailsError],
    +  "transactionDetails": TransactionDetails
    +}
     
    -
    +
    -

    TotpCode

    +

    TransactionEdge

    Description
    -

    A time-based one-time password

    -
    -
    -
    -
    -
    Example
    -
    TotpCode
    -
    +

    An edge in a connection.

    -
    -
    -
    -
    -
    - Types -
    -

    TotpRegistrationId

    -
    -
    -
    -
    Description
    -

    An id to be passed between set and verify for confirming totp

    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    cursor - String! + A cursor for use in pagination
    node - Transaction! + The item at the end of the edge
    Example
    -
    TotpRegistrationId
    +                  
    {
    +  "cursor": "xyz789",
    +  "node": Transaction
    +}
     
    -
    +
    -

    TotpSecret

    +

    TxDirection

    -
    -
    Description
    -

    A secret to generate time-based one-time password

    +
    +
    Values
    + + + + + + + + + + + + + + + + + +
    Enum ValueDescription
    +

    RECEIVE

    +
    +
    +

    SEND

    +
    +
    Example
    -
    TotpSecret
    +                  
    "RECEIVE"
     
    -
    +
    -

    Transaction

    +

    TxNotificationType

    -
    -
    Description
    -

    Give details about an individual transaction. Galoy have a smart routing system which is automatically settling intraledger when both the payer and payee use the same wallet therefore it's possible the transactions is being initiated onchain or with lightning but settled intraledger.

    -
    -
    Fields
    +
    Values
    - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -13496,57 +18167,49 @@
    Fields
    Example
    -
    {
    -  "createdAt": 1592577642,
    -  "direction": "RECEIVE",
    -  "id": "4",
    -  "initiationVia": InitiationViaIntraLedger,
    -  "memo": Memo,
    -  "settlementAmount": SignedAmount,
    -  "settlementCurrency": "BTC",
    -  "settlementDisplayAmount": SignedDisplayMajorAmount,
    -  "settlementDisplayCurrency": DisplayCurrency,
    -  "settlementDisplayFee": SignedDisplayMajorAmount,
    -  "settlementFee": SignedAmount,
    -  "settlementPrice": PriceOfOneSettlementMinorUnitInDisplayMinorUnit,
    -  "settlementVia": SettlementViaIntraLedger,
    -  "status": "FAILURE"
    -}
    +                  
    "IntraLedgerPayment"
     
    -
    +
    -

    TransactionConnection

    +

    TxStatus

    -
    -
    Description
    -

    A connection to a list of items.

    -
    -
    Fields
    +
    Values
    Field NameEnum Value Description
    createdAt - Timestamp! - -
    direction - TxDirection! +

    IntraLedgerPayment

    id - ID! - -
    initiationVia - InitiationVia! - From which protocol the payment has been initiated.
    memo - Memo +

    IntraLedgerReceipt

    settlementAmount - SignedAmount! - Amount of the settlement currency sent or received.
    settlementCurrency - WalletCurrency! - Wallet currency for transaction.
    settlementDisplayAmount - SignedDisplayMajorAmount! - -
    settlementDisplayCurrency - DisplayCurrency! +

    LnInvoicePaid

    settlementDisplayFee - SignedDisplayMajorAmount! - -
    settlementFee - SignedAmount! +

    OnchainPayment

    settlementPrice - PriceOfOneSettlementMinorUnitInDisplayMinorUnit! + +

    OnchainReceipt

    Price in WALLETCURRENCY/SETTLEMENTUNIT at time of settlement.
    settlementVia - SettlementVia! + To which protocol the payment has settled on.
    status - TxStatus! + +

    OnchainReceiptPending

    - + - + - - + + + + + -
    Field NameEnum Value Description
    edges - [TransactionEdge!] + +

    FAILURE

    +
    A list of edges.
    pageInfo - PageInfo! + +

    PENDING

    +
    +
    +

    SUCCESS

    +
    Information to aid in pagination.
    @@ -13555,45 +18218,56 @@
    Fields
    Example
    -
    {
    -  "edges": [TransactionEdge],
    -  "pageInfo": PageInfo
    -}
    +                  
    "FAILURE"
    +
    +
    +
    +
    +
    +
    +
    + Types +
    +

    USDCents

    +
    +
    +
    +
    Description
    +

    Amount in USD cents

    +
    +
    +
    +
    +
    Example
    +
    USDCents
     
    -
    +
    -

    TransactionEdge

    +

    UpdateExternalWalletInput

    -
    -
    Description
    -

    An edge in a connection.

    -
    Fields
    - + - - - - - -
    Field NameInput Field Description
    cursor - String! + + lnurlp - Lnurl! A cursor for use in pagination
    node - Transaction! + The item at the end of the edge
    @@ -13602,42 +18276,37 @@
    Fields
    Example
    -
    {
    -  "cursor": "abc123",
    -  "node": Transaction
    -}
    +                  
    {"lnurlp": Lnurl}
     
    -
    +
    -

    TxDirection

    +

    UpdateExternalWalletPayload

    -
    Values
    +
    Fields
    - + - - @@ -13649,67 +18318,46 @@
    Values
    Example
    -
    "RECEIVE"
    +                  
    {
    +  "errors": [Error],
    +  "walletId": WalletId
    +}
     
    -
    +
    -

    TxNotificationType

    +

    UpgradePayload

    -
    Values
    +
    Fields
    Enum ValueField Name Description
    -

    RECEIVE

    +
    errors - [Error!]!
    -

    SEND

    +
    walletId - WalletId
    - + - - - - - - - - - - - - - - - @@ -13721,94 +18369,149 @@
    Values
    Example
    -
    "IntraLedgerPayment"
    +                  
    {
    +  "authToken": AuthToken,
    +  "errors": [Error],
    +  "success": true
    +}
     
    -
    +
    -

    TxStatus

    +

    UsdWallet

    +
    +
    Description
    +

    A wallet belonging to an account which contains a USD balance and a list of transactions.

    +
    -
    Values
    +
    Fields
    Enum ValueField Name Description
    -

    IntraLedgerPayment

    -
    -
    -

    IntraLedgerReceipt

    -
    -
    -

    LnInvoicePaid

    -
    -
    -

    OnchainPayment

    +
    authToken - AuthToken
    -

    OnchainReceipt

    +
    errors - [Error!]!
    -

    OnchainReceiptPending

    +
    success - Boolean!
    - + - - - - -
    Enum ValueField Name Description
    -

    FAILURE

    +
    accountId - ID!
    -

    PENDING

    +
    balance - FractionalCentAmount
    -

    SUCCESS

    +
    id - ID!
    -
    -
    -
    -
    -
    Example
    -
    "FAILURE"
    -
    -
    -
    -
    -
    -
    -
    - Types -
    -

    UpgradePayload

    -
    -
    -
    -
    Fields
    - - - - + + - - - - + + + + + + + + + + + + + + - @@ -13821,25 +18524,31 @@
    Fields
    Example
    {
    -  "authToken": AuthToken,
    -  "errors": [Error],
    -  "success": false
    +  "accountId": 4,
    +  "balance": FractionalCentAmount,
    +  "id": "4",
    +  "isExternal": true,
    +  "lnurlp": Lnurl,
    +  "pendingIncomingBalance": SignedAmount,
    +  "transactions": TransactionConnection,
    +  "transactionsByAddress": TransactionConnection,
    +  "walletCurrency": "BTC"
     }
     
    -
    +
    -

    UsdWallet

    +

    UsdtWallet

    Description
    -

    A wallet belonging to an account which contains a USD balance and a list of transactions.

    +

    A wallet belonging to an account which contains a USDT balance and a list of transactions.

    Fields
    @@ -13858,7 +18567,7 @@
    Fields
    - @@ -13869,6 +18578,12 @@
    Fields
    + + + + @@ -13969,9 +18684,10 @@
    last
    Example
    {
    -  "accountId": 4,
    -  "balance": SignedAmount,
    -  "id": 4,
    +  "accountId": "4",
    +  "balance": FractionalCentAmount,
    +  "id": "4",
    +  "isExternal": true,
       "lnurlp": Lnurl,
       "pendingIncomingBalance": SignedAmount,
       "transactions": TransactionConnection,
    @@ -14000,6 +18716,11 @@ 
    Fields
    + + + + @@ -14088,12 +18809,13 @@
    username
    Example
    {
    +  "bankAccounts": [BankAccount],
       "contactByUsername": UserContact,
       "contacts": [UserContact],
       "createdAt": 1592577642,
       "defaultAccount": Account,
       "email": Email,
    -  "id": "4",
    +  "id": 4,
       "language": Language,
       "npub": npub,
       "phone": Phone,
    @@ -14190,7 +18912,7 @@ 
    Example
    "alias": ContactAlias, "id": Username, "transactions": TransactionConnection, - "transactionsCount": 987, + "transactionsCount": 123, "username": Username }
    @@ -14852,7 +19574,7 @@
    Fields
    Example
    -
    {"completed": false, "question": QuizQuestion}
    +                  
    {"completed": true, "question": QuizQuestion}
     
    @@ -14889,7 +19611,7 @@
    Fields
    Example
    -
    {"id": 4}
    +                  
    {"id": "4"}
     
    @@ -15545,7 +20267,7 @@
    Fields
    - @@ -15556,6 +20278,12 @@
    Fields
    + + + + @@ -15664,6 +20392,11 @@
    Possible Types

    BTCWallet

    + + + + + + +
    Field NameDescriptionisExternal - Boolean! + +
    authToken - AuthToken + lnurlp - Lnurl
    errors - [Error!]! + pendingIncomingBalance - SignedAmount! + An unconfirmed incoming onchain balance.
    transactions - TransactionConnection + +
    +
    +
    Arguments
    +
    +
    +
    after - String +
    +

    Returns the items in the list that come after the specified cursor.

    +
    +
    +
    before - String +
    +

    Returns the items in the list that come before the specified cursor.

    +
    +
    +
    first - Int +
    +

    Returns the first n items from the list.

    +
    +
    +
    last - Int +
    +

    Returns the last n items from the list.

    +
    +
    +
    +
    transactionsByAddress - TransactionConnection
    +
    +
    Arguments
    +
    +
    +
    address - OnChainAddress! +
    +

    Returns the items that include this address.

    +
    +
    +
    after - String +
    +

    Returns the items in the list that come after the specified cursor.

    +
    +
    +
    before - String +
    +

    Returns the items in the list that come before the specified cursor.

    +
    +
    +
    first - Int +
    +

    Returns the first n items from the list.

    +
    +
    +
    last - Int +
    +

    Returns the last n items from the list.

    +
    +
    +
    +
    success - Boolean! + walletCurrency - WalletCurrency!
    balance - SignedAmount! + balance - FractionalCentAmount
    isExternal - Boolean! + +
    lnurlp - Lnurl
    bankAccounts - [BankAccount!]! + Bank accounts available for cashout
    contactByUsername - UserContact!
    balance - SignedAmount! + balance - FractionalCentAmount
    isExternal - Boolean! + +
    lnurlp - Lnurl
    +

    UsdtWallet

    +

    UsdWallet

    @@ -15678,8 +20411,9 @@
    Possible Types
    Example
    {
       "accountId": 4,
    -  "balance": SignedAmount,
    -  "id": 4,
    +  "balance": FractionalCentAmount,
    +  "id": "4",
    +  "isExternal": false,
       "lnurlp": Lnurl,
       "pendingIncomingBalance": SignedAmount,
       "transactions": TransactionConnection,
    @@ -15722,6 +20456,13 @@ 
    Values
    +

    USDT

    +
    +
    @@ -15826,6 +20567,5 @@
    Example
    - - + \ No newline at end of file diff --git a/src/index.html b/src/index.html index ba079f6..810a928 100644 --- a/src/index.html +++ b/src/index.html @@ -267,9 +267,6 @@

    Endpoints

    -
    - ⚠️ Development Notice: The Flash API is currently under active development. All endpoints, parameters, and responses are subject to change and improvement. This documentation will be updated as the API evolves. -

    Flash GraphQL API

    This API provides access to Flash's Bitcoin and Lightning Network payment services for the Caribbean region.

    @@ -454,73 +451,7 @@

    Error Handling

    +
    ` + \u2190 Back to Overview` ); // Add version manager scripts