List all wallets

GET

wallets

Authorization

Query

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

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

{
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_count": 70,
    "total_pages": 4
  },
  "wallets": [
    {
      "balance_cents": 1000,
      "consumed_credits": "2.0",
      "created_at": "2022-04-29T08:59:51Z",
      "credits_balance": "28.0",
      "currency": "USD",
      "expiration_at": "null",
      "external_customer_id": "hooli_1234",
      "lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "last_balance_sync_at": "2022-04-29T08:59:51Z",
      "last_consumed_credit_at": "2022-04-29T08:59:51Z",
      "name": "Prepaid",
      "rate_amount": "1.5",
      "status": "active",
      "terminated_at": "2022-09-14T16:35:31Z"
    }
  ]
}

Authorizations

Authorization

string

headerrequired

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

Query Parameters

page

integer

Page number.

per_page

integer

Number of records per page.

external_customer_id

string

required

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

Response

200 - application/json

meta

object

required

wallets

object[]

required

wallets.balance_cents

integer

required

The current wallet balance expressed in cents.

wallets.consumed_credits

string

required

The number of consumed credits.

wallets.created_at

string

required

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

wallets.credits_balance

string

required

The current wallet balance expressed in credits.

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

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

wallets.external_customer_id

string

required

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

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

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

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

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

wallets.name

string

The name of the wallet.

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

wallets.status

enum<string>

required

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

Available options:

active,

terminated

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

Was this page helpful?

Retrieve a wallet The wallet transaction object

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

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

{
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_count": 70,
    "total_pages": 4
  },
  "wallets": [
    {
      "balance_cents": 1000,
      "consumed_credits": "2.0",
      "created_at": "2022-04-29T08:59:51Z",
      "credits_balance": "28.0",
      "currency": "USD",
      "expiration_at": "null",
      "external_customer_id": "hooli_1234",
      "lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "last_balance_sync_at": "2022-04-29T08:59:51Z",
      "last_consumed_credit_at": "2022-04-29T08:59:51Z",
      "name": "Prepaid",
      "rate_amount": "1.5",
      "status": "active",
      "terminated_at": "2022-09-14T16:35:31Z"
    }
  ]
}

API Reference

Authorizations

Query Parameters

Response