List all wallet transactions

API Reference

Getting started
Add-ons
Analytics
Billable metrics
Coupons
Credit notes
Customer usage
Customers
Events
Fees
Invoices
Organizations
Payments
Payment receipts
Payment requests
Plans
Resources
Subscriptions
Taxes
Wallets
- The wallet object
- POST
  Create a wallet
- PUT
  Update a wallet
- DEL
  Terminate a wallet
- GET
  Retrieve a wallet
- GET
  List all wallets
- The wallet transaction object
- POST
  Top-up a wallet
- POST
  Generate a payment URL
- GET
  Retrieve a transaction
- GET
  List all wallet transactions
Webhook endpoints
Webhooks

GET

wallets

{lago_id}

wallet_transactions

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request GET "$LAGO_URL/api/v1/wallets/:id/wallet_transactions?per_page=2&page=1" \
  --header "Authorization: Bearer $API_KEY"

{
  "wallet_transactions": [
    {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "lago_wallet_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "status": "settled",
      "source": "manual",
      "transaction_status": "purchased",
      "transaction_type": "inbound",
      "amount": "10.0",
      "credit_amount": "100.0",
      "invoice_requires_successful_payment": false,
      "metadata": [
        {
          "key": "example key",
          "value": "example value"
        },
        {
          "key": "another key",
          "value": "another value"
        }
      ],
      "settled_at": "2022-04-29T08:59:51Z",
      "failed_at": "2022-04-29T08:59:51Z",
      "created_at": "2022-04-29T08:59:51Z"
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_pages": 4,
    "total_count": 70
  }
}

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request GET "$LAGO_URL/api/v1/wallets/:id/wallet_transactions?per_page=2&page=1" \
  --header "Authorization: Bearer $API_KEY"

Authorizations

Authorization

string

header

required

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.

Example:

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

Query Parameters

page

integer

Page number.

Example:

1

per_page

integer

Number of records per page.

Example:

20

status

string

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

Example:

"pending"

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.

Example:

"purchased"

transaction_type

string

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

Example:

"inbound"

Response

200

application/json

Wallet transactions

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.

Example:

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

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.

Example:

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

wallet_transactions.status

enum<string>

required

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

Available options:

pending,

settled,

failed

Example:

"settled"

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

Example:

"purchased"

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

Example:

"inbound"

wallet_transactions.amount

string

required

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

Example:

"10.0"

wallet_transactions.credit_amount

string

required

The number of credits used in the wallet transaction.

Example:

"100.0"

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

Example:

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

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

Example:

"manual"

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.

Example:

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.

Example:

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

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

Example:

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

wallet_transactions.failed_at

string

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

Example:

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