Sign in

v1

OpenAPI 3.0.02026-07-13811489.0 KB
Rewards Actions

Withdraw Credits

Withdraws credits from a user.

post/users/{app_user_id}/rewards/withdraw-credits

Path parameters

app_user_idstring required

The app user id of the user to withdraw credits from.

Headers

x-api-keystring required

The API key to authenticate with.

Request body

keystring required

The key of the credit reward to withdraw

amountinteger required

The amount of credits to withdraw

operation_idstring nullable

An optional operation id that ensures the same operation won't be performed again

Example request

{
  "key": "credit-reward",
  "amount": 100,
  "operation_id": "821fae4b5-0123-4567-9152-5297086a161c"
}

Response

The result of the withdrawal of credits