Skip to main content
POST
Top up a wristband's balance

Authorizations

Authorization
string
header
required

Integrator API key, issued from the VENTRY dashboard. Format vk_live_... in production and vk_test_... in test environments.

Headers

idempotency-key
string
required

Path Parameters

code
string
required

Body

application/json
amount
integer
required

Amount to add, in cents. 2500 is €25.00.

Required range: 1 <= x <= 100000
bonus_amount
integer

Gift shown when charging, in cents.

Required range: 1 <= x <= 100000
bonus_rule
string

Id of the bonus that gives it, from GET /topup-bonuses/quote.

Pattern: ^[0-9a-fA-F]{24}$
granted_at
string<date-time>

When the gift was promised (when charging). The rule is checked at that moment: a top-up paid before the event may be delivered after the promotion has ended. Defaults to now.

Response

Result of the top-up.

Result of the top-up.

object
enum<string>
Available options:
topup_result
id
string
amount
integer
previous_balance
integer
new_balance
integer
bonus_amount
integer

Gift granted, in cents. 0 if none was requested or the rule no longer allows it.

bonus_id
null | string

Id of the gift's movement in GET /topups, or null if there was none.

previous_promo_balance
integer
new_promo_balance
integer

Gifted balance after the top-up, gift included.

replayed
boolean

true if the response was replayed from an earlier attempt with the same Idempotency-Key.