Interface TransactionItem

Transaction item as returned by the Wave API

Hierarchy

  • TransactionItem

Properties

aggregated_merchant_id? aggregated_merchant_name? amount balance? batch_id? business_user_mobile? business_user_name? checkout_api_session_id? client_reference? counterparty_id? counterparty_mobile? counterparty_name? currency custom_fields? employee_id? fee is_reversal? payment_reason? submerchant_id? submerchant_name? timestamp transaction_id transaction_type?

Properties

Optional aggregated_merchant_id

aggregated_merchant_id?: string

The ID of the aggregated merchant this transaction is assigned to

Optional aggregated_merchant_name

aggregated_merchant_name?: string

The name of the aggregated merchant this transaction is assigned to

amount

amount: string

The amount difference that this transaction had on your account

Optional balance

balance?: string

The wallet's balance after this transaction was executed

Optional batch_id

batch_id?: string

The batch ID if this transaction is part of a bulk payment

Optional business_user_mobile

business_user_mobile?: string

The mobile number of the business user involved in the transaction

Optional business_user_name

business_user_name?: string

The name of the business user involved in the transaction

Optional checkout_api_session_id

checkout_api_session_id?: string

If this payment is linked to a Checkout API session, this is its ID

Optional client_reference

client_reference?: string

A unique string that you (optionally) provided when submitting the transaction

Optional counterparty_id

counterparty_id?: string

The identifier of the counterparty in B2B payments

Optional counterparty_mobile

counterparty_mobile?: string

The mobile number of the counterparty (sender or receiver) of the transaction

Optional counterparty_name

counterparty_name?: string

The name of the counterparty (sender or receiver) of the transaction

currency

currency: Currency

The 3-letter ISO 4217 currency code of the transaction amount

Optional custom_fields

custom_fields?: Record<string, string>

A key-value map of any custom fields related to this payment

Optional employee_id

employee_id?: string

The employee ID associated with the busienss user involved in the transaction

fee

fee: string

The fee for the transaction

Optional is_reversal

is_reversal?: boolean

Marked true if this is a reversal or refund of a previous transaction

Optional payment_reason

payment_reason?: string

A payment reason or message that you (optionally) provided when submitting the transaction

Optional submerchant_id

submerchant_id?: string

If the transaction belongs to a sub-account, this field denotes the ID of the account

Optional submerchant_name

submerchant_name?: string

If the transaction belongs to a sub-account, this field denotes the name of the account

timestamp

timestamp: string

The execution time and date of the transaction

transaction_id

transaction_id: string

A unique identifier for a transaction. Up to 20 characters

Optional transaction_type

transaction_type?: TransactionType

Transaction type. Can be empty

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc