Last update 23/08/2016

1. Introduction

This guide explains how to use BillPay as a payment method.

It is a complement, and should be read alongside the e-Commerce documentation.

2. Integration

2.1 Standard

The following information is required for every transaction:

Format: AN= Alphanumeric / N=Numeric, maximum allowed amount of characters

Field 

Format

Description

PSPID

AN, 30

Merchant unique identifier in our system

ORDERID

AN, 40

Merchant unique order reference

AMOUNT

N

Amount x 100 --> 100 = 1.00

CURRENCY

AN, 3

Alpha ISO code of the currency

LANGUAGE

AN, 5

Customer language

OPERATION 

AN, 3

Specifies the Operation code to use.

For 'Open Invoice DE', we request that you always sends the RES value

2.2 Delivery and invoicing data

The following fields should be sent with each order for BillPay. An asterisk (*) indicates a required field.

Format: AN= Alphanumeric / N=Numeric, maximum allowed amount of characters

Field

Format

Description

CIVILITY*

AN, 10

Invoicing title (Mr., Mrs, etc.)

ECOM_BILLTO_POSTAL_NAME_FIRST

AN, 10

Invoicing first name

ECOM_BILLTO_POSTAL_NAME_LAST

AN, 50

Invoicing last name

ECOM_SHIPTO_DOB*

dd/mm/yyyy

Date of birth

EMAIL

AN, 50

Customer's e-mail address

ORDERSHIPCOST

N

Net delivery cost MULTIPLIED BY 100

ORDERSHIPMETH

AN, 25

Delivery method

ORDERSHIPTAX

N

Delivery tax amount MULTIPLIED BY 100 

ORDERSHIPTAXCODE

N

Delivery tax percentage

The decimal separator needs to be "." (not ","!) 

OWNERADDRESS

AN, 35

Invoicing address

ECOM_SHIPTO_POSTAL_STREET_NUMBER

AN, 10

Delivery street number

OWNERZIP

AN, 10

Invoicing zip/postcode

OWNERTOWN

AN, 25

Invoicing city 

OWNERCTY

AN, 2

Invoicing country code 

2.3 Order details

The following fields are mandatory for all BillPay orders 

Format: AN= Alphanumeric / N=Numeric, maximum allowed amount of characters

Field

Format

Description

ITEMIDX

AN, 15

Item identification (replace X with a number to send multiple items: ITEMID1, ITEMID2, etc.)

ITEMNAMEX

AN, 40

Item name (replace X with a number to send multiple items: ITEMNAME1, ITEMNAME2, etc.)

ITEMPRICEX

N

Item price (replace X with a number to send multiple items: ITEMPRICE1, ITEMPRICE2, etc.)

ITEMQUANTX

N

Item quantity (replace X with a number to send multiple items: ITEMQUANT1, ITEMQUANT2, etc.)

ITEMVATX

N

Item VAT value (replace X with a number to send multiple items: ITEMVAT1, ITEMVAT2, etc.)

TAXINCLUDEDX

N (0/1)

  • If this field is equal to 1, the ITEMPRICEX is considered to include VAT, and our system will not calculate the VAT for the item.
  • If this field is equal to 0 (or left blank, or not sent) our system will calculate the VAT for the item based on the ITEMVATCODEX  This feature is intended to avoid any issues when rounding off the order line totals.

(replace X with a number to send multiple items: TAXINCLUDED1, TAXINCLUDED2, etc.)

3. Transaction feedback

3.1 Virtual Bank Account

The BillPay Virtual Bank Account can be found in the "Virtual ticket" after activation/capture in the back office.

It must be displayed on the invoice sent to the customer.

3.2 Order details

All order details can be viewed in the back office by using the "View transactions" link.

4. Refunds

Note: In order to potentially perform refund operations, please ensure the "Refund" option is available in your account. If in doubt, please contact our Sales team.

When looking at a transaction, click on the "Advanced" button at the bottom of the screen, which will reveal the Refund options.

When clicking on "Refund", our system will show a detail screen in which you can specify which items are to be refunded.

By default, the Quantity column will contain the order quantities. If you only want to refund part of the order, adjust the values in the Quantity column accordingly.

Click "Submit" to refund the order.

This website uses cookies to be able to give you the best user experience. If you don't want to accept these cookies, we allow you to change the cookie settings. Click 'Accept' to allow all cookies from this website.

Cookie settings

Introduction

Functional

Functional cookies are required for the website to operate correctly. These cookies cannot be disabled.

Optimized

Optimization cookies allow us to analyze site usage so we can measure and improve our website.
This is the default level.

Personalized

Personalization cookies are used for social media and advanced personalization. They allow us to show you information related to your company.


Example functionality allowed

  • Store country preference
  • Store language preference

Example functionality not allowed

  • Saving personal data
  • Anonymous tracking via Google Analytics
  • Tracking for remarketing purposes

Example functionality allowed

  • Store country preference
  • Store language preference
  • Anonymous tracking via Google Analytics

Example functionality not allowed

  • Saving personal data
  • Tracking for remarketing purposes

Example functionality allowed

  • Store country preference
  • Store language preference
  • Anonymous tracking via Google Analytics
  • Serve content relevant to your interests
  • Serve ads relevant to your interests
  • Tracking for remarketing purposes

Example functionality not allowed

  • Saving personal data