Top-up a wallet

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

curl --location --request POST "$LAGO_URL/api/v1/wallet_transactions" \
  --header "Authorization: Bearer $API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "wallet_transaction": {
      "wallet_id": "wallet_1234",
      "paid_credits": "20.0",
      "granted_credits": "10.0"
    }
  }'

Authorizations

Authorization

string

header

required

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

Body

application/json

Wallet transaction payload

wallet_transaction

object

required

Show child attributes

wallet_transaction.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"

wallet_transaction.name

string | null

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.

Note that this name will apply to all transactions (paid_credits, granted_credits and voided_credits) created by this action.

Example:

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

wallet_transaction.paid_credits

string | null

The number of paid credits.

Example:

"20.0"

wallet_transaction.granted_credits

string | null

The number of free granted credits.

Example:

"10.0"

wallet_transaction.voided_credits

string | null

The number of voided credits.

Example:

"5.0"

wallet_transaction.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_transaction.ignore_paid_top_up_limits

boolean

When true, allows topping up the wallet with transactions that exceed the paid top-up limits. Defaults to false.

Example:

false

wallet_transaction.metadata

object[] | null

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

Show child attributes

wallet_transaction.metadata.key

string

The unique identifier for the attribute.

wallet_transaction.metadata.value

string

The value associated with the key.

Example:

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

Response

Wallet transaction created

wallet_transactions

object[]

required

Show child attributes

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

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

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

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<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"

wallet_transactions.name

string | null

required

Example:

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

wallet_transactions.invoice_requires_successful_payment

boolean

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.

Show child attributes

wallet_transactions.metadata.key

string

The unique identifier for the attribute.

wallet_transactions.metadata.value

string

The value associated with the key.

Example:

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

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

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

API Reference

Authorizations

Body

Response