Skip to main content
PUT
/
api
/
admin
/
accountInstitution
/
{id}
Transfer credits between account and institution
curl --request PUT \
  --url https://pria.praxislxp.com/api/admin/accountInstitution/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "institutionId": "<string>",
  "credits": 100
}
'
{
  "success": true,
  "data": {
    "account": {
      "id": "<string>",
      "credits": 123
    },
    "institution": {
      "id": "<string>",
      "credits": 123,
      "creditsTotal": 123,
      "creditsUsagePct": 123
    }
  },
  "message": "Account Transfer recorded!"
}

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Path Parameters

id
string
required

Account ID (the parent account to transfer credits from/to)

Body

application/json
institutionId
string
required

Institution ID to transfer credits to/from (must belong to the account)

credits
number
required

Number of credits to transfer. Positive = account to institution, negative = institution to account.

Example:

100

Response

Credit transfer completed and recorded

success
boolean
Example:

true

data
object
message
string
Example:

"Account Transfer recorded!"