The capture request is used to complete the order when a two-step capture process is being implemented (the capturerequestnecessary attribute is set to 1 in the preauthorize request). Legally speaking, it is with the successful completion of the capture request, that the customer’s debt to the merchant is transferred from the merchant to BillPay.

Request

Default Params Node (API 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="1234" 
        pid="5678" 
        bpsecure="25d55ad283aa400af464c76d713c07ad"/>

Capture Params Node

Attribute Type Possible Values Details
bptid + String AN..50 BillPay transaction number

The transaction number is sent in the response to the preauthorize-request. It is used to match preauthorize- and capture-requests.
carttotalgross + Int N..7 gross value of the order total (1,00 EUR = 100)
currency + String Vorgabe ISO4217 3-digit currency code of the order (e.g. "EUR")
reference + String AN..40 Unique order ID in the merchant system (allowed characters: 0-9, a-z, A-Z,.,-,_,/)
customerid - String AN..20 Customer ID in the merchant system
(Allowed characters are: 0-9, a-z, A-Z, .,-,_,/)
<capture_params bptid="1aa2fb2d-2b78-4393-bf06-be0012dda337" carttotalgross="3390" currency="EUR" reference="Bestellnummer123" customerid="Kunde123" />

Sample XML

<?xml version="1.0" encoding="UTF-8" ?>
<data api_version="1.5.18">
  <default_params mid="1234" pid="5678" bpsecure="25d55ad283aa400af464c76d713c07ad">
</default_params>
<capture_params bptid="1aa2fb2d-2b78-4393-bf06-be0012dda337" carttotalgross="3390" currency="EUR" reference="Bestellnummer123" customerid="Kunde123" />
</capture_params>
</data>

Response

Invoice Bank Account Node (only "Invoice" & "Transaction Credit CHE")

This node returns the BillPay bank account data to be used by the customer when paying for the order he/she placed. This information should be parsed and printed on the invoice document the customers receive with their package.

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_bank_account 
    account_holder="BillPay GmbH" 
    account_number="DE07312312312312312" 
    bank_code="BELADEBEXXX" 
    bank_name="Sparkasse Berlin" 
    invoice_reference="BP555666777/9999"/>