List all wallet transactions

GET

wallets

{lago_id}

wallet_transactions

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

lago_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.

Query Parameters

page

integer

Page number.

per_page

integer

Number of records per page.

status

string

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

transaction_status

string

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

transaction_type

string

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

Response

200 - application/json

wallet_transactions

object[]

required

wallet_transactions.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.

wallet_transactions.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.

wallet_transactions.status

enum<string>

required

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

Available options:

pending,

settled

wallet_transactions.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

wallet_transactions.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

wallet_transactions.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

wallet_transactions.amount

string

required

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

wallet_transactions.credit_amount

string

required

The number of credits used in the wallet transaction.

wallet_transactions.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.

wallet_transactions.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.

wallet_transactions.settled_at

string

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

wallet_transactions.created_at

string

required

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

API Reference

Authorizations

Path Parameters

Query Parameters

Response