Offerit REST API Get Transaction Payout Preview - Revision history

OfferitRob at 16:22, 27 August 2018

2018-08-27T16:22:16Z

Offeritnick at 21:33, 12 May 2017

2017-05-12T21:33:20Z

OfferitRob at 21:14, 22 March 2017

2017-03-22T21:14:55Z

OfferitDave: Created page with "{{Offerit Manual | show_api_admin_section = true }} == '''GET transaction/transaction_payout_preview''' == '''Description''' *Offerit has a REST API resource to look up the c..."

2015-12-21T16:14:17Z

Created page with "{{Offerit Manual | show_api_admin_section = true }} == '''GET transaction/transaction_payout_preview''' == '''Description''' *Offerit has a REST API resource to look up the c..."

New page

{{Offerit Manual
| show_api_admin_section = true
}}
== '''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'''
*<nowiki>http://domain/api/transaction/transaction_payout_preview</nowiki>
*Replace domain with the nats domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|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'''

<nowiki>http://domain.com/api/transaction/transaction_payout_preview</nowiki>

== '''Example Code''' ==

'''PHP'''
<pre>
<?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);
?>

</pre>

[[Category:Offerit API Articles]]

@@ Line 8: / Line 8: @@
 '''Resource URL'''
 *<nowiki>http://domain/api/transaction/transaction_payout_preview</nowiki>
-*Replace domain with the nats domain
+*Replace domain with the Offerit domain
 '''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]

@@ Line 67: / Line 67: @@
 $resp = curl_exec($curl);
-//dumps an associative array representation of the json
+//dumps an associative array representation of the json response
-var_dump(json_decode($resp, true));
+$output = json_decode($resp, true);
 // Close request to clear up some resources
 curl_close($curl);

@@ Line 1: / Line 1: @@
 {{Offerit Manual
-| show_api_admin_section = true
+| show_rest_api_section = true
 }}
 == '''GET transaction/transaction_payout_preview''' ==