Retrieve a wallet

GET

wallets

{lago_id}

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

curl --location --request GET "$LAGO_URL/api/v1/wallets/:id" \
  --header "Authorization: Bearer $API_KEY"

{
  "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": "2023-11-07T05:31:56Z",
    "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",
    "recurring_transaction_rules": [
      {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "rule_type": "interval",
        "interval": "monthly",
        "threshold_credits": "20.0",
        "paid_credits": "20.0",
        "granted_credits": "10.0",
        "created_at": "2022-04-29T08:59:51Z"
      }
    ],
    "ongoing_balance_cents": 800,
    "ongoing_usage_balance_cents": 200,
    "credits_ongoing_balance": "8.0",
    "credits_ongoing_usage_balance": "2.0"
  }
}

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.

Response

200 - application/json

wallet

object

required

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

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

wallet.external_customer_id

string

required

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

wallet.status

enum<string>

required

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

Available options:

active,

terminated

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

wallet.name

string

The name of the wallet.

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

wallet.credits_balance

string

required

The current wallet balance expressed in credits.

wallet.balance_cents

integer

required

The current wallet balance expressed in cents.

wallet.consumed_credits

string

required

The number of consumed credits.

wallet.created_at

string

required

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

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

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

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

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

wallet.recurring_transaction_rules

object[]

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

wallet.ongoing_balance_cents

integer

required

The wallet ongoing balance expressed in cents.

wallet.ongoing_usage_balance_cents

integer

required

The wallet ongoing usage balance expressed in cents.

wallet.credits_ongoing_balance

string

required

The wallet ongoing balance expressed in credits.

wallet.credits_ongoing_usage_balance

string

required

The wallet ongoing usage balance expressed in credits.

Was this page helpful?

Terminate a wallet List all wallets

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

curl --location --request GET "$LAGO_URL/api/v1/wallets/:id" \
  --header "Authorization: Bearer $API_KEY"

{
  "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": "2023-11-07T05:31:56Z",
    "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",
    "recurring_transaction_rules": [
      {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "rule_type": "interval",
        "interval": "monthly",
        "threshold_credits": "20.0",
        "paid_credits": "20.0",
        "granted_credits": "10.0",
        "created_at": "2022-04-29T08:59:51Z"
      }
    ],
    "ongoing_balance_cents": 800,
    "ongoing_usage_balance_cents": 200,
    "credits_ongoing_balance": "8.0",
    "credits_ongoing_usage_balance": "2.0"
  }
}

API Reference

Authorizations

Path Parameters

Response