Add Buyer credit via REST API

This article explains how to add credit to a Buyer using the LeadByte REST API. It covers the permissions required, how to set up an Administrator API key, and the endpoint you’ll use to submit a JSON POST request. You’ll also learn where to find your account name and Buyer ID so you can successfully authenticate and apply credit programmatically.

To add Buyer credit through the REST API, you’ll need an API key with the correct permissions.

Navigate to: Admin → Tech Hub → REST API

Then:

Create an Administrator API Key
Enable the permission: Buyer → Add Credit
Activate the API key so it can be used

Adding credit

To add credit to a Buyer, send a JSON POST request to:

https://UPDATEME.leadbyte.com/restapi/v1.3/credit/add

UPDATEME Replace this with your LeadByte account name. You can find it in your account URL or in your integration guide.
BID This is the Buyer ID. You’ll find it under Campaign → Buyers in the BID column.

With the following body:

{
    "key": "[API KEY GOES HERE]",
    "BID": "1234",
    "amount": "100.00"
}

Response

{
    "status": "Success",
    "message": "OK",
    "warnings": []
}

As always, please raise a support ticket with any questions or concerns.

LeadByte Support

Comments