About PagBrasil

General information about payment methods via PagBrasil

The majority of online payments in Brazil are made using credit cards. In 75% of these payments, Brazilian customers pay by instalment. The merchant is credited the full amount while the bank earns fees on the instalment payments. Only a third of all credit cards in Brazil can be used for international eCommerce. The majority of local cards, even issued by Visa, MasterCard or Amex, require contracts with local partners for these cards to be accepted and to achieve a good exchange rate. Domestic Brazilian cards include Hipercard, Elo and Aura.

The Cash-in solution of Boleto Bancário is another widely used payment method in eCommerce. The merchant provides the buyer with a type of pro forma invoice which can be paid at cash machines, banks, post offices, retailers or via Internet banking. Purely online transfers like PagBrasilOTF are also expected by customers from merchants in Brazil.

Similar to Boleto Bancário, the new Cash-in solution called PEC Flash is available for e-commerce consumers, who do not own a bank account or credit card, to pay for their online orders at any lottery agency. PEC Flash is very easy to use and payment is confirmed in few minutes.


Logo

null

Info

Payments with the Brazilian credit cards Hipercard, Elo and Aura can be processed via the Paygate. Computop offers extensive support for the control optimisation as well as foreign currency conversion.

More than 30% of online payments in Brazil are made using the Boleto Bancário cash-in solution. With a payment form customers can pay in cash in supermarkets, post office branches or at one of over 48,000 bank terminals.

PIX via PagBrasil is now also supported.

TypePayments by Credit Card

Card Scheme
VISA
MasterCard
AMEX

Diners

Elo
Aura
Hipercard

Process flow chart

PagBrasilOTF process flow


PagBrasil Boleto Bancário process flow



PagBrasil PIX process flow


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 PagBrasil via form interface

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

Key

Format

CND

Description

Beschreibung

Currency

a3

M

Only BRL permitted. Please find an overview here: A1 Currency table

Nur BRL zulässig. 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
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.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Vollständige URL, die das Paygate aufruft, wenn die Zahlung erfolgreich war. Die URL darf nur über Port 443 aufgerufen werden. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen nutzen Sie stattdessen den Parameter UserData.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

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

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Vollständige URL, die das Paygateaufruft, wenn die Zahlung gescheitert ist. Die URL darf nur über Port 443 aufgerufen werden. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen nutzen Sie stattdessen den Parameter UserData.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

KeyFormatCNDDescriptionBeschreibung
Response

a7

O

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

Die Status-Rückmeldung, die das Paygate an URLSuccess und URLFailure sendet, sollte verschlüsselt werden. Dazu übergeben Sie den Parameter Response=encrypt.

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

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Vollständige URL, die das Paygate aufruft, um den Shop zu benachrichtigen. Die URL darf nur über Port 443 aufgerufen werden. Sie darf keine Parameter enthalten: Nutzen Sie stattdessen den Parameter UserData.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

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.

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or 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 or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück.

Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

KeyFormatCNDDescriptionBeschreibung
Capture

an..6

OM

Determines the type and time of capture.

Capture ModeDescription
AUTOCapturing immediately after authorisation (default value).
MANUALCapturing made by the merchant. Capture is normally initiated at time of delivery.
<Number>Delay in hours until the capture (whole number; 1 to 696).

Bestimmt Art und Zeitpunkt der Buchung (engl. Capture).

BuchungsartBeschreibung
AUTOBuchung sofort nach Autorisierung (Standardwert).
MANUALBuchung erfolgt durch den Händler - in der Regel die Buchung zum Zeitpunkt der Warenauslieferung bzw. Leistungserbringung.
<Zahl>Verzögerung in Stunden bis zur Buchung (ganze Zahl; 1 bis 696).

Key

Format

CND

Description

Beschreibung

CreditCardHolderans..60MName of the card holderName des Karteninhabers

Name

ans..128

O

Name of the customer. If Name is not specified, the CreditCardHolder is transferred.

Name des Kunden. Wenn der Name nicht angegeben ist, wird der CreditCardHolder übergeben.

AddrStreet

ans..46

M

Customer's street name (Optional, if agreed with PagBrasil and Computop)

Straßenname des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

AddrCity

ans..40

M

Customer's town/city (Optional, if agreed with PagBrasil and Computop)

Ortsname des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

AddrZip

ans..8

M

Customer's post code (Optional, if agreed with PagBrasil and Computop)

Postleitzahl des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

AddrState

a2

M

Abbreviation of the customer’s Federal State. See the following table for the Federal States of Brazil. (Optional, if agreed with PagBrasil and Computop)

Abkürzung des Bundesstaats des Kunden. Siehe nachfolgende Tabelle Bundesstaaten Brasiliens. (Optional, wenn mit PagBrasil und Computop abgesprochen)

TaxNumber

n11/n14

M

In Brazil there are two kinds of tax numbers:

CPF for persons and CNPJ for companies.

CPF: 11 characters without separators, e.g. 12312312312

CNPJ: 14 characters without separators, e.g. 12345678000123

In Brasilien gibt es zwei Arten von Steuernummern:

CPF für Personen und CNPJ für Firmen

CPF: 11 Zeichen ohne Trennzeichen, z.B. 12312312312

CNPJ: 14 Zeichen, ohne Trennzeichen, z.B. 12345678000123

eMail

ans..128

M

Customer's email address (Optional, if agreed with PagBrasil and Computop)

E-Mail-Adresse des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

Phone

ans..40

M

Customer's phone number (Optional, if agreed with PagBrasil and Computop)

Telefonnummer des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

ChDesc

ans..12

M

Text printed on the customer’s credit card bill alongside the payee (‘PAGBRASIL’)

Text, der auf der Kreditkartenabrechnung des Kunden neben dem Zahlungsempfänger („PAGBRASIL“) steht

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

Beschreibung der gekauften Waren, Einzelpreise usw.

ArticleList

ans..254

O

Description of the goods purchased.

Example: ProductName; Quantity+ProductName;Number

The product and the quantity are indicated on the customer’s bill.

Beschreibung der gekauften Waren.

Beispiel: Produktname;Anzahl+Produktname;Anzahl

Das Produkt und die Anzahl werden auf der Abrechnung des Kunden angezeigt.

InstallmentNumber

n..2

O

Number of months of the payment by instalments (1-12), default=1.

Anzahl Monate der Ratenzahlung (1-12), Standard=1.

KeyFormatCNDDescriptionBeschreibung
Plain

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. 

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. 

Ein einzelner Wert, der von Ihnen gesetzt werden kann, um Informationen wieder unverschlüsselt in der Antwort bzw. im Notify zurückzugeben, z.B. die MID.

Da der "Plain"-Parameter Teil des verschlüsselten "Data" im Computop Paygate ist, ist dieser vor Manipulationen geschützt. 

KeyFormatCND

Description

Beschreibung
Custom

ans..1024

O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. 

Please find a samples here: Custom

Der "Custom"-Parameter wird vor der Verschlüsselung an den Aufruf angehängt und ist Teil des verschlüsselten "Data" im Computop Paygate Aufruf. Dadurch ist der Wert gegen Manipulation geschützt. 

Der Custom-Wert wird dann in Klartext an die Computop Paygate-Antwort angehängt und dabei wird "|" durch "&" ersetzt. Dadurch können Sie einen Custom-Wert übergeben und bekommen mehrere Key-Value-Paare zu Ihrer eigenen Verwendung in der Antwort zurück.

Hier finden Sie ein Beispiel: Custom

Key

Format

CND

Description

Beschreibung

IPAddrans..45OCardholder`s IP address (v4 or v6)IP-Adresse des Gerätes des Kunden
DeviceIDans..128OCardholder`s DeviceID for operationDeviceId des Gerätes des Kunden

Parameters for credit card payments with PagBrasil


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

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
Template

ans..20

O

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

Name der XSLT-Datei mit Ihrem individuellen Layout für das Bezahlformular. Wenn Sie das neugestaltete und abwärtskompatible Computop-Template nutzen möchten, übergeben Sie den Templatenamen „ct_compatible“. Wenn Sie das responsive Computop-Template für mobile Endgeräte nutzen möchten, übergeben Sie den Templatenamen „ct_responsive“.

KeyFormatCNDDescriptionBeschreibung
Background

ans..256

O

Background ambiance of form:

URL for a background image

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

- HTML-colour name

Formular Hintergrundumgebung:

- URL für ein Hintergrundbild

- HTML-Farbwert für Hintergrundfarbe als HEX-Wert oder

- HTML-Farbname

KeyFormatCNDDescriptionBeschreibung
BGColor

ans..7

O

Form background colour:

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

- HTML-colour name

Formular Hintergrundfarbe:

- HTML-Farbwert für Hintergrundfarbe als HEX-Wert oder

- HTML-Farbname

KeyFormatCNDDescriptionBeschreibung
BGImage

ans..256

O

Form background image:

URL for a background image

Please note that this value supersedes “BGColor”.

Formular Hintergrundbild:

URL für ein Hintergrundbild

Beachten Sie bitte, dass dieser Wert „BGColor“ überschreibt.

KeyFormatCNDDescriptionBeschreibung
FColor
ans..7
O

Text colour:

- HTML-colour value as HEX value or

- HTML-colour name

Textfarbe:

- HTML-Farbwert als HEX-Wert oder

- HTML-Farbname

KeyFormatCNDDescriptionBeschreibung
FFace
a..10
O
HTML-name for the font

HTML-Name der Schriftart

KeyFormatCNDDescriptionBeschreibung
FSize
n2
O
Number for font size

Zahl für die Schriftgröße

Key

Format

CND

Description

Beschreibung

Language

a2

O

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, <es> Spanish, <se> Swedish, <sk> Slovakian, <sl> Slovenian, <tr> Turkey, <zh> Simplified Chinese.

Sprachcode: <de> deutsch, <al> albanisch, <at> österreichisch, <cz/cs> tschechisch, <dk> dänisch, <en> englisch, <fi> finnisch, <fr> französisch, <gr> griechisch, <hu> ungarisch, <it> italienisch, <jp> japanisch, <nl> holländisch, <no> norwegisch, <pl> polnisch, <pt> portugiesisch, <ro> rumänisch, <ru> russisch, <es> spanisch, <se> schwedisch, <sk> slowakisch, <sl> slowenisch, <tr> türkisch, <zh> Simplified Chinese.

CCSelecta..16ODetermines preselected card type in the form: VISA, MasterCard, AMEX, DINERS, JCB, CBN, Hipercard, Elo, Aura, Dankort, Airplus, ComfortCard, CUP or MaestroBestimmt die vorausgewählte Kartenmarke im Formular: VISA, MasterCard, AMEX, DINERS, JCB, CBN, Hipercard, Elo, Aura, Dankort, Airplus, ComfortCard, CUP oder Maestro

KeyFormatCNDDescriptionBeschreibung
URLBack

ans..256

O

Complete URL which Paygate calls in case that Cancel is clicked by the customer.

The parameter "URLBack" can be sent

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

In order to exchange values between Paygate and shop you may use something like this:

URLBack=https://your.shop.com/back.php?param1%3Dvalue1%26param2%3Dvalue3%26status%3Dcancelled 

When user cancels payment this URL is called exactly like this and you may use URL Decode to extract parameter and values.

Vollständige URL, die das Paygate aufruft, wenn der Kunde auf Abbruch klickt.

Der Parameter "URLBack" kann

  • sowohl unverschlüsselt ans Paygate übermittelt werden (Kompabilitätsmodus)
  • als auch in den verschlüsselten Übergabeparametern (bevorzugte Variante)

Wenn Sie Parameter/Werte in der URLBack übergeben möchten, so können Sie folgende Methode verwenden:

URLBack=https://your.shop.com/back.php?param1%3Dvalue1%26param2%3Dvalue3%26status%3Dcancelled 

Wenn der Kunde auf Abbruch klickt, so wird die URL genauso aufgerufen, so dass Sie URL Decode verwenden können, um Parameter und Werte zu extrahieren.

KeyFormatCNDDescriptionBeschreibung
Center

n1

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

Standardmäßig ist das Formular vertikal und horizontal zentriert. Der Wert <1> justiert es oben mittig.

KeyFormatCNDDescriptionBeschreibung
tWidth

ans..4

O
Width of table for input in the form as percent- (50%) or pixel values (320).

Breite der Tabelle im Eingabeformular als Prozent- (50%) oder Pixelwerte (320)

KeyFormatCNDDescriptionBeschreibung
tHeight

ans..4

O
Height of table for input of the payment data in the form as percent- (70%) or pixel values (480).

Höhe der Tabelle für die Eingabe der Bezahldaten im Formular als Prozent- (70%) oder Pixelwerte (480)

KeyFormatCNDDescriptionBeschreibung
CustomField[n]

ans..50

O
Merchants can customize up to 14 special fields (called CustomField1 to CustomField14) on their payment form template. CustomFields are a feature that allows you to show additional information such as your logo, order details and customer details on the payment form.
Special characters (like &, ', <, >) are not allowed - even not "urlencoded".
The usage / display of CustomField{n] depends on the template that is used.
Händler können bis zu 14 spezielle Felder (genannt CustomField1 bis CustomField14) in ihrer Zahlungsformularvorlage anpassen. CustomFields sind eine Funktion, mit der Sie zusätzliche Informationen wie Ihr Logo, Bestelldetails und Kundendetails auf dem Zahlungsformular anzeigen können.
Sonderzeichen (wie &, ', <, >) sind nicht erlaubt - auch nicht "urlencoded".
Die Verwendung bzw. Darstellung der CustomField{n] ist abhängig vom verwendeten Template.

Layout parameters for Paygate forms for credit card payments with PagBrasil


The following table gives the result parameters which Computop Paygate transmits to URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted 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
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

Key

Format

CND

Description

Beschreibung

OrderIDans15MCNot to URLNotify: Corresponds to RefNr or TransID, depending on whether RefNr is transmitted or not.Nicht an URLNotify: Entspricht der RefNr oder TransID, je nachdem ob eine RefNr übergeben wurde oder nicht.
Statusa..50M

OK or AUTHORIZE_REQUEST (URLSuccess) as well as FAILED (URLFailure)

OK or FAILED on URLNotify

OK oder AUTHORIZE_REQUEST (URLSuccess) sowie FAILED (URLFailure)

OK oder FAILED an URLNotify

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

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.

KeyFormatCNDDescriptionBeschreibung
PCNr

n16

O

Pseudo Card Number: Random number generated by Computop 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. The PCN can be used like a genuine card number for authorisation, capture and credits.

PCNr is a response value from Computop Paygate and is sent as CCNr in Request or part of card-JSON

Pseudo Card Number: Vom Computop Paygate generierte Zufallszahl, die eine reale Kreditkartennummer repräsentiert. Die Pseudokartennummer (PKN) beginnt mit 0, und die letzten 3 Stellen entsprechen denen der realen Kartennummer. Die PKN kann wie eine Kreditkartennummer für Autorisierung, Buchung und Gutschriften verwendet werden.

PCNr ist ein Antwortwert von Computop Paygate und kann ebenfalls als CCNr im Request oder als Teil von card-JSON verwendet werden.

Key

Format

CND

Description

Beschreibung

CCBrand

a..22

O

In combination with PCNr: Description of the credit card brand including VISA, MasterCard, AMEX, DINERS, Elo, Aura or Hipercard

In Verbindung mit PCNr: Bezeichnung der Kreditkartenmarke wie VISA, MasterCard, AMEX, DINERS, Elo, Aura oder Hipercard
CCExpiryn6OIn combination with PCNr: Expiry date of the credit card in the format YYYYMMIn Verbindung mit PCNr: Ablaufdatum der Kreditkarte im Format JJJJMM
MaskedCCNran..19OCMasked card number 6X4Maskierte Kartennummer 6X4

KeyFormatCNDDescriptionBeschreibung
Plain

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. 

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. 

Ein einzelner Wert, der von Ihnen gesetzt werden kann, um Informationen wieder unverschlüsselt in der Antwort bzw. im Notify zurückzugeben, z.B. die MID.

Da der "Plain"-Parameter Teil des verschlüsselten "Data" im Computop Paygate ist, ist dieser vor Manipulationen geschützt. 

KeyFormatCND

Description

Beschreibung
Custom

ans..1024

O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. 

Please find a samples here: Custom

Der "Custom"-Parameter wird vor der Verschlüsselung an den Aufruf angehängt und ist Teil des verschlüsselten "Data" im Computop Paygate Aufruf. Dadurch ist der Wert gegen Manipulation geschützt. 

Der Custom-Wert wird dann in Klartext an die Computop Paygate-Antwort angehängt und dabei wird "|" durch "&" ersetzt. Dadurch können Sie einen Custom-Wert übergeben und bekommen mehrere Key-Value-Paare zu Ihrer eigenen Verwendung in der Antwort zurück.

Hier finden Sie ein Beispiel: Custom

Return parameters for URLSuccess, URLFailure and URLNotify with PagBrasil


The following table shows the Federal States of Brazil as well as their official Brazilian abbreviation which must be used in the AddrState transfer parameter.

Federal State

Abbreviation

Acre

AC

Alagoas

AL

Amapá

AP

Amazonas

AM

Bahia

BA

Ceará

CE

Distrito Federal

DF

Espírito Santo

ES

Goias

GO

Maranhão

MA

Mato Grosso

MT

Mato Grosso do Sul

MS

Minas Gerais

MG

Pará

PA

Paraíba

PB

Paraná

PR

Pernambuco

PE

Piauí

PI

Rio de Janeiro

RJ

Rio Grande do Norte

RN

Rio Grande do Sul

RS

Rondônia

RO

Roraima

RR

Santa Catarina

SC

São Paulo

SP

Sergipe

SE

Tocantins

TO

Federal States of Brazil



Credit card payment via Server-to-Server connection

In order to execute a SSL credit card payment with PagBrasil (Brazil) via a server-to-server connection, 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.

Key

Format

CND

Description

Beschreibung

Currency

a3

M

Only BRL permitted. Please find an overview here: A1 Currency table

Nur BRL zulässig. 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:

Key

Format

CND

Description

Beschreibung

URLNotify

ans..256

O

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.

The URL is called only if it is a payment with Hipercard, since in this case the reply from the acquirer is sent with a time delay. Alternatively the payment status can be queried via inquire.aspx.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Vollständige URL, die das Paygate aufruft, um den Shop zu benachrichtigen. Die URL darf nur über Port 443 aufgerufen werden. Sie darf keine Parameter enthalten: Nutzen Sie stattdessen den Parameter UserData.

Die URL wird nur aufgerufen, wenn es sich um eine Zahlung mit Hipercard handelt, da in diesem Fall die Antwort vom Acquirer zeitverzögert gesendet wird. Alternativ kann der Zahlungsstatus über inquire.aspx angefragt werden.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort vom Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

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

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Vollständige URL, die das Paygate aufruft, um den Shop zu benachrichtigen. Die URL darf nur über Port 443 aufgerufen werden. Sie darf keine Parameter enthalten: Nutzen Sie stattdessen den Parameter UserData.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

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.

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or 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 or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück.

Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

KeyFormatCNDDescriptionBeschreibung
Capture

an..6

OM

Determines the type and time of capture.

Capture ModeDescription
AUTOCapturing immediately after authorisation (default value).
MANUALCapturing made by the merchant. Capture is normally initiated at time of delivery.
<Number>Delay in hours until the capture (whole number; 1 to 696).

Bestimmt Art und Zeitpunkt der Buchung (engl. Capture).

BuchungsartBeschreibung
AUTOBuchung sofort nach Autorisierung (Standardwert).
MANUALBuchung erfolgt durch den Händler - in der Regel die Buchung zum Zeitpunkt der Warenauslieferung bzw. Leistungserbringung.
<Zahl>Verzögerung in Stunden bis zur Buchung (ganze Zahl; 1 bis 696).

Key

Format

CND

Description

Beschreibung

CCNr

n..19

M

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

Kreditkartennummer mind. 12stellig numerisch ohne Leerzeichen. Optional können Sie auch eine Pseudokartennummer übergeben.

CCCVC

n..4

O

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

Kartenprüfnummer: Die letzten 3 Ziffern auf dem Unterschriftsfeld der Kreditkarte. Bei AMEX 4 Ziffern.

CCExpiry

n6

M

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

Ablaufdatum der Kreditkarte (JJJJMM), z.B. 202607

CCBrand

a..22

M

Card type: VISA, MasterCard, AMEX, DINERS, Elo, Aura or Hipercard. Please note the spelling!

Kartenmarke: VISA, MasterCard, AMEX, DINERS, Elo, Aura oder Hipercard. Bitte beachten Sie die Schreibweise!
CreditCardHolderans..60MName of the card holderName des Karteninhabers

Name

ans..128

O

Name of the customer. If Name is not specified, the CreditCardHolder is transferred.

Name des Kunden. Wenn der Name nicht angegeben ist, wird der CreditCardHolder übergeben.

AddrStreet

ans..46

M

Customer's street name (Optional, if agreed with PagBrasil and Computop)

Straßenname des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

AddrCity

ans..40

M

Customer's town/city (Optional, if agreed with PagBrasil and Computop)

Ortsname des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

AddrZip

ans..8

M

Customer's post code (Optional, if agreed with PagBrasil and Computop)

Postleitzahl des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

AddrState

a2

M

Abbreviation of the customer’s Federal State. See the following table for the Federal States of Brazil. (Optional, if agreed with PagBrasil and Computop)

Abkürzung des Bundesstaats des Kunden. Siehe nachfolgende Tabelle Bundesstaaten Brasiliens. (Optional, wenn mit PagBrasil und Computop abgesprochen)

TaxNumber

n11/n14

M

In Brazil there are two kinds of tax numbers:

CPF for persons and CNPJ for companies.

CPF: 11 characters without separators, e.g. 12312312312

CNPJ: 14 characters without separators, e.g. 12345678000123

In Brasilien gibt es zwei Arten von Steuernummern:

CPF für Personen und CNPJ für Firmen

CPF: 11 Zeichen ohne Trennzeichen, z.B. 12312312312

CNPJ: 14 Zeichen, ohne Trennzeichen, z.B. 12345678000123

eMail

ans..128

M

Customer's email address (Optional, if agreed with PagBrasil and Computop)

E-Mail-Adresse des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

Phone

ans..40

M

Customer's phone number (Optional, if agreed with PagBrasil and Computop)

Telefonnummer des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

ChDesc

ans..12

M

Text printed on the customer’s credit card bill alongside the payee (‘PAGBRASIL’)

Text, der auf der Kreditkartenabrechnung des Kunden neben dem Zahlungsempfänger („PAGBRASIL“) steht

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

Beschreibung der gekauften Waren, Einzelpreise usw.

ArticleList

ans..254

O

Description of the goods purchased.

Example: ProductName; Quantity+ProductName;Number

The product and the quantity are indicated on the customer’s bill.

Beschreibung der gekauften Waren.

Beispiel: Produktname;Anzahl+Produktname;Anzahl

Das Produkt und die Anzahl werden auf der Abrechnung des Kunden angezeigt.

InstallmentNumber

n..2

O

Number of months of the payment by instalments (1-12), default=1.

Anzahl Monate der Ratenzahlung (1-12), Standard=1.
IPAddrans..45OCardholder`s IP address (v4 or v6)IP-Adresse des Gerätes des Kunden
DeviceIDans..128OCardholder`s DeviceID for operationDeviceId des Gerätes des Kunden

Parameters for credit card payments with PagBrasil via socket connection


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
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

Key

Format

CND

Description

Beschreibung

OrderIDan15MCorresponds to RefNr or TransID, depending on whether RefNr is transmitted or not.Entspricht der RefNr oder TransID, je nachdem ob eine RefNr übergeben wurde oder nicht.

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

KeyFormatCNDDescriptionBeschreibung
PCNr

n16

O

Pseudo Card Number: Random number generated by Computop 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. The PCN can be used like a genuine card number for authorisation, capture and credits.

PCNr is a response value from Computop Paygate and is sent as CCNr in Request or part of card-JSON

Pseudo Card Number: Vom Computop Paygate generierte Zufallszahl, die eine reale Kreditkartennummer repräsentiert. Die Pseudokartennummer (PKN) beginnt mit 0, und die letzten 3 Stellen entsprechen denen der realen Kartennummer. Die PKN kann wie eine Kreditkartennummer für Autorisierung, Buchung und Gutschriften verwendet werden.

PCNr ist ein Antwortwert von Computop Paygate und kann ebenfalls als CCNr im Request oder als Teil von card-JSON verwendet werden.

Key

Format

CND

Description

Beschreibung

CCBrand

a..22

O

In combination with PCNr: Description of the credit card brand including VISA, MasterCard, AMEX, DINERS, Elo, Aura or Hipercard

In Verbindung mit PCNr: Bezeichnung der Kreditkartenmarke wie VISA, MasterCard, AMEX, DINERS, Elo, Aura oder Hipercard
CCExpiryn6OIn combination with PCNr: Expiry date of the credit card in the format YYYYMMIn Verbindung mit PCNr: Ablaufdatum der Kreditkarte im Format JJJJMM
MaskedCCNran..19OCMasked card number 6X4Maskierte Kartennummer 6X4
acsURLstringCMerchant receives acsURL and needs to redirect customer to this URL to complete authenticationDer Händler erhält die acsURL und muss den Kunden zu dieser URL umleiten, um die Authentifizierung abzuschließen

Results parameters for socket connection for PagBrasil


In addition to the response of the payment request session, Paygate sends a notification to the URL deposited in Paygate or stated in the parameter [URLNotify], depending on the card brand and the configuration settings of the merchant. This is generally the case for payments with a card of the brand Hipercard (Itau).

In addition, Paygate sends chargeback notifications to the URLNotify for all supported card brands, if the merchant in question is correspondingly configured in Paygate. The chargeback notification contains these parameters

action=CHARGEBACK&chargebackamount={value}.

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
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

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

Response parameters to URLNotify for PagBrasil payments with Hipercard



PagBrasilOTF online transfer

In order to make a payment with PagBrasilOTF, 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.

Key

Format

CND

Description

Beschreibung

Currency

a3

M

Only BRL permitted. Please find an overview here: A1 Currency table

Nur BRL zulässig. 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
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.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Vollständige URL, die das Paygate aufruft, wenn die Zahlung erfolgreich war. Die URL darf nur über Port 443 aufgerufen werden. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen nutzen Sie stattdessen den Parameter UserData.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

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

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Vollständige URL, die das Paygateaufruft, wenn die Zahlung gescheitert ist. Die URL darf nur über Port 443 aufgerufen werden. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen nutzen Sie stattdessen den Parameter UserData.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

KeyFormatCNDDescriptionBeschreibung
Response

a7

O

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

Die Status-Rückmeldung, die das Paygate an URLSuccess und URLFailure sendet, sollte verschlüsselt werden. Dazu übergeben Sie den Parameter Response=encrypt.

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

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Vollständige URL, die das Paygate aufruft, um den Shop zu benachrichtigen. Die URL darf nur über Port 443 aufgerufen werden. Sie darf keine Parameter enthalten: Nutzen Sie stattdessen den Parameter UserData.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

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.

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or 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 or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück.

Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

Key

Format

CND

Description

Beschreibung

Name

ans..128

O

Name of the customer

Name des Kunden

AddrStreet

ans..46

M

Customer's street name (Optional, if agreed with PagBrasil and Computop, but not for BankCode = U)

Straßenname des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen, jedoch nicht bei BankCode = U)

AddrCity

ans..40

M

Customer's town/city (Optional, if agreed with PagBrasil and Computop, but not for BankCode = U)

Ortsname des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen, jedoch nicht bei BankCode = U)

AddrZip

ans..8

M

Customer's post code (Optional, if agreed with PagBrasil and Computop, but not for BankCode = U)

Postleitzahl des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen, jedoch nicht bei BankCode = U)

AddrState

a2

M

Abbreviation of the customer’s Federal State. See the table above for the Federal States of Brazil. (Optional, if agreed with PagBrasil and Computop, but not for BankCode = U)

Abkürzung des Bundesstaats des Kunden. Siehe obige Tabelle Bundesstaaten Brasiliens. (Optional, wenn mit PagBrasil und Computop abgesprochen, jedoch nicht bei BankCode = U)

TaxNumber

n11/n14

M

In Brazil there are two kinds of tax numbers:

CPF for persons and CNPJ for companies.

CPF: 11 characters without separators, e.g. 12312312312

CNPJ: 14 characters without separators, e.g. 12345678000123

In Brasilien gibt es zwei Arten von Steuernummern:

CPF für Personen und CNPJ für Firmen

CPF: 11 Zeichen ohne Trennzeichen, z.B. 12312312312

CNPJ: 14 Zeichen, ohne Trennzeichen, z.B. 12345678000123

eMail

ans..128

M

Customer's email address (Optional, if agreed with PagBrasil and Computop, but not for BankCode = U)

E-Mail-Adresse des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen, jedoch nicht bei BankCode = U)

Phone

ans..40

M

Customer's phone number (Optional, if agreed with PagBrasil and Computop, but not for BankCode = U)

Telefonnummer des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen, jedoch nicht bei BankCode = U)

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

Beschreibung der gekauften Waren, Einzelpreise usw.

ArticleList

ans..254

O

Description of the goods purchased.

Example: ProductName; Quantity+ProductName;Number

The product and the quantity are indicated on the customer’s bill.

Beschreibung der gekauften Waren.

Beispiel: Produktname;Anzahl+Produktname;Anzahl

Das Produkt und die Anzahl werden auf der Abrechnung des Kunden angezeigt.

BankCodeenumM

Identification of the financial institution of the customer

R = Bradesco Comércio Eletrônico

E = Banco do Brasil Comércio Eletrônico

S = Banricompras

U = Itaú Shopline

Identifikation des Finanzinstituts des Kunden

R = Bradesco Comércio Eletrônico

E = Banco do Brasil Comércio Eletrônico

S = Banricompras

U = Itaú Shopline

KeyFormatCNDDescriptionBeschreibung
Plain

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. 

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. 

Ein einzelner Wert, der von Ihnen gesetzt werden kann, um Informationen wieder unverschlüsselt in der Antwort bzw. im Notify zurückzugeben, z.B. die MID.

Da der "Plain"-Parameter Teil des verschlüsselten "Data" im Computop Paygate ist, ist dieser vor Manipulationen geschützt. 

KeyFormatCND

Description

Beschreibung
Custom

ans..1024

O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. 

Please find a samples here: Custom

Der "Custom"-Parameter wird vor der Verschlüsselung an den Aufruf angehängt und ist Teil des verschlüsselten "Data" im Computop Paygate Aufruf. Dadurch ist der Wert gegen Manipulation geschützt. 

Der Custom-Wert wird dann in Klartext an die Computop Paygate-Antwort angehängt und dabei wird "|" durch "&" ersetzt. Dadurch können Sie einen Custom-Wert übergeben und bekommen mehrere Key-Value-Paare zu Ihrer eigenen Verwendung in der Antwort zurück.

Hier finden Sie ein Beispiel: Custom

Parameters for online transfers with PagBrasil


The following table gives the result parameters which Computop Paygate transmits to URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted 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
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

Key

Format

CND

Description

Beschreibung

OrderIDan15MCNot to URLNotify: Corresponds to RefNr or TransID, depending on whether RefNr is transmitted or not.Nicht an URLNotify: Entspricht der RefNr oder TransID, je nachdem ob eine RefNr übergeben wurde oder nicht.

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

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.

KeyFormatCNDDescriptionBeschreibung
Plain

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. 

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. 

Ein einzelner Wert, der von Ihnen gesetzt werden kann, um Informationen wieder unverschlüsselt in der Antwort bzw. im Notify zurückzugeben, z.B. die MID.

Da der "Plain"-Parameter Teil des verschlüsselten "Data" im Computop Paygate ist, ist dieser vor Manipulationen geschützt. 

KeyFormatCND

Description

Beschreibung
Custom

ans..1024

O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. 

Please find a samples here: Custom

Der "Custom"-Parameter wird vor der Verschlüsselung an den Aufruf angehängt und ist Teil des verschlüsselten "Data" im Computop Paygate Aufruf. Dadurch ist der Wert gegen Manipulation geschützt. 

Der Custom-Wert wird dann in Klartext an die Computop Paygate-Antwort angehängt und dabei wird "|" durch "&" ersetzt. Dadurch können Sie einen Custom-Wert übergeben und bekommen mehrere Key-Value-Paare zu Ihrer eigenen Verwendung in der Antwort zurück.

Hier finden Sie ein Beispiel: Custom

Response parameters for URLSuccess, URLFailure and URLNotify with PagBrasilOTF



Cash payment with PagBrasil Boleto Bancário

In order to execute a cash payment with PagBrasil Boleto Bancário (Brazil) via a server-to-server connection, 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

Key

Format

CND

Description

Beschreibung

RefNr

ans..30

M

Unique reference number. Format must be mutually agreed beforehand with Computop!

Eindeutige Referenznummer. Das Format muss vorher mit Computop abgestimmt werden!

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.

Key

Format

CND

Description

Beschreibung

Currency

a3

M

Only BRL permitted. Please find an overview here: A1 Currency table

Nur BRL zulässig. 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.

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

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Vollständige URL, die das Paygate aufruft, um den Shop zu benachrichtigen. Die URL darf nur über Port 443 aufgerufen werden. Sie darf keine Parameter enthalten: Nutzen Sie stattdessen den Parameter UserData.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

Key

Format

CND

Description

Beschreibung

Name

ans..128

M

Name of the customer

Name des Kunden

AddrStreet

ans..46

M

Customer's street name (Optional, if agreed with PagBrasil and Computop)

Straßenname des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

AddrCity

ans..40

M

Customer's town/city (Optional, if agreed with PagBrasil and Computop)

Ortsname des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

AddrZip

ans..8

M

Customer's post code (Optional, if agreed with PagBrasil and Computop)

Postleitzahl des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

AddrState

a2

M

Abbreviation of the customer’s Federal State. See the table above for the Federal States of Brazil. (Optional, if agreed with PagBrasil and Computop)

Abkürzung des Bundesstaats des Kunden. Siehe obige Tabelle Bundesstaaten Brasiliens. (Optional, wenn mit PagBrasil und Computop abgesprochen)

TaxNumber

n11/n14

M

In Brazil there are two kinds of tax numbers:

CPF for persons and CNPJ for companies.

CPF: 11 characters without separators, e.g. 12312312312

CNPJ: 14 characters without separators, e.g. 12345678000123

In Brasilien gibt es zwei Arten von Steuernummern:

CPF für Personen und CNPJ für Firmen

CPF: 11 Zeichen ohne Trennzeichen, z.B. 12312312312

CNPJ: 14 Zeichen, ohne Trennzeichen, z.B. 12345678000123

eMail

ans..128

M

Customer's email address (Optional, if agreed with PagBrasil and Computop)

E-Mail-Adresse des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

Phone

ans..40

M

Customer's phone number (Optional, if agreed with PagBrasil and Computop)

Telefonnummer des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

Beschreibung der gekauften Waren, Einzelpreise usw.

ArticleList

ans..254

M

Description of the goods purchased.

Example: ProductName; Quantity+ProductName;Number

The product and the quantity are indicated on the customer’s bill.

Beschreibung der gekauften Waren.

Beispiel: Produktname;Anzahl+Produktname;Anzahl

Das Produkt und die Anzahl werden auf der Abrechnung des Kunden angezeigt.

Expirationn..3ONumber of days for which the payment form is validAnzahl der Tage, wie lange der Zahlschein gilt

KeyFormatCND

Description

Beschreibung
Custom

ans..1024

O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. 

Please find a samples here: Custom

Der "Custom"-Parameter wird vor der Verschlüsselung an den Aufruf angehängt und ist Teil des verschlüsselten "Data" im Computop Paygate Aufruf. Dadurch ist der Wert gegen Manipulation geschützt. 

Der Custom-Wert wird dann in Klartext an die Computop Paygate-Antwort angehängt und dabei wird "|" durch "&" ersetzt. Dadurch können Sie einen Custom-Wert übergeben und bekommen mehrere Key-Value-Paare zu Ihrer eigenen Verwendung in der Antwort zurück.

Hier finden Sie ein Beispiel: Custom

Parameters for payments with Boleto Bancário via socket connection


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
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

Key

Format

CND

Description

Beschreibung

OrderIDan15MCNot to URLNotify: Corresponds to RefNr or TransID, depending on whether RefNr is transmitted or not.Nicht an URLNotify: Entspricht der RefNr oder TransID, je nachdem ob eine RefNr übergeben wurde oder nicht.

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

PaymentSlipLinkans..256MComplete URL (URL-encoded) for the page which presents the payment formVollständige URL (URL-encoded) für die Seite, die den Zahlschein darstellt

Results parameters for socket connection for Boleto Bancário


The following table describes the parameters which the Paygate transfers to URLNotify:

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
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

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

PaymentSlipLinkans..256MComplete URL (URL-encoded) for the page which presents the payment formVollständige URL (URL-encoded) für die Seite, die den Zahlschein darstellt

AmountAuth

n..10

M

Authorized amount in the smallest currency unit (e.g. BRL Centavos)

Autorisierter Betrag in der kleinsten Währungseinheit (z.B. BRL Centavos)

AmountCap

n..10

M

Captured amount in the smallest currency unit (e.g. BRL Centavos). Used to check whether the total amount has been captured.

Gebuchter Betrag in der kleinsten Währungseinheit (z.B. BRL Centavos). Dient zur Prüfung, ob der gesamte Betrag gebucht wurde.

AmountCred

n..10

M

Credited amount in the smallest currency unit (e.g. BRL Centavos)

Gutgeschriebener Betrag in der kleinsten Währungseinheit (z.B. BRL Centavos)
PaymentDatedttmMDate when the Boleto Bancário was paid by the customer. Format: YYYY-MM-DD.Datum, wann der Kunde mit Boleto Bancário bezahlt hat. Format: JJJJ-MM-TT.

KeyFormatCND

Description

Beschreibung
Custom

ans..1024

O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. 

Please find a samples here: Custom

Der "Custom"-Parameter wird vor der Verschlüsselung an den Aufruf angehängt und ist Teil des verschlüsselten "Data" im Computop Paygate Aufruf. Dadurch ist der Wert gegen Manipulation geschützt. 

Der Custom-Wert wird dann in Klartext an die Computop Paygate-Antwort angehängt und dabei wird "|" durch "&" ersetzt. Dadurch können Sie einen Custom-Wert übergeben und bekommen mehrere Key-Value-Paare zu Ihrer eigenen Verwendung in der Antwort zurück.

Hier finden Sie ein Beispiel: Custom

Response parameters to URLNotify for payments with Boleto Bancário



PIX payment with PagBrasil

In order to execute a PIX payment with PagBrasil via a server-to-server connection, 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

Key

Format

CND

Description

Beschreibung

RefNr

ans..30

M

Unique reference number. Format must be mutually agreed beforehand with Computop!

Eindeutige Referenznummer. Das Format muss vorher mit Computop abgestimmt werden!

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.

Key

Format

CND

Description

Beschreibung

Currency

a3

M

Only BRL permitted. Please find an overview here: A1 Currency table

Nur BRL zulässig. 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.

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

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Vollständige URL, die das Paygate aufruft, um den Shop zu benachrichtigen. Die URL darf nur über Port 443 aufgerufen werden. Sie darf keine Parameter enthalten: Nutzen Sie stattdessen den Parameter UserData.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

Key

Format

CND

Description

Beschreibung

Name

ans..128

M

Name of the customer

Name des Kunden

AddrStreet

ans..46

M

Customer's street name (Optional, if agreed with PagBrasil and Computop)

Straßenname des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

AddrCity

ans..40

M

Customer's town/city (Optional, if agreed with PagBrasil and Computop)

Ortsname des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

AddrZip

ans..8

M

Customer's post code (Optional, if agreed with PagBrasil and Computop)

Postleitzahl des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

AddrState

a2

M

Abbreviation of the customer’s Federal State. See the table above for the Federal States of Brazil. (Optional, if agreed with PagBrasil and Computop)

Abkürzung des Bundesstaats des Kunden. Siehe obige Tabelle Bundesstaaten Brasiliens. (Optional, wenn mit PagBrasil und Computop abgesprochen)

TaxNumber

n11/n14

M

In Brazil there are two kinds of tax numbers:

CPF for persons and CNPJ for companies.

CPF: 11 characters without separators, e.g. 12312312312

CNPJ: 14 characters without separators, e.g. 12345678000123

In Brasilien gibt es zwei Arten von Steuernummern:

CPF für Personen und CNPJ für Firmen

CPF: 11 Zeichen ohne Trennzeichen, z.B. 12312312312

CNPJ: 14 Zeichen, ohne Trennzeichen, z.B. 12345678000123

eMail

ans..128

M

Customer's email address (Optional, if agreed with PagBrasil and Computop)

E-Mail-Adresse des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

Phone

ans..40

M

Customer's phone number (Optional, if agreed with PagBrasil and Computop)

Telefonnummer des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

Beschreibung der gekauften Waren, Einzelpreise usw.

ArticleList

ans..254

M

Description of the goods purchased.

Example: ProductName; Quantity+ProductName;Number

The product and the quantity are indicated on the customer’s bill.

Beschreibung der gekauften Waren.

Beispiel: Produktname;Anzahl+Produktname;Anzahl

Das Produkt und die Anzahl werden auf der Abrechnung des Kunden angezeigt.

Expirationn..3ONumber of days for which the payment form is validAnzahl der Tage, wie lange der Zahlschein gilt

KeyFormatCND

Description

Beschreibung
Custom

ans..1024

O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. 

Please find a samples here: Custom

Der "Custom"-Parameter wird vor der Verschlüsselung an den Aufruf angehängt und ist Teil des verschlüsselten "Data" im Computop Paygate Aufruf. Dadurch ist der Wert gegen Manipulation geschützt. 

Der Custom-Wert wird dann in Klartext an die Computop Paygate-Antwort angehängt und dabei wird "|" durch "&" ersetzt. Dadurch können Sie einen Custom-Wert übergeben und bekommen mehrere Key-Value-Paare zu Ihrer eigenen Verwendung in der Antwort zurück.

Hier finden Sie ein Beispiel: Custom

Parameters for payments with PIX via PagBrasil via socket connection


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
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

Key

Format

CND

Description

Beschreibung

OrderIDan15MCNot to URLNotify: Corresponds to RefNr or TransID, depending on whether RefNr is transmitted or not.Nicht an URLNotify: Entspricht der RefNr oder TransID, je nachdem ob eine RefNr übergeben wurde oder nicht.

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

QRCodeUrlans..80CPix QR Code image link.Vollständige URL (URL-encoded) für die Seite, die den Zahlschein darstellt
QRCodeIDans..254CAlternative code for mobile users to complete the payment when they cannot scan the code.
ExpirationDateans10C

Last date to pay the PagBrasil Pix.

Format: MM/DD/YYYY


ExpirationTimeans5C

Maximum time within the expiration date the PagBrasil Pix will be allowed to be paid.

Format: HH:MM.


Results parameters for socket connection for PIX via PagBrasil


The following table describes the parameters which the Paygate transfers to URLNotify:

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
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

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

QRCodeUrlans..80CPix QR Code image link.
QRCodeIDans..254CAlternative code for mobile users to complete the payment when they cannot scan the code.
ExpirationDateans10C

Last date to pay the PagBrasil Pix.

Format: MM/DD/YYYY


ExpirationTimeans5C

Maximum time within the expiration date the PagBrasil Pix will be allowed to be paid.

Format: HH:MM.


AmountAuth

n..10

M

Authorized amount in the smallest currency unit (e.g. BRL Centavos)

Autorisierter Betrag in der kleinsten Währungseinheit (z.B. BRL Centavos)

AmountCap

n..10

M

Captured amount in the smallest currency unit (e.g. BRL Centavos). Used to check whether the total amount has been captured.

Gebuchter Betrag in der kleinsten Währungseinheit (z.B. BRL Centavos). Dient zur Prüfung, ob der gesamte Betrag gebucht wurde.

AmountCred

n..10

M

Credited amount in the smallest currency unit (e.g. BRL Centavos)

Gutgeschriebener Betrag in der kleinsten Währungseinheit (z.B. BRL Centavos)
PaymentDatedttmMDate when the Boleto Bancário was paid by the customer. Format: YYYY-MM-DD.Datum, wann der Kunde mit Boleto Bancário bezahlt hat. Format: JJJJ-MM-TT.

KeyFormatCND

Description

Beschreibung
Custom

ans..1024

O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. 

Please find a samples here: Custom

Der "Custom"-Parameter wird vor der Verschlüsselung an den Aufruf angehängt und ist Teil des verschlüsselten "Data" im Computop Paygate Aufruf. Dadurch ist der Wert gegen Manipulation geschützt. 

Der Custom-Wert wird dann in Klartext an die Computop Paygate-Antwort angehängt und dabei wird "|" durch "&" ersetzt. Dadurch können Sie einen Custom-Wert übergeben und bekommen mehrere Key-Value-Paare zu Ihrer eigenen Verwendung in der Antwort zurück.

Hier finden Sie ein Beispiel: Custom

Response parameters to URLNotify for payments with PIX via PagBrasil



Cash payment with PagBrasil PEC Flash

In order to execute a cash payment with PagBrasil PEC Flash, 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.

Key

Format

CND

Description

Beschreibung

Currency

a3

M

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

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Nur BRL zulässig. 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.

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

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Vollständige URL, die das Paygate aufruft, um den Shop zu benachrichtigen. Die URL darf nur über Port 443 aufgerufen werden. Sie darf keine Parameter enthalten: Nutzen Sie stattdessen den Parameter UserData.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von Paygate zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

Key

Format

CND

Description

Beschreibung

Name

ans..128

M

Name of the customer

Name des Kunden

AddrStreet

ans..46

C

Customer's street name (Optional, if agreed with PagBrasil and Computop)

Straßenname des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

AddrCity

ans..40

C

Customer's town/city (Optional, if agreed with PagBrasil and Computop)

Ortsname des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

AddrZip

ans..8

C

Customer's post code (Optional, if agreed with PagBrasil and Computop)

Postleitzahl des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

AddrState

a2

C

Abbreviation of the customer’s Federal State. See the table above for the Federal States of Brazil. (Optional, if agreed with PagBrasil and Computop)

Abkürzung des Bundesstaats des Kunden. Siehe obige Tabelle Bundesstaaten Brasiliens. (Optional, wenn mit PagBrasil und Computop abgesprochen)

TaxNumber

n11/n14

C

In Brazil there are two kinds of tax numbers:

CPF for persons and CNPJ for companies.

CPF: 11 characters without separators, e.g. 12312312312

CNPJ: 14 characters without separators, e.g. 12345678000123

In Brasilien gibt es zwei Arten von Steuernummern:

CPF für Personen und CNPJ für Firmen

CPF: 11 Zeichen ohne Trennzeichen, z.B. 12312312312

CNPJ: 14 Zeichen, ohne Trennzeichen, z.B. 12345678000123

eMail

ans..128

C

Customer's email address (Optional, if agreed with PagBrasil and Computop)

E-Mail-Adresse des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

Phone

ans..40

C

Customer's phone number (Optional, if agreed with PagBrasil and Computop)

Telefonnummer des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen)

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

Beschreibung der gekauften Waren, Einzelpreise usw.

ArticleList

ans..254

M

Description of the goods purchased.

Example: ProductName; Quantity+ProductName;Number

The product and the quantity are indicated on the customer’s bill.

Beschreibung der gekauften Waren.

Beispiel: Produktname;Anzahl+Produktname;Anzahl

Das Produkt und die Anzahl werden auf der Abrechnung des Kunden angezeigt.

Expirationn..3ONumber of days (0 - 5), which the PEC Flash® payment slip is valid. If you do not use this parameter the default value configured within PagBrasil dashboard will be used.

Anzahl der Tage (0 - 5), für die der PEC Flash® Zahlschein gültig ist. Wenn Sie diesen Parameter nicht verwenden, wird der im PagBrasil-Dashboard festgelegte Standardwert verwendet.

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or 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 or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück.

Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

KeyFormatCND

Description

Beschreibung
Custom

ans..1024

O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. 

Please find a samples here: Custom

Der "Custom"-Parameter wird vor der Verschlüsselung an den Aufruf angehängt und ist Teil des verschlüsselten "Data" im Computop Paygate Aufruf. Dadurch ist der Wert gegen Manipulation geschützt. 

Der Custom-Wert wird dann in Klartext an die Computop Paygate-Antwort angehängt und dabei wird "|" durch "&" ersetzt. Dadurch können Sie einen Custom-Wert übergeben und bekommen mehrere Key-Value-Paare zu Ihrer eigenen Verwendung in der Antwort zurück.

Hier finden Sie ein Beispiel: Custom

Parameters for payments with PEC Flash


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
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

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

OrderIDan15MCorresponds to RefNr or TransID, depending on whether RefNr is transmitted or notEntspricht der RefNr oder TransID, je nachdem ob eine RefNr übergeben wurde oder nicht
TransactionIDans..17O

The payment generated code which the shopper needs to show at the lottery store for paying in CASH.

It will be returned in case of successful Authorization Request.

Der für die Zahlung erzeugte Code, den der Käufer im Lotteriegeschäft für die Barzahlung vorzeigen muss.

Er wird bei einer erfolgreichen Autorisierungsanfrage zurückgegeben.

CompanyIDans..10OCompany code to be used in the order confirmation page for the shopper, as part of payment instruction information to the lottery storeFirmencode zur Verwendung auf der Bestätigungsseite für den Käufer als Teil der Zahlungsinformationen für das Lotteriegeschäft
Noteans..254OPayment instructions that contains a Portuguese text detailing exactly where the customer can pay and which information he will need to provide to the agent. PagBrasil recommends merchants to use this element "payment_instructions" on their confirmation page instead of mounting the text from XML elements (company_code, payment_id, customer_taxid).Zahlungsanweisungen mit einem portugiesischen Text, wo der Käufer bezahlen kann und welche Informationen er dem Händler geben muss. PagBrasil empfiehlt den Händlern, dieses Element "payment_instructions" auf ihrer Bestätigungsseite zu verwenden, anstatt den Text aus den XML-Elementen (company_code, payment_id, customer_taxid) zusammenzusetzen.

Response parameters for PEC Flash


The following table describes the parameters which the Paygate transfers to URLNotify:

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
refnr

ns..30

O

Merchant’s unique reference number

Eindeutige Referenznummer des Händlers

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

TransactionIDans..17O

The payment generated code which the shopper needs to show at the lottery store for paying in cash.

It will be returned in case of successful Authorization Request.

Der für die Zahlung erzeugte Code, den der Käufer im Lotteriegeschäft für die Barzahlung vorzeigen muss.

Er wird bei einer erfolgreichen Autorisierungsanfrage zurückgegeben.

CompanyIDans..10OCompany code to be used in the order confirmation page for the shopper, as part of payment instruction information to the lottery storeFirmencode zur Verwendung auf der Bestätigungsseite für den Käufer als Teil der Zahlungsinformationen für das Lotteriegeschäft
Noteans..254OPayment instructions that contains a Portuguese text detailing exactly where the customer can pay and which information he will need to provide to the agent. PagBrasil recommends merchants to use this element "payment_instructions" on their confirmation page instead of mounting the text from XML elements (company_code, payment_id, customer_taxid).Zahlungsanweisungen mit einem portugiesischen Text, wo der Käufer bezahlen kann und welche Informationen er dem Händler geben muss. PagBrasil empfiehlt den Händlern, dieses Element "payment_instructions" auf ihrer Bestätigungsseite zu verwenden, anstatt den Text aus den XML-Elementen (company_code, payment_id, customer_taxid) zusammenzusetzen.

AmountAuth

n..10

M

Authorized amount in the smallest currency unit (e.g. BRL Centavos)

Autorisierter Betrag in der kleinsten Währungseinheit (z.B. BRL Centavos)

AmountCap

n..10

M

Captured amount in the smallest currency unit (e.g. BRL Centavos). Used to check whether the total amount has been captured.

Gebuchter Betrag in der kleinsten Währungseinheit (z.B. BRL Centavos). Dient zur Prüfung, ob der gesamte Betrag gebucht wurde.

AmountCred

n..10

M

Credited amount in the smallest currency unit (e.g. BRL Centavos)

Gutgeschriebener Betrag in der kleinsten Währungseinheit (z.B. BRL Centavos)
PaymentDatedttmMDate when the Boleto Bancário was paid by the customer. Format: YYYY-MM-DD.Datum, wann der Kunde mit Boleto Bancário bezahlt hat. Format: JJJJ-MM-TT.

KeyFormatCND

Description

Beschreibung
Custom

ans..1024

O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. 

Please find a samples here: Custom

Der "Custom"-Parameter wird vor der Verschlüsselung an den Aufruf angehängt und ist Teil des verschlüsselten "Data" im Computop Paygate Aufruf. Dadurch ist der Wert gegen Manipulation geschützt. 

Der Custom-Wert wird dann in Klartext an die Computop Paygate-Antwort angehängt und dabei wird "|" durch "&" ersetzt. Dadurch können Sie einen Custom-Wert übergeben und bekommen mehrere Key-Value-Paare zu Ihrer eigenen Verwendung in der Antwort zurück.

Hier finden Sie ein Beispiel: Custom

Response parameters to URLNotify for payments with PEC Flash



Updating a payment with PEC Flash & PIX

In order to extend a payment slip for PEC Flash via a server-to-server connection, 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, 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.

Key

Format

CND

Description

Beschreibung

Expiration

n1

M

Number of days that should be added to the present expiration date (maximum 5)

Anzahl der Tage, die zum aktuellen Ablaufdatum hinzugefügt werden sollen (maximal 5)

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:

Parameters for updating payments with PEC Flash


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)

Key

Format

CND

Description

Beschreibung

OrderID

an15

MC

Corresponds to RefNr or TransID, depending on whether RefNr is transmitted or not.

Entspricht der RefNr oder TransID, je nachdem ob eine RefNr übergeben wurde oder nicht.
PaymentSlipLinkans..256CComplete URL to the PDF document, which presents the payment slip with barcode. Only with Boleto Bancário.Vollständige URL zum PDF-Dokument, welches den Zahlschein mit dem Barcode darstellt. Nur bei Boleto Bancário.
QRCodeUrlans..80CPix QR Code image link. Only with PIX
QRCodeIDans..254CAlternative code for mobile users to complete the payment when they cannot scan the code. Only with PIX
ExpirationDateans10C

Last date to pay the PagBrasil Pix. Only with PIX

Format: MM/DD/YYYY


ExpirationTimeans5C

Maximum time within the expiration date the PagBrasil Pix will be allowed to be paid. Only with PIX

Format: HH:MM.


Response parameters for updating payments with PEC Flash & pix



Capture of a credit card payment with PagBrasil

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

Key

Format

CND

Description

Beschreibung

Currency

a3

M

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

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Nur BRL zulässig. 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
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or 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 or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück.

Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

Parameters for captures of PagBrasil, PagBrasilOTF and Boleto Bancário


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

OrderID

an15

MC

Corresponds to RefNr or TransID, depending on whether RefNr is transmitted or not.

Entspricht der RefNr oder TransID, je nachdem ob eine RefNr übergeben wurde oder nicht.

Response parameters for captures of PagBrasil, PagBrasilOTF and Boleto Bancário



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.

Credits with credit cards can be made within up to 90 days on the credit card given with the payment but only on the same day with debit cards. Later it will be possible to make credit only with the optional parameters AccNr, AccBankName and AccBIC. These must be requested from the customer since no data would be available for a credit on payment. In the case of credits for payments with PagBrasilOTF and Boleto Bancário there is also no data for a credit. Here again the details must be requested from the customer and transferred to the parameters AccNr, AccBankName and AccBIC.

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

Key

Format

CND

Description

Beschreibung

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. For PagBrasilOTF and Boleto Bancário only BRL is permitted. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Bei PagBrasilOTF und BoletoBancário ist nur BRL zulässig. 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
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or 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 or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück.

Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

Key

Format

CND

Description

Beschreibung

CredNo

ans..

OC

Not with PagBrasilOTF/Boleto Bancário: Credit number. Will be set to “0” if not transmitted.

Nicht bei PagBrasilOTF/Boleto Bancário: Kreditnummer. Wird auf den Wert „0“ gesetzt, falls nicht übermittelt.

RefNr

ans..30

OC

Only with PagBrasilOTF and Boleto Bancário: Reference number (e.g. invoice number) which must be unique for each return shipment

Nur bei PagBrasilOTF und Boleto Bancário: Referenznummer (z.B. Rechnungsnummer), die für jede Retoure eindeutig sein muss

AccBankName

ans..40

O

Bank name of the customer

Bankname des Kunden

AccNr

ans..12

O

Customer's account number (must contain a hyphen, e.g. 12345-6)

Kontonummer des Kunden (muss Bindestrich enthalten, z.B. 12345-6)

AccBIC

ans..12

O

Bank sort code or rather branch number of the bank

Bankleitzahl bzw. Filialnummer der Bank

Parameters for credit of payments with PagBrasil, PagBrasilOTF and Boleto Bancário


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)

Key

Format

CND

Description

Beschreibung

RefNr

ans..30

OC

Only with PagBrasilOTF and Boleto Bancário: Merchant’s unique reference number

Nur bei PagBrasilOTF und Boleto Bancário: Referenznummer des Händlers
OrderID

an15

MC

Corresponds to RefNr or TransID, depending on whether RefNr is transmitted or not.

Entspricht der RefNr oder TransID, je nachdem ob eine RefNr übergeben wurde oder nicht.

Response parameters for credit of payments with PagBrasil, PagBrasilOTF and Boleto Bancário



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 PagBrasil, PagBrasilOTF and Boleto Bancário 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:

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

Credit

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 PagBrasil payment within a Batch file to be submitted is the following:

HEAD,<MerchantID>,<Date>,<Version>
PagBraCC,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>
PagBraCC,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<AccBankName>,<AccNr>,<AccBIC>
PagBraBB,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<AccBankName>,<AccNr>,<AccBIC>
PagBraOTF,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<AccBankName>,<AccNr>,<AccBIC>
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 für Header, FOOT for Footer, PagBraCC for PagBrasil credit card, PagBraOTF for PagBrasil online transfer, PagBraBB for Boleto Bancário

HEAD für Header, FOOT für Footer, PagBraCC für PagBrasil Kreditkarte, PagBraOTF für PagBrasil Online-Überweisung, PagBraBB für Boleto Bancário

Action

a..20

M

The parameter Action defines the type of transaction:

Capture

Credit

For credit card payments with PagBrasil captures and credits are possible, for payments with PagBrasilOTF as well as Boleto Bancário only credits are possible.

Der Action-Parameter definiert die Art der Transaktion:

Capture (Buchung)

Credit (Gutschrift)

Für Kreditkartenzahlungen mit PagBrasil sind Buchungen und Gutschriften möglich, für Zahlungen mit PagBrasilOTF sowie Boleto Bancário sind nur Gutschriften möglich.

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

Key

Format

CND

Description

Beschreibung

AccBankName

ans..40

M

Bank name of the customer

Bankname des Kunden

AccNr

ans..12

M

Customer's account number (must contain a hyphen, e.g. 12345-6)

Kontonummer des Kunden (muss Bindestrich enthalten, z.B. 12345-6)

AccBIC

ans..12

M

Bank sort code or rather branch number of the bank

Bankleitzahl bzw. Filialnummer der Bank

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>
PagBraCC,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>
PagBraCC,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<AccBankName>,<AccNr>,<AccBIC>,<Status>,<Code>
PagBraBB,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<AccBankName>,<AccNr>,<AccBIC>,<Status>,<Code>
PagBraOTF,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<AccBankName>,<AccNr>,<AccBIC>,<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:

Capture

Credit

Der Action-Parameter definiert die Art der Transaktion:

Capture (Buchung)

Credit (Gutschrift)

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