Skip to main content
POST
/
api
/
user
/
userInstitutionCredit
/
{userInstitutionId}
Credit user institution with tokens
curl --request POST \
  --url http://localhost:3000/api/user/userInstitutionCredit/{userInstitutionId} \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "credits": 1000
}
'
{
  "success": true,
  "message": "Transfer successfully executed and recorded!"
}

Authorizations

​
x-access-token
string
header
required

JWT token passed in x-access-token header

Path Parameters

​
userInstitutionId
string
required

The user institution ID to credit

Body

application/json
​
credits
integer

Number of credits to transfer (default 1000)

Example:

1000

Response

Credits transferred successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Transfer successfully executed and recorded!"