Skip to main content
GET
/
wallets
/
{id}
Get a business wallet balance by ID
curl --request GET \
  --url https://api.leadping.ai/wallets/{id}
{
  "balance": "<string>",
  "balanceCalculatedAt": "2023-11-07T05:31:56Z",
  "amountPurchased": "<string>",
  "amountRemaining": "<string>",
  "currency": "<string>",
  "purchasedAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "businessId": "<string>",
  "originalTransactionId": "<string>",
  "stripePaymentIntentId": "<string>",
  "stripeChargeId": "<string>",
  "stripeInvoiceId": "<string>",
  "nextCreditExpirationAt": "2023-11-07T05:31:56Z",
  "nextExpiringCreditAmount": "<string>",
  "expiredCreditAmount": "<string>",
  "name": "<string>",
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z"
}

Path Parameters

​
id
string
required

The ID of the wallet to retrieve.

Response

Wallet was successfully retrieved.

API response containing wallet data returned to callers.

​
balance
string<double> | null

The monetary balance for this wallet.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
​
balanceCalculatedAt
string<date-time> | null

The date and time for the balance calculated at value on this wallet.

​
amountPurchased
string<double> | null
Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
​
amountRemaining
string<double> | null
Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
​
currency
string | null
​
purchasedAt
string<date-time> | null
​
expiresAt
string<date-time> | null
​
sourceType
enum<string> | null

Defines the source that created a wallet credit lot.

Available options:
purchase,
promo,
admin_adjustment,
refund_adjustment,
migration,
chargeback_reversal,
compromise_restoration
​
creditStatus
enum<string> | null

Defines the lifecycle state for a wallet credit lot.

Available options:
active,
consumed,
expired,
refunded,
voided,
disputed
​
businessId
string | null
​
originalTransactionId
string | null
​
stripePaymentIntentId
string | null
​
stripeChargeId
string | null
​
stripeInvoiceId
string | null
​
nextCreditExpirationAt
string<date-time> | null
​
nextExpiringCreditAmount
string<double> | null
Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
​
expiredCreditAmount
string<double> | null
Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
​
name
string

The display name for the entity.

​
id
string

The unique identifier for the entity.

​
createdAt
string<date-time>

The date and time when the entity was created.

​
modifiedAt
string<date-time> | null

The date and time when the entity was last modified, if applicable.