---
title: "Search for batches"
method: GET
path: "/eclipse-conductor/rest/v1/global/batches"
tags: ["z) Global Functionality"]
---

# Search for batches

`GET /eclipse-conductor/rest/v1/global/batches`

Returns a paginated list of batch history records, optionally filtered by type, status, date range, and other criteria.

## Query parameters

- `activateFromDate` string
- `activateToDate` string
- `closedFromDate` string
- `closedToDate` string
- `createdBy` string
- `dateFromIncl` string
- `dateToExcl` string
- `includeCreatorDetails` boolean
- `includeProductDetails` boolean
- `limit` integer
- `offset` integer
- `organisationId` string
- `productId` string
- `subType` string
- `supplierId` string
- `tenantId` string
- `type` string, required

## Response `200`

OK

- EclipseBatchHistory[]
  - `activatedDate` string, date-time
  - `batchId` integer
  - `batchNumber` string
  - `batchType` 'IMPORT_COMPLIANCE' | 'POSTILION_CARDS' | 'POSTILION_QRCODE' | 'PRODUCT_BATCH' | 'RATIFY_BATCH' | 'RATIFY_SDN' | 'TNX_HISTORY'
  - `callBackId` integer
  - `callbackUrl` string
  - `closedDate` string, date-time
  - `created` string, date-time
  - `createdBy` integer
  - `creator` EclipseCustomer — A customer of a Tenant. A physical human being with a legal identity. Customers can be grouped into an organisation if needed. Customers can belong to multiple organisations. Customers link to an organisation is through the posiiton they hold in that organisation.
    - `accountableInstitutionCif` string
    - `additionalIdentityNumber` string — Additional identity number
    - `address` EclipseAddress — A physical, postal or other type of address that can be captured against an organisation or customer
      - `addressId` integer — Unique system generated identifier for an address
      - `addressType` 'BRANCH' | 'HEADQUARTERS' | 'OPERATING' | 'PHYSICAL' | 'POSTAL' | 'PRIMARY' | 'REGISTERED', required
      - `city` string, required
      - `code` string
      - `country` string, required
      - `customerId` integer — The customer the address is for
      - `gpsLatitude` number — GPS latitude of the address in decimal degrees
      - `gpsLongitude` number — GPS longitude of the address in decimal degrees
      - `line1` string, required
      - `line2` string
      - `line3` string
      - `organisationId` integer — The organisation the address is for
      - `state` string, required
      - `tenantId` integer
      - `version` integer, required — A number indicating the version of the record. Updates will only be accepted if the passed in version is the same as the current version on record. This is in order to prevent concurrent modifications by multiple users.
    - `asylumCountryOfIssuance` string — ISO Alpha-2 country code for Issue of Asylum
    - `asylumDateOfIssuance` string — Mandatory If the asylum number is provided and must be in form of yyyyMMdd
    - `asylumPaperExpiry` string — Mandatory If the asylum ref number is provided and must be in form of yyyyMMdd
    - `asylumRefNumber` string — Asylum ref number
    - `birthCity` string — Customer City of birth
    - `birthCountry` string — Customer Country of birth - Eclipse will support ISO two character, all the existing countries will be replaced by the ISO two character country code. For example if 'South Africa' has added as Birth Country it will be replaced by 'ZA'
    - `communicationPreference` 'EMAIL' | 'PUSH' | 'SMS' | 'TEMPLATE'
    - `countryOfResidence` string — Customer's resident country
    - `countryOfTaxation` string — FATCA/CRS: ISO country code of taxation jurisdiction
    - `created` string, date-time — ISO 8601 date/time of when the record was first created
    - `customerId` integer — Unique system generated identifier for a customer
    - `dateOfBirth` string — Customer Date of birth must be in form of yyyyMMdd
    - `email` string — Customers email address
    - `externalUniqueId` string — A globally unique identifier set by the tenant for this customer. Useful for correlating between the tenants systems and Eclipse
    - `firstName` string — Customer first/given name
    - `gender` 'F' | 'M' | 'O' — Gender. M:Male, F:Female, O:Other
    - `industry` string — Industry customer belongs to
    - `isForeignTaxResident` boolean — FATCA/CRS: Whether the customer is a foreign tax resident
    - `lastModified` string, date-time — ISO 8601 date/time of when the record was last modified
    - `lastName` string — Customers last/family name
    - `locale` string — ISO 639-1 language code of the customer
    - `maidenName` string — Customers maiden name
    - `maritalStatus` 'D' | 'M' | 'S' | 'W' — Maritial status of the customer. S:Single, M:Married, D:Divorced, W:Widowed
    - `middleName` string — Customers middle name
    - `monthlyIncome` integer — Customer's expected income per month
    - `nationalIdentityCountryOfIssuance` string — ISO Alpha-2 country code for Issue of National Identity
    - `nationalIdentityDateOfIssuance` string — Mandatory If the national identity number is provided and must be in form of yyyyMMdd
    - `nationalIdentityExpiry` string — Mandatory If the national identity number is provided and must be in form of yyyyMMdd
    - `nationalIdentityNumber` string — National identity number
    - `nationalIdentitySerialNumber` string — national identity serial number of customer
    - `nationality` string — Nationality of Customer
    - `nextMandatoryKycDate` string, date-time
    - `nextOfKinInfo` string — Next of kin info as a json
    - `other` string
    - `passportCountry` string — ISO Alpha-2 country code
    - `passportDateOfIssuance` string — Mandatory If the passport number is provided and must be in form of yyyyMMdd
    - `passportExpiry` string — Mandatory If the passport number is provided and must be in form of yyyyMMdd
    - `passportNumber` string — National identity number
    - `passportPlaceOfIssuance` string — Mandatory If the passport number is provided.
    - `permitExpiry` string — Mandatory If the PERMIT is provided and must be in form of yyyyMMdd.
    - `permitNumber` string — Permit number
    - `phone1` string — Customers primary phone number
    - `phone2` string — Customers secondary phone number
    - `positions` EclipseCustomerPosition[] — Positions the customer has in organisations. Only populated if the fields parameter has positions in it
      - `division` EclipseDivision
        - `divisionId` integer
        - `divisionName` string, required
        - `organisationId` integer, required
      - `divisionId` integer
      - `organisation` EclipseOrganisation — A company, organisation or grouping of customers which can in turn own a wallet, have an address or have associated documents. Typically known as a Juristic but organisation can also include just a grouping of people like a family, club or association.
        - `bankDetails` Avp[]
          - `att` string, required
          - `val` string, required
        - `businessRegistrationDate` string — Business registration date must be in form of yyyyMMdd
        - `businessType` 'CLOSE_CORPORATION' | 'LIMITED_COMPANY' | 'PARTNERSHIP' | 'PERSONAL_LIABILITY_COMPANY' | 'PUBLIC_LISTED_COMPANY' | 'SOLE_PROPRIETOR' | 'STATE_OWNED_COMPANY' | 'TRUST' | 'UNREGISTERED'
        - `categoryCode` integer — Four digit Category code for this organisation.
        - `companyNumber` string — Legal company number of the organisation
        - `created` string, date-time — ISO 8601 date/time of when the record was first created
        - `email` string — Email address of the organisation
        - `externalUniqueId` string — A globally unique identifier set by the tenant for this organisation. Useful for correlating between the tenants systems and Eclipse
        - `industrialClassification` string
        - `industrialSector` string
        - `lastModified` string, date-time — ISO 8601 date/time of when the record was last modified
        - `merchantId` string — Merchant Id used for some card payment types to the organisations wallet
        - `name` string — Name of the organisation
        - `organisationId` integer — Unique system generated identifier for an organisation
        - `phone1` string, required — Organisations primary phone number
        - `phone2` string — Organisations secondary phone number
        - `status` 'ACTIVE' | 'BARRED' | 'INACTIVE' — Status of the eclipse organisation. ACTIVE:Organisation is active, INACTIVE:Organisation is in active, BARRED:Organisation is in barred
        - `taxNumber` string — Tax number of the organisation
        - `tenantId` integer
        - `tradingName` string
        - `type` 'BUSINESS' | 'CLUB' | 'FAMILY' | 'MERCHANT' | 'OTHER' | 'PERMISSION_GROUP' | 'RAP' — OrganisationType
        - `vatNumber` string — VAT number of organisation
        - `version` integer, required — A number indicating the version of the record. Updates will only be accepted if the passed in version is the same as the current version on record. This is in order to prevent concurrent modifications by multiple users.
      - `organisationId` integer, required
      - `position` 'DIRECTOR' | 'EMPLOYEE' | 'HEAD' | 'MANAGER' | 'MEMBER' | 'OWNER' | 'PARTNER' | 'PRIMARY_CONTACT', required
    - `profession` string — Customer's profession
    - `profileCompletionStatus` integer — Determines if the customer can update their own Profile, Adddress,Documents. This int is a bitmask. Least significant bit (bit 1) means the basic profile data like last name is complete and cannot be changed by the customer themselves. Bit 2 indicates Address data cannot be changed. Bit 3 means documents are complete. Bit 4 means attachments are complete. Bit 5 means DOB is complete. But 6 means National Identity number is complete. E.g. To disallow changing attachments, documents, and addresses only, this int would be set as 001110 = 14
    - `purposeOfUse` string — Purpose of business Relationship
    - `reasonCode` 'DUE_DILIGENCE' | 'EXCON' | 'FRAUD' | 'LEGAL' | 'NONE' | 'REGULATORY' | 'RISK'
    - `riskRating` string
    - `riskScore` number — Customers are assigned a risk score based on their KYC information. The score is determined by various factors and helps financial institutions manage risk and prevent fraud or losses.
    - `schoolName` string — School name of customer
    - `sourceOfFunds` string — Customer's source of fund
    - `sourceOfWealth` string
    - `ssn` string — FATCA/CRS: US Social Security Number
    - `status` 'ACTIVE' | 'BARRED' | 'INACTIVE' — Status of the eclipse customer. ACTIVE:Customer is Active, INACTIVE customer is INACTIVE
    - `taxNumber` string — Tax number of customer
    - `temporaryIdentityExpiry` string — Mandatory If the temporary Id is provided and must be in form of yyyyMMdd. User should enter temporaryIdentityExpiry = issue date + 2 months
    - `tenantId` integer — The unique identifier of the tenant this customer belongs to
    - `title` 'CHIEF' | 'DR' | 'MISS' | 'MR' | 'MRS' | 'MS' | 'SIR'
    - `userTypeId` integer
    - `version` integer, required — A number indicating the version of the record. Updates will only be accepted if the passed in version is the same as the current version on record. This is in order to prevent concurrent modifications by multiple users.
    - `walletRiskScore` number — Wallet risk score is calculated by multiplying the risk of the wallet type by the risk of the customer profile.
  - `description` string
  - `eclipseProduct` EclipseProduct
    - `alertMessage` string
    - `base64EncodedImage` string
    - `category` string
    - `configuration` Avp[]
      - `att` string, required
      - `val` string, required
    - `created` string, date-time
    - `currency` string
    - `description` string
    - `externalId` string
    - `itemCount` integer
    - `lastModified` string, date-time
    - `lowStockCount` integer
    - `mediaType` string
    - `mode` string
    - `name` string
    - `organisationId` integer, required
    - `partnerName` string
    - `pinnedProduct` boolean
    - `pricingData` EclipseProductPricing
      - `billInAdvanceAtBillRun` boolean
      - `billInAdvanceImmediately` boolean
      - `priceIsPerDay` boolean
      - `priceIsPerHour` boolean
      - `priceIsPerMinute` boolean
      - `priceIsPerMonth` boolean
      - `priceIsPerSecond` boolean
      - `priceIsPerWeek` boolean
      - `priceIsPerYear` boolean
      - `prorata` boolean
    - `productId` integer
    - `sku` string
    - `status` string
    - `supplierId` integer
    - `taxType` 'VAT'
    - `tenantId` integer, required
    - `type` string
    - `unitPriceExcl` number
    - `version` integer
  - `email` string
  - `info` string
  - `lastModified` string, date-time
  - `qrcodeType` 'EXTERNAL_REF' | 'RANDOM_10' | 'ZA_MASTERPASS'
  - `seqNumber` string
  - `status` string
  - `subType` string
  - `tenantId` integer

## Other responses

- `500` — Internal Server Error

---

[API](https://skmtc.dev/eftcorp/apis/eclipse-rest-api.md) · [All operations](https://skmtc.dev/eftcorp/apis/eclipse-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/eftcorp/eclipse-rest-api/revisions/9213d52d49a3/schema)