Maintenance Work Notice!

We will carry out maintenance work on this documentation on Tuesday, 15.06.2021 between 3 pm and 4 pm CEST. Thank you for your understanding.

Page tree

Search

Skip to end of metadata
Go to start of metadata


About BillPay

General information about BillPay

With BillPay the merchant sends the invoice with the logo and bank details of BillPay. BillPay pays the invoice amount and takes over the complete downstream debtor management.


Logo

Info

BillPay enables merchants to offer purchase on account in Germany, Austria, Switzerland and the Netherlands or purchase by direct debit in Germany and Austria. Instalment payments can also be offered in Germany and Austria with PayLater. A graphic snippet provided by BillPay simplifies the calculation of instalments and reduces programming work. A 100% disbursement takes place already after the first month.

TypeMixed payment methods EN


Further information can be found at the webpage of BillPay (http://www.billpay.de).


Notice: For a simpler integration into the merchant’s shop, BillPay has a Javascript widget which displays BillPay’s payment methods in the checkout process, which must be implemented. The documentation of the widget is available on the website https://techdocs.billpay.de/de/An_Entwickler/JavaScript-Widget.html.

 

Process flow chart


BillPay process flow including payment method control PreScore (above the middle line)


Paygate interface

Definitions

Data formats

Format

Description

a

alphabetical

as

alphabetical with special characters

n

numeric

an

alphanumeric

ans

alphanumeric with special characters

ns

numeric with special characters

bool

boolean expression (true or false)

3

fixed length with 3 digits/characters

..3

variable length with maximum 3 digits/characters

enum

enumeration of allowed values

dttm

ISODateTime (YYYY-MM-DDThh:mm:ss)


Abbreviations

Abbreviation

Description

Comment

CND

condition


M

mandatory

If a parameter is mandatory, then it must be present

O

optional

If a parameter is optional, then it can be present, but it is not required

C

conditional

If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional


Notice: Please note that the names of parameters can be returned in upper or lower case.


Calling the interface for Billpay invoice purchase

This chapter describes how to initiate a BillPay payment. After successful initialisation you can post BillPay payments on delivery. Additionally you can partly activate BillPay reservations and in this way set the date of payment for the customer. A subsequent change of the shopping cart is possible via the same interface and is described here. The cancellation of a BillPay payment is explained later in this document.

In order to execute a BillPay payment via server-to-server communication, please go to the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the transfer parameters to be encrypted:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ns..30

O

Unique reference number

Amount

n..10

M

Total amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217 Only EUR and CHF permissible.

MAC

an64

O

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

Language

a2

M

language code according to ISO 639-1 (e.g. de for German)

NewCustomer

ans..5

M

Defines whether or not the purchaser is a new customer. Values: <YES>, <NO>, <GUEST>

BillPayAction

n1

M

Defines the method of payment used. Values:

<1> for invoice purchase
<2> for direct debit
<4> for PayLater
<7> for PayLater with assumption of debt
<8> for invoice purchase with assumption of debt
<9> for direct debit with assumption of debt

GtcValue

a..3

M

Defines whether or not the customer has confirmed BillPay’s terms and conditions. Values: <YES> or <NO>

DateOfBirth

an10

MC

Birth date of the customer in the format YYYY-MM-DD (may not be transmitted in the case of BillPay B2B)

IpAddr

ans15

M

Customer´s IP address in IPv4 or IPv6 format

ActivationDelay

n..3

OC

Mandatory for BillPayAction = 7, 8 or 9 (assumption of debt)

Number of days until fulfilment of service (e.g. start of journey)

CompanyOrPerson

a1

OC

Distinction of the purchaser as private person or company. Values: <F> for companies, <P> for persons, default value <P>. Obligatory for BillPay B2B

BrowserSessionID

ans..100

O

SessionID for fraud detection (must be the same with the SessionID from the JavaScript-Widget)

Invoice data

bdSalutation

a..15

M

Salutation of the customer on the invoice. Permissible values:

Male: Herr, Hr, Hr., Mister, Mr, Mr., Sir, Signor, Sig, Sig., Gentleman, Gentiluomo, Padrone, Monsieur, M, M.

Female: Frau, Fräulein, Fr, Fr., Miss, Ms, Ms., Mrs, Mrs., Signora, Sig.ra, Donna, La Signora, Madame, Mme, Mademoiselle, Mlle, Mle

bdTitle

ans..20

O

Title of the customer or contact person within the company on the invoice, e.g. Dr. or Prof.

bdFirstName

ans..50

M

First name of customer or contact person in company

bdLastName

ans..50

M

Last name of customer or contact person in company

bdStreet

a..50

M

Street name in the invoicing address

bdStreetNr

ans..5

M

Street number of the invoicing address

bdStreet2

a..50

O

Address addition in the billing address

bdZip

n5

M

Postcode in the invoicing address

bdCity

ans..50

M

Town/city of the invoicing address

bdCountryCode

a3

M

Country code in the billing address, 3 characters. Germany (DEU), Suisse (CHE) and Austria (AUT) are currently permitted.

EMail

ans..50

M

E-mail address of the customer or contact person on the invoicing address

Phone

ans..15

OC

Telephone number of the customer or contact person on the invoicing address.

Obligatory for hire purchase (BillPayAction=3)

MobileNo

ans..50

O

Mobile telephone number of the customer on the invoicing address

Delivery data

UseBillingData

a3

M

Is the invoicing address to be used as the delivery address? Permissible: <Yes> or <No>. If <No>, parameters for the delivery address become obligatory. If <Yes>, no parameters are transferred for the delivery address.

sdSalutation

a..15

C

Salutation of the customer on the invoice. Permissible values:

Male: Herr, Hr, Hr., Mister, Mr, Mr., Sir, Signor, Sig, Sig., Gentleman, Gentiluomo, Padrone, Monsieur, M, M.

Female: Frau, Fräulein, Fr, Fr., Miss, Ms, Ms., Mrs, Mrs., Signora, Sig.ra, Donna, La Signora, Madame, Mme, Mademoiselle, Mlle, Mle

Obligatory, if UseBillingData=No

sdTitle

ans..20

O

Title of the customer on the invoice, e.g. Dr. or Prof.

sdFirstName

ans..50

C

Obligatory, if UseBillingData=No: First name of customer or contact person in company

sdLastName

ans..50

C

Obligatory, if UseBillingData=No: Last name of customer or contact person in company

sdStreet

a..50

C

Obligatory, if UseBillingData=No: Street in the delivery address

sdStreetNr

ans..5

C

Obligatory, if UseBillingData=No: Street number of the delivery address

sdStreet2

a..50

O

Address addition in the delivery address

sdZip

n5

C

Obligatory, if UseBillingData=No: Postcode in the delivery address

sdCity

ans..50

C

Obligatory, if UseBillingData=No: Town/city of the delivery address

sdCountryCode

a3

C

Obligatory, if UseBillingData=No: Country code in the delivery address, 3 characters. Germany (DEU), Suisse (CHE) and Austria (AUT) are currently permitted.

sdPhone

ans..15

O

Telephone number of the customer in the delivery address

sdMobileNo

ans..50

O

Mobile telephone number of the customer in the delivery address

Company data

CompanyName

ans..200

C

Company name. Obligatory if CompanyOrPerson=F

LegalForm

a..12

C

Legal form of the company. Obligatory, if CompanyOrPerson=F

Values: <ag>, <eg>, <einzel>,  <ek>, <e_ges>, <ev>, <foundation>, <freelancer>, <gbr>, <gmbh>, <gmbh_ig>, <gmbh_co_kg>, <inv_kk>, <kg>, <kgaa>, <k_ges>, <ltd>, <ltd_co_kg>, <ohg>, <public_inst>, <misc_capital>, <misc>, <ug>.

RegisterNumber

ans..20

C

Register of Companies number/commercial register

Obligatory if CompanyOrPerson=F and a certain combination of LegalForm and bdCountryCode applies

HolderName

ans..100

C

Optional: Name of the firm owner

Obligatory if CompanyOrPerson=F and a certain combination of LegalForm and bdCountryCode applies

TaxNumber

ans..20

C

VAT Reg. No.

Notice: The specification of the VAT Reg. No. increases the probability of a hit

Article and order data

ArticleList

ans..768

M

Customer’s shopping cart with the following article data:

- Article no., ans..20
- Quantity, n..7
- Article name, ans..50
- Article description, ans..50
- Article price net in smallest currency unit, n..7
- Article price gross in smallest currency unit, n..7
- Category, ans..
- Sub category1, ans..
- Sub category2, ans..
- Artikcle type, optional, Obligatory for BillPayAction 7/8/9; n1:
     0: Other (default value)

     1: Flight

     2: Luggage with flight

     3: Combination of articles with flight

     4: Combination of articles without flight

     5: Hotel

     6: Travel insurance

     7: Car rental
- Departure destination, optional, mandatory with article type 1-3; a..3
- Departure date, optional, mandatory with article type 1-3; n8 in format YYYYMMDD
- Arrival destination, optional, mandatory with article type 1-3; a..3
- Arrival date, optional, mandatory with article type 1-3; n8 in format YYYYMMDD
- Booking class, optional, mandatory with article type 1-3; a..2 (bc: Business class, fc: First class, co: Bus, na: not available)
- Route type, optional, mandatory with article type 1-3; a..2 (rt: Round trip, ow: One-way, na: not available)
- Route type, optional, mandatory with article type 1-3; a..2 (rt: Change of booking not possible, rf: Change of booking, chargeable, possible, fl: No change of booking fees, na: not available)

Note on the structure of the article list:

<;> separates the fields of an article data set
<+> separates the article data sets

Each article is transferred as a complete article data set:

articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross;category;subcategory1;subcategory2;articletype;departingfrom;departingon;arrivingat;arrivingon;bookingclass;routtype;tickettype+articleid;articlequantity;articlename;articledescription;articleprice; articlepricegross;category;subcategory1;subcategory2;articletype;departingfrom;departingon;arrivingat;arrivingon;bookingclass;routtype;tickettype +…

OrderDesc

ans..768

M

Customer’s complete shopping cart including order, fees and discount with the following data:

- Shipping name (name of shipping method), ans..50
- Shipping costs net in the smallest currency unit, n..7
- Shipping costs gross in the smallest currency unit, n..7
- Net discount (incl. all discounts, coupons and other items) in the smallest currency unit, n..7
- Gross discount (incl. all discounts, coupons and other items) in the smallest currency unit, n..7
- Total price net in the smallest currency unit, n..7
- Total price gross in the smallest currency unit, n..7

Note on the structure of the order information:

<;> separates the fields of the order information

Each order is transferred as a complete article data set.

All transferred data is validated wherein the sum of individual items must give the total price. In this case the following must apply:

Total price gross=sum(article number x article gross price) + shipping costs gross – discount gross

Total price gross=sum(article number x article net price) + shipping costs – discount

Example:

Shipping name;shipping costs;shipping costs gross;discount;discount gross;total price; total price gross

DHL Standard;336;400;1390;1654;22307;26546

OrderHistory

ans..768

O

Customer’s order history/order information from the last 20 orders with the following information:

- Historical order number., ans..20
- Date of order, format YYYYMMDD hh:mm:ss
- Total price in the smallest currency unit, n..7
- Currency according to ISO 4217
- Payment method of the order with the following values:

<0> Direct Debit, <1> Credit Card, <2> Advance Payment, <3> Cash on Delivery, <4> Paypal, <5> Online Transfer, <6> Invoice, <7> BillPay invoice, <100> Other.

- Status of the order with the following values:
<0> paid, <1> open, <2> reminder, <3> debt collection, <4> overpaid, <5> underpaid, <6> cancelled.

Note on the structure of the OrderHistory:

<;> separates the fields of an article data set
<+> separates the article data sets

A max. of 20 data records may be transferred

Example: hordrid;hdate;hamount;hcurrency;hpaymenttype; hstatus+hordrid;hdate;hamount;hcurrency; hpaymenttype;hstatus+…

CustomerClassification

n1

O

Customer specification

0 – Customer has not yet ordered or has successfully completed payment for fewer than 2 orders

1 – Customer has already made successful payment for 2 or more orders

Limit

n..12

OC

Mandatory if CustomerClassification is transmitted: Numeric value Limit, based on the positive payment history x in Euro.

If CustomerClassification=0
- and no successful payment: Limit=0
- and one successful payment: Limit=2500


If CustomerClassification=1

Rule               Limit
1 € < x < 40 €         8000
40 € =< x < 75 €  15000
75 € =< x < 300 € x * 200
300 € =< x < 2000 €      (600 + (x-300) / 2) * 100
2000 € =< x           250000

Example: Payment history EUR 180 over 2 purchases:

Limit = 180*200 = 36000

Bank data

AccOwner

ans..50

M

First name and surname of the account holder (purchaser)

Notice: Obligatory parameters if BillPayAction=2 (electronic direct debit) or 3 (instalment payment)

IBAN

ans..34

M

Customer's IBAN

Notice: Obligatory parameters if BillPayAction=2 (electronic direct debit) or 3 (instalment payment)

BIC

an..11

OC

Customer’s BIC

Notice: Obligatory parameters if BillPayAction=2 (electronic direct debit) or 3 (instalment payment)

in case of BillPay hire purchase

BpBaseAmount

n..7

C

Obligatory in case of hire purchase (BillPayAction=3): gross amount to be financed excluding fees.

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

BpRateCount

n..2

C

Obligatory in case of hire purchase (BillPayAction=3): Number of monthly instalments selected by purchaser, e.g. 6/9/12/18/24

Notice: BpRateCount is to be used together with PayID and BillPayAction for a subsequent call

Travel data

TripData

ans..768

OC

Mandatory if ArticleList/ArticleType 1-3: Customer’s travel information with the following data:

- Number of trips already posted, n..3
- Total amount of trips already posted in the smallest currency unit , n..7
- Currency of trips already posted, a3

Hints on structure of parameter TripData:
<;> separates the fields of a data set

Example:
historicaltripcount;historicaltripamount;historicalcurrency

TravelerList

ans..768

OC

Mandatory if ArticleList/ArticleType 1-3: List of travellers with the following data:

- Salutation, a..
- First name, ans..40
- Surname, ans..40
- Birthday in format YYYYMMDD, a8
- Membership, n1
     0: Not available (standard value)

     1: Member of a frequent flyer programme

     2: No member of a frequent flyer programme

- MemberID in the frequent flyer programme, ans..50 (standard: 0)

Hints on structure of parameter TraverlList:
<;> separates the fields of a data set

A complete data record must be transferred per traveller.

Example:
salutation;firstname;lastname;birthday;membership;program;membershipid+ salutation;firstname;lastname;birthday;membership;program;membershipid+…

Parameters for BillPay payments


The following table describes the result parameters with which the Paygate responds:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

Status

a..50

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

RefNr

ans..30

O

Unique reference number for accounting

BpTransactionID

ans..50

C

BillPay transaction number

Notice: BpTransactionID is returned only if BpStatus=APPROVED

BpStatus

a..8

M

Status of the BillPay identity check and credit rating. Values: <APPROVED>, <DENIED> or <NOSTATUS> if errors occurred

Corrected address data

Street

ans..50

O

corrected street of customer

StreetNr

ans..5

O

corrected street number of customer

Zip

ans..5

O

corrected postcode of customer

City

ans..50

O

corrected town/city of customer

Country

a3

O

Customer’s corrected country code according to ISO3166 alpha-3

virtual BillPay bank details

BpAccOwner

ans..255

C

Account holder for the receivables (usually “BillPay GmbH”)

Notice: is returned only if BpStatus=APPROVED

IBAN

ans..34

C

BillPay-IBAN for the receivables

Notice: is returned only if BpStatus=APPROVED

BIC

an..11

C

BillPay-BIC for the receivables

Notice: is returned only if BpStatus=APPROVED

BpBank

ans..255

C

Name of the bank for the receivables

Notice: is returned only if BpStatus=APPROVED

BpInvoiceRef

ans..255

C

Purpose (contains RefNr)

Notice: is returned only if BpStatus=APPROVED

Response in case of hire purchase

BpConditionsList

ans..768

M

BillPay conditions for instalment payment

- Number of monthly instalments “term”, n..7
- Value of shopping cart, “base” n..7
- Gross order value “cart”, n..7
- Financing interest charge “surcharge”, n..7
- Gross total value “total”, n..7
- Monthly charge % “interest”, n..2
- eff. annual interest rate % “annual”, n..4
- BillPay fee “fee”, n..7

All amounts in the smallest currency unit (e.g. EUR Cent)

<;> separates fields of a hire purchase data record  
<+> separates different hire purchase conditions

Example: „term“;„base“;„cart“;„surcharge“;„total“; „interest“;„anual“;„fee“+…

BpPaymentPlan

ans..768

M

BillPay instalment plans with the following data:

- Number of monthly instalments “term”, n..2
- Gross value of first instalment, “due1”, n..7
- Gross value of 2nd to nth instalment, “due2” to “due-n”, n..7

<;> separates fields of a data record in the instalment plan   
<+> separates different instalment plans

Example: „term“;„due1“;„due2“;„due_n“+ „term“;„due1“;„due2“;„due_n“+

BpLink1

ans..768

M

Link to BillPay terms and condition for hire purchase which is to be displayed

BpLink2

ans..768

M

Link to BillPay data protection regulations which is to be displayed

BpLink3

ans..768

M

Link to BillPay terms of payment which is to be displayed

BpInfo1

ans..

MC

Base64 encrypted data string for the generation of a PDF document which contains a summary of all relevant data for the BillPay purchase by instalment order. This document must be forwarded to the purchaser!

Notice: This parameter is returned only with purchase by instalment with the subsequent request to finalise the payment.

BpInfo2

ans..

MC

Base64-encrypted data string for the generation of a PDF document which contains standard information about the conclusion of credit contracts and which must be sent to the credit recipient.

Notice: This parameter is returned only with purchase by instalment with the subsequent request to finalise the payment.

Response in case of error

ErrorText1

ans..255

O

ErrorText1 contains the detailed error message from BillPay for the merchant.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with Computop support.

ErrorText2

ans..255

O

ErrorText2 contains the detailed error message from BillPay for the purchaser.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with Computop support.

ErrorText3

n..6

O

ErrorText3 contains the detailed BillPay error code.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with Computop support.

ValidationErrors

ans..1024

O

in case of one or more validation errors with following data:

- error field
- error code > 1
- Customer error notification
- Merchant error notification

<;> separates fields within a validation error
<+> separates different validation errors

Example: <error field>; <error code>; <error message customer>; <error message merchant>+etc.

Result parameters for BillPay payments


Subsequent change of shopping cart

The contents of a shopping cart can be changed later, in the case of goods returned or additional articles. In this case the old shopping cart is completely replaced, but address, reference numbers, currency, method of payment and number of instalments are retained. If the order value is same or less this change is always accepted. In the case of an increase in the order value a new authorisation is attempted. The new shopping cart is valid only in the case of success otherwise the previous cart is retained. If an order is already activated, BillPay will notify the customer about the changed amount.

Enter the following URL to change the shopping cart associated with a payment previously initialised with BillPay:


The following table describes the transfer parameters to be encrypted:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

TransID

ans..64

M

TransactionID which should be unique for each payment

Amount

n..10

M

Total amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Article and order data

ArticleList

ans..768

M

Customer’s shopping cart with the following article data:

- Article no., ans..20
- Quantity, n..7
- Article name, ans..50
- Article description, ans..50
- Article price net in smallest currency unit, n..7
- Article price gross in smallest currency unit, n..7
- Category, ans..
- Sub category1, ans..
- Sub category2, ans..

Note on the structure of the article list:

<;> separates the fields of an article data set
<+> separates the article data sets

Each article is transferred as a complete article data set:

articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross;category;subcategory1;subcategory2;articletype;departingfrom;departingon;arrivingat;arrivingon;bookingclass;routtype;tickettype+articleid;articlequantity;articlename;articledescription;articleprice; articlepricegross;category;subcategory1;subcategory2;articletype;departingfrom;departingon;arrivingat;arrivingon;bookingclass;routtype;tickettype +…

OrderDesc

ans..768

M

Customer’s complete shopping cart including order, fees and discount with the following data:

- Shipping name (name of shipping method), ans..50
- Shipping costs net in the smallest currency unit, n..7
- Shipping costs gross in the smallest currency unit, n..7
- Net discount (incl. all discounts, coupons and other items) in the smallest currency unit, n..7
- Gross discount (incl. all discounts, coupons and other items) in the smallest currency unit, n..7
- Total price net in the smallest currency unit, n..7
- Total price gross in the smallest currency unit, n..7

Note on the structure of the order information:

<;> separates the fields of the order information

Each order is transferred as a complete article data set.

All transferred data is validated wherein the sum of individual items must give the total price. In this case the following must apply:

Total price gross=sum(article number x article gross price) + shipping costs gross – discount gross

Total price gross=sum(article number x article net price) + shipping costs – discount

Example:

Shipping name;shipping costs;shipping costs gross;discount;discount gross;total price; total price gross

DHL Standard;336;400;1390;1654;22307;26546

EventToken

a2

M

Abbreviation of the action to be done: Presently only CO (Change order) possible

Parameters for subsequent change of shopping cart with BillPay payments


The following table describes the result parameters, which Paygate sends in response:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

RefNr

ans..30

O

Unique reference number for accounting. Returned only if a RefNr has already been assigned.

BrTransactionID

ans..50

M

BillPay transaction number

BpStatus

a..8

M

Status of the BillPay identity check and credit rating. Values: <APPROVED>, <DENIED> or <NOSTATUS> if errors occurred

Response in case of hire purchase

BpConditionsList

ans..768

M

BillPay conditions for instalment payment

- term: Number of monthly instalments, n..7
- base: Value of shopping cart, n..7
- cart: Gross value including fees and rebates, n..7
- surcharge: Interest increase of financing, n..7
- total: Gross total value, n..7
- interest: monthly %-surcharge, n..2
- anual: eff. Interest per annum in %, n..4
- fee: BillPay handling fee, n..7

Notice: In this case the new conditions for the already selected number of monthly instalments are given.

<;>separates fields within a data record

Example: <term>;<base>;<cart>;<surcharge>;<total>;<interest>;<anual>;<fee>

BpPaymentPlan

ans..768

M

Instalment plan selected by the buyer:

- RateNr: number of the instalment
- RateAmount: instalment amount
- DueDate: due date of the instalment

Notice: In this case the instalment plan for the already selected number of monthly instalments are given.

<;>separates fields within a data record
<+> separates different data records

Example: <Rate1>;<RateAmount>;<DueDate>+ <Rate_n>;<RateAmount_n>;<DueDate_n>+ etc.

Notice: DueDate is empty if the order has not been activated.

Response in case of error

ErrorText1

ans..255

O

ErrorText1 contains the detailed error message from BillPay for the merchant.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with Computop support.

ErrorText2

ans..255

O

ErrorText2 contains the detailed error message from BillPay for the purchaser.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with Computop support.

ErrorText3

n..6

O

ErrorText3 contains the detailed BillPay error code.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with Computop support.

Result parameters for BillPay payments



BillPay with payment method control (PreScore)

BillPay‘s payment method control lets online merchants preselect BillPay payment methods in their online shop to be displayed to a specific customer. Customers only see the payment methods which apply to them, which leads to an increase in sales. For payment method control, the end customer identity and creditworthiness checks must take place before the payment method selection. The BillPay payment method control is thus an alternative to checking the end customer request after selecting a payment method. A merchant portal in the case of BillPay can work either with or without payment method control but not both at the same time.

For use of the payment method control the merchant must have a corresponding contract with BillPay and be enabled. The BillPay process is divided for this process into the prior payment method control (PreScore) and the subsequent creation of the BillPay payment which now requires fewer call-up parameters. The response to the reservation corresponds again to the declared normal proceedings declared above.

In order to execute the BillPay payment method control via server-to-server communication, please go to the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ns..30

O

Unique reference number

Amount

n..10

M

Total amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217

MAC

an64

O

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

UserData

ans..1024

O

If specified upon call, Paygate forwards the parameter with the payment result to the shop.

EventToken

a2

M

Token for the call of the request: <PS> for PreScore

Language

a2

M

language code according to ISO 639-1 (e.g. de for German)

NewCustomer

ans..5

M

Defines whether or not the purchaser is a new customer. Values: <YES>, <NO>, <GUEST>

IpAddr

ans15

M

Customer´s IP address in IPv4 or IPv6 format

CompanyOrPerson

a1

OC

Distinction of the purchaser as private person or company. Values: <F> for companies, <P> for persons, default value <P>. Obligatory for BillPay B2B

DateOfBirth

an10

OC

Birth date of the customer in the format YYYY-MM-DD (may not be transmitted in the case of BillPay B2B)

BrowserSessionID

ans..100

O

SessionID for fraud detection (must be the same with the SessionID from the JavaScript-Widget)

Invoice data

bdSalutation

a..15

M

Salutation of the customer on the invoice. Permissible values:

Male: Herr, Hr, Hr., Mister, Mr, Mr., Sir, Signor, Sig, Sig., Gentleman, Gentiluomo, Padrone, Monsieur, M, M.

Female: Frau, Fräulein, Fr, Fr., Miss, Ms, Ms., Mrs, Mrs., Signora, Sig.ra, Donna, La Signora, Madame, Mme, Mademoiselle, Mlle, Mle

bdTitle

ans..20

O

Title of the customer or contact person within the company on the invoice, e.g. Dr. or Prof.

bdFirstName

ans..50

M

First name of customer or contact person in company

bdLastName

ans..50

M

Last name of customer or contact person in company

bdStreet

a..50

M

Street name in the invoicing address

bdStreetNr

ans..5

M

Street number of the invoicing address

bdStreet2

a..50

O

Address addition in the billing address

bdZip

n5

M

Postcode in the invoicing address

bdCity

ans..50

M

Town/city of the invoicing address

bdCountryCode

a3

M

Country code in the billing address, 3 characters. Germany (DEU), Suisse (CHE) and Austria (AUT) are currently permitted.

EMail

ans..50

M

E-mail address of the customer or contact person on the invoicing address

Phone

ans..15

O

Telephone number of the customer or contact person on the invoicing address.

MobileNo

ans..50

O

Mobile telephone number of the customer on the invoicing address

Delivery data

UseBillingData

a3

M

Is the invoicing address to be used as the delivery address? Permissible: <Yes> or <No>. If <No>, parameters for the delivery address become obligatory. If <Yes>, no parameters are transferred for the delivery address.

sdSalutation

a..15

C

Salutation of the customer on the invoice. Permissible values:

Male: Herr, Hr, Hr., Mister, Mr, Mr., Sir, Signor, Sig, Sig., Gentleman, Gentiluomo, Padrone, Monsieur, M, M.

Female: Frau, Fräulein, Fr, Fr., Miss, Ms, Ms., Mrs, Mrs., Signora, Sig.ra, Donna, La Signora, Madame, Mme, Mademoiselle, Mlle, Mle

Obligatory, if UseBillingData=No

sdTitle

ans..20

O

Title of the customer on the invoice, e.g. Dr. or Prof.

sdFirstName

ans..50

C

Obligatory, if UseBillingData=No: First name of customer or contact person in company

sdLastName

ans..50

C

Obligatory, if UseBillingData=No: Last name of customer or contact person in company

sdStreet

a..50

C

Obligatory, if UseBillingData=No: Street in the delivery address

sdStreetNr

ans..5

C

Obligatory, if UseBillingData=No: Street number of the delivery address

sdStreet2

a..50

O

Address addition in the delivery address

sdZip

n5

C

Obligatory, if UseBillingData=No: Postcode in the delivery address

sdCity

ans..50

C

Obligatory, if UseBillingData=No: Town/city of the delivery address

sdCountryCode

a3

C

Obligatory, if UseBillingData=No: Country code in the delivery address, 3 characters. Germany (DEU), Suisse (CHE) and Austria (AUT) are currently permitted.

sdPhone

ans..15

O

Telephone number of the customer in the delivery address

sdMobileNo

ans..50

O

Mobile telephone number of the customer in the delivery address

Company data

CompanyName

ans..200

C

Company name. Obligatory if CompanyOrPerson=F

LegalForm

a..12

C

Legal form of the company. Obligatory, if CompanyOrPerson=F

Values: <ag>, <eg>, <einzel>,  <ek>, <e_ges>, <ev>, <foundation>, <freelancer>, <gbr>, <gmbh>, <gmbh_ig>, <gmbh_co_kg>, <inv_kk>, <kg>, <kgaa>, <k_ges>, <ltd>, <ltd_co_kg>, <ohg>, <public_inst>, <misc_capital>, <misc>, <ug>.

RegisterNumber

ans..20

C

Register of Companies number/commercial register

Obligatory if CompanyOrPerson=F and a certain combination of LegalForm and bdCountryCode applies

HolderName

ans..100

C

Optional: Name of the firm owner

Obligatory if CompanyOrPerson=F and a certain combination of LegalForm and bdCountryCode applies

TaxNumber

ans..20

C

VAT Reg. No.

Notice: The specification of the VAT Reg. No. increases the probability of a hit

Article and order data

ArticleList

ans..768

M

Customer’s shopping cart with the following article data:

- Article no., ans..20
- Quantity, n..7
- Article name, ans..50
- Article description, ans..50
- Article price net in smallest currency unit, n..7
- Article price gross in smallest currency unit, n..7
- Category, ans..
- Sub category1, ans..
- Sub category2, ans..
- Article type, optional, Obligatory for BillPayAction 7/8/9; n1:
     0: Other (default value)

     1: Flight

     2: Luggage with flight

     3: Combination of articles with flight

     4: Combination of articles without flight

     5: Hotel

     6: Travel insurance

     7: Car rental
- Departure destination, optional, mandatory with article type 1-3; a..3
- Departure date, optional, mandatory with article type 1-3; n8 in format YYYYMMDD
- Arrival destination, optional, mandatory with article type 1-3; a..3
- Arrival date, optional, mandatory with article type 1-3; n8 in format YYYYMMDD
- Booking class, optional, mandatory with article type 1-3; a..2 (bc: Business class, fc: First class, co: Bus, na: not available)
- Route type, optional, mandatory with article type 1-3; a..2 (rt: Round trip, ow: One-way, na: not available)
- Route type, optional, mandatory with article type 1-3; a..2 (rt: Change of booking not possible, rf: Change of booking, chargeable, possible, fl: No change of booking fees, na: not available)

Note on the structure of the article list:

<;> separates the fields of an article data set
<+> separates the article data sets

Each article is transferred as a complete article data set:

articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross;category;subcategory1;subcategory2;articletype;departingfrom;departingon;arrivingat;arrivingon;bookingclass;routtype;tickettype+articleid;articlequantity;articlename;articledescription;articleprice; articlepricegross;category;subcategory1;subcategory2;articletype;departingfrom;departingon;arrivingat;arrivingon;bookingclass;routtype;tickettype +…

OrderDesc

ans..768

M

Customer’s complete shopping cart including order, fees and discount with the following data:

- Shipping name (name of shipping method), ans..50
- Shipping costs net in the smallest currency unit, n..7
- Shipping costs gross in the smallest currency unit, n..7
- Net discount (incl. all discounts, coupons and other items) in the smallest currency unit, n..7
- Gross discount (incl. all discounts, coupons and other items) in the smallest currency unit, n..7
- Total price net in the smallest currency unit, n..7
- Total price gross in the smallest currency unit, n..7

Note on the structure of the order information:

<;> separates the fields of the order information

Each order is transferred as a complete article data set.

All transferred data is validated wherein the sum of individual items must give the total price. In this case the following must apply:

Total price gross=sum(article number x article gross price) + shipping costs gross – discount gross

Total price gross=sum(article number x article net price) + shipping costs – discount

Example:

Shipping name;shipping costs;shipping costs gross;discount;discount gross;total price; total price gross

DHL Standard;336;400;1390;1654;22307;26546

OrderHistory

ans..768

O

Customer’s order history/order information from the last 20 orders with the following information:

- Historical order number., ans..20
- Date of order, format YYYYMMDD hh:mm:ss
- Total price in the smallest currency unit, n..7
- Currency according to ISO 4217
- Former payment method of the order with the following values:

<0> Direct Debit, <1> Credit Card, <2> Advance Payment, <3> Cash on Delivery, <4> Paypal, <5> Online Transfer, <6> Invoice, <7> BillPay invoice, <100> Other.

- Status of the order with the following values:
<0> paid, <1> open, <2> reminder, <3> debt collection, <4> overpaid, <5> underpaid, <6> cancelled.

Note on the structure of the OrderHistory:

<;> separates the fields of an article data set
<+> separates the article data sets

A max. of 20 data records may be transferred

Example: hordrid;hdate;hamount;hcurrency;hpaymenttype; hstatus+hordrid;hdate;hamount;hcurrency; hpaymenttype;hstatus+…

CustomerClassification

n1

O

Customer specification

0 – Customer has not yet ordered or has successfully completed payment for fewer than 2 orders

1 – Customer has already made successful payment for 2 or more orders

Limit

n..12

OC

Mandatory if CustomerClassification is transmitted: Numeric value Limit, based on the positive payment history x in Euro.

If CustomerClassification=0
- and no successful payment: Limit=0
- and one successful payment: Limit=2500


If CustomerClassification=1

Rule               Limit
1 € < x < 40 €         8000
40 € =< x < 75 €  15000
75 € =< x < 300 € x * 200
300 € =< x < 2000 €      (600 + (x-300) / 2) * 100
2000 € =< x           250000

Example: Payment history EUR 180 over 2 purchases:

Limit = 180*200 = 36000

Travel data

TripData

ans..768

OC

Mandatory if ArticleList/ArticleType 1-3: Customer’s travel information with the following data:

- Number of trips already posted, n..3
- Total amount of trips already posted in the smallest currency unit , n..7
- Currency of trips already posted, a3

Hints on structure of parameter TripData:
<;> separates the fields of a data set

Example:
historicaltripcount;historicaltripamount;historicalcurrency

TravelerList

ans..768

OC

Mandatory if ArticleList/ArticleType 1-3: List of travellers with the following data:

- Salutation, a..
- First name, ans..40
- Surname, ans..40
- Birthday in format YYYYMMDD, a8
- Membership, n1
     0: Not available (standard value)

     1: Member of a frequent flyer programme

     2: No member of a frequent flyer programme

- MemberID in the frequent flyer programme, ans..50 (standard: 0)

Hints on structure of parameter TraverlList:
<;> separates the fields of a data set

A complete data record must be transferred per traveller.

Example:
salutation;firstname;lastname;birthday;membership;program;membershipid+ salutation;firstname;lastname;birthday;membership;program;membershipid+…

Parameters for BillPay payment method control (PreScore)


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

ID assigned by Paygate for the payment transaction.

TransID

ans..64

M

Merchant’s transaction number

Status

a..50

M

AUTHORIZE_REQUEST or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

RefNr

ans..30

O

Merchant’s reference number. In case of updating the RefNr the new RefNr is returned to the merchant.

UserData

ans..1024

O

If specified upon call, Paygate forwards the parameter with the payment result to the shop.

BillPay answer

BpStatus

a..8

M

Status of the BillPay identity check and credit rating. Values: <APPROVED>, <DENIED> or <NOSTATUS> if errors occurred

BpTransactionID

ans..50

O

BillPay transaction number

Notice: BpTransactionID is returned only if BpStatus=APPROVED

Street

ans..50

O

Corrected street of customer

StreetNr

ans..15

O

Corrected street number of customer

Zip

ans..5

O

Corrected postcode of customer

City

ans..50

O

Corrected town/city of the customer

Country

a3

O

Customer’s corrected country code according to ISO3166 alpha-3

BrowserSessionID

ans..100

O

SessionID for fraud detection (must be the same with the SessionID from the JavaScript-Widget)

AllowedPayMethods

ans..768

OC

List of allowed payment methods (is returned only if BpStatus=APPROVED)

1 for INVOICE
2 for DIRECT_DEBIT
4 for PAYLATER (instalment payment)
8 for INVOICE_COLLATERAL_PROMISE
9 for DIRECT_DEBIT_COLLATERAL_PROMISE
7 for PAYLATER_COLLATERAL_PROMIS


Customer group: PRIVATE for B2C; BUSINESS for B2B Todo

<;>separates fields within a data record
<+> separates data records

Example: <ID>;< Name>,<Customer group>+<ID>;< Name>;<Customer group>+…

ValidationErrors

ans..1024

O

Is returned in the case of one or more validation errors. Contains following data:

-     error field
-     error code. Value is always > 1
-     Customer error notification
-     Detailed merchant error notification
<;> separates the fields of a data set
<+> separates data records

Example: <error field>; <error code>; <error message customer>; <error message merchant>+etc.

BillPay response in case of errors

ErrorText1

ans..255

O

ErrorText1 contains the detailed error message from BillPay for the merchant.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with Computop support.

ErrorText2

ans..255

O

ErrorText2 contains the detailed error message from BillPay for the purchaser.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with Computop support.

ErrorText3

n..6

O

ErrorText3 contains the detailed BillPay error code.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with Computop support.

Result parameters for BillPay payments methods control


To create and reserve the payment the second access requires just a few additional parameters depending on the payment method.

Notice: As soon as the customer changes its personal data or shopping basket, the payment method control must be resent. The previously implemented payment method control is no longer valid.


To generate a BillPay payment via a Server-to-Server connection, call the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing of batch files.

TransID

ans..64

M

TransactionID which should be unique for each payment

MAC

an64

O

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

UserData

ans..1024

O

If specified upon call, Paygate forwards the parameter with the payment result to the shop.

BillPayAction

n1

M

Defines the method of payment used.

<1> for invoice purchase, <2> for direct debit, <4> for PayLater, <7> for PayLater with assumption of debt, <8> for invoice purchase with assumption of debt, <9> for direct debit with assumption of debt.

Notice: Only permitted payment methods may be used. See return parameter AllowedPayMethods in the response to the payment method control.

ActivationDelay

n..3

OC

Mandatory for BillPayAction = 7, 8 or 9 (assumption of debt)

Number of days until fulfilment of service (e.g. start of journey)

DateOfBirth

an10

OC

Mandatory if not yet transferred in the payment method control request: Birth date of the customer in the format YYYY-MM-DD (may not be transmitted in the case of BillPay B2B)

GtcValue

a..3

M

Defines whether or not the customer has confirmed BillPay’s terms and conditions. Values: <YES> or <NO>

AccOwner

ans..50

OC

Obligatory if BillPayAction=2 (electronic direct debit) or 4 (PayLater)

First name and last name of the account holder (purchaser)

IBAN

ans..34

OC

Obligatory if BillPayAction=2 (electronic direct debit) or 4 (PayLater)

Customer's IBAN

BIC

an..11

OC

Obligatory if BillPayAction=2 (electronic direct debit) or 4 (PayLater)

Customer’s BIC

BpBaseAmount

n..7

OC

Obligatory if BillPayAction=4 (PayLater): gross amount to be financed (total price + interest charge + transaction charge)

The values come from the BillPay JavaScript-Snippet.

BpRateCount

n..2

OC

Mandatory if BillPayAction=4 (PayLater): Number of monthly instalments selected by purchaser

The values come from the BillPay JavaScript-Snippet.

URLBack

ans..256

OC

Mandatory if BillPayAction=4 (PayLater): URL to which the customer is routed back after the down payment. Please use a reference within this URL in order to allocate the payment later.

The parameter "URLBack" can be sent

  • either as plain parameter (unencrypted) (compatibility mode)
  • or be part of encrypted payment request parameters (preferred mode)

URLNotify

ans..256

OC

Mandatory if BillPayAction=4 (PayLater) and no URLNotify for PayLater ist stored at Computop:

Complete URL, which calls up Paygate in order to notify the shop. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead.

This URL is callad only if the customer was forwarded to the gateway for down payment, because in this case the response from gateway is delayed.

Travel data

TripData

ans..768

OC

Mandatory if ArticleList/ArticleType 1-3: Customer’s travel information with the following data:

- Number of trips already posted, n..3
- Total amount of trips already posted in the smallest currency unit , n..7
- Currency of trips already posted, a3

Hints on structure of parameter TripData:
<;> separates the fields of a data set

Example:
historicaltripcount;historicaltripamount;historicalcurrency

TravelerList

ans..768

OC

Mandatory if ArticleList/ArticleType 1-3: List of travellers with the following data:

- Salutation, a..
- First name, ans..40
- Surname, ans..40
- Birthday in format YYYYMMDD, a8
- Membership, n1
     0: Not available (standard value)

     1: Member of a frequent flyer programme

     2: No member of a frequent flyer programme

- MemberID in the frequent flyer programme, ans..50 (standard: 0)

Hints on structure of parameter TraverlList:
<;> separates the fields of a data set

A complete data record must be transferred per traveller.

Example:
salutation;firstname;lastname;birthday;membership;program;membershipid+ salutation;firstname;lastname;birthday;membership;program;membershipid+…

Parameters for BillPay payment after payment methods control


The response parameters correspond to the parameters of general process which are explained above.



PayLater via BillPay

This chapter describes how to process a PayLater payment via BillPay. PayLater is an extension of the Billpay-connection. Further functions and general parameters are described in the general documentation of Billpay.

To make a payment with PayLater via BillPay, go to the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ns..30

O

Unique reference number

Amount

n..10

M

Total amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217

MAC

an64

O

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

Language

a2

M

language code according to ISO 639-1 (e.g. de for German)

NewCustomer

ans..5

M

Defines whether or not the purchaser is a new customer. Values: <YES>, <NO>, <GUEST>

BillPayAction

n1

M

Defines the method of payment used. Values:

<1> for invoice purchase
<2> for direct debit
<4> for PayLater
<7> for PayLater with assumption of debt
<8> for invoice purchase with assumption of debt
<9> for direct debit with assumption of debt

GtcValue

a..3

M

Defines whether or not the customer has confirmed BillPay’s terms and conditions. Values: <YES> or <NO>

DateOfBirth

an10

OC

Customer’s birth date in the format YYYY-MM-DD (mandatory when CompanyOrPerson=F)

IpAddr

ans15

M

Customer´s IP address in IPv4 or IPv6 format

ActivationDelay

n..3

OC

Mandatory for BillPayAction = 7, 8 or 9 (assumption of debt)

Number of days until fulfilment of service (e.g. start of journey)

CompanyOrPerson

a1

OC

Distinction of the purchaser as private person or company. Values: <F> for companies, <P> for persons, default value <P>. Obligatory for BillPay B2B

BrowserSessionID

ans..100

O

SessionID for fraud detection (must be the same with the SessionID from the JavaScript-Widget)

Invoice data

bdSalutation

a..15

OC

Obligatory if CompanyOrPerson=P: Salutation of the customer on the invoice. Permissible values:

Male: Herr, Hr, Hr., Mister, Mr, Mr., Sir, Signor, Sig, Sig., Gentleman, Gentiluomo, Padrone, Monsieur, M, M.

Female: Frau, Fräulein, Fr, Fr., Miss, Ms, Ms., Mrs, Mrs., Signora, Sig.ra, Donna, La Signora, Madame, Mme, Mademoiselle, Mlle, Mle

bdTitle

ans..20

O

Title of the customer or contact person within the company on the invoice, e.g. Dr. or Prof.

bdFirstName

ans..50

M

First name of customer or contact person in company

bdLastName

ans..50

M

Last name of customer or contact person in company

bdStreet

a..50

M

Street name in the invoicing address

bdStreetNr

ans..5

M

Street number of the invoicing address

bdStreet2

a..50

O

Address addition in the billing address

bdZip

n5

M

Postcode in the invoicing address

bdCity

ans..50

M

Town/city of the invoicing address

bdCountryCode

a3

M

Country code in the billing address, 3 characters. Germany (DEU), Suisse (CHE) and Austria (AUT) are currently permitted.

EMail

ans..50

M

E-mail address of the customer or contact person on the invoicing address

Phone

ans..15

M

Telephone number of the customer or contact person on the invoicing address.

MobileNo

ans..50

O

Mobile telephone number of the customer on the invoicing address

Delivery data

UseBillingData

a3

M

Is the invoicing address to be used as the delivery address? Permissible: <Yes> or <No>. If <No>, parameters for the delivery address become obligatory. If <Yes>, no parameters are transferred for the delivery address.

sdSalutation

a..15

OC

Obligatory, if UseBillingData=No: Salutation of the customer on the invoice. Permissible values:

Male: Herr, Hr, Hr., Mister, Mr, Mr., Sir, Signor, Sig, Sig., Gentleman, Gentiluomo, Padrone, Monsieur, M, M.

Female: Frau, Fräulein, Fr, Fr., Miss, Ms, Ms., Mrs, Mrs., Signora, Sig.ra, Donna, La Signora, Madame, Mme, Mademoiselle, Mlle, Mle

Obligatory, if UseBillingData=No

sdTitle

ans..20

O

Title of the customer on the invoice, e.g. Dr. or Prof.

sdFirstName

ans..50

OC

Obligatory, if UseBillingData=No: First name of customer or contact person in company

sdLastName

ans..50

OC

Obligatory, if UseBillingData=No: Last name of customer or contact person in company

sdStreet

a..50

OC

Obligatory, if UseBillingData=No: Street in the delivery address

sdStreetNr

ans..5

OC

Obligatory, if UseBillingData=No: Street number of the delivery address

sdStreet2

a..50

OO

Address addition in the delivery address

sdZip

n5

OC

Obligatory, if UseBillingData=No: Postcode in the delivery address

sdCity

ans..50

OC

Obligatory, if UseBillingData=No: Town/city of the delivery address

sdCountryCode

a3

OC

Obligatory, if UseBillingData=No: Country code in the delivery address, 3 characters. Germany (DEU), Suisse (CHE) and Austria (AUT) are currently permitted.

sdPhone

ans..15

O

Telephone number of the customer in the delivery address

sdMobileNo

ans..50

O

Mobile telephone number of the customer in the delivery address

Company data

CompanyName

ans..200

C

Obligatory if CompanyOrPerson=F: Name of company

LegalForm

a..12

C

Obligatory, if CompanyOrPerson=F: Legal form of the company.

Values: <ag>, <eg>, <einzel>,  <ek>, <e_ges>, <ev>, <foundation>, <freelancer>, <gbr>, <gmbh>, <gmbh_ig>, <gmbh_co_kg>, <inv_kk>, <kg>, <kgaa>, <k_ges>, <ltd>, <ltd_co_kg>, <ohg>, <public_inst>, <misc_capital>, <misc>, <ug>.

RegisterNumber

ans..20

C

Register of Companies number/commercial register

Obligatory if CompanyOrPerson=F and a certain combination of LegalForm and bdCountryCode applies

HolderName

ans..100

C

Name of the firm owner

Obligatory if CompanyOrPerson=F and a certain combination of LegalForm and bdCountryCode applies

TaxNumber

ans..20

C

VAT Reg. No.

Notice: The specification of the VAT Reg. No. increases the probability of a hit

Article and order data

ArticleList

ans..768

M

Customer’s shopping cart with the following article data:

- Article no., ans..20
- Quantity, n..7
- Article name, ans..50
- Article description, ans..50
- Article price net in smallest currency unit, n..7
- Article price gross in smallest currency unit, n..7
- Category, ans..
- Sub category1, ans..
- Sub category2, ans..
- Artikcle type, optional, Obligatory for BillPayAction 7/8/9; n1:
     0: Other (default value)

     1: Flight

     2: Luggage with flight

     3: Combination of articles with flight

     4: Combination of articles without flight

     5: Hotel

     6: Travel insurance

     7: Car rental
- Departure destination, optional, mandatory with article type 1-3; a..3
- Departure date, optional, mandatory with article type 1-3; n8 in format YYYYMMDD
- Arrival destination, optional, mandatory with article type 1-3; a..3
- Arrival date, optional, mandatory with article type 1-3; n8 in format YYYYMMDD
- Booking class, optional, mandatory with article type 1-3; a..2 (bc: Business class, fc: First class, co: Bus, na: not available)
- Route type, optional, mandatory with article type 1-3; a..2 (rt: Round trip, ow: One-way, na: not available)
- Route type, optional, mandatory with article type 1-3; a..2 (rt: Change of booking not possible, rf: Change of booking, chargeable, possible, fl: No change of booking fees, na: not available)

Note on the structure of the article list:

<;> separates the fields of an article data set
<+> separates the article data sets

Each article is transferred as a complete article data set:

articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross;category;subcategory1;subcategory2;articletype;departingfrom;departingon;arrivingat;arrivingon;bookingclass;routtype;tickettype+articleid;articlequantity;articlename;articledescription;articleprice; articlepricegross;category;subcategory1;subcategory2;articletype;departingfrom;departingon;arrivingat;arrivingon;bookingclass;routtype;tickettype +…

OrderDesc

ans..768

M

Customer’s complete shopping cart including order, fees and discount with the following data:

- Shipping name (name of shipping method), ans..50
- Shipping costs net in the smallest currency unit, n..7
- Shipping costs gross in the smallest currency unit, n..7
- Net discount (incl. all discounts, coupons and other items) in the smallest currency unit, n..7
- Gross discount (incl. all discounts, coupons and other items) in the smallest currency unit, n..7
- Total price net in the smallest currency unit, n..7
- Total price gross in the smallest currency unit, n..7

Note on the structure of the order information:

<;> separates the fields of the order information

Each order is transferred as a complete article data set.

All transferred data is validated wherein the sum of individual items must give the total price. In this case the following must apply:

Total price gross=sum(article number x article gross price) + shipping costs gross – discount gross

Total price gross=sum(article number x article net price) + shipping costs – discount

Example:

Shipping name;shipping costs;shipping costs gross;discount;discount gross;total price; total price gross

DHL Standard;336;400;1390;1654;22307;26546

OrderHistory

ans..768

O

Customer’s order history/order information from the last 20 orders with the following information:

- Historical order number., ans..20
- Date of order, format YYYYMMDD hh:mm:ss
- Total price in the smallest currency unit, n..7
- Currency according to ISO 4217
- Former payment method of the order with the following values:

<0> Direct Debit, <1> Credit Card, <2> Advance Payment, <3> Cash on Delivery, <4> Paypal, <5> Online Transfer, <6> Invoice, <7> BillPay invoice, <100> Other.

- Status of the order with the following values:
<0> paid, <1> open, <2> reminder, <3> debt collection, <4> overpaid, <5> underpaid, <6> cancelled.

Note on the structure of the OrderHistory:

<;> separates the fields of an article data set
<+> separates the article data sets

A max. of 20 data records may be transferred

Example: hordrid;hdate;hamount;hcurrency;hpaymenttype; hstatus+hordrid;hdate;hamount;hcurrency; hpaymenttype;hstatus+…

CustomerClassification

n1

O

Customer specification

0 – Customer has not yet ordered or has successfully completed payment for fewer than 2 orders

1 – Customer has already made successful payment for 2 or more orders

Limit

n..12

OC

Mandatory if CustomerClassification is transmitted: Numeric value Limit, based on the positive payment history x in Euro.

If CustomerClassification=0
- and no successful payment: Limit=0
- and one successful payment: Limit=2500


If CustomerClassification=1

Rule               Limit
1 € < x < 40 €         8000
40 € =< x < 75 €  15000
75 € =< x < 300 € x * 200
300 € =< x < 2000 €      (600 + (x-300) / 2) * 100
2000 € =< x           250000

Example: Payment history EUR 180 over 2 purchases:

Limit = 180*200 = 36000

Bank data

AccOwner

ans..50

M

First name and surname of the account holder (purchaser)

IBAN

ans..34

M

Customer's IBAN

BIC

an..11

M

Customer’s BIC

In case of hire purchase

BpBaseAmount

n..7

M

Re financing gross amount (total price + interest + transaction fee)

BpRateCount

n..2

M

Number of monthly instalments selected by purchaser

Notice: BpRateCount is to be used together with PayID and BillPayAction for a subsequent call.

URLBack

ans..256

M

URL to which the customer is routed back after the down payment. Please use a reference within this URL in order to allocate the payment later.

The parameter "URLBack" can be sent

  • either as plain parameter (unencrypted) (compatibility mode)
  • or be part of encrypted payment request parameters (preferred mode)

URLNotify

ans..256

MC

Mandatory if no URLNotify for PayLater ist stored at Computop:

Complete URL, which calls up Paygate in order to notify the shop. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead.

This URL is callad only if the customer was forwarded to the gateway for down payment, because in this case the response from gateway is delayed.

Travel data

TripData

ans..768

OC

Mandatory if ArticleList/ArticleType 1-3: Customer’s travel information with the following data:

- Number of trips already posted, n..3
- Total amount of trips already posted in the smallest currency unit , n..7
- Currency of trips already posted, a3

Hints on structure of parameter TripData:
<;> separates the fields of a data set

Example:
historicaltripcount;historicaltripamount;historicalcurrency

TravelerList

ans..768

OC

Mandatory if ArticleList/ArticleType 1-3: List of travellers with the following data:

- Salutation, a..
- First name, ans..40
- Surname, ans..40
- Birthday in format YYYYMMDD, a8
- Membership, n1
     0: Not available (standard value)

     1: Member of a frequent flyer programme

     2: No member of a frequent flyer programme

- MemberID in the frequent flyer programme, ans..50 (standard: 0)

Hints on structure of parameter TraverlList:
<;> separates the fields of a data set

A complete data record must be transferred per traveller.

Example:
salutation;firstname;lastname;birthday;membership;program;membershipid+ salutation;firstname;lastname;birthday;membership;program;membershipid+…

Parameters for PayLater via BillPay


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

ID assigned by Paygate for the payment transaction.

TransID

ans..64

M

Merchant’s transaction number

Status

a..50

M

OK, FAILED or AUTHORIZE_REQUEST if a down payment is needed

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

RefNr

ans..30

O

Merchant’s reference number. In case of updating the RefNr the new RefNr is returned to the merchant.

BpTransactionID

ans..50

M

BillPay transaction number

Notice: BpTransactionID is returned only if BpStatus=APPROVED

BpStatus

a..8

M

Status of the BillPay identity check and credit rating. Values: <APPROVED>, <DENIED>, <PRE_APPROVED> (in case of a necessary down payment) or <NOSTATUS> if errors occurred

Response from PayLater

BpConditionsList

ans..768

C

is returned only if BpStatus=APPROVED Values for calculation of the instalment plan:

- num_inst: Number of monthly partial amounts to be paid by the customer
- duration: Term of instalment plan
- fee_percent: Percentage of PayLater fee
- fee_total: Total sum of PayLater fee
- pre_payment: Amount paid
- total_amount: Total amount of PayLater order
- eff_anual: eff. annual interest rate in percent
- nominal: Annual nominal interest rate in percent

<;>separates fields within a financing data record

Example: <num_inst>;<duration>;<fee_percent>;<fee_total>;<pre_payment>;<total_amount>;<eff_anual>;<nominal>

BpPaymentPlan

ans..768

C

is returned only if BpStatus=APPROVED List with monthly instalments and due date and amount of instalment

-     Value of instalments payable in the smallest currency unit “instl”

-     Date of expected receipt “date”

-     Type of instalment “type”

<;> separates the instalment and date of a data record
<+> separates monthly instalments

Example: „instl1“; „date1“; „type1“+ „instl2“; „date2“; „type2“ + „instl3“…

PrePayment

n..12

C

is returned only if BpStatus=PRE_APPROVED Amount of prepayment to be payed by the customer

BpLink1

ans..768

C

is returned only if BpStatus=PRE_APPROVED URL for forwarding to the prepayment partner. This value is URL-encoded und must be URL-decoded.

BpLink2

ans.768

C

is returned only if BpStatus=PRE_APPROVED URL for the updated instalment plan including the amount of prepayment. This value is URL-encoded und must be URL-decoded.

Campaign

ans..768

C

is returned only if BpStatus=PRE_APPROVED

Campaign information

- type of campaign. This describes the shifting of the payment date (e.g. 14 days or 7 days) “type”

- Text displayed on the page before transfer to payment partner “display_text”

- Path to a promotional image depending on the campaign “display_image_url”

<;> separates the fields of the campaign information

Example: „type“; „display_text“; „display_image_url“

Corrected address data

Street

ans..50

O

Corrected street of customer

StreetNr

ans..15

O

Corrected street number of customer

Zip

ans..5

O

Corrected postcode of customer

City

ans..50

O

Corrected town/city of the customer

Country

a3

O

Customer’s corrected country code according to ISO3166 alpha-3

Response in case of errors

ErrorText1

ans..255

O

ErrorText1 contains the detailed error message from BillPay for the merchant.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with Computop support.

ErrorText2

ans..255

O

ErrorText2 contains the detailed error message from BillPay for the purchaser.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with Computop support.

ErrorText3

n..6

O

ErrorText3 contains the detailed BillPay error code.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with Computop support.

Result parameters for PayLater via BillPay



Capture & partial capture via socket connection

Captures are possible via a Server-to-Server connection. Additionally the merchant can full or partly activate BillPay reservations and in this way set the date of payment for the customer. If the merchant transfers a new reference number, the reference number of the reservation will be updated and then the invoice is activated. To carry out a Capture via a Server-to-Server connection please use the following URL:


The following tables describe the transfer parameters and return values which are exchanged via the socket connection.

Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

TransID

ans..64

M

ID assigned by Merchant for the payment process to be captured

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency code, three digits DIN / ISO 4217. Only EUR and CHF permissible.

RefNr

ans..30

M

Unique reference number which appears on your printed card account or in the EPA-file (Electronic Payment Advice). Format must be mutually agreed beforehand with Computop! For EVO Payments International Customers: compulsory field for unique number.

The RefNr will be updated, if another RefNr is submitted than for the reservation.

ReqIDans..32OTo avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

InvoiceNr

ans..30

C

Only for BillPay partial activation: unique invoice number

Delay

n..3

O

Number of days to delay the due date

ArticleList

ans..768

C

BillPay partial activation only:

Customer’s shopping cart with the following article data:

- Article no., ans..20
- Quantity, n..7
- Article name, ans..50
- Article description, ans..50
- Article price net in smallest currency unit, n..7
- Article price gross in smallest currency unit, n..7

Note on the structure of the article list:

<;> separates the fields of an article data set
<+> separates the article data sets

Each article is transferred as a complete article data set:

articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross+articleid;articlequantity;articlename;articledescription;articleprice;articlepricegross+…

OrderDesc

ans..768

C

BillPay partial activation only:

Customer’s complete shopping cart including order, fees and discount with the following data:

- Shipping name (name of shipping method), ans..50
- Shipping costs net in the smallest currency unit, n..7
- Shipping costs gross in the smallest currency unit, n..7
- Net discount (incl. all discounts, coupons and other items) in the smallest currency unit, n..7
- Gross discount (incl. all discounts, coupons and other items) in the smallest currency unit, n..7
- Total price net in the smallest currency unit, n..7
- Total price gross in the smallest currency unit, n..7

Note on the structure of the order information:

<;> separates the fields of the order information

Each order is transferred as a complete article data set.

All transferred data is validated wherein the sum of individual items must give the total price. In this case the following must apply:

Total price gross=sum(article number x article gross price) + shipping costs gross – discount gross
Total price gross=sum(article number x article net price) + shipping costs – discount

Example: Shipping name;shipping costs;shipping costs gross;discount;discount gross;total price; total price gross

DHL Standard;336;400;1390;1654;22307;26546

Parameters for the capture of BillPay payments


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

M

ID assigned by Paygate for the payment transaction.

TransID

ans..64

M

Merchant’s transaction number

Status

a..50

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

RefNr

ans..30

M

Merchant’s reference number. In case of updating the RefNr the new RefNr is returned to the merchant.

InvoiceStatus

a..10

M

Status of activation request: Indicates whether reservation has been activated or not. Return values: „Activated“ or „Not Active“

InvoiceNr

ans..30

C

BillPay partial activation only: Unique invoice number for partial activation

BillPay bank account

BpAccOwner

ans..255

M

Account holder for the receivables (usually “BillPay GmbH”)

IBAN

ans..34

M

BillPay-IBAN for the receivables (can vary per order!)

BIC

an..11

M

BillPay-BIC for the receivables

BpBank

ans..255

M

Name of the bank for the receivables

BpInvoiceRef

ans..255

M

Purpose

BpInvoiceDate

n8

M

Customer's due date

in case of BillPay hire purchase

BpPaymentPlan

ans..768

M

Instalment plan selected by the buyer with information

- RateNr: number of the instalment
- RateAmount: instalment amount
- DueDate: due date of the instalment

<;>separates fields within a data record
<+> separates different data records

Example: <Rate1>;<RateAmount>;<DueDate>+ <Rate_n>;<RateAmount_n>;<DueDate_n>+ etc.

BillPay response in case of errors

ErrorText1

ans..255

O

ErrorText1 contains the detailed error message from BillPay for the merchant.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with Computop support.

ErrorText2

ans..255

O

ErrorText2 contains the detailed error message from BillPay for the purchaser.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with Computop support.

ErrorText3

n..6

O

ErrorText3 contains the detailed BillPay error code.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with Computop support.

Response parameters for the capture of BillPay payments



Reversal of BillPay payments

Reversals are possible via a Server-to-Server connection. BillPay can cancel both reservations and activations wherein there must be differentiation between full and partial cancellations. In order to reverse a BillPay payment, please use the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following tables describe the transfer parameters and return values which are exchanged via the socket connection.

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment to be reversed

TransID

ans..64

M

Merchant ID for the identification of the payment process to be reversed

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a..3

M

Currency code, three digits DIN / ISO 4217. Only EUR and CHF permissible.

ReqIDans..32OTo avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

NetRebate

n..7

O

Value by which the discount is to be increased or reduced (net value).

Notice: This parameter is only used for partial reversals. Do not process NetRebate/GrRebate together with shRebate/shRebateGr. Please make separate requests to the Paygate.

GrRebate

n..7

O

Value by which the discount is to be increased or reduced (gross value).

Notice: This parameter is only used for partial reversals. Do not process NetRebate/GrRebate together with shRebate/shRebateGr. Please make separate requests to the Paygate.

shRebate

n..7

O

Rebate on net shipping costs.

Notice: This parameter is only used for partial reversals. Do not process NetRebate/GrRebate together with shRebate/shRebateGr. Please make separate requests to the Paygate.

shRebateGr

n..7

O

Rebate on gross shipping costs.

Notice: This parameter is only used for partial reversals. Do not process NetRebate/GrRebate together with shRebate/shRebateGr. Please make separate requests to the Paygate.

ArticleList

ans..768

O

Article list with data of the articles to be cancelled. The full ArticleList does not need to be transmitted; only the ArticleID (ans..20) and articlequantity (n..7) fields:

Note on the structure of the article list:
<;> separates the fields of an article data set
<+> separates the article data sets

Example: articleid;articlequantity+ articleid;articlequantity+…

Notice: This parameter is only used for partial reversals.

Reason

a11

O

indicates that cancellation refers to articles that have not yet been activated. Only necessary after partial activation.

Reason=RESERVATION

Parameters for the reversal of BillPay payments


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

RefNr

ans..30

M

Unique reference number. When updating the reference number the new RefNr is returned to the merchant.

Response in case of partial reversal for hire purchase

BpConditionsList

ans..

C

New calculated data for hire purchase after partial reversal.

- Number of monthly instalments “term”, n..7
- Value of shopping cart, “base” n..7
- Gross order value “cart”, n..7
- Financing interest charge “surcharge”, n..7
- Gross total value “total”, n..7
- Monthly charge % “interest”, n..2
- eff. annual interest rate % “anual”, n..4
- BillPay fee “fee”, n..7

All amounts in the smallest currency unit (e.g. EUR Cent)

<;> separates fields of a hire purchase data record  
<+> separates different hire purchase conditions

Example: <term>;<base>;<cart>; <surcharge>;<total>;<interest>;<anual>;<fee>+…

BpPaymentPlan

ans..

C

New calculated rate plans for the financing.

- RateNr: number of the instalment
- RateAmount: instalment amount
- DueDate: due date of the instalment

<;>separates fields within a data record
<+> separates different data records

Example: <Rate1>;<RateAmount>;<DueDate>+ <Rate_n>;<RateAmount_n>;<DueDate_n>+ etc.

Notice: If partial cancellation is carried out on a purchase by instalment reservation, the new instalment plan will have NO due dates!

Response in case of error

ErrorText1

ans..255

O

ErrorText1 contains the detailed error message from BillPay for the merchant.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with Computop support.

ErrorText2

ans..255

O

ErrorText2 contains the detailed error message from BillPay for the merchant.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with Computop support.

ErrorText3

n6

O

ErrorText3 contains the detailed BillPay error code.

Notice: This will be additionally returned to the merchant if it is configured and an error occurs. Use is possible only in agreement with Computop support.

Result parameters for reversals of BillPay payments



Batch processing via the interface

Basic information about using Batch files and about their structure you can be found in the Batch Manager manual. Within batch processing not alle functions are available which are usually available for the online interface.

This section describes the parameters which must be transferred within the data set (Record) for executing a BillPay payment and which information can be found within the response file about the payment status.

Following table gives an overview of all batch versions that are possible for a specific action and their specialities:

Action

Version

Description

Capture

1.0 / 2.0

Standard version without return of parameter Code

 

1.x / 2.x

with RefNr (valid for all versions other than 1.0)

Reverse

1.0 / 2.0

Standard version without return of parameter Code

 

1.x / 2x.

with RefNr (valid for all versions other than 1.0)

Description of the possible batch versions


The structure for a BillPay payment within a Batch file to be submitted is the following:

HEAD,<MerchantID>,<Date>,<Version>

BillPay,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>

BillPay,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>

FOOT,<CountRecords>,<SumAmount>


Example for Master MID Funktion:

HEAD,[Master]MerchantID,Date,2.x
Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action)
FOOT,CountRecords,SumAmount


The following table describes the individual fields and values used within the data set (record) within the batch file:

Parameter

Format

CND

Description

Type

a..11

M

HEAD for Header, FOOT for Footer, BillPay for BillPay

Action

a..20

M

The parameter Action defines the type of transaction:

Capture

Reverse (cancellation)

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency code, three digits DIN / ISO 4217

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ans..30

O

Unique reference number

PayID

an32

M

ID for this transaction given by Paygate

Description of fields within the record for Batch files

 

The record area within the response file for Batch transactions looks the following way:

HEAD,<MerchantID>,<Date>,<Version>

BillPay,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>

BillPay,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>

FOOT,<CountRecords>,<SumAmount>

 

The following table describes the response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> and request parameters are returned unchanged and correspond to the call as specified in):

Parameter

Format

CND

Description

Action

a..20

M

The parameter Action defines the type of transaction: Capture, Reverse

PayID

an32

M

ID for this transaction given by Paygate

Status

a..50

M

OK or FAILED

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

Description of result parameters within the record for Batch files