Skip to main content

BillPay

This page provides an overview of the payments methods provided by the BillPay adapter in the IXOPAY platform. It also includes a full list of all configuration options available to you when integrating BillPay within your payments landscape, as well as an overview of the parameters required when submitting a transaction via IXOPAY's API.

Payment Methods

Payment MethodTransaction FlowsTransaction Types
DirectDebitServer-To-ServerRegister, Debit, Refund
InvoiceServer-To-ServerRegister, Debit, Refund

Note: any Debit transaction automatically creates the authorization & the invoice on BillPay side.

Mandatory parameters

Extra DataRequiredDescription
DescriptionfalseDescription that should be shown on the bank statement
extraData.expectedDaysTillShippingtrueinteger in days
extraData.shippingMethodtrueany string
extraData.itemIdentificationFor Registerany string, used as articleId
extraData.itemNameFor Registerany string, used as articleName
customer.identificationtrue
customer.firstNametrue
customer.lastNametrue
customer.emailtrue
customer.billingAddresstrueall address details
customer.birthDatetruee.g. 1980-01-01
customer.ibantruefor DirectDebit
customer.ipAddresstrue
customer.extraData.salutationtrueMr., Mrs., Hr., Fr., etc.
customer.extraData.typetrueguest, existing or new
itemstrueat least one item
extraData.paymentTypefalseone of invoice, directDebit - overrules configuration
extraData.shippingPriceNetfalsedecimal
extraData.shippingPriceGrossfalsedecimal
extraData.rebateNetfalsedecimal
extraData.rebateGrossfalsedecimal
extraData.orderAmountNetfalsedecimal
extraData.shippingTrackingNumberfalsestring
customer.extraData.titlefalsestring
customer.extraData.copmanyLegalFormfalsestring
customer.extraData.companyHolderNamefalsestring
customer.extraData.companyTaxNumberfalsestring
item.extraData.categoryfalsestring
item.extraData.subcategory1falsestring
item.extraData.subcategory2falsestring
item.extraData.priceNetfalsestring
note

Make sure to use the ibanCustomer element within the XML instead of the normal customer object. The ibanCustomer contains the fields necessary for DirectDebit transactions.

note

For a partial refund it is important to also include items in the request where the sum of the items and the amount to refund have to be the same as the amount of the original transaction. If no items are submitted, the refund amount has to be the same as the original transactions amount and only a full refund can be done this way.