Cancellation Request

Using the "Cancel" request, an existing order can be fully cancelled and the debt in will be closed. If the customer has already transferred money or the customer's account was already debited, the funds will be returned and a notification email will be sent to the customer.

*Attention: Fully cancelling an order may incur a cancellation fee.

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

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)

Cancel params node

Attribute Type Possible Values Details
reference + String AN..40 Unique order ID in the merchant system (allowed characters: 0-9,a-z,A-Z,.,-,_,/)
carttotalgross + Int N..7 Current gross total order value (1,00 EUR = 100)
currency + String Vorgabe ISO 4217 3-digit currency code (z.B. "EUR")
        currency="EUR" />

Full XML example

<?xml version="1.0" encoding="UTF-8"?>
<data api_version="1.5.11">
   <default_params mid="4441" pid="6021" bpsecure="25d55ad283aa400af464c76d713c07ad" />
   <cancel_params reference="1773673332" carttotalgross="43000" currency="EUR" />

Cancellation Response

The BillPay server response for the "Cancel" request will not return any additional fields besides the error code / error message.

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