This documentation has moved

XML API documentation can now be found at developer.openprovider.com. This page will remain available until September 2026, but will no longer be updated.

The XML API itself is not changing. Your existing integration continues to work.

API Module Financial searchPaymentResellerRequest

From Openprovider API documentation

Revision as of 14:08, 15 December 2010 by WikiSysop (Talk | contribs)
(diff) ← Older revision | Current revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Contents

Module Reseller > Search Payments

Module reseller
Command name searchPaymentResellerRequest
Use Retrieves a list of payments from your reseller account
Input
  • limit default value: 100
  • offset default value: 0
  • type bank or online
  • status one of the statuses new, paid, confirmed, processed
  • startCreationDate format: yyyy-mm-dd
  • endCreationDate format: yyyy-mm-dd
Output
  • id
  • type
  • status
  • creationDate
  • paymentDate
  • confirmationDate
  • amount
  • isProcessed

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

<?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>
Views
Personal tools