Difference between revisions of "NATS4 REST API Set Affiliate Payvia Info"
From TMM Wiki
Jump to navigationJump to search| Line 7: | Line 7: | ||
'''Resource URL''' | '''Resource URL''' | ||
| − | *<nowiki>http://domain/api | + | *<nowiki>http://domain/api/affiliate/setpayviainfo</nowiki> |
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| Line 39: | Line 39: | ||
'''PATCH''' | '''PATCH''' | ||
| − | <nowiki>http://domain/api | + | <nowiki>http://domain/api/affiliate/setpayviainfo</nowiki> |
*Response: | *Response: | ||
Latest revision as of 15:30, 31 March 2015
PATCH /affiliate/setpayviainfo
Description
- The /affiliate/setpayviainfo action is a feature in NATS4 that allows you to set the affiliate payvia info settings
Resource URL
- http://domain/api/affiliate/setpayviainfo
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded
- loginid: is the affiliates loginid
- type: string
- required
- payvia_type_id: is the id of the payvia that the loginid should be switched to
- type: string
- required
- payvia_info: is an array containing arrays of info to update for the payvia type.
- type: array
- required
Example Request
PATCH
http://domain/api/affiliate/setpayviainfo
- Response:
[
{
"field":"Payvia Type",
"result":"Updated Payvia Type to 1 for loginid 1"
},
{
"field":"Pay To",
"result":"Updated Payvia Info: 'Pay To' is now 'TestPayTo'"
},
{
"field":"Address",
"result":"Updated Payvia Info: 'Address' is now 'Riga, Latvia'"
}
]
Example Code
PHP
<?php
$curl = curl_init();
$payvia_info = array();
$payvia_info[] = array(
'field' => 'Pay To',
'value' => 'TestPayTo'
);
$payvia_info[] = array(
'field' => 'Address',
'value' => 'Riga, Latvia'
);
$data = array(
'loginid' => 1,
'payvia_type_id' => '1',
'payvia_info' => $payvia_info
);
$url = 'http://domain/api/affiliate/setpayviainfo';
$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
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
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
