---
updatedAt: 2026-05-29T13:25:42.000Z
agentTools:
  projectIndex: https://developer.eftcorp.com/llms.txt
---

# Search for a wallet across all tenants

Returns wallet information without disclosing personal details. Either a phone number or at least two matching search fields are required. This endpoint is rate-limited; callers should store the walletId rather than searching on each use.

# OpenAPI definition

```json
{
  "servers": [
    {
      "url": "https://eclipse-java-sandbox.ukheshe.rocks",
      "description": "Eclipse sandbox environment"
    },
    {
      "url": "https://ukheshe.live",
      "description": "Eclipse production environment"
    },
    {
      "url": "https://eclipse-java-develop.ukheshe.rocks",
      "description": "Eclipse development environment"
    },
    {
      "url": "https://zw.ukheshe.live",
      "description": "Zim Eclipse production environment"
    }
  ],
  "openapi": "3.1.0",
  "components": {
    "schemas": {
      "Avp": {
        "description": "An attribute/value pair for providing weakly typed data on various messages",
        "type": "object",
        "required": [
          "att",
          "val"
        ],
        "properties": {
          "att": {
            "type": "string",
            "pattern": "\\S"
          },
          "val": {
            "type": "string"
          }
        }
      },
      "CardRules": {
        "description": "Specific rules on what the card can and cannot do",
        "type": "object",
        "properties": {
          "ecommerceTransactionsEnabled": {
            "type": "boolean",
            "description": "eCommerce transactions allowed or not"
          },
          "internationalTransactionsEnabled": {
            "type": "boolean",
            "description": "International transactions allowed or not"
          }
        }
      },
      "CardStatus": {
        "description": "Status of the card ACTIVE:Can be used, STOPPED is temporarily blocked from use. CANCELLED is permanently disabled.",
        "type": "string",
        "enum": [
          "ACTIVE",
          "CANCELLED",
          "EXPIRED",
          "FIRST_TIME_ACTIVATION",
          "LOST_PICKUP",
          "NO_SAVING_ACCOUNT",
          "PIN_TRIES_EXCEEDED",
          "REPLACED",
          "RESTRICTED",
          "STOLEN_PICKUP",
          "STOPPED"
        ]
      },
      "EclipseCardOperationType": {
        "type": "string",
        "enum": [
          "ADDON_CARD",
          "PRIMARY_CARD",
          "SUPPLEMENTARY_CARD"
        ]
      },
      "EclipseCardType": {
        "description": "Card type either physical or virtual card",
        "type": "string",
        "enum": [
          "PERSONALISED",
          "PHYSICAL",
          "VIRTUAL"
        ]
      },
      "EclipsePublicWalletInfo": {
        "description": "Obfuscated publically available information about a wallet.",
        "type": "object",
        "properties": {
          "accountNumber": {
            "type": "string",
            "description": "A bank account number for the wallet if supported by the sponsor bank"
          },
          "cards": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EclipseWalletCardSummary"
            },
            "description": "Cards linked to this wallet. Only populated when the search is called with fields=cards. Empty when the wallet has no linked cards"
          },
          "currency": {
            "type": "string"
          },
          "customerId": {
            "type": "integer",
            "format": "int64",
            "description": "A customerId for the wallet"
          },
          "externalUniqueId": {
            "type": "string"
          },
          "firstName": {
            "type": "string",
            "description": "Obfuscated first name. Only present if the owner has this field on their profile"
          },
          "lastName": {
            "type": "string",
            "description": "Obfuscated last name. Only present if the owner has this field on their profile"
          },
          "name": {
            "type": "string",
            "description": "Obfuscated name of the organisation. Only present if the organisation has this field"
          },
          "nationalIdentityNumber": {
            "type": "string",
            "description": "Obfuscated national identity number of the wallet holder. Only present if the owner has this field on their profile"
          },
          "passportNumber": {
            "type": "string",
            "description": "Obfuscated passport number of the wallet holder. Only present if the owner has this field on their profile"
          },
          "phone1": {
            "type": "string",
            "description": "Obfuscated phone number 1 of the wallet holder. Only present if the owner has this field on their profile"
          },
          "phone2": {
            "type": "string",
            "description": "Obfuscated phone number 2 of the wallet holder. Only present if the owner has this field on their profile"
          },
          "status": {
            "$ref": "#/components/schemas/WalletStatus",
            "description": "The status of the wallet. Impacts if it can currently be used",
            "type": "string"
          },
          "tenantId": {
            "type": "integer",
            "format": "int64",
            "description": "The tenant ID of the tenant the wallet is held with"
          },
          "tenantName": {
            "type": "string",
            "description": "The name of the tenant the wallet is held with"
          },
          "tradingName": {
            "type": "string",
            "description": "Obfuscated trading name of the organisation. Only present if the organisation has this field"
          },
          "walletFriendlyId": {
            "type": "string",
            "description": "A unique string reference for a wallet used for deposit references and other transactions"
          },
          "walletId": {
            "type": "integer",
            "format": "int64",
            "description": "A unique system generated numeric identifier for the wallet. This is the required identifier for doing transfers to the wallet in field toWalletId"
          },
          "walletName": {
            "type": "string",
            "description": "The name of the wallet"
          },
          "walletTypeConfiguration": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Avp"
            },
            "description": "Weakly typed additional configuration data about the wallet type"
          },
          "walletTypeId": {
            "type": "integer",
            "format": "int32",
            "description": "The type ID of the wallet"
          }
        }
      },
      "EclipseWalletCardSummary": {
        "type": "object",
        "description": "Limited, always masked summary of a card linked to a wallet. Only returned by the wallet search endpoints when called with fields=cards",
        "properties": {
          "cardId": {
            "type": "integer",
            "format": "int64",
            "description": "Unique system generated identifier for a card"
          },
          "cardIdentifierType": {
            "$ref": "#/components/schemas/EclipseCardOperationType",
            "description": "Type of operation that was specified when creating the card",
            "type": "string"
          },
          "cardPackId": {
            "type": "string",
            "description": "Masked card pack identifier"
          },
          "cardRules": {
            "$ref": "#/components/schemas/CardRules",
            "description": "Rules currently applied to the card",
            "type": "object"
          },
          "cardType": {
            "$ref": "#/components/schemas/EclipseCardType",
            "description": "Card type either physical or virtual card",
            "type": "string"
          },
          "created": {
            "type": "string",
            "format": "date-time",
            "examples": [
              "2022-03-10T12:15:50-04:00"
            ],
            "description": "ISO 8601 date/time of when the record was first created"
          },
          "expires": {
            "type": "string",
            "format": "date-time",
            "examples": [
              "2022-03-10T12:15:50-04:00"
            ],
            "description": "ISO 8601 date/time of when the card expires"
          },
          "pan": {
            "type": "string",
            "description": "Masked primary account number. First 6 and last 4 digits only"
          },
          "programName": {
            "type": "string",
            "description": "Name of the card program the card was issued under"
          },
          "status": {
            "$ref": "#/components/schemas/CardStatus",
            "description": "Current status of the card. Reflects the last known state held by the card management system",
            "type": "string"
          }
        }
      },
      "ExceptionData": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "environment": {
            "type": "string"
          },
          "info": {
            "type": "object",
            "additionalProperties": {}
          },
          "severity": {
            "$ref": "#/components/schemas/ExceptionSeverity"
          },
          "spanId": {
            "type": "string"
          },
          "stackTrace": {
            "type": "string"
          },
          "traceId": {
            "type": "string"
          },
          "type": {
            "$ref": "#/components/schemas/ExceptionType"
          }
        }
      },
      "ExceptionSeverity": {
        "type": "string",
        "enum": [
          "CRITICAL",
          "HIGH",
          "INFO",
          "LOW",
          "MEDIUM"
        ]
      },
      "ExceptionType": {
        "type": "string",
        "enum": [
          "BUSINESS",
          "SYSTEM"
        ]
      },
      "WalletStatus": {
        "description": "Status of the wallet. ACTIVE:Can be used, LOCKED:Is blocked from use but can be customer controlled. CANCELED is deprecated. CANCELLED is in use, BARRED: Wallet cannot be used due to possible fraud or similar investigation",
        "type": "string",
        "enum": [
          "ACTIVE",
          "BARRED",
          "CANCELED",
          "CANCELLED",
          "JOINT_ACTIVE",
          "JOINT_PARTIAL",
          "LOCKED",
          "PENDING"
        ]
      }
    },
    "securitySchemes": {
      "JWTBearerAuthorisation": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "info": {
    "description": "A RESTful API using JSON as the data transfer model, covering all tenant-facing functionality in the Eclipse payments platform.",
    "title": "Eclipse ReST API",
    "version": "3.0.0"
  },
  "tags": [
    {
      "name": "z) Global Functionality",
      "description": "For internal use only. Functionality that is not specific to a tenant"
    }
  ],
  "paths": {
    "/eclipse-conductor/rest/v1/global/wallets": {
      "get": {
        "summary": "Search for a wallet across all tenants",
        "description": "Returns wallet information without disclosing personal details. Either a phone number or at least two matching search fields are required. This endpoint is rate-limited; callers should store the walletId rather than searching on each use.",
        "tags": [
          "z) Global Functionality"
        ],
        "parameters": [
          {
            "description": "Account number",
            "required": false,
            "name": "accountNumber",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "External unique Id",
            "required": false,
            "name": "externalUniqueId",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Comma-separated list of additional fields to include in the response. Supported values: cards. 'cards' returns a limited, always masked summary of the cards linked to each wallet.",
            "required": false,
            "name": "fields",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Customers last (family) name of max length 50",
            "required": false,
            "name": "lastName",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Max length 20",
            "required": false,
            "name": "nationalIdentityNumber",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Max length 20",
            "required": false,
            "name": "passportNumber",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Either with or without the country code. E.g. 0821112222 or 27821112222",
            "required": false,
            "name": "phone",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "If transferable is true it will return the list of wallets from tenants which accept the cross tenant payments",
            "required": false,
            "name": "transferable",
            "in": "query",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "description": "Will be length 8 if provided",
            "required": false,
            "name": "walletFriendlyId",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "walletId",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/EclipsePublicWalletInfo"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ExceptionData"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "JWTBearerAuthorisation": []
          }
        ]
      }
    }
  }
}
```