Skip to end of metadata
Go to start of metadata


About Gothia PayByBill

General information about PayByBill

With PayByBill from the Gothia Financial Group you can offer your customers popular methods of payment such as direct debit, purchase on invoice or flexible hire purchase. PayByBill enables merchants to send their own invoice. At the same time merchants will receive payments. PayByBill takes care of the debt collection.


Logo

Info

PayByBill enables merchants to offer payment methods such as invoice purchasing, financing and direct debit. The solution offers merchants a payment guarantee and is available for Denmark, Germany, Finland, the Netherlands, Norway and Sweden.

TypePayments by Cash-In / Bill


Further information can be found on the webpage of PayByBill (www.paybybill.com/de).

 

Process flow charts

Process flow PayByBill


Process flow PayByBill installment payment


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.


PayByBill purchase on invoice and hire purchase

This chapter describes how to reserve a PayByBill payment. Following successful reservation you can capture PayByBill payments or if necessary credit them. Merchants can also cancel PayByBill reservations.

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


Notice: For security reasons, Computop 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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

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

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyFormatCNDDescriptionBeschreibung
Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyFormatCNDDescriptionBeschreibung
UserData

ans..1024

O

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

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

Key

Format

CND

Description

Beschreibung

PayTypeans..16MPayment type: “Invoice” or “DirectDebet”. “DirectDebet” is permitted in Germany only. In case of hire purchase via Germany only ‘DirectDebet’ is allowed.Zahlungsart: “Invoice” für Rechnung oder “DirectDebet” für Lastschrift. „DirectDebet“ nur für Deutschland erlaubt. Bei Ratenkauf über Deutschland nur „DirectDebet“ erlaubt.

FirstName

ans..30

M

First name of the custumer

Vorname des Kunden

LastName

ans..30

M

Last name of the customer or company name

Nachname des Kunden oder Firmenname

AddrStreet

ans..128

M

Customer’s street

Straße des Kunden

AddrHouseNr

ans..5

O

Customer’s street number

Hausnummer des Kunden

AddrZipCode

ans..15

M

Postcode of the customer

Postleitzahl des Kunden

AddrCity

ans..30

M

Customer’s place of residence

Wohnort des Kunden

AddrCountryCode

a2

M

Country code of the customer's residence, 2 characters according to ISO 3166

Ländercode des Wohnortes, zweistellig gemäß ISO 3166

BirthDate

ans..10

OC

Obligatory if AddrCountryCode=DE: Date of birth in the format YYYY-MM-DD

Pflicht, falls AddrCountryCode=DE: Geburtsdatum im Format JJJJ-MM-TT
SocialSecurityNumberans..20OC

Obligatory if AddrCountryCode=DE: Social security number if CompanyOrPerson=P. Register of Companies number if CompanyOrPerson=C.

Country-specific formats

SE: DDMMYYNNNN

NO: DDMMYYNNNNN

DK: DDMMYY-NNNN

FI: DDMMYY-NNNN

NL: DDMMYYYY

Pflicht, falls AddrCountryCode ungleich DE. Sozialversicherungsnummer, falls CompanyOrPerson=P. Handelsregisternummer, falls CompanyOrPerson=C.

Länderspezifische Formate

SE: DDMMYYNNNN

NO: DDMMYYNNNNN

DK: DDMMYY-NNNN

FI: DDMMYY-NNNN

NL: DDMMYYYY

Email

ans..100

M

Email address of the customer

E-Mail-Adresse des Kunden

Phone

ans..20

O

Customer’s phone number

Telefonnummer des Kunden

MobileNo

ans..16

O

Customer’s mobile telephone number

Mobiltelefonnummer des Kunden

AccIBAN

n8

OC

Obligatory if PayType=DirectDebet: Identification of the financial institution of the account holder

Pflicht, falls PayType=DirectDebet: Identifikation des Finanzinstituts des Kontoinhabers

AccNr

n..11

OC

Obligatory if PayType=DirectDebet: account holder’s account number

Pflicht, falls PayType=DirectDebet; Kontonummer des Kontoinhabers

CustomerID

ans..50

M

Customer number at the merchant

Kundennummer beim Händler

CompanyOrPerson

a1

O

P=Person (standard), C=Company

P=Person (Standard), C=Company

Salutation

ans..10

O

Salutation – ‘Mr’, ‘Mrs’, ‘Miss’

Anrede – “Mr”, “Mrs”, “Miss”

Title

ans..20

O

Title, e.g. Dr. or Prof.

Titel z.B. Dr. oder Prof.

DistributionType

ans..8

O

Method of dispatch of the invoice: ‘paper’ or by ‘email’

Auslieferungsart der Rechnung: „Papier“ oder per „E-Mail“

DistributionBy

ans..8

O

Sender of the printed invoice. ‘Company’ for Gothia; ‘Client’ if the merchant is the sender.

Auslieferer der gedruckten Rechnung. „Company“ für Gothia; „Client“, wenn der Händler selbst der Auslieferer ist.



In case of hire purchasebei Ratenkauf

EventToken

a2

M

1. call: “IP” for Instalment Purchase (to request the terms & conditions and AcceptID)

2. call: “AT” for AcceptAccountTermsAndConditions (to confirm the terms & conditions)

1. Aufruf: „IP“ für Installment Purchase (zur Anforderung der AGB und AcceptID)

2 Aufruf: „AT“ für AcceptAccountTermsAndConditions (zur Bestätigung der AGB)

Month

n..2

M

Number of instalments

Anzahl der Raten

ProductNr

ans..4

O

Account profile number, as configured with Gothia, e.g. ‘1’

Account-Profilnummer, wie bei Gothia konfiguriert, z.B. „1“

PayID

an32

OC

Obligatory on second call: Paygate ID for the identification of a payment

bei zweitem Aufruf Pflicht: ID des Paygate zur Identifizierung einer Zahlung

Parameters for payments with PayByBill


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

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

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Key

Format

CND

Description

Beschreibung

Statusa..50MOK (URLSuccess) or FAILED (URLFailure), AUTHORIZE_REQUEST on first call with EventToken=IP
OK (URLSuccess) oder FAILED (URLFailure), AUTHORIZE_REQUEST beim ersten Aufruf mit EventToken=IP

KeyFormatCNDDescriptionBeschreibung
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!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

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

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

KeyFormatCNDDescriptionBeschreibung
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyFormatCNDDescriptionBeschreibung
UserData

ans..1024

O

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

Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop.

Key

Format

CND

Description

Beschreibung

CodeExt

n..10

O

Error code from PayByBill, if agreed with Computop Helpdesk

Fehlercode von PayByBill, wenn mit Computop Helpdesk abgesprochen

ErrorText

ans..1024

O

Error text from PayByBill, if agreed with Computop Helpdesk

Fehlertext von PayByBill, wenn mit Computop Helpdesk abgesprochen

InstallmentData

ans..1024

O

Installment plan

InstallmentData=<Month>;<PaymentAmount>;

<CapitalBalance>;<Fees>;<Interest>+ <Month>;<PaymentAmount>; …

Ratenplan

InstallmentData=<Monat>;<Zahlungsbetrag>;

<Kapitalbalance>;<Gebühren>;<Zinsen>+ <Monat>;<Zahlungsbetrag>;…

TermsAndConditions

ans..1024

O

Terms & conditions for payment by instalment

AGBs für die Ratenzahlung

FirstName

ans..128

O

First name

Vorname

LastName

ans..128

O

Last name

Nachname

AddrStreet

ans..255

O

Street and street number in the delivery address

Straße und Hausnummer der Lieferadresse

AddrZip

ans..20

O

Postcode in the delivery address

Postleitzahl der Lieferadresse

AddrCity

ans..50

O

Town/city in the delivery address

Ortsname der Lieferadresse

InvoiceText

ans..1024

O

Access data for the instalment payment portal and the minimum instalment amount for the product plus invoice information.

Example:

InvoiceText=<minimum rate amount>;<Text>;<account number>;<password>;<LogonText>;<OCR number>

Zugangsdaten für das Ratenzahlungsvereinbarungsportal sowie die minimale Ratenhöhe des Produkts, sowie Rechnungsinformationen.

Beispiel:

InvoiceText=<minimale Ratenhöhe>;<Text>;<Kontonummer>;<Passwort>;<LogonText>;<OCR-Nummer>

Result parameters for PayByBill payments



Capture

Captures are possible via a Server-to-Server connection. To settle an invoice / carry out dispatch by PayByBill, please use the following URL:


Notice: For security reasons, Computop 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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

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

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for the payment to be captured

Vom Paygate vergebene ID für die zu buchende Zahlung

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyFormatCNDDescriptionBeschreibung
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction / action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion / Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder auch jede Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung / weitere Aktion aus sondern gibt nur den Status der ursprünglichen Transaktion / Aktion zurück. Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

Key

Format

CND

Description

Beschreibung

InvoiceNrans..16Munique reference numbereindeutige Rechnungsnummer
ProductNrans..4OAccount profile number, as configured with Gothia, e.g. ‘1’Rechnungsprofilnummer, wie bei Gothia konfiguriert; z.B. „1“.
ArticleListans..1024M

Article list with description of items and prices:

<Article number> ;<quantity> ;<article description> ;<net price> ;<gross price> ;<VAT> ;<tax rate>; <unit>

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

Data type (size):

Article number (ans..100)

Quantity (n..3)

Article description (ans..100)

Net amount (n..10) in the smallest currency unit (e.g. EUR Cent)

Gross amount (n..10) in the smallest currency unit (e.g. EUR Cent)

VAT amount (n..10) in the smallest currency unit (e.g. EUR Cent)

VAT rate (n..2), e.g. 19 for 19%

unit (ans..50), e.g. kg for kilogram, or l for litre

Artikelliste mit Beschreibung der Waren und Preise:

< Artikelnummer >;<Anzahl>;<Artikelbeschreibung>; <Nettopreis>;<Bruttopreis>;<MwSt>;<Steuersatz>;<Maßeinheit>

<;> trennt Felder innerhalb eines Artikeldatensatzes
<+> trennt mehrere Artikeldatensätze

Datentyp (Größe):

Artikelnummer (ans..100)

Anzahl (n..3)

Artikelbeschreibung (ans..100)

Nettopreis (n..12) in der kleinsten Währungseinheit (z.B. EUR Cent)

Bruttopreis (n..12) in der kleinsten Währungseinheit (z.B. EUR Cent)

MwSt.  (n..12) in der kleinsten Währungseinheit (z.B. EUR Cent)

Steuersatz (n..2), z.B. „19“ für 19%)

Maßeinheit (ans..50), z.B. st für Stück, kg für Kilogramm oder l für Liter

BDStreet

ans..100

M

Street name in the invoicing address

Straßenname in der Rechnungsadresse

BDHouseNr

ans..5

O

Street number in the invoicing address

Hausnummer in der Rechnungsadresse

BDCity

ans..100

M

Town/city in the invoicing address

Ort in der Rechnungsadresse

BDCountryCode

a2

M

Country code for the invoicing address, 2 characters according to ISO 3166

Ländercode in der Rechnungsadresse, zweistellig gemäß ISO 3166

BDZipCode

ans..8

M

Postcode in the invoicing address

Postleitzahl in der Rechnungsadresse

DueDate

n8

O

Due date in the format DDMMYYYY

Fälligkeitsdatum im Format TTMMJJJJ

InvoiceDate

n8

O

Invoice date in the format DDMMYYYY:

Rechnungsdatum im Format TTMMJJJJ

TxAmount

n..10

O

Tax amount of the entire order in the smallest currency unit (e.g. EUR Cent).

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

Steuerbetrag der gesamten Bestellung in der kleinsten Währungseinheit (z.B. EUR Cent).

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

NetAmount

n..10

O

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

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

Nettobetrag in der kleinsten Währungseinheit (z.B. EUR Cent).

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Parameters for PayByBill captures


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

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

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
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!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

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

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

KeyFormatCNDDescriptionBeschreibung
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

Key

Format

CND

Description

Beschreibung

Reference

ans..16

O

Reference number for PayByBill (OCR number)

Referenznummer für PayByBill (OCR-Nummer)

DocumentLink

ans..1024

O

Link to PDF document of the invoice

Link zum PDF-Dokument der Rechnung

InvoiceText

ans..1024

O

Access data for the instalment payment portal and the minimum instalment amount for the product plus invoice information.

Example:

InvoiceText=<minimum rate amount>;<Text>;<account number>;<password>;<LogonText>;<OCR number>

Zugangsdaten für das Ratenzahlungsvereinbarungsportal sowie die minimale Ratenhöhe des Produkts, sowie Rechnungsinformationen.

Beispiel:

InvoiceText=<minimale Ratenhöhe>;<Text>;<Kontonummer>;<Passwort>;<LogonText>;<OCR-Nummer>

File

ans..1024

O

Instalment payment contract as PDF document: Base64 encrypted data string

Ratenzahlungsvertrag als PDF-Dokument: Base64-codierter Datenstring

CodeExt

n..10

O

Error code from PayByBill, if agreed with Computop Helpdesk

Fehlercode von PayByBill, wenn mit Computop Helpdesk abgesprochen

ErrorText

ans..256

O

Error text from PayByBill, if agreed with Computop Helpdesk

Fehlertext von PayByBill, wenn mit Computop Helpdesk abgesprochen

Result parameters for PayByBill captures



Credit with reference and partial credit

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 (returns via PayByBill), please use the following URL:


Notice: For security reasons, Computop 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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

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

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for the payment to be credited

Vom Paygate vergebene ID für die gutzuschreibende Zahlung

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyFormatCNDDescriptionBeschreibung
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction / action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion / Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder auch jede Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung / weitere Aktion aus sondern gibt nur den Status der ursprünglichen Transaktion / Aktion zurück. Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

Key

Format

CND

Description

Beschreibung

InvoiceNrans..16MNumber of invoice as reference for the refundNummer der Rechnung, auf die sich die Gutschrift bezieht
ArticleListans..1024M

Article list with description of items and prices:

<Article number> ;<quantity> ;<article description> ;<net price> ;<gross price> ;<VAT> ;<tax rate>; <unit>

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

Data type (size):

Article number (ans..100)

Quantity (n..3)

Article description (ans..100)

Net amount (n..10) in the smallest currency unit (e.g. EUR Cent)

Gross amount (n..10) in the smallest currency unit (e.g. EUR Cent)

VAT amount (n..10) in the smallest currency unit (e.g. EUR Cent)

VAT rate (n..2), e.g. 19 for 19%

unit (ans..50), e.g. kg for kilogram, or l for litre

Artikelliste mit Beschreibung der Waren und Preise:

< Artikelnummer >;<Anzahl>;<Artikelbeschreibung>; <Nettopreis>;<Bruttopreis>;<MwSt>;<Steuersatz>;<Maßeinheit>

<;> trennt Felder innerhalb eines Artikeldatensatzes
<+> trennt mehrere Artikeldatensätze

Datentyp (Größe):

Artikelnummer (ans..100)

Anzahl (n..3)

Artikelbeschreibung (ans..100)

Nettopreis (n..12) in der kleinsten Währungseinheit (z.B. EUR Cent)

Bruttopreis (n..12) in der kleinsten Währungseinheit (z.B. EUR Cent)

MwSt.  (n..12) in der kleinsten Währungseinheit (z.B. EUR Cent)

Steuersatz (n..2), z.B. „19“ für 19%)

Maßeinheit (ans..50), z.B. st für Stück, kg für Kilogramm oder l für Liter

TxAmount

n..10

O

Tax amount of the entire order in the smallest currency unit (e.g. EUR Cent).

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

Steuerbetrag der gesamten Bestellung in der kleinsten Währungseinheit (z.B. EUR Cent).

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

NetAmount

n..10

O

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

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

Nettobetrag in der kleinsten Währungseinheit (z.B. EUR Cent).

Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

Parameters for PayByBill credits


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

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

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
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!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

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

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

KeyFormatCNDDescriptionBeschreibung
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

Key

Format

CND

Description

Beschreibung

Reference

ans..16

O

Reference number for PayByBill

Referenznummer für PayByBill

CodeExt

n..10

O

Error code from PayByBill, if agreed with Computop Helpdesk

Fehlercode von PayByBill, wenn mit Computop Helpdesk abgesprochen

ErrorText

ans..256

O

Error text from PayByBill, if agreed with Computop Helpdesk

Fehlertext von PayByBill, wenn mit Computop Helpdesk abgesprochen

Result parameters for PayByBill credits



Reversal and Updating

To reverse a payment with PayByBill, please use the following URL:


Notice: For security reasons, Computop 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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

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

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for the payment to be reversed

Vom Paygate vergebene ID für die zu stornierende Zahlung

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyFormatCNDDescriptionBeschreibung
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction / action. Please note that the Computop Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion / Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder auch jede Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung / weitere Aktion aus sondern gibt nur den Status der ursprünglichen Transaktion / Aktion zurück. Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

Parameters for reversals of PayByBill payments


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

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

Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
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!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

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

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

KeyFormatCNDDescriptionBeschreibung
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

Key

Format

CND

Description

Beschreibung

CodeExt

n..10

O

Error code from PayByBill, if agreed with Computop Helpdesk

Fehlercode von PayByBill, wenn mit Computop Helpdesk abgesprochen

ErrorText

ans..256

O

Error text from PayByBill, if agreed with Computop Helpdesk

Fehlertext von PayByBill, wenn mit Computop Helpdesk abgesprochen

Result parameters for PayByBill reversals



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 a PayByBill payment and which information can be found within the response file about the payment status. You can only cancel in full.

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

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Action

Version

Description

Beschreibung

Reverse

1.0 / 2.0

Standard version without return of parameter Code

Standardversion ohne Rückgabe von Parameter Code


1.x / 2.x

with RefNr (valid for all versions other than 1.0)

mit RefNr (gilt für alle Versionen außer 1.0)

Description of the possible batch versions


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

HEAD,<MerchantID>,<Date>,<Version>
PayByBill,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>
FOOT,<CountRecords>,<SumAmount>

Example for Master MID function:

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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

Beschreibung

Type

a..11

M

HEAD for Header, FOOT for Footer, PayByBill for PayByBill

HEAD für Header, FOOT für Footer, PayByBill für PayByBill

Action

a..20

M

The parameter Action defines the type of transaction:

Reverse (cancellation)

Der Action-Parameter definiert die Art der Transaktion:

Reverse (Storno)

KeyFormatCNDDescriptionBeschreibung
Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for this transaction

Vom Paygate vergebene ID für diese Transaktion

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>
PayByBill,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):

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

Beschreibung

Action

a..20

M

The parameter Action defines the type of transaction:

Reverse (cancellation)

Der Action-Parameter definiert die Art der Transaktion:

Reverse (Storno)

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Paygate for this transaction

Vom Paygate vergebene ID für diese Transaktion

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

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

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes)

Description of result parameters within the record for Batch files