Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
h) Wallets

Get wallets transactions

Retrieves the transaction history for a wallet

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

Path parameters

tenantIdinteger required
walletIdinteger required

Query parameters

cardIdstring

To get the transaction history for specific card

currencystring

To get the transaction history in given currency(ISO 3-letter currency. i.e USD, ZAR etc), applicable only to wallet created with ZIM_POSTILION_CLOSED_LOOP walletType mode

dateFromInclstring

fromDate, the date from where we want to get the transactions inclusive.

dateToExclstring

toDate, the date upto when we want to get the transactions exclusive

externalIdstring

The externalId used when the transaction was initiated. Other parameters other than walletId are ignored if this is passed

externalUniqueIdstring

The externalUniqueId used when the transaction was initiated. Other parameters other than walletId are ignored if this is passed. NB: Prefix with CR- or DB- for the credit or debit leg

fieldsstring

Additional field data to include. Comma separated list. Supports payments,withdrawals,remittances.

filterstring

Filter string to search in fields of the transaction to further filter results. Not case sensitive.

limitinteger
maskedPanstring

To get the transaction history with maskedPan e.g 123456******1234

merchantNamestring

To get the transaction history with merchant name for specific card

offsetinteger
rrnstring

To get the transaction history with rrn for specific card

Response

OK

amountnumber

Amount. Negative for debits, positive for credits. Amounts are in major currency unit

authorisationCodestring

Auth code for card transactions

balancenumber

Closing balance in the currency of the wallet.

currencystring

Currency of the transaction. E.g. USD, ZAR, NGN etc

datestring date-time

ISO 8601 of the transaction

descriptionstring

Transaction description

externalIdstring

External identifier for the transaction which can be used for reconciliation. Need not be unique

externalUniqueIdstring

The externally provided unique identifier for the transaction

feenumber

Fee. The additional fee charged as part of the transaction

fraudReferencestring
locationstring

Any location information about the transaction such as IP address or GPS

originalAmountnumber

Amount in the original currency of the transaction. E.g. USD while the ledger could be in ZAR

originalCurrencystring

Currency of the merchants transaction. E.g. USD, ZAR, NGN etc. MAy be converted to the wallets currency as per amount/currency

otherWalletIdinteger

If this was a transfer then this field will contain the other walletId which was debited/credited

reallocationboolean

If this transaction is a reallocation

reversalboolean

If this transaction is a reversal

sessionIdstring

SessionId of the transaction if one was provided

tracingContextstring

Tracing data about the transaction

transactionIdstring required

Unique identifier for the transaction generated by the wallet/card system

typestring

Transaction type

walletIdinteger required

The walletId of the transaction

Example response

[
  {
    "date": "2022-03-10T12:15:50-04:00",
    "payment": {
      "created": "2022-03-10T12:15:50-04:00",
      "expires": "2022-03-10T12:15:50-04:00",
      "lastModified": "2022-03-10T12:15:50-04:00"
    },
    "remittance": {
      "created": "2022-03-10T12:15:50-04:00",
      "quoteExpires": "2022-03-10T12:15:50-04:00"
    },
    "withdrawal": {
      "created": "2022-03-10T12:15:50-04:00",
      "expires": "2022-03-10T12:15:50-04:00",
      "holdUntil": "2022-03-10T12:15:50-04:00",
      "lastModified": "2022-03-10T12:15:50-04:00"
    }
  }
]