Skip to main content

Transaction

Description of a user's transactions​

Sample Output​

{
    "id": 0,
    "user_id": "user_id",
    "account_type": "account_type",
    "institution_name": "institution_name",
    "event": "event",
    "transaction_type": "transaction_type",
    "timestamp": 0,
    "amount": 0,
    "amount_currency": 0,
    "balance": 0,
    "balance_currency": 0
}

Fields​

id​

Unique ID for that transaction.

user_id​

Refers to the unique identifier for a user.

account_type​

Account type that received a transaction, can be debit, credit_limit, telecom or ewallet.

institution_name​

The institution that is associated with that transaction (i.e. CIB, NBE, HSBC, etc.).

event​

Describes if the transaction resulted in money loss or money gain to the account, and can also describe alerts.

transaction_type​

Describes the nature of the transaction (i.e. transfer, purchase, withdrawal, etc.).

timestamp​

The time the transaction SMS was received by the user.

amount​

Describes the amount in the transaction.

amount_currency​

Describes the currency for the amount in the transaction.

balance​

Describes the remaining balance for the account if present in the SMS.

balance_currency​

Describes the remaining balance's currency for the account if present in the SMS.