--- updatedAt: 2026-05-29T13:25:42.000Z agentTools: projectIndex: https://developer.eftcorp.com/llms.txt --- # Initiate a cross-border remittance Initiates a new cross-border remittance from the wallet. Required fields vary by remittance type. # 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": { "EclipseBeneficiaryIdentityType": { "type": "string", "enum": [ "SBR", "SID", "SPP", "TRN" ] }, "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" ] }, "NewEclipseRemittanceBeneficiary": { "type": "object", "properties": { "accountHolderName": { "type": "string", "description": "Beneficiary account holder name", "minLength": 2, "maxLength": 50 }, "accountType": { "type": "string", "description": "Optional. Account type of beneficiary account details.", "minLength": 2, "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)", "minLength": 1, "maxLength": 50 }, "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": 2, "maxLength": 50 }, "bankName": { "type": "string", "description": "Beneficiary's Bank name" }, "beneficiaryAccountId": { "type": "string", "description": "Account Id of Beneficiary's account" }, "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" }, "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])$", "minLength": 8, "maxLength": 8 }, "email": { "type": "string" }, "firstName": { "type": "string", "description": "Beneficiary first/given name", "minLength": 2, "maxLength": 50 }, "iban": { "type": "string", "description": "International Bank Account Number unique identifier for a specific customer", "minLength": 2, "maxLength": 50 }, "identityNumber": { "type": "string", "description": "Beneficiary identity number" }, "identityType": { "$ref": "#/components/schemas/EclipseBeneficiaryIdentityType", "description": "Beneficiary identity Type", "type": "string" }, "lastName": { "type": "string", "description": "Beneficiary last name", "minLength": 2, "maxLength": 50 }, "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" }, "onlyCheck": { "type": "boolean", "description": "Optional. If true, the beneficiary will not be created, but the account number will be validated in AVS to confirm its eligibility for the transaction." }, "organisationId": { "type": "integer", "format": "int64", "description": "Id of Organisation" }, "provider": { "type": "string" }, "reference": { "type": "string", "description": "Reference (some reference name)" }, "saveOnPass": { "type": "boolean", "description": "Optional. If true, the beneficiary will be created only if the beneficiary status is ACTIVE." }, "state": { "type": "string", "description": "Beneficiary's state" }, "walletId": { "type": "integer", "format": "int64", "description": "Beneficiary's wallet-Id" } } }, "NewEclipseWalletRemittance": { "type": "object", "properties": { "additionalFields": { "type": "array", "items": { "$ref": "#/components/schemas/RemittanceAdditionalField" } }, "amount": { "type": "number", "description": "Amount in the major currency unit of the associated wallet e.g. 50.80 for 50 GBP and 80 pence" }, "beneficiaryId": { "type": "integer", "format": "int64", "description": "Optional. Who the remittance is going to. Either this or destination is required" }, "callbackUrl": { "type": "string", "description": "The URL Eclipse must post the WalletRemittanceResult to when the remittance is finalised (either successful or error). Optional as one can always do a GET to get the result instead of using callbacks. This will be a system-system call", "pattern": "^http(s)?:\\/\\/.*\\..*$", "minLength": 10, "maxLength": 2000 }, "customFraudChecks": { "type": "boolean" }, "description": { "type": "string", "pattern": "(?s)^(?:[\\t\\r\\n]|[^\\p{C}<>])*$", "minLength": 0, "maxLength": 200 }, "destination": { "$ref": "#/components/schemas/NewEclipseRemittanceBeneficiary", "description": "Optional. Who the remittance is going to. Either this or beneficiaryId is required", "type": "object" }, "destinationAmount": { "type": "number", "description": "This is only applicable when the driving currency is FX currency, as denoted by useFxCurrencyAsBase=True. Consequently, it is an optional field. If both destinationAmount and useFxCurrencyAsBase=True are provided, destinationAmount will retain its value while the amount will be adjusted" }, "destinationCountry": { "type": "string" }, "destinationCurrency": { "type": "string", "description": "The destination currency - e.g. USD, ZAR, NGN, TSH", "minLength": 3, "maxLength": 3 }, "externalUniqueId": { "type": "string", "description": "Provide a GUID for the remittance to prevent replays/duplicates", "minLength": 6, "maxLength": 100 }, "provider": { "type": "string" }, "saveDestinationAsBeneficiary": { "type": "boolean", "description": "Save the profile details of the destination as a new beneficiary against the wallet owner" }, "useFxCurrencyAsBase": { "type": "boolean" } }, "required": [ "externalUniqueId", "destinationCurrency" ] }, "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" } } }, "WalletRemittanceResult": { "type": "object", "properties": { "additionalFields": { "type": "array", "items": { "$ref": "#/components/schemas/RemittanceAdditionalField" } }, "amount": { "type": "number", "description": "Amount in the major currency unit of the associated wallet e.g. 50.80 for 50 GBP and 80 pence" }, "created": { "type": "string", "format": "date-time", "examples": [ "2022-03-10T12:15:50-04:00" ] }, "currency": { "type": "string", "description": "The currency of the wallet - e.g. USD, ZAR, NGN, TSH" }, "customFraudChecks": { "type": "boolean" }, "description": { "type": "string" }, "destinationAmount": { "type": "number", "description": "Amount in the major currency unit of the associated wallet e.g. 50.80 for 50 GBP and 80 pence being used to buy the destination currency at the exchange rate" }, "destinationCountry": { "type": "string" }, "destinationCurrency": { "type": "string" }, "errorDescription": { "type": "string" }, "exchangeRate": { "type": "number", "description": "The amount to pay in the wallets currency for one major unit of the destination currency. The recipient will get exchangeAmount/exchangeRate in the destination currency" }, "externalUniqueId": { "type": "string" }, "extraInfo": { "type": "string", "description": "Loosely typed data resulting from the remittance payment. E.g. could be a voucher code if the payment was for a VAS. The structure depends on what was being paid for." }, "fee": { "type": "number", "description": "Fee that will be decuted from wallet in wallet currency. walletFeeAmount + walletSendingAmount = walletTotalAmount" }, "gatewayTransactionId": { "type": "string", "description": "The transaction identifier for this remittance as provided by the gateway itself" }, "mtoProvider": { "type": "string" }, "note": { "type": "string" }, "quoteExpires": { "type": "string", "format": "date-time", "examples": [ "2022-03-10T12:15:50-04:00" ] }, "remittanceId": { "type": "integer", "format": "int64" }, "status": { "$ref": "#/components/schemas/WalletRemittanceStatus", "description": "Status of the remittance", "type": "string" }, "totalSourceAmount": { "type": "number", "description": "If fees are INCLUSIVE this will be same as sourceAmount,if fees are EXCLUSIVE it will be sourceAmount + fee" }, "walletId": { "type": "integer", "format": "int64" } } }, "WalletRemittanceStatus": { "description": "Status of a remittance", "type": "string", "enum": [ "BUILDING", "CANCELLED", "ERROR_PERM", "ERROR_TEMP", "PENDING", "REVERSED", "SUCCESSFUL", "TIMEOUT" ] } }, "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": "r) Wallet Cross Border Remittances", "description": "Enables customers to send money internationally through partner remittance networks. Covers customer enrollment, exchange rate quotes, and catalog lookup." } ], "paths": { "/eclipse-conductor/rest/v1/tenants/{tenantId}/wallets/{walletId}/remittances": { "post": { "summary": "Initiate a cross-border remittance", "description": "Initiates a new cross-border remittance from the wallet. Required fields vary by remittance type.", "tags": [ "r) Wallet Cross Border Remittances" ], "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewEclipseWalletRemittance" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletRemittanceResult" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExceptionData" } } } } } }, "security": [ { "JWTBearerAuthorisation": [] } ] } } } } ```