Skip to main content
Retrieves external accounts for the authenticated organization.

Arguments

input
required

Fields

items
required
pageInfo
required
query externalBankAccounts($input: ExternalBankAccountInput!) {
  externalBankAccounts(input: $input) {
    items {
      id
      accountNumber
      routingNumber
      nickname
      type
      verificationStatus
      accountStatus
      nameOnAccount
      usersWithAccess {
        organization {
          id
          acceptors {
            items {
              ...AcceptorFragment
            }
            pageInfo {
              ...PageInfoFragment
            }
          }
          businessName
          legalName
          name
          allowedMerchantCategories {
            code
          }
          settings {
            access {
              ...OrganizationAccessSettingsFragment
            }
          }
          businessAddress {
            address1
            address2
            address3
            city
            state
            postalCode
            countryCode
          }
          phoneNumber
          achNotificationsOfChange {
            items {
              ...AchNotificationOfChangeFragment
            }
            pageInfo {
              ...PageInfoFragment
            }
          }
          achReturns {
            items {
              ...AchReturnFragment
            }
            pageInfo {
              ...PageInfoFragment
            }
          }
          allocations {
            items {
              ...AllocationDetailFragment
            }
            pageInfo {
              ...PageInfoFragment
            }
          }
          authorizationSummaries {
            items {
              ...AuthorizationSummaryFragment
            }
            pageInfo {
              ...PageInfoFragment
            }
          }
          fees {
            items {
              ...FeeFragment
            }
            pageInfo {
              ...PageInfoFragment
            }
          }
          feeSummaries {
            items {
              ...FeeSummaryFragment
            }
            pageInfo {
              ...PageInfoFragment
            }
          }
          fundingAchReturns {
            items {
              ...FundingAchReturnOutputFragment
            }
            pageInfo {
              ...PageInfoFragment
            }
          }
          fundingDisputeEvents {
            items {
              ...FundingDisputeEventOutputFragment
            }
            pageInfo {
              ...PageInfoFragment
            }
          }
          fundingSummaries {
            items {
              ...FundingSummaryFragment
            }
            pageInfo {
              ...PageInfoFragment
            }
          }
          fundingTransactions {
            items {
              ...FundingTransactionFragment
            }
            pageInfo {
              ...PageInfoFragment
            }
          }
          reportAvailability {
            dateType
            availabilityStartDate
            availabilityEndDate
          }
          paymentTransactions {
            items {
              ...PaymentTransactionFragment
            }
            pageInfo {
              ...PageInfoFragment
            }
          }
          paymentTransactionSummaries {
            items {
              ...PaymentTransactionSummaryFragment
            }
            pageInfo {
              ...PageInfoFragment
            }
          }
          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 {
              ...OrganizationFragment
            }
            permissions {
              ...PermissionFragment
            }
            id
            address {
              ...AddressOutputFragment
            }
            defaultOrganizationId
            email
            jobTitle
            lastLoggedInDateTime
            name
            phoneNumber
            status
            embeddedBankAccounts {
              ...EmbeddedBankAccountFragment
            }
            externalBankAccounts {
              ...ExternalBankAccountFragment
            }
            type
          }
        }
        type
      }
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
    }
  }
}

Response

Returns a ExternalBankAccountCollection
{
  "data": {
    "externalBankAccounts": {
      "items": [
        ExternalBankAccount
      ],
      "pageInfo": PageInfo
    }
  }
}