The wallet transaction 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.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

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.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

status

enum<string>

required

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

Available options:

pending,

settled

Example:

"settled"

transaction_status

enum<string>

required

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

Available options:

purchased,

granted,

voided,

invoiced

Example:

"purchased"

transaction_type

enum<string>

required

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

Available options:

inbound,

outbound

Example:

"inbound"

amount

string

required

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

Example:

"10.0"

credit_amount

string

required

The number of credits used in the wallet transaction.

Example:

"100.0"

created_at

string

required

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

Example:

"2022-04-29T08:59:51Z"

source

enum<string>

The source field represents the origin or trigger of the wallet transaction. Possible values are manual, interval. threshold

Available options:

manual,

interval,

threshold

Example:

"manual"

invoice_requires_successful_payment

boolean

A boolean setting that, when set to true, delays issuing an invoice for a wallet top-up until a successful payment is made; if false, the invoice is issued immediately upon wallet top-up, regardless of the payment status. Default value of false.

Example:

false

metadata

object[]

This field allows you to store a list of key-value pairs that hold additional information or custom attributes related to the data.

Example:

[
  {
    "key": "example key",
    "value": "example value"
  },
  {
    "key": "another key",
    "value": "another value"
  }
]

settled_at

string

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

Example:

"2022-04-29T08:59:51Z"

API Reference