POST
/
v1
/
wallets
/
{id}
/
load
curl --request POST \
  --url https://api.hyperline.co/v1/wallets/{id}/load \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 123,
  "amount_free": 123
}'
{
  "id": "wal_PPpxP5d3uvgiTT",
  "customer_id": "cus_QalW2vTAdkR6IY",
  "state": "active",
  "currency": "EUR",
  "balance": {
    "amount": 2400
  },
  "projected_balance": {
    "amount": 2400
  },
  "created_at": "2023-01-20T16:04:11Z"
}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

id
string
required

Body

application/json
amount
number

Amount to be loaded onto the wallet. A corresponding invoice to pay will be generated.

amount_free
number

Amount free/offered to be loaded onto the wallet. No invoice is generated.

Response

200 - application/json
id
string
required

Wallet ID.

customer_id
string
required

Wallet customer ID.

state
enum<string>
required

Wallet state.

Available options:
active,
paused
currency
string
required

Currency code. See ISO 4217.

balance
object
required

Wallet actual balance.

projected_balance
object
required

Wallet projected balance. Automatically computed by Hyperline depending on the customer's active subscriptions and future payments.

created_at
string
required

Wallet creation date.

Update walletGet wallet transactions