Accounts

Top-up allowance (balance cap and rolling 30-day cap)

Requires account:r.

get/v1/accounts/{id}/topup-allowance

Request

  • Base URL: https://api.honkio.ca
  • URL: https://api.honkio.ca/v1/accounts/{id}/topup-allowance
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring required

Response

How much may be added now. Amounts are CAD cents.

max_topup_now_centsinteger required

The largest top-up accepted right now: the smaller of the two headrooms.

headroom_balance_centsinteger required

Room left under the balance cap.

headroom_30d_centsinteger required

Room left under the rolling 30-day cap.

max_balance_centsinteger required
max_30d_centsinteger required
balance_centsinteger required
topped_up_30d_centsinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.