Passer au contenu principal
POST
/
v1
/
wallets
/
{id}
/
load
Load wallet
curl --request POST \
  --url https://api.hyperline.co/v1/wallets/{id}/load \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "free",
  "amount": 2400,
  "comment": "Offline payment received",
  "document_status": "draft"
}
'
{
  "id": "wal_PPpxP5d3uvgiTT",
  "customer_id": "cus_QalW2vTAdkR6IY",
  "state": "active",
  "currency": "EUR",
  "balance": {
    "amount": 2400
  },
  "projected_balance": {
    "amount": 2400
  },
  "created_at": "2024-12-20T16:04:11Z",
  "low_projected_balance_threshold": 10000,
  "is_auto_load_enabled": true,
  "auto_load_type": "paid",
  "auto_load_amount": 20000,
  "auto_load_reset": false,
  "auto_load_interval": {
    "period": "months",
    "count": 1
  },
  "auto_load_next_date": "2024-12-20T16:04:11Z",
  "auto_load_threshold": 5000
}

Autorisations

​
Authorization
string
header
requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

​
id
string
requis

Corps

application/json

Load wallet payload.

​
type
enum<string>
requis

Wallet load type. Use paid to collect payment from the customer's payment method, or free to grant credits without collecting payment.

Options disponibles:
free
Exemple:

"free"

​
amount
number
requis

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.

Exemple:

2400

​
comment
string

Internal comment stored on the wallet transaction for context.

Minimum string length: 1
Exemple:

"Offline payment received"

​
document_status
enum<string> | null

Indicates the status of the generated credit note for free top-ups.

Options disponibles:
draft

Réponse

​
id
string
requis

Wallet ID.

Exemple:

"wal_PPpxP5d3uvgiTT"

​
customer_id
string
requis

Wallet customer ID.

Exemple:

"cus_QalW2vTAdkR6IY"

​
state
enum<string>
requis

Wallet state.

Options disponibles:
active,
paused
Exemple:

"active"

​
currency
enum<string>
requis

Currency code. See ISO 4217.

Options disponibles:
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
Exemple:

"EUR"

​
balance
object
requis

Wallet actual balance. Expressed in currency's smallest unit.

​
projected_balance
object
requis

Wallet projected balance. Automatically computed by Hyperline depending on the customer's active subscriptions and future payments. Expressed in currency's smallest unit.

​
created_at
string<date-time>
requis

Wallet creation date.

Exemple:

"2024-12-20T16:04:11Z"

​
low_projected_balance_threshold
number | null
requis

Threshold indicating a low level of wallet projected balance.

Exemple:

10000

​
is_auto_load_enabled
enum<boolean>
requis

Indicates if the wallet is auto-loaded regularly.

Options disponibles:
true
Exemple:

true

​
auto_load_type
enum<string>
requis

Indicates if the auto-load is free or paid.

Options disponibles:
free,
paid
Exemple:

"paid"

​
auto_load_amount
number
requis

Amount to auto-load. Expressed in currency's smallest unit.

Exemple:

20000

​
auto_load_reset
boolean
requis

Indicates if the wallet amount must be reset before auto-load.

Exemple:

false

​
auto_load_interval
object
requis

Interval indicating how often the wallet is auto-loaded.

Exemple:
{ "period": "months", "count": 1 }
​
auto_load_next_date
string<date-time>
requis

Date on which the next auto-load will be executed. UTC date time string in the ISO 8601 format.

Exemple:

"2024-12-20T16:04:11Z"

​
auto_load_threshold
number
requis

Threshold to auto-load. Expressed in currency's smallest unit.

Exemple:

5000