cancel_transfer

Cancels transfers that are pending owner approval.

Request parameters for cancel_transfer

Standard parameters

  • action = cancel_transfer
  • object = transfer attributes

Attributes

Parameters within the attributes associative array are described below.

Parameter name

Obligation

Definition/Value

domain

Optional - either order-id or domain must be specified.

The domain to be cancelled.

order_id

Optional - either order-id or domain must be specified.

The ID of the order to be cancelled.

reseller

Required

Reseller username.

Response parameters for cancel_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

Examples for cancel_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">cancel_transfer</item>
                <item key="object">transfer</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="reseller">purple</item>
                        <item key="order_id">3533098</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="response_text">Transfer with order id: 3533098 has been cancelled.</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>
<?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="response_text">Command Failed: Transfer State Prohibits Cancellation</item>
                <item key="is_success">0</item>
                <item key="response_code">400</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>