Skip to main content
POST
/
api
/
admin
/
institution
/
{id}
/
credits
Adjust an institution's credit balance (super admin only)
curl --request POST \
  --url https://pria.praxislxp.com/api/admin/institution/{id}/credits \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "credits": 100,
  "note": "compensation for outage",
  "skipParentDebit": false
}
'
{
  "success": true,
  "data": {
    "institution": {
      "id": "<string>",
      "credits": 123
    },
    "account": {
      "id": "<string>",
      "credits": 123
    },
    "transfer": {
      "_id": "<string>",
      "institution": "<string>",
      "account": "<string>",
      "user": "<string>",
      "credits": 123,
      "status": "active",
      "created": "2023-11-07T05:31:56Z",
      "transferMode": 1,
      "note": "<string>"
    }
  },
  "message": "Institution credits adjusted!"
}

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!"