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

# Get a remittance by ID

# 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": {
      "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"
          }
        }
      },
      "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/{remittanceId}": {
      "get": {
        "summary": "Get a remittance by ID",
        "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"
            }
          },
          {
            "name": "remittanceId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WalletRemittanceResult"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ExceptionData"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ExceptionData"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "JWTBearerAuthorisation": []
          }
        ]
      }
    }
  }
}
```