Wallets

Get the current organization wallet balance

Returns the current organization wallet, including balance and funding status used for communication delivery and billing.

get/wallets/me

Request

  • Base URL: https://api.leadping.ai
  • URL: https://api.leadping.ai/wallets/me
  • Auth: HTTP bearer

Response

Wallet was successfully retrieved.

balancenumber double nullable

Wallet or account balance after this transaction is applied.

balanceCalculatedAtstring date-time nullable

UTC timestamp when Leadping last calculated the wallet balance.

amountPurchasednumber double nullable

Amount of wallet credit purchased in this deposit.

amountRemainingnumber double nullable

Amount of wallet credit still available for future usage.

currencystring nullable

ISO currency code used for the monetary amounts in this billing wallet response.

purchasedAtstring date-time nullable

UTC timestamp when the wallet credit was purchased.

expiresAtstring date-time nullable

UTC timestamp when the wallet credit expires.

sourceType'purchase' | 'promo' | 'admin_adjustment' | 'refund_adjustment' | 'chargeback_reversal' | 'compromise_restoration' nullable

Defines the source that created a wallet credit lot.

creditStatus'active' | 'consumed' | 'expired' | 'refunded' | 'voided' | 'disputed' nullable

Defines the lifecycle state for a wallet credit lot.

organizationIdstring nullable

Organization ID that owns this wallet balance or credit.

originalTransactionIdstring nullable

Original wallet transaction ID referenced by a reversal, refund, or adjustment.

nextCreditExpirationAtstring date-time nullable

UTC timestamp when the next wallet credit amount expires.

nextExpiringCreditAmountnumber double nullable

Amount of wallet credit scheduled to expire next.

expiredCreditAmountnumber double nullable

Amount of wallet credit that has expired.

namestring
idstring
createdAtstring date-time
modifiedAtstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.