Report Customer Payment Request

The reportCustomerPayment request is used to inform BillPay of cases where the customer has transferred funds for a given invoice order to the merchant's bank account, instead of the account provided by BillPay at the time the order was placed.

XML Header

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

Data Node

Attribute Type Mandatory 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"/>

Report Params Node

Attribute Mandatory Type Possible Values Details
reference + String AN..40 Unique order ID in the merchant system (allowed characters: 0-9, a-z, A-Z,.,-,_,/)
amount + Int N..7 Amount the customer has paid (1,00 EUR = 100)

Full XML example

<?xml version="1.0" encoding="UTF-8" ?>
<data api_version="1.5.11">
    <default_params 
        mid="4441" 
        pid="6021" 
        bpsecure="25d55ad283aa400af464c76d713c07ad"/>
    <report_params 
        reference="313423299" 
        amount="43000"/>  
</data>        

Report Customer Payment Response

The BillPay server response for the "reportCustomerPayment" 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" 
    customer_message="" 
    error_code="0" 
    merchant_message="">
</data>