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

# Transfer funds between wallets

Transfers funds between two Eclipse wallets. Authorization rules are enforced based on the caller's relationship to the source wallet — ownership, organisation position, or tenant-level system access depending on the wallet 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": {
      "Check": {
        "type": "string",
        "enum": [
          "BOTH",
          "FROM",
          "TO"
        ]
      },
      "EclipseTransfer": {
        "description": "A transfer between two wallets in the currency of the wallets",
        "type": "object",
        "properties": {
          "amount": {
            "type": "number",
            "description": "Amount to transfer. Amounts are in major currency unit",
            "minimum": 1e-9
          },
          "check": {
            "$ref": "#/components/schemas/Check",
            "description": "Only provide if onlyCheck=true. If TO is passed then source wallet permissions are ignored when the check is done",
            "type": "string"
          },
          "description": {
            "type": "string",
            "description": "Description for the statement/s",
            "pattern": "(?s)^(?:[\\t\\r\\n]|[^\\p{C}<>])*$",
            "minLength": 0,
            "maxLength": 200
          },
          "externalId": {
            "type": "string",
            "description": "External identifier for the transfer which can be used for reconciliation. Need not be unique",
            "minLength": 5,
            "maxLength": 200
          },
          "externalUniqueId": {
            "type": "string",
            "description": "Unique identifier for the transfer (idempotency key). Duplicates are rejected to ensure double transactions are impossible",
            "minLength": 6,
            "maxLength": 200
          },
          "fromAccountNumber": {
            "type": "string",
            "description": "fromAccountNumber for wallet to debit"
          },
          "fromWalletId": {
            "type": "integer",
            "format": "int64",
            "description": "The wallet to debit"
          },
          "ignoreLimits": {
            "type": "boolean",
            "description": "Optional. If true then the transfer will ignore the wallets transfer limits and any positive minimum balance setting. Requires special permissions"
          },
          "location": {
            "type": "string",
            "description": "Optional. Any location information to add to the transfer such as GPS coordinates",
            "minLength": 0,
            "maxLength": 200
          },
          "onlyCheck": {
            "type": "boolean",
            "description": "Optional. If true then the transfer wont actually be done but only validated to see if it could have been done"
          },
          "replyPolicy": {
            "$ref": "#/components/schemas/ReplyPolicy",
            "description": "Optional: Indicates to Eclipse whether to reply to the caller after the transfer has actually happened on both wallets. WHEN_GUARANTEED: Eclipse should reply when the result is guaranteed to happen and will eventually happen, WHEN_COMPLETE: Eclipse should only reply when the source and destination are fully consistent. In all normal situations and by default, WHEN_GUARANTEED should be used. For most wallet transfers between wallets in the same store of value, WHEN_GUARANTEED and WHEN_COMPLETE are identical. WHEN_COMPLETE is only useful when transferring from a digital wallet within Eclipse to a store of value like a card wallet which sits outside of Eclipse. The semantics of these transactions is that the source is debited and the destination is credited in a separate transaction that is retried until success. If the destination wallet is not complete within 5 seconds then Eclipse will reply as if WHEN_GUARANTEED was passed in In order to prevent timeouts on the client.",
            "type": "string"
          },
          "sessionId": {
            "type": "string",
            "description": "Optional: Used for 2-step reserve/transfer transactions. The sessionId of a reservation in order to make this transfer first remove the reservation and then do the transfer atomically",
            "maxLength": 200
          },
          "toAccountNumber": {
            "type": "string",
            "description": "toAccountNumber for wallet to credit"
          },
          "toPan": {
            "type": "string",
            "description": "toPan for wallet to credit"
          },
          "toWalletFriendlyId": {
            "type": "string",
            "description": "toWalletFriendlyId for wallet to credit"
          },
          "toWalletId": {
            "type": "integer",
            "format": "int64",
            "description": "The wallet to credit"
          }
        },
        "required": [
          "description",
          "externalUniqueId"
        ]
      },
      "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"
        ]
      },
      "ReplyPolicy": {
        "type": "string",
        "enum": [
          "WHEN_COMPLETE",
          "WHEN_GUARANTEED",
          "WHEN_RECEIVED"
        ]
      }
    },
    "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": "m.1) Wallet Transfers",
      "description": "Move funds between wallets within the Eclipse ecosystem. Transfer eligibility is governed by wallet type rules and the caller's relationship to the source wallet, including ownership, organisation position, and tenant-level system permissions."
    }
  ],
  "paths": {
    "/eclipse-conductor/rest/v1/tenants/{tenantId}/wallets/transfers": {
      "post": {
        "summary": "Transfer funds between wallets",
        "description": "Transfers funds between two Eclipse wallets. Authorization rules are enforced based on the caller's relationship to the source wallet — ownership, organisation position, or tenant-level system access depending on the wallet type.",
        "tags": [
          "m.1) Wallet Transfers"
        ],
        "parameters": [
          {
            "name": "tenantId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EclipseTransfer"
              }
            }
          },
          "required": true
        },
        "responses": {
          "204": {
            "description": "Transfer submitted successfully"
          },
          "400": {
            "description": "Bad Request"
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ExceptionData"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "JWTBearerAuthorisation": []
          }
        ]
      }
    }
  }
}
```