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 Be2bill

General information about Be2bill

With the connection of the French acquirer be2bill, merchants who are active in France have a powerful alternative for the selection of acquirer. As well as VISA and Mastercard credit cards, Paygate also handles payments made with the extremely widespread Cartes Bancaires via this partner. Be2bill offers online merchants a “3-in-1” solution for the management of its online payments including bank and payment services, internet-based marketing and solutions for increasing customer loyalty.

Credit card payments via be2bill can be made with or without 3D-Secure. For 3DS transactions, be2bill offers its own fraud prevention service which determines whether 3D authentication is needed. Along with one-off payments, be2bill also offers payment by instalment, recurring payments and one-click payments.


Logo

Info

Be2bill is specially optimized for the “Cartes Bancaires” credit cards which is widely used in France.

TypePayments by Credit Card EN

Card Scheme
VISA
MasterCard
Cartes Bancaires

Process flow charts


Be2bill process flow via the form interface



Be2bill process flow via server-to-server-communication



Configuration for Be2bill

To set up Be2bill the merchant needs to save the required Paygate interface URLs in the backend. Each of these is a “Transaction feedback URL”:

https://www.computop-paygate.com/Be2billComplete.aspx

and for “Redirection URL after payment form or 3DSECURE processing” and “Redireciton URL after payment form cancelling” respectively:

https://www.computop-paygate.com/cbBe2bill.aspx



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.


Credit card payment with Be2bill via Paygate form interface

Payments with Be2bill are made via the standard Paygate form interface for credit card payments. In order to execute an SSL credit card payment with Be2bill via a Paygate form, visit 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..40

M

TransactionID which should be unique for each payment. Matches the Be2bill OrderID.

RefNr

ans..30

M

Unique reference number. The RefNr is submitted together with the PayID and separated by | to Be2bill within the parameter ExtraData: PayID|RefNr.

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, three digits DIN / ISO 4217

MAC

an64

M

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

URLSuccess

ans..256

M

Complete URL which calls up Paygate if payment has been successful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

URLFailure

ans..256

M

Complete URL which calls up Paygate if payment has been unsuccessful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

Response

a7

O

Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.

URLNotify

ans..256

M

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

Alternatively the payment status can be queried via inquire.aspx.

CreditCardHolder

an..255

M

Name of the card holder

Capture

an..6

O

Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696). For transactions with Hipercard only AUTO is possible.

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop

ReqID

ans..32

O

To 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.

Language

a2

O

Language: FR / EN / DE / ES / IT / NL / CN / RU / PT / CZ

CustomerID

ans..255

M

Unique ID of card holder on the merchant's webpage (e.g. the ID inside the customer database or the email address of the customer)

Email

ans..255

M

Email address of the card holder

ChDesc

ans..255

O

Source URL of the merchant or the shop system

DateOfBirth

dttm10

O

Date of birth of the card holder: YYYY-MM-DD

InstallmentAmount

ans..1024

O

Amount of single instalments.

The rate values are to be separated by comma and the first rate must have the highest value. e.g.: 200,100,100

InstallmentAmount

ans..1024

C

In combination with InstallmentAmount:

Date when the rates are to be collected.

The date details must be comma-separated and specified in the UTC time zone (coordinated universal time). The time period from the first instalment to the last instalment also needs to be within a maximum 90 days.

e.g.: YYYY-MM-DD,YYYY-MM-DD,YYYY-MM-DD

UserAgent

ans..128

O

Browser type of the purchaser who requests the page. For example: IE Mozilla/4. 0 (compatible; MSIE 6.0; Windows NT 5.0; NET CLR 1.0.3705)

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Delivery address

sdFirstName

as..15

O

First name in the delivery address

sdLastName

as..30

O

Last name in the delivery address

sdStreet

ans..50

O

Number and street in the delivery address

sdZIP

ans..9

O

Postcode in the delivery address

sdCity

ans..255

O

Town/city in the delivery address

sdCountryCode

a..3

O

Country code in the delivery address, 2 or 3 characters according to ISO 3166

sdPhone

ans..32

O

Telephone number in the delivery address

Invoicing address

bdFirstName

as..15

O

First name in the invoicing address

bdLastName

as..30

O

Last name in the invoicing address

bdStreet

ans..50

O

Number and street in the invoicing address

bdZIP

ans..9

O

Postcode in the invoicing address

bdCity

ans..255

O

Town/city in the invoicing address

bdCountryCode

a..3

O

Country code in the invoicing address, 2 or 3 characters according to ISO 3166

bdPhone

ans..32

O

Phone number in the billing address

Subscriptions

RTF

a1

O

For recurring payments:

I = Initial payment of a new subscription
R = Routine payment (Recurring)

TokenExt

an..32

OC

In connection with RTF=R TokenExt must be transmitted for referencing the credit card data

Fraud prevention (please notice also the further optional parameters and response values for Fraud prevention)
IPAddrans..15MIP address. With this parameter Paygate can determine in which country and in which town your customer has connected with the Internet (see also IPZone). Format: 123.456.789.012

Parameters for credit card payments with Be2bill


To adapt the layout of the SSL-page to your shop you can use the following unencrypted parameters to configure colours, fonts and images.

Parameter

Format

CND

Description

Template

ans..20

M

Name of XSLT-file with your own layout for the pay form. If you want to use the redesigned and downwards compatible Computop template, please transfer the template name “ct_compatible”. If you want to use the responsive Computop template for mobile devices, please transfer the template name “ct_responsive”.

Background

ans..256

M

Background ambiance of form:

URL for a background image

- HTML-colour value for background colour as HEX value or

- HTML-colour name

BGColor

ans..7

M

Form background colour:

- HTML-colour value for background colour as HEX value or

- HTML-colour name

BGImage

ans..256

M

Form background image:

URL for a background image

Please note that this value supersedes “BGColor”.

FColor

ans..6

M

Text colour:

- HTML-colour value as HEX value or

- HTML-colour name

FFace

a..10

M

HTML-name for the font

FSize

n2

M

Number for font size

Language

a2

(enum)

M

Language code: <de> German, <al> Albanian, <at> Austrian, <cz/cs> Czech, <dk> Danish, <en> English, <fi> Finish, <fr> French, <gr> Greek, <hu> Hungarian, <it> Italian, <jp> Japanese,  <nl> Dutch, <no> Norwegian, <pl> Polish,
<pt> Portuguese, <ro> Romanian, <ru> Russian, <sp> Spanish, <se> Swedish, <sk> Slovakian, <sl> Slovenian, <tr> Turkey, <zh> Simplified Chinese.

No details means the language is German.

CCSelect

a..10

M

Determines preselected card type in the form: VISA, MasterCard, AMEX, DINERS, JCB, CBN, Hipercard, Elo, Aura, Dankort, Airplus, ComfortCard, CUP

URLBack

ans..256

M

URL for "Cancel" button

Center

n1

M

By default the form is centered vertically and horizontally. The value <1> centres the form at the top.

tWidth

ans..4

M

Width of table for input of the credit card data as percent- (50%) or pixel values (320).

tHeight

ans..4

M

Height of table for input of the credit card data as percent- (70%) or pixel values (480).

Layout parameters for Paygate forms for credit card payments with Be2bill


The following table describes the result parameters that the Paygate transmits to your URLSuccess, URLFailure or URLNotify. If you have specified the Response=encrypt parameter, the following parameters are forwarded Blowfish encrypted to your system:

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

The PayID is submitted together with the RefNr and separated by | to Be2bill within the parameter ExtraData: PayID|RefNr.

XID

an32

M

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

TransID

ans..40

M

TransactionID which should be unique for each payment. Matches the Be2bill OrderID.

Status

a..30

M

OK or AUTHORIZE_REQUEST on the URLSuccess-page and FAILED on the URLFailure-page

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)

MAC

an64

M

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

RefNr

ans..30

O

Unique reference number. The RefNr is submitted together with the PayID and separated by | to Be2bill within the parameter ExtraData: PayID|RefNr.

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop

ErrorText

ans..128

O

Detailed Be2bill error message.

Notice: Is returned only if Status=FAILED. Use is possible only in agreement with Computop support.

PCNr

n..16

O

Pseudo Card Number: Random number generated by Paygate which represents a genuine credit card number. The pseudo card number (PCN) starts with 0 and the last 3 digits correspond to those of the real card number. You can use the PCN like a genuine card number for authorisation, capture and credits.

CCBrand

a..22

O

In combination with PCNr: Name of credit card brand, e.g. Visa, MasterCard, Cartes Bancaires

CCExpiry

n6

O

In combination with PCNr: Expiry date of the credit card in the format YYYYMM.

TokenExt

an..32

O

For recurring payments (RTF=I) the TokenExt is transmitted for referencing the credit card data

TransactionID

an..32

O

Transaction ID from Be2bill

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Return parameters for URLSuccess, URLFailure and URLNotify with Be2bill



Credit card payment via Server-to-Server connection

In order to execute an SSL credit card payment with Be2bill 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.

TransID

ans..40

M

TransactionID which should be unique for each payment. Matches the Be2bill OrderID.

RefNr

ans..30

M

Unique reference number. The RefNr is submitted together with the PayID and separated by | to Be2bill within the parameter ExtraData: PayID|RefNr.

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, three digits DIN / ISO 4217

Capture

an..6

O

Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696).

OrderDesc

ans..510

M

Description of purchased goods, unit prices etc.

MAC

an64

M

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

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop

ReqID

ans..32

O

To 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.

CCNr

n..19

M

Credit card number at least 12-digit, numerical without spaces. You can optionally transmit also a pseudo card number (PCN)

CCCVC

n..4

C

Card verification number: The last 3 digits on the signature strip of the credit card. 4 characters in the case of AMEX. Optional if pseudo card number is used.

CCExpiry

n6

M

Credit card expiry date (YYYYMM), e.g. 201607

CCBrand

a..22

M

Card type: VISA, MasterCard, Cartes Bancaires. Please note the spelling!

CreditCardHolder

ans..255

M

Name of the card holder

Email

ans..255

M

Email address of the card holder

Language

a2

O

Language: FR / EN / DE / ES / IT / NL / CN / RU / PT / CZ

CustomerID

ans..255

M

Unique ID of card holder on the merchant's webpage (e.g. the ID inside the customer database or the email address of the customer)

ChDesc

ans..255

O

Source URL of the merchant or the shop system

DateOfBirth

dttm10

O

Date of birth of the card holder: YYYY-MM-DD

InstallmentAmount

ans..1024

O

Amount of single instalments.

The rate values are to be separated by comma and the first rate must have the highest value.

e.g.: 200,100,100

InstallmentAmount

ans..1024

O

In combination with InstallmentAmount:

Date when the rates are to be collected.

The date details must be comma-separated and specified in the UTC time zone (coordinated universal time). The time period from the first instalment to the last instalment also needs to be within a maximum 90 days.

e.g.: YYYY-MM-DD,YYYY-MM-DD,YYYY-MM-DD

UserAgent

ans..128

M

Browser type of the purchaser who requests the page. For example: IE Mozilla/4. 0 (compatible; MSIE 6.0; Windows NT 5.0; NET CLR 1.0.3705)

Delivery address

sdFirstName

as..15

O

First name in the delivery address

sdLastName

as..30

O

Last name in the delivery address

sdStreet

ans..50

O

Number and street in the delivery address

sdZIP

ans..9

O

Postcode in the delivery address

sdCity

ans..255

O

Town/city in the delivery address

sdCountryCode

a..3

O

Country code in the delivery address, 2 or 3 characters according to ISO 3166

sdPhone

ns..32

O

Telephone number in the delivery address

Invoicing address

bdFirstName

as..15

O

First name in the invoicing address

bdLastName

as..30

O

Last name in the invoicing address

bdStreet

ans..50

O

Number and street in the invoicing address

bdZIP

ans..9

O

Postcode in the invoicing address

bdCity

ans..255

O

Town/city in the invoicing address

bdCountryCode

a..3

O

Country code in the invoicing address, 2 or 3 characters according to ISO 3166

bdPhone

ns..32

O

Phone number in the billing address

Subscriptions

RTF

a1

O

For recurring payments:

I = Initial payment of a new subscription
R = Routine payment (Recurring)

TokenExt

an..32

OC

In connection with RTF=R TokenExt must be transmitted for referencing the credit card data

Fraud prevention (please notice also the further optional parameters and response values for Fraud prevention)
IPAddrans..15MIP address. With this parameter Paygate can determine in which country and in which town your customer has connected with the Internet (see also IPZone). Format: 123.456.789.012

Parameters for credit card payments with Be2bill via socket connection


The following table gives the 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

The PayID is submitted together with the RefNrD and separated by | to Be2bill within the parameter ExtraData: PayID|RefNr.

XID

an32

M

ID assigned by Paygate for the payment transaction

TransID

ans..40

M

TransactionID which should be unique for each payment. Matches the Be2bill OrderID.

Status

a..30

M

OK , AUTHORIZED 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. The RefNr is submitted together with the PayID and separated by | to Be2bill within the parameter ExtraData: PayID|RefNr.

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

ErrorText

ans..128

O

Detailed Be2bill error message.

Notice: Is returned only if Status=FAILED. Use is possible only in agreement with Computop support.

PCNr

n..16

O

Pseudo Card Number; random number generated by Paygate which represents a genuine credit card number. The pseudo card number (PCN) starts with 0 and the last 3 digits correspond to those of the real card number. You can use the PCN like a genuine card number for authorisation, capture and credits.

CCBrand

a..22

O

In combination with PCNr: Name of credit card brand, e.g. VISA, MasterCard, AMEX, Cartes Bancaires

CCExpiry

n6

O

In combination with PCNr: Expiry date of the credit card in the format YYYYMM.

TokenExt

an..32

O

For recurring payments (RTF=I) the TokenExt is transmitted for referencing the credit card data

TransactionID

an..32

O

Transaction ID from Be2bill

Results parameters for socket connection for Be2bill

 


Capture of a credit card payment with Be2bill

Captures are possible via a Server-to-Server connection. To carry out a Capture for a Be2bill credit card payment via a Server-to-Server connection 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 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 to be captured

TransID

ans..40

M

ID assigned by Merchant for the payment process to be captured. Matches the Be2bill OrderID.

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

MAC

an64

M

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

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.

Parameters for captures of Be2bill via socket connections

 

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..40

M

ID assigned by Merchant for the payment process to be captured. Matches the Be2bill OrderID.

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)

Response parameters for captures of Be2bill via socket connections



Credit with reference

Credits (refunds) are possible via a Server-to-Server connection. For a Credit with reference to a capture the amount of the Credit is limited to the amount of the previous capture.

To carry out a credit with a reference transaction, 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 to be credited

TransID

ans..40

M

ID assigned by Merchant for the payment process to be credited. Matches the Be2bill OrderID.

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

MAC

an64

M

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

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.

Parameters for credit payments with Be2bill via socket connection


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..40

M

ID assigned by Merchant for the payment process to be credited. Matches the Be2bill OrderID.

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)

Response parameters for credits of Be2bill via socket connections



Reversal

Reversals of an instalment payment are possible via a Server-to-Server connection. The Paygate permits only reversals that reference on a capture previously made via Paygate. Only instalment payments can be cancelled. The reversal of a simple authorization is not possible.

To carry out a reversal with a reference transaction, 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 to be reverted

TransID

ans..40

M

Merchant ID for the identification of the payment process to be reversed. Matches the Be2bill OrderID.

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

MAC

an64

M

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

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.

Parameters for reversals with Be2bill via socket connection


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..40

M

Merchant ID for the identification of the payment process to be reversed. Matches the Be2bill OrderID.

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)

Response parameters for reversals of Be2bill via socket connections



Batch processing via the interface

Basic information about using Batch files and about their structure 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 payments / credits with Be2bill and which information can be found within the response file about the payment status.

For Batch calls there must be considered batch versions, from which optional parameters depend. All version designations starting with „2.“ pertain calls for a group of enterprises. That means within a batch file for a particular MerchantID can be transferred transactions for other merchants with a separate Sub-MID.

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

Action

Version

Description

Credit

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)

Description of the possible batch versions


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

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

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

CC,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>

CC,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) in the batch file:

Parameter

Format

CND

Description

Type

a..11

M

HEAD for Header, FOOT for Footer, CC for Be2bill

Action

a..20

M

The parameter Action defines the type of transaction:

Capture

Credit

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..40

M

TransactionID which should be unique for each payment. Matches the Be2bill OrderID.

RefNr

ns..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 as follows:

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

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

CC,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>

CC,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 before):

Parameter

Format

CND

Description

Action

a..20

M

The parameter Action defines the type of transaction:

Capture

Credit

Reverse (cancellation)

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



Test data

Be2bill provides specific Sandbox test data: Test Be2Bill Sandbox