Skip to main content
POST
Adjust an institution's credit balance (super admin only)

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Path Parameters

id
string
required

Institution ID

Body

application/json
credits
integer
required

Non-zero integer. Positive adds, negative subtracts.

Example:

100

note
string
required

Mandatory reason for the adjustment. Max 2000 chars.

Example:

"compensation for outage"

skipParentDebit
boolean
default:false

If true, inject credits directly into the institution without debiting the parent account. Only meaningful when the institution has a parent account. Intended for promo/compensation credits funded by the platform rather than the client account.

Response

Credits adjusted and transfer recorded

success
boolean
Example:

true

data
object
message
string
Example:

"Institution credits adjusted!"