Wallets

Get Customer Wallets

Changed on

Use when resolving wallets by external customer id or lookup key (e.g. from your app's user id). Supports optional real-time balance and expand.

get/customers/wallets

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/customers/wallets
  • Auth
    API key in header x-api-key

Query parameters

-integer

populated from x-max-live header, not query param

expandstring
from_cacheboolean
idstring
include_real_time_balanceboolean
lookup_keystring

Response

OK

alert_state'ok' | 'info' | 'warning' | 'in_alarm'
balancestring
conversion_ratestring

amount in the currency = number of credits * conversion_rate ex if conversion_rate is 1, then 1 USD = 1 credit ex if conversion_rate is 2, then 1 USD = 0.5 credits ex if conversion_rate is 0.5, then 1 USD = 2 credits

created_atstring date-time
created_bystring
credit_balancestring
currencystring
customer_idstring
descriptionstring
environment_idstring
idstring
metadataTypesMetadata
namestring
real_time_balancestring
real_time_credit_balancestring
status'published' | 'deleted' | 'archived'
tenant_idstring
topup_conversion_ratestring

topup_conversion_rate is the conversion rate for the topup to the currency ex if topup_conversion_rate is 1, then 1 USD = 1 credit ex if topup_conversion_rate is 2, then 1 USD = 0.5 credits ex if topup_conversion_rate is 0.5, then 1 USD = 2 credits

updated_atstring date-time
updated_bystring
wallet_status'active' | 'frozen' | 'closed'
wallet_type'PRE_PAID' | 'POST_PAID'

Changes

  • e36fe54e0efbRevision changes
    • info

      added the optional property // to the response with the status

  • 50b7421a9690Revision changes
    • info

      added the optional property // to the response with the status