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

process_transfer

Creates a new order with the same data as a cancelled order; the existing cancelled order is not modified. This command is only available for failed transfers with the status of 'cancelled'.

Request parameters for process_transfer

Standard parameters

  • action = process_transfer

  • object = transfer attributes

Attributes

Parameters within the attributes associative array are described below.

Parameter name
Obligation
Definition/Value

order_id

Required

The ID of the order to be resubmitted.

reseller

Required

Reseller username.

Response parameters for process_transfer

Standard parameters

  • action = reply
  • object = transfer
  • 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

order_id

Returned if is_success = true

´┐╝ID of the newly created order.

Examples for process_transfer

Request

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">PROCESS_TRANSFER</item>
                <item key="object">TRANSFER</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="reseller">test_rsp</item>
                        <item key="order_id">111111</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">TRANSFER</item>
                <item key="is_success">1</item>
                <item key="response_text">Transfer request has been successfully sent. Admin contact email: admin@example.com'</item>
                <item key="response_code">200</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="order_id">1111111</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

process_transfer

Creates a new order with the same data as a cancelled order; the existing cancelled order is not modified. This command is only available for failed transfers with the status of 'cancelled'.