Difference between revisions of "Void Conversions Remotely"
From Offerit
OfferitJames (talk | contribs) |
OfferitRob (talk | contribs) (→Posting a Chargeback Transaction) |
||
| (11 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {{Offerit Manual | ||
| + | | show_misc_section = true | ||
| + | }} | ||
| + | |||
You can void any conversion recorded remotely by sending a post to the process_void.php script. This will allow you to automate voiding transactions in your system so you don't have to manually void customer transactions in the Customers Admin. ( | You can void any conversion recorded remotely by sending a post to the process_void.php script. This will allow you to automate voiding transactions in your system so you don't have to manually void customer transactions in the Customers Admin. ( | ||
| Line 12: | Line 16: | ||
Parameters: | Parameters: | ||
*'''orderid''' - The orderid of the conversion/transaction you are trying to void. | *'''orderid''' - The orderid of the conversion/transaction you are trying to void. | ||
| + | *'''click_hash/transaction_hash''' - (optional) The click_hash/transaction_hash of the transaction being voided. | ||
*'''type''' - (optional) This is an optional parameter for recording voids. (Can be sent as either "void" or you can omit this parameter.) | *'''type''' - (optional) This is an optional parameter for recording voids. (Can be sent as either "void" or you can omit this parameter.) | ||
| − | + | *'''approved''' - (optional) If you want to void a pending transaction that has been approved, pass in the "orderid" of the pending transaction and set this parameter to "1". | |
| + | *'''trans_custom1''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used. | ||
| + | *'''trans_custom2''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used. | ||
| + | *'''trans_custom3''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used. | ||
| + | *'''trans_custom4''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used. | ||
| + | *'''trans_custom5''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used. | ||
===Example=== | ===Example=== | ||
| − | < | + | <pre>http://yourdomain.offerit.com/signup/process_void.php?orderid=12345</pre> |
==Posting a Chargeback Transaction== | ==Posting a Chargeback Transaction== | ||
| Line 21: | Line 31: | ||
Parameters: | Parameters: | ||
*'''orderid''' - The orderid of the conversion/transaction you are trying to chargeback. | *'''orderid''' - The orderid of the conversion/transaction you are trying to chargeback. | ||
| − | *''' | + | *'''click_hash/transaction_hash''' - (optional) The click_hash/transaction_hash of the transaction being charged back. |
| + | *'''type''' - "chargeback" - This is a required parameter for recording chargebacks. (This must be set to "chargeback".) | ||
*'''cost''' - (optional) This is an optional parameter that can be set to add a transaction fee for processing the chargeback. By default, this fee will be deducted from the referring affiliate's payout. For example, If you want the chargeback fee to be $25.00, you would set this parameter to "25.00". | *'''cost''' - (optional) This is an optional parameter that can be set to add a transaction fee for processing the chargeback. By default, this fee will be deducted from the referring affiliate's payout. For example, If you want the chargeback fee to be $25.00, you would set this parameter to "25.00". | ||
| + | *'''trans_custom1''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used. | ||
| + | *'''trans_custom2''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used. | ||
| + | *'''trans_custom3''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used. | ||
| + | *'''trans_custom4''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used. | ||
| + | *'''trans_custom5''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used. | ||
| − | === | + | ===Examples=== |
| − | < | + | <pre>http://demo.offerit.com/signup/process_void.php?orderid=12345&type=chargeback&cost=25.00</pre> |
| + | <pre>http://demo.offerit.com/signup/process_void.php?click_hash=45a552e2b7ea632.76210061</pre> | ||
==Reversing a Void or Chargeback Transaction== | ==Reversing a Void or Chargeback Transaction== | ||
Latest revision as of 17:43, 23 June 2020
You can void any conversion recorded remotely by sending a post to the process_void.php script. This will allow you to automate voiding transactions in your system so you don't have to manually void customer transactions in the Customers Admin. (
When a void is recorded for a transaction the amount of revenue recorded for that transaction will be deducted from your Profit and Loss reports. Also, your offers will (by default) remove any affiliate payout given to the affiliate for that conversion.
A transaction may only be voided if you can supply the orderid of the transaction. This means that your system must create a unique orderid when a conversion occurs and the pixel for this conversion must contain the orderid.
Contents
Enabling Void Posts
Before voids can be posted to your network, you must first enable this feature in the Misc section of the Configuration Admin by checking the setting named "Allow Remote Void Posts".
Posting a Void Transaction
Parameters:
- orderid - The orderid of the conversion/transaction you are trying to void.
- click_hash/transaction_hash - (optional) The click_hash/transaction_hash of the transaction being voided.
- type - (optional) This is an optional parameter for recording voids. (Can be sent as either "void" or you can omit this parameter.)
- approved - (optional) If you want to void a pending transaction that has been approved, pass in the "orderid" of the pending transaction and set this parameter to "1".
- trans_custom1 - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
- trans_custom2 - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
- trans_custom3 - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
- trans_custom4 - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
- trans_custom5 - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
Example
http://yourdomain.offerit.com/signup/process_void.php?orderid=12345
Posting a Chargeback Transaction
Parameters:
- orderid - The orderid of the conversion/transaction you are trying to chargeback.
- click_hash/transaction_hash - (optional) The click_hash/transaction_hash of the transaction being charged back.
- type - "chargeback" - This is a required parameter for recording chargebacks. (This must be set to "chargeback".)
- cost - (optional) This is an optional parameter that can be set to add a transaction fee for processing the chargeback. By default, this fee will be deducted from the referring affiliate's payout. For example, If you want the chargeback fee to be $25.00, you would set this parameter to "25.00".
- trans_custom1 - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
- trans_custom2 - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
- trans_custom3 - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
- trans_custom4 - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
- trans_custom5 - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
Examples
http://demo.offerit.com/signup/process_void.php?orderid=12345&type=chargeback&cost=25.00
http://demo.offerit.com/signup/process_void.php?click_hash=45a552e2b7ea632.76210061
Reversing a Void or Chargeback Transaction
Parameters:
- reverse - This parameter is required to reverse a void/chargeback transaction and must be set to 1.
Security
To protect your system and prevent fraudulent transactions from being recorded, you can restrict which IP addresses can send posts to process_void.php. To do this, edit the landing page of the offer you are trying to restrict postbacks for, then enter the comma-separated list of IP addresses in the field named "Secure Landing Page Void IPs".
Example
11.22.33.44,55.66.77.88
