API: OpenSRS

OpenSRS API Guide: Domains and SSL

Welcome to the OpenSRS API guide. Here you will find comprehensive documentation regarding our domain and SSL services. We hope this guide will help you start working with OpenSRS as quickly as possible. If you have any questions or concerns, please do not hesitate to contact help@opensrs.com

Get Started

pay subreseller

Transfers funds from the reseller account into a subreseller account.

Request parameters for pay subreseller

Standard parameters

  • action = pay
  • object = subreseller

Attributes

Parameters within the attributes associative array are described below.

Parameter name
Obligation
Definition/Value

amount

Required

The amount that you want to transfer to the subreseller account; this value must be a positive number.

username

Required

The username of the subreseller that is receiving the funds.

Response parameters for pay subreseller

Standard parameters

  • action = reply
  • is_success = a Boolean is returned, indicating success or failure of the request
  • response_code = response code indicating outcome of the request
  • response_text = message describing the outcome of the request

Attributes

If the request is successful, the attributes associative array may include the
following:

Parameter name
Obligation
Definition/Value

id

Returned if is_success = true

The ID number of the transaction.

Examples for pay subreseller

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">PAY</item>
                <item key="object">SUBRESELLER</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="amount">1.00</item>
                        <item key="username">subtest</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>
<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="object">SUBRESELLER</item>
                <item key="response_text">Funds Transferred</item>
                <item key="action">REPLY</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="id">3627217</item>
                    </dt_assoc>
                </item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

pay subreseller

Transfers funds from the reseller account into a subreseller account.