Skip to main content
POST
https://api.zebedee.io
/
api
/
v1
/
rewards
/
user
/
{rewardsUserId}
/
withdrawal-limit
Increase Withdrawal Limit
curl --request POST \
  --url https://api.zebedee.io/api/v1/rewards/user/{rewardsUserId}/withdrawal-limit \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "amount": 123,
  "currency": "<string>"
}
'
{
  "success": true,
  "message": "Success."
}
Increase the withdrawal limit for a specific user in your Rewards App from your server. This endpoint allows you to raise the maximum amount a user can withdraw from their rewards balance.
Server-Side Authentication: This endpoint requires a secure API key. Learn how to create an API key for your Rewards App. Keep your API key secure and never expose it in client-side code.

​
Configuration

​
Header Parameters

​
x-api-key
string
required
Your Rewards App API key for authentication.Create an API key if you haven’t already.

​
Path Parameters

​
rewardsUserId
string
required
The user’s rewards ID (UUID format)

​
Body Parameters

​
amount
number
required
Amount to increase the withdrawal limit by. Must be a positive number greater than 0.
​
currency
string
required
Currency type for the amountOptions: MSATS or POINT
{
  "success": true,
  "message": "Success."
}

​
Response Status Codes

CodeDescription
200Limit added successfully
400Bad request, invalid parameters or negative amount
401Unauthorized, authentication required
403Forbidden, admin access required
404User not found
500Internal server error
{
  "success": false,
  "message": "Invalid amount or currency"
}

​
Response Fields

FieldTypeDescription
successbooleanWhether the request was successful
messagestringResponse message indicating the result

​
Code Examples

const rewardsUserId = 'USER_REWARDS_ID';
const apiKey = 'YOUR_API_KEY'; // Get from https://docs.zbdpay.com/earn/sdk/create-api-key

async function increaseWithdrawalLimit(rewardsUserId, amount, currency) {
  const response = await fetch(
    `https://api.zebedee.io/api/v1/rewards/user/${rewardsUserId}/withdrawal-limit`,
    {
      method: 'POST',
      headers: {
        'x-api-key': apiKey,
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        amount: amount,
        currency: currency
      })
    }
  );

  const data = await response.json();

  if (data.success) {
    console.log('Withdrawal limit increased successfully');
    return data;
  } else {
    throw new Error(`Failed: ${data.message}`);
  }
}

// Increase limit by 1000 MSATS
await increaseWithdrawalLimit('b28e0306-2c06-4092-8d56-a1623d6b97fb', 1000, 'MSATS');
Validation Rules: The amount must be a positive number greater than 0. Negative values or zero will result in a 400 Bad Request error.

​
Try It Out

Ready to increase a user’s withdrawal limit? Use our API playground on the right to test with your API key and user ID.