--- updatedAt: 2026-05-29T13:25:42.000Z agentTools: projectIndex: https://developer.eftcorp.com/llms.txt --- # List top-ups for a wallet Returns top-ups for the wallet, optionally filtered by date range. # 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": { "EclipsePaymentStatus": { "description": "Status of a payment BUILDING: Not yet submitted as more data needs to be captured, PENDING:Being processed and can no longer be enhanced, SUCCESSFUL: Successfully completed, ERROR_PERM: Failed and wont ever succeed, ERROR_TEMP: Currently having an error but its being retried and may succeed or permanently fail, TIMEOUT: Failed as the process was not finalised in time, CANCELLED: Cancelled prior to SUCCESS or FAILURE, REVERSED: Reversed after success", "type": "string", "enum": [ "BUILDING", "CANCELLED", "ERROR_PERM", "ERROR_TEMP", "PENDING", "REVERSED", "SUCCESSFUL", "TIMEOUT" ] }, "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" ] }, "FieldType": { "description": "Status of a payment NUMERIC: The numeric keyboard is only needed, STRING: The full keyboard is needed", "type": "string", "enum": [ "DROPDOWN", "NUMERIC", "STRING" ] }, "PaymentAdditionalField": { "type": "object", "description": "Some form of additional data required in order for a customer to do a payment", "properties": { "defaultValue": { "type": "string", "description": "The default value to put on the UI which can be changed by the customer" }, "fixed": { "type": "boolean", "description": "This field is required and is fixed and must be the default value. E.g. if there is a fixed tip amount" }, "id": { "type": "string", "description": "Unique identifier for the field to be used when specifying the value on the PUT" }, "regex": { "type": "string", "description": "If provided then the value must match this regex pattern" }, "regexErrorMessage": { "type": "string", "description": "If the regex field is present and the end users value does not match the regex then display this user friendly message" }, "template": { "type": "string", "description": "Information for the input. E.g. if the type is DROPDOWN then this is the comma delimited list of options to put in the dropdown" }, "title": { "type": "string", "description": "The title of the field when asking the customer for the info" }, "type": { "$ref": "#/components/schemas/FieldType", "description": "The field type so the UI knows what keyboard it can use", "type": "string" }, "value": { "type": "string", "description": "The value if supplied" } } }, "WalletTopupResult": { "description": "Data which will be posted in a callback/webhook to the tenant when a topup has permanently failed or succeeded", "type": "object", "properties": { "additionalFields": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentAdditionalField" }, "description": "Additional fields captured by the customer be submitted for processing. These fields relate to additionalFields requested when the topup was initiated " }, "amount": { "type": "number", "description": "Amount in the major currency unit e.g. 50.80 for 50 GBP and 80 pence" }, "authCode": { "type": "string" }, "bankName": { "type": "string" }, "cardBin": { "type": "string" }, "cardExpires": { "type": "string", "format": "date-time", "examples": [ "2022-03-10T12:15:50-04:00" ] }, "cardLast4": { "type": "string" }, "cardName": { "type": "string" }, "cardPhone": { "type": "string" }, "cardType": { "type": "string" }, "created": { "type": "string", "format": "date-time", "examples": [ "2022-03-10T12:15:50-04:00" ], "description": "When the topup was created" }, "currency": { "type": "string", "description": "Currency of the transaction. E.g. USD, ZAR, NGN etc" }, "customerId": { "type": "integer", "format": "int64" }, "description": { "type": "string" }, "errorDescription": { "type": "string", "description": "This will only be populated if there was an error" }, "expires": { "type": "string", "format": "date-time", "examples": [ "2022-03-10T12:15:50-04:00" ], "description": "When the token expires if applicable" }, "externalUniqueId": { "type": "string" }, "gateway": { "type": "string" }, "gatewayTransactionId": { "type": "string", "description": "The transaction identifier for this topup as provided by the gateway itself" }, "organisationId": { "type": "integer", "format": "int64" }, "paId": { "type": "string" }, "paymentReference": { "type": "string" }, "status": { "$ref": "#/components/schemas/EclipsePaymentStatus", "description": "As the callback will only trigger when the the topup is in a final status, the possibilities are SUCCESSFUL, ERROR_PERM, TIMEOUT, CANCELLED", "type": "string" }, "subType": { "type": "string" }, "topupId": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "walletId": { "type": "integer", "format": "int64" } } } }, "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": "k) Wallet Topups", "description": "Manage individual top-up records, including retrieving their current status and simulating status changes in sandbox environments." } ], "paths": { "/eclipse-conductor/rest/v1/tenants/{tenantId}/wallets/{walletId}/topups": { "get": { "summary": "List top-ups for a wallet", "description": "Returns top-ups for the wallet, optionally filtered by date range.", "tags": [ "k) Wallet Topups" ], "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "description": "Start of the date range (inclusive). Must be supplied together with dateToExcl.", "name": "dateFromIncl", "in": "query", "schema": { "type": "string" } }, { "description": "End of the date range (exclusive). Must be supplied together with dateFromIncl.", "name": "dateToExcl", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WalletTopupResult" } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExceptionData" } } } } } }, "security": [ { "JWTBearerAuthorisation": [] } ] } } } } ```