NATS For Networks REST API Process Chargeback

From TMMwiki
Jump to: navigation, search
NATS For Networks
REST API
General
API Overview
GET /service/ping
Advertiser
POST /advertiser/add_advertiser
PATCH /advertiser/edit_advertiser
Affiliate
GET /affiliate/get_links
GET /affiliate/get_single_link
GET /affiliate/search
GET /affiliate/decode_trackingcode
PATCH /affiliate/edit_affiliate
POST /affiliate/add_affiliate
POST /affiliate/affiliate_login_ips
Creative
GET /creative/get_creatives
GET /creative/get_creative_fields
GET /creative/get_creative_rules
PATCH /creative/delete_creative
PATCH /creative/edit_creative
PATCH /creative/edit_creative_rules
PATCH /creative/undelete_creative
POST /creative/add_creative
POST /creative/add_creative_rule
POST /creative/delete_creative_rules
Offer
GET /offer/check_orderid_exists
GET /offer/get_commission_changes
PATCH /offer/activate_offer
PATCH /offer/edit_landing_page
PATCH /offer/edit_offer
PATCH /offer/pause_offer
PATCH /offer/set_commission_change_payouts
PATCH /offer/set_enabled_affiliates
PATCH /offer/set_offer_categories
PATCH /offer/set_offer_countries
PATCH /offer/set_offer_goals
PATCH /offer/set_offer_groups
PATCH /offer/set_offer_marketing_types
PATCH /offer/store_offer_ips
POST /offer/add_commission_change
POST /offer/add_landing_page
POST /offer/add_offer
POST /offer/add_tracking_domain
Reporting
GET /report/profitloss
GET /report/transaction
Transaction
GET /transaction/transaction_payout_preview
PATCH /transaction/transaction_update_revenue_by_orderid
PATCH /transaction/transaction_update_revenue_by_transaction_hash
POST /transaction/process_void
POST /transaction/process_chargeback
POST /transaction/process_reversal

POST transaction/process_chargeback

Description This REST API resource to used to issue a chargeback for a transaction that was previously converted

Resource URL

  • http://domain/api/transaction/process_chargeback
  • Replace domain with your NATS for Networks domain

Request Method

  • POST

Response Format

  • JSON

Authentication

  • HTTP headers

Parameters

  • type: This should always be set as chargeback
    • type: string
    • required
  • transaction_hash: The click_hash/transaction_hash of the transaction you want to chargeback.
    • type: string
    • optional
  • click_hash: The click_hash/transaction_hash of the transaction you want to chargeback.
    • type: string
    • optional
  • orderid: The transaction identifier sent on conversion (orderid) you want to chargeback.
    • type: string
    • optional
  • transactionid: The N4N generated transaction identifier you want to chargeback
    • type: string
    • optional
  • cost: The cost of the chargeback (decimal format) will be taken away from the affiliate payout
    • type: double
    • optional


Example Request

POST

http://domain.com/api/transaction/process_chargeback

  • Response:
Success
{
   "result": "success",
   "message": "*success*"
}

Failure
{
   "result": "error",
   "message": "Missing required field for chargeback (type)."
}

Example Code

PHP

<?php
$curl = curl_init();

$data = array(
    'type' => 'chargeback',
    'transaction_hash' => '156097c947ece92.38318951',
);
$url = 'http://domain/api/transaction/process_chargeback';
$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);
?>