Offeritnick at 21:33, 12 May 2017

2017-05-12T21:33:43Z

Offeritnick: /* POST /transaction/transaction_update_revenue_by_orderid */

2017-05-12T17:18:20Z

‎POST /transaction/transaction_update_revenue_by_orderid

Offeritnick: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''POST /transaction/transaction_update_revenue_by_orderid''' == '''Description''' *Updates the amount of a transaction..."

2017-05-12T17:12:55Z

Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''POST /transaction/transaction_update_revenue_by_orderid''' == '''Description''' *Updates the amount of a transaction..."

New page

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /transaction/transaction_update_revenue_by_orderid''' ==
'''Description'''
*Updates the amount of a transaction for a provided orderid

'''Resource URL'''
*<nowiki>http://domain/api/transaction/transaction_update_revenue_by_orderid</nowiki>
*Replace domain with the Offerit domain

'''Response Format'''
*JSON

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

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
*amount
**'''''type: integer'''''
**'''''required'''''
**'''''the amount to set for the transaction in cents'''''
*orderid
**'''''type: string'''''
**'''''required'''''
**'''''the orderid of the transaction to update in Offerit'''''

== '''Example Request''' ==

'''PATCH'''
<pre>
<nowiki>
http://domain/api/transaction/transaction_update_revenue_by_orderid
orderid = OFFERIT:14940018242790524363
amount = 2500

</nowiki>
</pre>
*Response:
<pre>
array(1) {
'result' => string(7) "success"
}
</pre>

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

'''PHP'''
<pre>
<?php
$curl = curl_init();

$url = 'http://domain/api/transaction/transaction_update_revenue_by_orderid';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

$data = array(
'amount' => '2500', // $25.00
'orderid' => 'OFFERIT:14940018242790524363',
);

// do the api call
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_URL, $url);
$resp = curl_exec($curl);

//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
var_dump($output);
}
else {
//invalid json, just dump the raw response
var_dump($resp);
}
?>

</pre>

[[Category:Offerit API Articles]]

@@ Line 84: / Line 84: @@
 	var_dump($resp);
+}
 ?>

@@ Line 5: / Line 5: @@
 '''Description'''
 *Updates the amount of a transaction for a provided orderid
 '''Resource URL'''

Offerit REST API Transaction Update Revenue By Orderid - Revision history

Offeritnick at 21:33, 12 May 2017

Offeritnick: /* POST /transaction/transaction_update_revenue_by_orderid */

Offeritnick: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''POST /transaction/transaction_update_revenue_by_orderid''' == '''Description''' *Updates the amount of a transaction..."