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 Method | Transaction Flows | Transaction Types |
---|---|---|
DirectDebit | Server-To-Server | Register, Debit, Refund |
Invoice | Server-To-Server | Register, Debit, Refund |
Note: any Debit transaction automatically creates the authorization & the invoice on BillPay side.
Mandatory parameters
Extra Data | Required | Description |
---|---|---|
Description | false | Description that should be shown on the bank statement |
extraData.expectedDaysTillShipping | true | integer in days |
extraData.shippingMethod | true | any string |
extraData.itemIdentification | For Register | any string, used as articleId |
extraData.itemName | For Register | any string, used as articleName |
customer.identification | true | |
customer.firstName | true | |
customer.lastName | true | |
customer.email | true | |
customer.billingAddress | true | all address details |
customer.birthDate | true | e.g. 1980-01-01 |
customer.iban | true | for DirectDebit |
customer.ipAddress | true | |
customer.extraData.salutation | true | Mr., Mrs., Hr., Fr., etc. |
customer.extraData.type | true | guest , existing or new |
items | true | at least one item |
extraData.paymentType | false | one of invoice , directDebit - overrules configuration |
extraData.shippingPriceNet | false | decimal |
extraData.shippingPriceGross | false | decimal |
extraData.rebateNet | false | decimal |
extraData.rebateGross | false | decimal |
extraData.orderAmountNet | false | decimal |
extraData.shippingTrackingNumber | false | string |
customer.extraData.title | false | string |
customer.extraData.copmanyLegalForm | false | string |
customer.extraData.companyHolderName | false | string |
customer.extraData.companyTaxNumber | false | string |
item.extraData.category | false | string |
item.extraData.subcategory1 | false | string |
item.extraData.subcategory2 | false | string |
item.extraData.priceNet | false | string |
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.
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.