API Module Financial searchPaymentResellerRequest
From Openprovider API documentation
(Difference between revisions)
(Created page with '==Module Reseller > Search Payments== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |reseller |- style="background-color:#EEEEEE;" |'''Command …') |
(→Raw XML) |
||
| (2 intermediate revisions not shown) | |||
| Line 13: | Line 13: | ||
|'''Input''' | |'''Input''' | ||
| | | | ||
| - | *limit ''default value: 100'' | + | *[[API Format Limit|limit]] (''default value: 100, maximum value: 1000'') |
| - | *offset ''default value: 0'' | + | *[[API Format Offset|offset]] (''default value: 0'') |
| - | *type ''bank or online'' | + | *type (''bank or online'') |
| - | *status ''one of the statuses new, paid, confirmed, processed'' | + | *status (''one of the statuses new, paid, confirmed, processed'') |
| - | *startCreationDate ''format: yyyy-mm-dd'' | + | *startCreationDate (''format: yyyy-mm-dd'') |
| - | *endCreationDate ''format: yyyy-mm-dd'' | + | *endCreationDate (''format: yyyy-mm-dd'') |
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
|'''Output''' | |'''Output''' | ||
| Line 45: | Line 45: | ||
===Raw XML=== | ===Raw XML=== | ||
| + | ''Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider.'' | ||
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
<openXML> | <openXML> | ||
| Line 62: | Line 63: | ||
<openXML> | <openXML> | ||
<reply> | <reply> | ||
| - | < code>0</code> | + | <nowiki><code>0</code></nowiki> |
<desc /> | <desc /> | ||
<data> | <data> | ||
Current revision as of 11:13, 17 June 2016
Contents |
Module Reseller > Search Payments
| Module | reseller |
| Command name | searchPaymentResellerRequest |
| Use | Retrieves a list of payments from your reseller account |
| Input | |
| Output |
|
Examples
Using PHP class
$request = new OP_Request;
$request->setCommand('searchPaymentResellerRequest')
->setAuth(array('username' => 'username', 'password' => 'password'))
->setArgs(array(
'type' => 'online',
'status' => 'processed',
'startCreationDate' => '2010-01-01',
'endCreationDate' => '2010-03-31'
));
Raw XML
Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider.
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<credentials>
<username>username</username>
<password>password</password>
</credentials>
<searchPaymentResellerRequest>
<type>online</type>
<status>processed</status>
<startCreationDate>2010-01-01</startCreationDate>
<endCreationDate>2010-03-31</endCreationDate>
</searchPaymentResellerRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<reply>
<code>0</code>
<desc />
<data>
<results>
<array>
<item>
<id>50320</id>
<type>online</type>
<creationDate>2010-01-06 10:43:43</creationDate>
<amount>
<product>
<price>100.00</price>
<currency>EUR</currency>
</product>
<reseller>
<price>100.00</price>
<currency>EUR</currency>
</reseller>
</amount>
<paymentDate>2010-01-07 09:27:29</paymentDate>
<confirmationDate>2010-01-06 10:45:46</confirmationDate>
<isProcessed>1</isProcessed>
<status>processed</status>
</item>
<item>
<id>50540</id>
<type>online</type>
<creationDate>2010-01-11 08:38:29</creationDate>
<amount>
<product>
<price>100.00</price>
<currency>EUR</currency>
</product>
<reseller>
<price>100.00</price>
<currency>EUR</currency>
</reseller>
</amount>
<paymentDate>2010-01-12 09:26:03</paymentDate>
<confirmationDate>2010-01-11 08:40:53</confirmationDate>
<isProcessed>1</isProcessed>
<status>processed</status>
</item>
<item>
<id>51831</id>
<type>online</type>
<creationDate>2010-02-09 10:22:29</creationDate>
<amount>
<product>
<price>500.00</price>
<currency>EUR</currency>
</product>
<reseller>
<price>500.00</price>
<currency>EUR</currency>
</reseller>
</amount>
<paymentDate>2010-02-10 10:08:49</paymentDate>
<confirmationDate>2010-02-09 10:26:11</confirmationDate>
<isProcessed>1</isProcessed>
<status>processed</status>
</item>
<item>
<id>54036</id>
<type>online</type>
<creationDate>2010-03-29 15:50:02</creationDate>
<amount>
<product>
<price>350.00</price>
<currency>EUR</currency>
</product>
<reseller>
<price>350.00</price>
<currency>EUR</currency>
</reseller>
</amount>
<paymentDate>2010-03-31 10:05:28</paymentDate>
<confirmationDate>2010-03-29 15:52:51</confirmationDate>
<isProcessed>1</isProcessed>
<status>processed</status>
</item>
</array>
</results>
<total>4</total>
</data>
</reply>
</openXML>