GET
/
wallet_transactions
/
{lago_id}
Retrieve a wallet transaction
curl --request GET \
  --url https://api.getlago.com/api/v1/wallet_transactions/{lago_id} \
  --header 'Authorization: Bearer <token>'
{
  "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",
  "name": "Tokens for models 'high-fidelity-boost'"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
lago_id
string<uuid>
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's record within the Lago system.

Example:

"bb0a27be-51f7-4f4f-aad0-2abc80534c0f"

Response

Wallet transaction

​
lago_id
string<uuid>
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<uuid>
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, settled or failed.

Available options:
pending,
settled,
failed
Example:

"settled"

​
source
enum<string>
required

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"

​
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<date-time>
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"

​
name
string | null
required

The name of the wallet transaction. It will appear on the invoice as the label for the fee. If not set, the label on the invoice will fallback to either Prepaid credits - {{wallet_name}} if the wallet name is set, or Prepaid credits.

Example:

"Tokens for models 'high-fidelity-boost'"

​
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<date-time> | null

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"

​
failed_at
string<date-time> | null

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"