Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
r) Wallet Cross Border Remittances

Get a remittance by ID

get/eclipse-conductor/rest/v1/tenants/{tenantId}/wallets/{walletId}/remittances/{remittanceId}

Path parameters

tenantIdinteger required
walletIdinteger required
remittanceIdinteger required

Response

OK

amountnumber

Amount in the major currency unit of the associated wallet e.g. 50.80 for 50 GBP and 80 pence

createdstring date-time
currencystring

The currency of the wallet - e.g. USD, ZAR, NGN, TSH

customFraudChecksboolean
descriptionstring
destinationAmountnumber

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

destinationCountrystring
destinationCurrencystring
errorDescriptionstring
exchangeRatenumber

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

externalUniqueIdstring
extraInfostring

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.

feenumber

Fee that will be decuted from wallet in wallet currency. walletFeeAmount + walletSendingAmount = walletTotalAmount

gatewayTransactionIdstring

The transaction identifier for this remittance as provided by the gateway itself

mtoProviderstring
notestring
quoteExpiresstring date-time
remittanceIdinteger
status'BUILDING' | 'CANCELLED' | 'ERROR_PERM' | 'ERROR_TEMP' | 'PENDING' | 'REVERSED' | 'SUCCESSFUL' | 'TIMEOUT'

Status of a remittance

totalSourceAmountnumber

If fees are INCLUSIVE this will be same as sourceAmount,if fees are EXCLUSIVE it will be sourceAmount + fee

walletIdinteger

Example response

{
  "created": "2022-03-10T12:15:50-04:00",
  "quoteExpires": "2022-03-10T12:15:50-04:00"
}