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 Reseller retrieveSettingsResellerRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(Module Reseller > Retrieve Settings)
 
(5 intermediate revisions not shown)
Line 9: Line 9:
|-
|-
|'''Use'''
|'''Use'''
-
|Retrieves information about the settings and configuration in your reseller account
+
|Retrieves information about configuration of your reseller account
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Input'''
|'''Input'''
Line 19: Line 19:
*currency
*currency
*language
*language
-
*isAutoRenewEnabled
+
*[[API Format autorenew|isAutoRenewEnabled]]
*minimumPayment
*minimumPayment
-
*payMethods
+
*payMethods (payment methods available for reseller)
-
*signedContracts
+
*signedContracts (contracts signed by reseller)
|}
|}
Line 34: Line 34:
===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 46: Line 47:
  <openXML>
  <openXML>
   <reply>
   <reply>
-
     <code >0</code>
+
     <nowiki><code>0</code></nowiki>
     <desc />
     <desc />
     <data>
     <data>

Current revision as of 11:49, 17 June 2016

Contents

Module Reseller > Retrieve Settings

Module reseller
Command name retrieveSettingsResellerRequest
Use Retrieves information about configuration of your reseller account
Input

-

Output
  • currency
  • language
  • isAutoRenewEnabled
  • minimumPayment
  • payMethods (payment methods available for reseller)
  • signedContracts (contracts signed by reseller)

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('retrieveSettingsResellerRequest')
 ->setAuth(array('username' => 'username', 'password' => 'password'))
 ->setArgs(array(
));

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>
  <retrieveSettingsResellerRequest />
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc />
    <data>
      <currency>EUR</currency>
      <language>EN</language>
      <isAutoRenewEnabled>1</isAutoRenewEnabled>
      <minimumPayment>5000</minimumPayment>
      <minimumWesternUnionPayment>500</minimumWesternUnionPayment>
      <CreditCardFeePercent>3</CreditCardFeePercent>
      <maximumIDealPayment>1000</maximumIDealPayment>
      <maximumCreditCardPayment>970</maximumCreditCardPayment>
      <payMethods>
        <array>
          <item>credit_card</item>
          <item>western_union</item>
          <item>bank</item>
        </array>
      </payMethods>
      <signedContracts>
        <array>
          <item>
            <id>eu</id>
            <version>20060221</version>
            <modificationDate>2006-02-21 14:33:32</modificationDate>
            <isSigned>1</isSigned>
            <signOnDate>2006-11-13 11:47:45</signOnDate>
          </item>
          <item>
            <id>com</id>
            <version>20060221</version>
            <modificationDate>2006-02-21 14:33:32</modificationDate>
            <isSigned>1</isSigned>
            <signOnDate>2006-09-15 11:07:23</signOnDate>
          </item>
          <item>
            <id>info</id>
            <version>20060221</version>
            <modificationDate>2006-02-21 14:33:32</modificationDate>
            <isSigned>1</isSigned>
            <signOnDate>2007-06-14 15:01:49</signOnDate>
          </item>
        </array>
      </signedContracts>
    </data>
  </reply>
</openXML>
Views
Personal tools