Difference between revisions of "Offerit REST API Get Transaction Payout Preview"

Revision as of 12:14, 21 December 2015

GET transaction/transaction_payout_preview

Description

• Offerit has a REST API resource to look up the commission amount that would be paid for a specific conversion before it happens

Resource URL

• http://domain/api/transaction/transaction_payout_preview
• Replace domain with the nats domain

Request Method

• GET

Response Format

• JSON

Authentication

• HTTP headers

Parameters

Paremeters can be sent as url encoded params. See examples below.

• transaction_hash: The click_hash of the click you are looking up.
  • type: string
  • required

• amount: The conversion amount. If unspecified, % based conversions will be based on an amount of 100
  • type: float
  • optional

• transaction_type: Default is initial for conversions
  • type: string
  • optional

Example Request

GET

http://domain.com/api/transaction/transaction_payout_preview

Example Code

PHP

<?php
$curl = curl_init();

$data = array(
    'transaction_hash' => 156097c947ece92.38318951,
    'amount' => 50.25,

);

$data_string = http_build_query($data);
$url = 'http://domain/api/transaction/transaction_payout_preview?'.$data_string;

$headers = array(
    'api-key: 44b5498dbcb481a0d00b404c0169af62',
    'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>