BillPay TechDocs

For developers XML API Get Billpay Bank Data

Thursday, September 7, 2017 6:16 AM

Get BillPay Bank Data Request

The getBillPayBankData request will return the unique bank account information for the specified order. The response contains all information needed for the customer to initiate their bank transfer. The response also contains the due date for the payment.

Notice: Usually it is sufficient to parse the bank account information from the preauthorize/auto-capture reqsponse. The request getBillPayBankData should be seen as an additional support request in case the information is needed in a later step in the merchant's shipping process.

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

Order 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,.,-,_,/)

Full XML example

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

Get BillPay Bank Data Response

The XML service response for this request contains all the relevant information for the customer to pay for the open debt.

Attribute Mandatory Type Possible Values Details
account_holder + String AN..255 Account holder
account_number + String AN..40 BillPay IBAN
bank_code + String AN..16 BillPay BIC
bank_name + String AN..255 Name of the BillPay bank
invoice_reference + String AN..255 Transaction purpose
invoice_duedate + Int N..8 Payment due date in the format YYYYMMDD
duedate +* Int N..8 Payment due date for a partial activation
invoice_number + String AN..40 Invoice number for the partially activated debt
(If this ID has not been specifically assigned, BillPay will calculate an ID with the following format: [merchant reference]+"#")		 
<?xml version="1.0" encoding="UTF-8" ?>
<data api_version="1.5.11"
    customer_message="" 
    error_code="0" 
    merchant_message="">
    <bank_account 
        account_holder="Billpay GmbH" 
        account_number="DE1200TEST333222110000492156" 
        bank_code="TESTBIC0001" 
        bank_name="BillPay Test Bank" 
        first_duedate="20160324" 
        invoice_reference="BP2032322603/3042">
        <invoice_list>
              <invoice 
                  duedate="20160324" 
                  invoice_number="2032322603#1"/>
        </invoice_list>
    </bank_account>    
</data>