The wallet transaction object

This object represents a wallet transaction. It is used for topping up or voiding prepaid credits.

The wallet transaction object

{
  "wallet_transaction": {
    "lago_id": "b7ab2926-1de8-4428-9bcd-779314ac1111",
    "lago_wallet_id": "12345",
    "status": "settled",
    "transaction_type": "inbound",
    "transaction_status": "purchased",
    "amount": "10.0",
    "credit_amount": "10.0",
    "settled_at": "2022-04-29T08:59:51Z",
    "created_at": "2022-04-29T08:59:51Z"
  }
}

Attributes

wallet_transaction · object

Hide object

lago_id · string · required

Unique identifier assigned to the wallet transaction within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet transaction’s record within the Lago system.

lago_wallet_id · string · required

Unique identifier assigned to the wallet within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the wallet’s record within the Lago system.

status · string · required

The status of the wallet transaction. Possible values are pending or settled.

transaction_status · string · required

The transaction status of the wallet transaction. Possible values are purchased (with pending or settled status), granted (without invoice_id) or voided (with outbound transaction type).

transaction_type · string · required

The type of transaction. Possible values are inbound (increasing the balance) or outbound (decreasing the balance).

credit_amount · string · required

The number of credits used in the wallet transaction.

amount · string · required

The amount of credits based on the rate and the currency.

created_at · string · required

The date of the wallet transaction creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).

settled_at · string

The date when wallet transaction is settled, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).