Offerit REST API Process Void - Revision history

OfferitRob: /* Parameters */

2020-06-24T18:23:42Z

‎Parameters

OfferitRob: /* Parameters */

2020-06-23T20:44:40Z

‎Parameters

OfferitRob at 21:45, 6 February 2018

2018-02-06T21:45:30Z

OfferitRob: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''POST transaction/process_void''' == '''Description''' *Offerit has a REST API resource to void a transaction previous..."

2018-02-06T21:05:36Z

Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''POST transaction/process_void''' == '''Description''' *Offerit has a REST API resource to void a transaction previous..."

New page

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST transaction/process_void''' ==
'''Description'''
*Offerit has a REST API resource to void a transaction previously that was previously converted

'''Resource URL'''
*<nowiki>http://domain/api/transaction/process_void</nowiki>
*Replace domain with your Offerit network domain

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

'''Response Format'''
*JSON

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

== '''Parameters''' ==
*'''type''': ''This should always be set as void''
**'''''type: string'''''
**'''''required'''''

*'''transaction_hash''': ''The click_hash/transaction_hash of the transaction you want voided.''
**'''''type: string'''''
**'''''optional'''''

*'''click_hash''': ''The click_hash/transaction_hash of the transaction you want voided.''
**'''''type: string'''''
**'''''optional'''''

*'''orderid''': ''The transaction identifier sent on conversion (orderid) you want voided.''
**'''''type: string'''''
**'''''optional'''''

*'''transactionid''': ''The Offerit generated transaction identifier you want voided''
**'''''type: string'''''
**'''''optional'''''

*'''approved''': ''Used in setups with pending conversions so the initial transaction identifier can be sent to void the associated approval''
**'''''type: string'''''
**'''''optional'''''

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

'''POST'''

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

*Response:
<pre>
Success
{
"result": "success",
"message": "*success*"
}

Failure
{
"result": "error",
"message": "*error* - Void transaction exists."
}
</pre>

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

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

$data = array(
'type' => 'void',
'transaction_hash' => '156097c947ece92.38318951',
);
$url = 'http://domain/api/transaction/process_void';
$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
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
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>

</pre>

[[Category:Offerit API Articles]]

@@ Line 20: / Line 20: @@
 == '''Parameters''' ==
 *'''transaction_hash''': ''The click_hash/transaction_hash of the transaction you want voided.''
 **'''''type: string'''''

← Older revision		Revision as of 20:44, 23 June 2020
Line 44:		Line 44:
	**'''''optional'''''		**'''''optional'''''

		+	*'''trans_custom1 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
		+	**'''''type: string'''''
		+	**'''''optional'''''

		+	*'''trans_custom2 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
		+	**'''''type: string'''''
		+	**'''''optional'''''
		+
		+	*'''trans_custom3 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
		+	**'''''type: string'''''
		+	**'''''optional'''''
		+
		+	*'''trans_custom4 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
		+	**'''''type: string'''''
		+	**'''''optional'''''
		+
		+	*'''trans_custom5 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
		+	**'''''type: string'''''
		+	**'''''optional'''''

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

@@ Line 4: / Line 4: @@
 == '''POST transaction/process_void''' ==
 '''Description'''
-*Offerit has a REST API resource to void a transaction previously that was previously converted
+*This REST API resource is used to void a transaction that was previously converted
 '''Resource URL'''