The wallet object

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

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"

lago_customer_id

string

required

Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system.

Example:

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

external_customer_id

string

required

The customer external unique identifier (provided by your own application)

Example:

"hooli_1234"

status

enum<string>

required

The status of the wallet. Possible values are active or terminated.

Available options:

active,

terminated

Example:

"active"

currency

enum<string>

required

The currency of the wallet.

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLF,

CLP,

CNY,

COP,

CRC,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

ISK,

JMD,

JPY,

KES,

KGS,

KHR,

KMF,

KRW,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRO,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

STD,

SZL,

THB,

TJS,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

Example:

"USD"

rate_amount

string

required

The rate of conversion between credits and the amount in the specified currency. It indicates the ratio or factor used to convert credits into the corresponding monetary value in the currency of the transaction.

Example:

"1.5"

credits_balance

string

required

The current wallet balance expressed in credits. This reflects the available balance after all transactions are settled.

Example:

"28.0"

balance_cents

integer

required

The current wallet balance expressed in cents. This reflects the available balance after all transactions are settled.

Example:

1000

consumed_credits

string

required

The number of consumed credits.

Example:

"2.0"

created_at

string

required

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

Example:

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

ongoing_balance_cents

integer

required

The ongoing wallet balance expressed in cents. This represents the balance_cents minus the ongoing_usage_balance_cents, showing the real time balance after accounting for current usage including taxes.

Example:

800

ongoing_usage_balance_cents

integer

required

The ongoing usage balance of the wallet, expressed in cents. This reflects all current usage and draft invoices including taxes.

Example:

200

credits_ongoing_balance

string

required

The ongoing wallet balance expressed in credits. This represents the credits_balance minus the credits_ongoing_usage_balance, showing the real time balance after accounting for current usage including taxes.

Example:

"8.0"

credits_ongoing_usage_balance

string

required

The ongoing usage balance of the wallet, expressed in credits. This reflects all current usage and draft invoices including taxes.

Example:

"2.0"

name

string

The name of the wallet.

Example:

"Prepaid"

expiration_at

string | null

The date and time that determines when the wallet will expire. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).

Example:

null

last_balance_sync_at

string | null

The date and time of the last balance top-up. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).

Example:

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

last_consumed_credit_at

string | null

The date and time of the last credits consumption. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).

Example:

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

terminated_at

string | null

The date of terminaison of the wallet. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).

Example:

"2022-09-14T16:35:31Z"

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

recurring_transaction_rules

object[]

List of recurring transaction rules. Currently, we only allow one recurring rule per wallet.

Object that represents rule for wallet recurring transactions.

recurring_transaction_rules.lago_id

string

required

A unique identifier for the recurring transaction rule in the Lago application. Can be used to update a recurring transaction rule.

Example:

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

recurring_transaction_rules.trigger

enum<string>

required

The trigger. Possible values are interval or threshold.

Available options:

interval,

threshold

Example:

"interval"

recurring_transaction_rules.method

enum<string>

required

The method used for recurring top-up. Possible values are fixed or target.

Available options:

fixed,

target

Example:

"target"

recurring_transaction_rules.interval

enum<string>

required

The interval used for recurring top-up. It represents the frequency at which automatic top-up occurs. The interval can be one of the following values: weekly, monthly, quarterly or yearly. Required only if trigger is set to interval.

Available options:

weekly,

monthly,

quarterly,

yearly

Example:

"monthly"

recurring_transaction_rules.threshold_credits

string

required

The threshold for recurring top-ups is the value at which an automatic top-up is triggered. For example, if this threshold is set at 10 credits, an automatic top-up will occur whenever the wallet balance falls to or below 10 credits. Required only when trigger is set to threshold.

Example:

"20.0"

recurring_transaction_rules.paid_credits

string

required

The number of paid credits. Required only if there is no granted credits.

Example:

"20.0"

recurring_transaction_rules.granted_credits

string

required

The number of free granted credits. Required only if there is no paid credits.

Example:

"10.0"

recurring_transaction_rules.target_ongoing_balance

string

required

The target ongoing balance is the value set for the ongoing balance to be reached by the automatic top-up. Required only when trigger is set to target.

Example:

"200.0"

recurring_transaction_rules.created_at

string

required

The date of the metadata object creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The creation_date provides a standardized and internationally recognized timestamp for when the metadata object was created

Example:

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

recurring_transaction_rules.status

enum<string>

The status of the recurring transaction rule. Possible values are active or terminated.

Available options:

active,

terminated

Example:

"active"

recurring_transaction_rules.started_at

string

The effective start date for recurring top-ups. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).

Example:

"2022-08-08T00:00:00Z"

recurring_transaction_rules.expiration_at

string

The expiration date and time for this specific recurring transaction rule. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC).

Example:

"2023-09-30T23:59:59Z"

recurring_transaction_rules.invoice_requires_successful_payment

boolean

Example:

false

recurring_transaction_rules.transaction_metadata

object[]

This field allows you to store a list of key-value pairs containing additional information or custom attributes. These key-value pairs will populate the metadata of the wallet transactions triggered by this rule.

Example:

[
  {
    "key": "example_key",
    "value": "example_value"
  },
  {
    "key": "another_key",
    "value": "another_value"
  }
]

Was this page helpful?

Suggest edits Raise issue

List all tax rates Create a wallet

{
  "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "external_customer_id": "hooli_1234",
  "status": "active",
  "currency": "USD",
  "name": "Prepaid",
  "rate_amount": "1.5",
  "credits_balance": "28.0",
  "balance_cents": 1000,
  "consumed_credits": "2.0",
  "created_at": "2022-04-29T08:59:51Z",
  "expiration_at": null,
  "last_balance_sync_at": "2022-04-29T08:59:51Z",
  "last_consumed_credit_at": "2022-04-29T08:59:51Z",
  "terminated_at": "2022-09-14T16:35:31Z",
  "invoice_requires_successful_payment": false,
  "recurring_transaction_rules": [
    {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "trigger": "interval",
      "method": "target",
      "interval": "monthly",
      "status": "active",
      "threshold_credits": "20.0",
      "paid_credits": "20.0",
      "granted_credits": "10.0",
      "started_at": "2022-08-08T00:00:00Z",
      "target_ongoing_balance": "200.0",
      "created_at": "2022-04-29T08:59:51Z",
      "expiration_at": "2023-09-30T23:59:59Z",
      "invoice_requires_successful_payment": false,
      "transaction_metadata": [
        {
          "key": "example_key",
          "value": "example_value"
        },
        {
          "key": "another_key",
          "value": "another_value"
        }
      ]
    }
  ],
  "ongoing_balance_cents": 800,
  "ongoing_usage_balance_cents": 200,
  "credits_ongoing_balance": "8.0",
  "credits_ongoing_usage_balance": "2.0"
}