Load wallet
Load free credits or paid credits from a paid invoice, an existing transaction, or a new transaction onto a wallet.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
Load wallet payload.
- Free
- Paid from existing transaction
- Paid from invoice line items
- Paid from new transaction
- Deprecated
Wallet load type. Use paid to load paid invoice line items, apply an existing payment transaction, or record a new one, or free to grant credits without collecting payment.
free "free"
Amount to be loaded onto the wallet as free credits. A corresponding credit note will be generated and no payment is collected. Expressed in currency's smallest unit.
2400
Internal comment stored on the wallet transaction for context.
1"Offline payment received"
Indicates the status of the generated credit note for free top-ups.
draft Response
- Wallet: interval + threshold
- Wallet: interval
- Wallet: threshold
- Wallet: no auto-load
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, BGN, BHD, BIF, XOF, 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"
Threshold indicating a low level of wallet projected balance.
10000
Indicates if the wallet is auto-loaded regularly.
true true
Indicates if the auto-load is free or paid.
free, paid "paid"
Amount to auto-load. Expressed in currency's smallest unit.
20000
Indicates if the wallet amount must be reset before auto-load.
false
Interval indicating how often the wallet is auto-loaded.
Threshold to auto-load. Expressed in currency's smallest unit.
5000

