Get wallets
Retrieve all existing wallets.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Response
Wallet ID.
"wal_PPpxP5d3uvgiTT"
Wallet customer ID.
"cus_QalW2vTAdkR6IY"
Wallet state.
active
, paused
"active"
Currency code. See ISO 4217.
EUR
, AED
, AFN
, XCD
, ALL
, AMD
, AOA
, ARS
, USD
, AUD
, AWG
, AZN
, BAM
, BBD
, BDT
, XOF
, BGN
, BHD
, BIF
, BMD
, BND
, BOB
, BRL
, BSD
, BTN
, NOK
, BWP
, BYR
, BZD
, CAD
, CDF
, XAF
, CHF
, NZD
, CLP
, CNY
, COP
, CRC
, CUP
, CVE
, ANG
, CZK
, DJF
, DKK
, DOP
, DZD
, EGP
, MAD
, ERN
, ETB
, FJD
, FKP
, GBP
, GEL
, GHS
, GIP
, GMD
, GNF
, GTQ
, GYD
, HKD
, HNL
, HRK
, HTG
, HUF
, IDR
, ILS
, INR
, IQD
, IRR
, ISK
, JMD
, JOD
, JPY
, KES
, KGS
, KHR
, KMF
, KPW
, KRW
, KWD
, KYD
, KZT
, LAK
, LBP
, LKR
, LRD
, LSL
, LYD
, MDL
, MGA
, MKD
, MMK
, MNT
, MOP
, MRO
, MUR
, MVR
, MWK
, MXN
, MYR
, MZN
, NAD
, XPF
, NGN
, NIO
, NPR
, OMR
, PAB
, PEN
, PGK
, PHP
, PKR
, PLN
, PYG
, QAR
, RON
, RSD
, RUB
, RWF
, SAR
, SBD
, SCR
, SDG
, SEK
, SGD
, SHP
, SLL
, SOS
, SRD
, SSP
, STD
, SYP
, SZL
, THB
, TJS
, TMT
, TND
, TOP
, TRY
, TTD
, TWD
, TZS
, UAH
, UGX
, UYU
, UZS
, VEF
, VND
, VUV
, WST
, YER
, ZAR
, ZMW
, ZWL
"EUR"
Wallet actual balance. Expressed in currency's smallest unit.
Wallet projected balance. Automatically computed by Hyperline depending on the customer's active subscriptions and future payments. Expressed in currency's smallest unit.
Wallet creation date.
"2024-12-20T16:04:11Z"
Indicates if the wallet is auto-loaded regularly.
true
Indicates if the auto-load is free or paid.
free
, paid
"paid"
Amount to auto-load. Expressed in currency's smallest unit.
20000
Interval indicating how often the wallet is auto-loaded.
{ "period": "months", "count": 1 }
Date on which the next auto-load will be executed. UTC date time string in the ISO 8601 format.
"2024-12-20T16:04:11Z"
Indicates if the wallet amount must be reset before auto-load.
false
Was this page helpful?