Loading...Endpoint
POST /api/v1/withdraw-tokensDescription
This endpoint allows you to withdraw a specific number of tokens from a user's balance for a particular paywall. To use this endpoint, you need an API key that can be created in your account settings under the "API Keys" tab. The API key owner must be the creator of the paywall for which the tokens are being withdrawn.
Authentication
Authenticate your requests by including your API key in the X-Api-Key header.
X-Api-Key: your-api-keyRequest Parameters
The request body should be in JSON format and include the following parameters:
{ "paywall_id": "123", // ID of the paywall "user_id": "user-uuid", // ID of the user whose tokens will be withdraw "tokens": 5, // Number of tokens to withdraw (must be greater than 0) "token_type": "standard" // Type of tokens to withdraw (default: "standard") }
Success Response
Successful Response (200 OK)
{ "success": true, "remaining": 45 }
The remaining field indicates the number of tokens of the specified type left in the user's balance after the withdrawal.
Error Responses
Missing API Key (401 Unauthorized)
{"error": "API key is required"}Invalid API Key (401 Unauthorized)
{"error": "Invalid API key"}Inactive API Key (403 Forbidden)
{"error": "API key is inactive"}Not the Owner (403 Forbidden)
{"error": "Unauthorized. You are not the owner of this paywall"}Missing Parameters (400 Bad Request)
{"error": "User ID is required"}Insufficient Tokens (400 Bad Request)
{"error": "Insufficient tokens", "available": 3, "requested": 5}Paywall Not Found (404 Not Found)
{ "error": "Paywall not found"}User Balance Not Found (404 Not Found)
{"error": "No balance found for this user and paywall"}