PATCH
/
v1
/
wallets
/
settings
curl --request PATCH \
  --url https://api.hyperline.co/v1/wallets/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "enabled": true,
  "allow_free_credits": true,
  "allow_topup_on_portal": false,
  "product_ids": []
}'
{
  "enabled": true,
  "allow_free_credits": true,
  "allow_topup_on_portal": false,
  "product_ids": [],
  "updated_at": "2024-12-20T16:04:11Z"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
Update wallet settings payload
​
enabled
boolean

Indicates if the wallet feature is enabled or not. If disabled, wallets won't be debited even if they are in active state and with money.

Example:

true

​
allow_free_credits
boolean

Allow top up for free amounts on wallets.

Example:

true

​
allow_topup_on_portal
boolean

Allow wallet top up on customer's portal.

Example:

false

​
product_ids
string[]

Product IDs on which wallet will apply. If empty, the wallet will apply to all invoice line items.

Example:
[]

Response

200 - application/json
​
enabled
boolean
required

Indicates if the wallet feature is enabled or not. If disabled, wallets won't be debited even if they are in active state and with money.

Example:

true

​
allow_free_credits
boolean
required

Allow top up for free amounts on wallets.

Example:

true

​
allow_topup_on_portal
boolean
required

Allow wallet top up on customer's portal.

Example:

false

​
product_ids
string[]
required

Product IDs on which wallet will apply. If empty, the wallet will apply to all invoice line items.

Example:
[]
​
updated_at
string | null
required

Last edition date of the wallet settings.

Example:

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

Was this page helpful?