Update Order Request

Using the UpdateOrder request, the unique order reference can be changed. Attention! When changing this reference, the transaction purpose for the bank transfer will also change. If the customer has already received an invoice, another corrected invoice has to be sent. (The new bank information can be retrieved sending another "invoiceCreated" request)

XML Header

<?xml version="1.0" encoding="UTF-8"?>

Data Node

Attribute Typ Mögliche Werte Details
version String - Version number of the API
<data api_version="1.5.11">
    <!-- Request Daten -->
</data>

Default Params Node (Merchant Credentials)

Attribute Type Details
mid Int Merchant Id
pid Int Portal Id
bpsecure String MD5 hash of the API security key (delivered by BillPay)
    <default_params 
        mid="4441" 
        pid="6021" 
        bpsecure="25d55ad283aa400af464c76d713c07ad"/>

update_params node

This node contains the the unique BillPay transaction ID (retrieved from the original preauthorization server response) and the new desired order reference.

Attribute Mandatory Type Possible Values Details
bptid + String AN..50 Unique BillPay transaction ID for this order
reference + String AN..40 New unique order reference (allowed characters: 0-9, a-z, A-Z,.,-,_,/)
<update_params
        bptid="1aa2fb2d-2b78-4393-bf06-be0012dda337"
        reference="Bestellnummer321"/>

id_update_list node

This node contains all individual article IDs to be updated by the request.

Attribute Mandatory? Type Possible Values Details
articleid + String AN..40 The original article ID
updateid + String AN..40 The new article ID
<id_update_list>
        <id_update articleid="54321" updateid="12345"/>
</id_update_list>

Full XML example

<?xml version="1.0" encoding="UTF-8" ?>
<data api_version="1.5.11">
    <default_params 
        mid="4441" 
        pid="6021" 
        bpsecure="25d55ad283aa400af464c76d713c07ad"/>
    <update_params 
        bptid="b61648a3-46a1-4771-834f-903b89510ed9" 
        reference="1591605922_updated" />
    <id_update_list>
      <id_update 
          articleid="1234" 
          updateid="1234_mod" />
      <id_update 
          articleid="2345" 
          updateid="2345_mod" />
    </id_update_list>
</data>        

Update Order Response

<?xml version="1.0" encoding="UTF-8"?>
<data api_version="1.5.11" customer_message="" merchant_message="" error_code="0">
</data>