Skip to main content
Unlocks a user account.

Arguments

input
required
mutation unlockUser($input: UnlockUserInput!) {
  unlockUser(input: $input) {
    user {
      organization {
        id
        acceptors {
          items {
            id
            businessName
            name
            reference
            billingDescriptor {
              ...BillingDescriptorFragment
            }
            allocations {
              ...AllocationDetailCollectionFragment
            }
            fees {
              ...FeeCollectionFragment
            }
            feeSummaries {
              ...FeeSummaryCollectionFragment
            }
            fundingAchReturns {
              ...FundingAchReturnOutputCollectionFragment
            }
            fundingDisputeEvents {
              ...FundingDisputeEventOutputCollectionFragment
            }
            fundingSummaries {
              ...FundingSummaryCollectionFragment
            }
            fundingTransactions {
              ...FundingTransactionCollectionFragment
            }
            authorizationSummaries {
              ...AuthorizationSummaryCollectionFragment
            }
            paymentTransactions {
              ...PaymentTransactionCollectionFragment
            }
            paymentTransactionSummaries {
              ...PaymentTransactionSummaryCollectionFragment
            }
          }
          pageInfo {
            hasNextPage
            hasPreviousPage
          }
        }
        businessName
        legalName
        name
        allowedMerchantCategories {
          code
        }
        settings {
          access {
            acceptorBoarding
            underwriting
          }
        }
        businessAddress {
          address1
          address2
          address3
          city
          state
          postalCode
          countryCode
        }
        phoneNumber
        achNotificationsOfChange {
          items {
            organization {
              ...OrganizationFragment
            }
            acceptor {
              ...AcceptorFragment
            }
            id
            accountNumber
            accountNumberUpdated
            accountType
            accountTypeUpdated
            activityDate
            changeReasonCode
            changeReason
            routingNumber
            routingNumberUpdated
            transactionActivityDate
            transactionAmount
            transactionCurrency
            transactionDateTime
            transactionId
            transactionReference
            transactionType
            paymentId
          }
          pageInfo {
            hasNextPage
            hasPreviousPage
          }
        }
        achReturns {
          items {
            id
            acceptor {
              ...AcceptorFragment
            }
            accountNumberEndingIn
            accountOwnerName
            accountOwnerType
            accountType
            activityDate
            amount
            currency
            organization {
              ...OrganizationFragment
            }
            reasonCode
            reason
            routingNumber
            traceNumber
            transactionActivityDate
            transactionAmount
            paymentId
            transactionDateTime
            transactionId
            transactionReference
            transactionTraceNumber
            transactionType
          }
          pageInfo {
            hasNextPage
            hasPreviousPage
          }
        }
        allocations {
          items {
            organization {
              ...OrganizationFragment
            }
            acceptor {
              ...AcceptorFragment
            }
            presenterId
            rateUnitAmount
            rateMultiplier
            allocationType
            name
            description
            allocationCalculatedAmount
            productPillar
            activityDate
            transactionDateTime
            billableEventAmount
            accountNumberPrefix
            accountNumberSuffix
            paymentBrand
            paymentFundingSource
            fundingCurrency
            billableEventCurrency
            merchantCategory
            processingNetwork
            orderReference
            transactionReference
            transactionId
            fundsTransferDescriptor
            fundsReleaseDate
            fundsTransferId
            paymentId
            billableEventType
            paymentProduct
            consumerType
            billingEventSourceId
            billingEventSourceType
            perspective
          }
          pageInfo {
            hasNextPage
            hasPreviousPage
          }
        }
        authorizationSummaries {
          items {
            organization {
              ...OrganizationFragment
            }
            acceptor {
              ...AcceptorFragment
            }
            transactionCurrency
            transactionCount
            transactionAmountApproved
            transactionAmountRequested
            processorResponseCode
            processorResponseMessage
            avsResponse
            securityCodeNetworkResponse
            paymentChannel
            merchantCategory
            transactionType
            issuingBankName
            issuingBankCountry
            paymentProduct
            paymentFundingSource
            approvalStatus
            transactionActivityDate
            paymentBrand
            processingNetwork
          }
          pageInfo {
            hasNextPage
            hasPreviousPage
          }
        }
        fees {
          items {
            organization {
              ...OrganizationFragment
            }
            acceptor {
              ...AcceptorFragment
            }
            presenterId
            rateUnitAmount
            rateMultiplier
            feeType
            name
            description
            feeCalculatedAmount
            productPillar
            activityDate
            transactionDateTime
            billableEventAmount
            accountNumberPrefix
            accountNumberSuffix
            paymentBrand
            paymentFundingSource
            fundingCurrency
            billableEventCurrency
            merchantCategory
            processingNetwork
            orderReference
            transactionReference
            transactionId
            fundsTransferDescriptor
            fundsReleaseDate
            fundsTransferId
            paymentId
            billableEventType
            paymentProduct
            consumerType
            billingEventSourceId
            billingEventSourceType
            perspective
          }
          pageInfo {
            hasNextPage
            hasPreviousPage
          }
        }
        feeSummaries {
          items {
            organization {
              ...OrganizationFragment
            }
            acceptor {
              ...AcceptorFragment
            }
            feeActivityDate
            feeType
            billableEventType
            fundsReleaseDate
            feeName
            feeDescription
            productPillar
            feeProfileId
            fundingCurrency
            feeCount
            feeRateMultiplier
            feeRateUnitAmount
            feeAmount
            processingNetwork
            paymentBrand
            paymentProduct
            paymentFundingSource
            merchantCategory
            billableEventAmount
            fundsTransferId
            perspective
          }
          pageInfo {
            hasNextPage
            hasPreviousPage
          }
        }
        fundingAchReturns {
          items {
            id
            fundingAmount
            fundingCurrency
            fundsTransferDescriptor
            fundsTransferId
            fundsReleaseDate
            perspective
            acceptor {
              ...AcceptorFragment
            }
            accountNumberEndingIn
            accountOwnerName
            accountOwnerType
            accountType
            activityDate
            amount
            currency
            organization {
              ...OrganizationFragment
            }
            reasonCode
            reason
            routingNumber
            traceNumber
            transactionActivityDate
            transactionAmount
            paymentId
            transactionDateTime
            transactionId
            transactionReference
            transactionTraceNumber
            transactionType
          }
          pageInfo {
            hasNextPage
            hasPreviousPage
          }
        }
        fundingDisputeEvents {
          items {
            organization {
              ...OrganizationFragment
            }
            acceptor {
              ...AcceptorFragment
            }
            id
            acquirerReferenceNumber
            disputeId
            dateOfEvent
            fundingAmount
            fundingCurrency
            fundsTransferDescriptor
            fundsTransferId
            fundsReleaseDate
            lifeCycle
            paymentBrand
            paymentId
            processingNetwork
            transactionId
            transactionReference
            perspective
          }
          pageInfo {
            hasNextPage
            hasPreviousPage
          }
        }
        fundingSummaries {
          items {
            organization {
              ...OrganizationFragment
            }
            acceptor {
              ...AcceptorFragment
            }
            transactionActivityDate
            paymentBrand
            fundsTransferProfileId
            fundsTransferProfileName
            disputeReversalAmount
            disputeReversalCount
            acceptorPaymentsAmount
            miscCreditsAmount
            miscDebitsAmount
            miscCreditsCount
            miscDebitsCount
            miscAdjustmentsAmount
            processingNetwork
            fundingCurrency
            fundsTransferDescriptor
            fundsTransferId
            fundsTransfer {
              ...FundsTransferFragment
            }
            fundsReleaseDate
            processorFeesAmount
            networkFeesAmount
            interchangeFeesAmount
            partnerFeesAmount
            transactorFeesAmount
            salesGrossAmount
            refundsGrossAmount
            disputesGrossAmount
            disputesCreditAmount
            disputesCreditCount
            disputesDebitAmount
            disputesDebitCount
            disputesNetAmount
            reservesNetAmount
            thirdPartyPaymentAmount
            fundingNetAmount
            salesCount
            refundsCount
            fundedDisputesCount
            disputesCount
            feeAmount
            feesAmount
            salesNetAmount
            feesCount
            interchangeFeesCount
            networkFeesCount
            partnerFeesCount
            processorFeesCount
            serviceFeesAmount
            serviceFeesCount
            convenienceFeesAmount
            convenienceFeesCount
            surchargeAmount
            surchargeCount
            acceptorFundingNetAmount
            achReturnsAmount
            achReturnsCount
            acceptorAchReturnsAmount
            paymentChannel
            perspective
            acceptorNetworkFeesAmount
            acceptorInterchangeFeesAmount
            acceptorNetworkFeesCount
            acceptorInterchangeFeesCount
            acceptorDisputesNetAmount
            acceptorFeesCount
            acceptorFeesAmount
            acceptorSalesNetAmount
          }
          pageInfo {
            hasNextPage
            hasPreviousPage
          }
        }
        fundingTransactions {
          items {
            organization {
              ...OrganizationFragment
            }
            acceptor {
              ...AcceptorFragment
            }
            fundsTransferId
            fundsTransfer {
              ...FundsTransferFragment
            }
            fundsReleaseDate
            fundsTransferDescriptor
            fundingCurrency
            fundingGrossAmount
            interchangeFeesAmount
            networkFeesAmount
            acceptorInterchangeFeesAmount
            acceptorNetworkFeesAmount
            processorFeesAmount
            transactorFeesAmount
            partnerFeesAmount
            isPartnerFeeAdjusted
            convenienceFeesAmount
            serviceFeesAmount
            surchargeAmount
            fundingNetAmount
            paymentTransaction {
              ...PaymentTransactionFragment
            }
            perspective
          }
          pageInfo {
            hasNextPage
            hasPreviousPage
          }
        }
        reportAvailability {
          dateType
          availabilityStartDate
          availabilityEndDate
        }
        paymentTransactions {
          items {
            id
            reference
            billingDescriptor
            paymentId
            activityDate
            transactionDateTime
            processingNetwork
            organization {
              ...OrganizationFragment
            }
            acceptor {
              ...AcceptorFragment
            }
            transactionType
            businessApplicationId
            fees {
              ...FeeDetailsFragment
            }
            taxes {
              ...TaxesFragment
            }
            amountDetails {
              ...AmountDetailsFragment
            }
            lineItems {
              ...LineItemFragment
            }
            taxIdentificationNumber
            processorResponseCode
            processorResponseMessage
            merchantCategory
            responseType
            paymentMethod {
              ...PaymentMethodFragment
            }
            resultLabel
          }
          pageInfo {
            hasNextPage
            hasPreviousPage
          }
        }
        paymentTransactionSummaries {
          items {
            organization {
              ...OrganizationFragment
            }
            acceptor {
              ...AcceptorFragment
            }
            paymentBrand
            processingNetwork
            conveyedStatus
            transactionCurrency
            transactionCount
            transactionType
            transactionAmount
            transactionActivityDate
            paymentFundingSource
            transactionProcessingDecision
            presenterId
            paymentChannel
          }
          pageInfo {
            hasNextPage
            hasPreviousPage
          }
        }
        acceptorApplicationCounts {
          acceptorApplicationStatus
          total
        }
      }
      permissions {
        id
        key
        name
        description
      }
      id
      address {
        address1
        address2
        address3
        city
        state
        postalCode
        countryCode
      }
      defaultOrganizationId
      email
      jobTitle
      lastLoggedInDateTime
      name
      phoneNumber
      status
      embeddedBankAccounts {
        id
        nickname
        accountNumber
        routingNumber
      }
      externalBankAccounts {
        id
        accountNumber
        routingNumber
        nickname
        type
        verificationStatus
        accountStatus
        nameOnAccount
        usersWithAccess {
          organization {
            id
            acceptors {
              ...AcceptorCollectionFragment
            }
            businessName
            legalName
            name
            allowedMerchantCategories {
              ...MerchantCategoryFragment
            }
            settings {
              ...OrganizationSettingsOutputFragment
            }
            businessAddress {
              ...AddressOutputFragment
            }
            phoneNumber
            achNotificationsOfChange {
              ...AchNotificationOfChangeCollectionFragment
            }
            achReturns {
              ...AchReturnCollectionFragment
            }
            allocations {
              ...AllocationDetailCollectionFragment
            }
            authorizationSummaries {
              ...AuthorizationSummaryCollectionFragment
            }
            fees {
              ...FeeCollectionFragment
            }
            feeSummaries {
              ...FeeSummaryCollectionFragment
            }
            fundingAchReturns {
              ...FundingAchReturnOutputCollectionFragment
            }
            fundingDisputeEvents {
              ...FundingDisputeEventOutputCollectionFragment
            }
            fundingSummaries {
              ...FundingSummaryCollectionFragment
            }
            fundingTransactions {
              ...FundingTransactionCollectionFragment
            }
            reportAvailability {
              ...ReportAvailabilityFragment
            }
            paymentTransactions {
              ...PaymentTransactionCollectionFragment
            }
            paymentTransactionSummaries {
              ...PaymentTransactionSummaryCollectionFragment
            }
            acceptorApplicationCounts {
              ...AcceptorApplicationCountsFragment
            }
          }
          permissions {
            id
            key
            name
            description
          }
          id
          address {
            address1
            address2
            address3
            city
            state
            postalCode
            countryCode
          }
          defaultOrganizationId
          email
          jobTitle
          lastLoggedInDateTime
          name
          phoneNumber
          status
          embeddedBankAccounts {
            id
            nickname
            accountNumber
            routingNumber
          }
          externalBankAccounts {
            id
            accountNumber
            routingNumber
            nickname
            type
            verificationStatus
            accountStatus
            nameOnAccount
            usersWithAccess {
              ...UserFragment
            }
          }
          type
        }
      }
      type
    }
    errors {
      ... on AuthenticationError {
        advice
        code
        message
      }
      ... on ForbiddenError {
        advice
        code
        message
      }
    }
  }
}

Response

Returns a UnlockUserPayload
{
  "data": {
    "unlockUser": {
      "user": User,
      "errors": [
        AuthenticationError
      ]
    }
  }
}