--- updatedAt: 2026-05-29T13:25:42.000Z agentTools: projectIndex: https://developer.eftcorp.com/llms.txt --- # Get a customers beneficiaries Get all a customers beneficiaries # 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": { "EclipseBeneficiary": { "type": "object", "properties": { "accountHolderName": { "type": "string", "description": "Beneficiary account holder name" }, "accountType": { "type": "string", "description": "Optional. Account type of beneficiary account details.", "minLength": 5, "maxLength": 30 }, "additionalFields": { "type": "array", "items": { "$ref": "#/components/schemas/RemittanceAdditionalField" } }, "address1": { "type": "string", "description": "Beneficiary address1" }, "address2": { "type": "string", "description": "Beneficiary address2" }, "alias": { "type": "string", "description": "Alias (some friendly name)" }, "bankAccountNumber": { "type": "string", "description": "Beneficiary's bank account number" }, "bankIdentificationCode": { "type": "string", "description": "Bank Identification Code(BIC) unique identifier for a specific financial institution", "minLength": 3, "maxLength": 50 }, "bankName": { "type": "string", "description": "Beneficiary's Bank name" }, "beneficiaryId": { "type": "integer", "format": "int64", "description": "Unique Id of Beneficiary" }, "branchCode": { "type": "string", "description": "Beneficiary's branch code" }, "city": { "type": "string", "description": "Beneficiary's city" }, "code": { "type": "string", "description": "Beneficiary postal code" }, "country": { "type": "string", "description": "Beneficiary's country" }, "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" }, "customerId": { "type": "integer", "format": "int64", "description": "Id of Customer" }, "dob": { "type": "string", "description": "Beneficiary's Date of birth must be in form of yyyyMMdd", "pattern": "^\\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$" }, "email": { "type": "string" }, "firstName": { "type": "string", "description": "Beneficiary first/given name" }, "iban": { "type": "string", "description": "International Bank Account Number unique identifier for a specific customer" }, "identityNumber": { "type": "string", "description": "Beneficiary identity number" }, "identityType": { "$ref": "#/components/schemas/EclipseBeneficiaryIdentityType", "description": "Beneficiary identity Type", "type": "string" }, "lastModified": { "type": "string", "format": "date-time", "examples": [ "2022-03-10T12:15:50-04:00" ], "description": "ISO 8601 date/time of when the record was last modified" }, "lastName": { "type": "string", "description": "Beneficiary last name" }, "middleName": { "type": "string", "description": "Beneficiary middle name" }, "mobileMoneyNetwork": { "type": "string", "description": "Beneficiary mobile-money network" }, "mobileNumber": { "type": "string", "description": "Beneficiary mobile number" }, "nationality": { "type": "string" }, "organisationId": { "type": "integer", "format": "int64", "description": "Id of Organisation" }, "reference": { "type": "string", "description": "Reference (some reference name)" }, "state": { "type": "string", "description": "Beneficiary's state" }, "status": { "$ref": "#/components/schemas/EclipseBeneficiaryStatus", "description": "1) ACTIVE : An active beneficiary status indicates that the beneficiary is currently valid and transactions can be performed using this beneficiary. 2) BLOCKED : When a beneficiary is marked as blocked, transactions involving this beneficiary are temporarily disabled. This status might be triggered due to security concerns or other reasons. 3) PENDING : A beneficiary with a pending status implies that it has been added but hasn't yet been approved or verified. Transactions cannot be initiated until the beneficiary's status changes to Active. 4) REJECTED : A beneficiary with a rejected status signifies that the request to add this beneficiary has been declined. Transactions cannot be performed using this beneficiary.", "type": "string" }, "walletId": { "type": "integer", "format": "int64", "description": "Beneficiary's wallet-Id" } } }, "EclipseBeneficiaryIdentityType": { "type": "string", "enum": [ "SBR", "SID", "SPP", "TRN" ] }, "EclipseBeneficiaryStatus": { "type": "string", "enum": [ "ACTIVE", "BLOCKED", "PENDING", "REJECTED" ] }, "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" ] }, "RemittanceAdditionalField": { "type": "object", "properties": { "defaultValue": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "identifier": { "type": "string" }, "regex": { "type": "string" }, "regexErrorMessage": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } } } }, "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": "d) Customer Management", "description": "Operations on an individual customer profile including identity management, addresses, documents, wallets, cards, beneficiaries, and KYC ratification." } ], "paths": { "/eclipse-conductor/rest/v1/tenants/{tenantId}/customers/{customerId}/beneficiaries": { "get": { "summary": "Get a customers beneficiaries", "description": "Get all a customers beneficiaries", "tags": [ "d) Customer Management" ], "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "bankAccountNumber", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1000 } }, { "name": "mobileNumber", "in": "query", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "walletId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EclipseBeneficiary" } } } } }, "500": { "description": "Internal Server error", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExceptionData" } } } } } }, "security": [ { "JWTBearerAuthorisation": [] } ] } } } } ```