Postback

Our server will make an HTTP GET request to your server, including the following parameters.

Postback parameters

Parameter	Description
subId	The unique identifier for the user who completed the offer.
transId	Unique identification code of the transaction made by your user on Adjoemedia.
reward	The offer payout in dollars.
payout_usd	The offer payout in dollars.
signature	MD5 hash to verify that the call has been made from our servers.
status	Indicates whether to add or subtract the reward amount. "1" means adding virtual currency to the user, and "2" means subtracting it due to issues like fraud or data entry mistakes.
Ip	The user's IP address who completed the action.
campaign_id	ID of the offer completed.
type	Type of offer (Offers/Surveys/PTC/Shortlink).
country	Country (ISO2 form) where the lead comes from.
uuid	Unique identification code of the click made by your user on Adjoemedia.
offer_name	Name of the offer completed.
sign	secret key of your site

"Rewards" and "Payout" parameters are always absolute values. Check the "status" parameter to determine if you need to add or subtract that amount from your users.

Custom postback parameters

To receive custom parameter names in your postbacks, specify them in the postback URL. You can use any of the parameters from the table above by enclosing them in {}.

Example:

https://postback.example.com/?custom={subId2}&nameOfCampaign={campaign_name}

Do not remove or change any query parameters we send.

Security

Verify the signature received in the postback to ensure that the call comes from our servers. The signature parameter should match the MD5 hash of subid, transactionid, reward, and your secret key.

PHP example for signature verification

verify_signature.php

<?php

$secret = ""; // Your secret key

$subId = isset($_GET['subId']) ? $_GET['subId'] : null;
$transId = isset($_GET['transId']) ? $_GET['transId'] : null;
$reward = isset($_GET['reward']) ? $_GET['reward'] : null;
$signature = isset($_GET['signature']) ? $_GET['signature'] : null;

// Validate signature
if (md5($subId . $transId . $reward . $secret) != $signature) {
    echo "ERROR: Signature doesn't match";
    return;
}

?>

Postback response

Our server expects the following responses:

• "OK" when you receive a new transaction.

• "DUP" when you receive a duplicate transaction. This stops further attempts for that transaction.

Our servers wait for a response for a maximum of 60 seconds before a timeout. If a timeout occurs, the request will be retried up to five times in the following hours. Ensure the transaction ID sent to you is unique in your database to prevent duplicate virtual currency rewards.

Postback example implementation

postback_handler.php

<?php

$secret = ""; // Your secret key
$userId = isset($_GET['subId']) ? $_GET['subId'] : null;
$transactionId = isset($_GET['transId']) ? $_GET['transId'] : null;
$points = isset($_GET['reward']) ? $_GET['reward'] : null;
$signature = isset($_GET['signature']) ? $_GET['signature'] : null;
$action = isset($_GET['status']) ? $_GET['status'] : null;
$ipuser = isset($_GET['userIp']) ? $_GET['userIp'] : "0.0.0.0";

// Validate signature
if (md5($userId . $transactionId . $points . $secret) != $signature) {
    echo "ERROR: Signature doesn't match";
    return;
}

if ($action == 2) { // action = 1 CREDITED // action = 2 REVOKED
    $points = -abs($points);
}

if (isNewTransaction($transactionId)) { // Check if the transaction is new
    processTransaction($userId, $points, $transactionId);
    echo "OK";
} else {
    // If the transaction already exists, please echo DUP.
    echo "DUP";
}

?>

Ensure the transaction ID you store is unique in your database to prevent duplicate rewards. Also ensure your server responds within 60 seconds to avoid retries.

Image

There is no need to put our parameters in the postback link because they are taken automatically.

Note: This guide was last updated 25/11/2024.