Difference between revisions of "Offerit REST API Transaction Update Revenue By Orderid"
From Offerit
Offeritnick (talk | contribs) (Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''POST /transaction/transaction_update_revenue_by_orderid''' == '''Description''' *Updates the amount of a transaction...") |
Offeritnick (talk | contribs) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 5: | Line 5: | ||
'''Description''' | '''Description''' | ||
*Updates the amount of a transaction for a provided orderid | *Updates the amount of a transaction for a provided orderid | ||
| − | |||
'''Resource URL''' | '''Resource URL''' | ||
| Line 85: | Line 84: | ||
var_dump($resp); | var_dump($resp); | ||
} | } | ||
| + | // Close request to clear up some resources | ||
| + | curl_close($curl); | ||
?> | ?> | ||
Latest revision as of 16:33, 12 May 2017
Contents
POST /transaction/transaction_update_revenue_by_orderid
Description
- Updates the amount of a transaction for a provided orderid
Resource URL
- http://domain/api/transaction/transaction_update_revenue_by_orderid
- Replace domain with the Offerit domain
Response Format
- JSON
- PATCH
- 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
http://domain/api/transaction/transaction_update_revenue_by_orderid orderid = OFFERIT:14940018242790524363 amount = 2500
- Response:
array(1) {
'result' => string(7) "success"
}
Example Code
PHP
<?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);
}
// Close request to clear up some resources
curl_close($curl);
?>
