Über PagBrasil
Allgemeines zu Zahlungsmethoden via PagBrasil
Ein großer Teil der Online-Zahlungen in Brasilien wird über Kreditkarten abgewickelt. Bei 75% dieser Zahlungen nutzen brasilianische Kunden die Ratenzahlung. Der Händler bekommt dabei den vollen Betrag sofort gutgeschrieben, während die Bank an den Gebühren für die Ratenzahlung verdient. Nur etwa ein Drittel aller Kreditkarten in Brasilien ist international für E-Commerce einsetzbar. Für den Großteil lokaler Karten, auch wenn sie von Visa, MasterCard oder Amex ausgegeben wurden, sind Verträge mit lokalen Partnern nötig, um diese brasilianischen Kreditkarten annehmen und einen guten Umrechnungskurs erzielen zu können. Zu den inländischen Karten in Brasilien zählen Hipercard, Elo und Aura.
Zusätzlich ist die Cash-in-Lösung Boleto Bancário eine verbreitete Zahlungsmethode im Rahmen des E-Commerce. Der Händler stellt dem Käufer eine Art Pro-forma-Rechnung aus, die an Geldautomaten, bei Banken, Postfilialen, Einzelhändlern oder via Internet-Banking bezahlt werden kann. Auch reine Online-Überweisungen wie PagBrasilOTF gehören zu den Zahlungsarten, die Kunden vom Händler in Brasilien erwarten.
Ahnlich zu Boleto Bancário ist die neue Cash-in-Lösung PEC Flash für Kunden im E-Commerce verfügbar, die weder Bankkonto noch Kreditkarte haben, um ihre Online-Bestellungen in jedem Lotteriegeschäft zu bezahlen. PEC Flash ist sehr einfach zu nutzen und die Zahlung wird in wenigen Minuten bestätigt.
Diagramme zum Prozessablauf
PagBrasilOTF Prozessablauf
PagBrasil Boleto Bancário Prozessablauf
Paygate-Schnittstelle
Datenformate: a alphabetisch as alphabetisch mit Sonderzeichen n numerisch an alphanumerisch ans alphanumerisch mit Sonderzeichen ns numerisch mit Sonderzeichen bool Bool’scher Ausdruck (true oder false) 3 feste Länge mit 3 Stellen/Zeichen ..3 variable Länge mit maximal 3 Stellen/Zeichen enum Aufzählung erlaubter Werte dttm ISODateTime (JJJJ-MM-TTThh:mm:ss) Abkürzungen: CND Bedingung (condition) M Pflicht (mandatory) O optional C bedingt (conditional) Hinweis: Bitte beachten Sie, dass die Bezeichnungen der Parameter in Groß- oder Kleinbuchstaben zurückgegeben werden können.Definitionen
Format Beschreibung Abkürzung Beschreibung Kommentar Wenn ein Parameter Pflicht ist, dann muss er vorhanden sein Wenn ein Parameter optional ist, dann kann er vorhanden sein, ist aber nicht erforderlich Wenn ein Parameter bedingt ist, dann gibt es eine Bedingungsregel, die angibt, ob er Pflicht oder optional ist
Kreditkartenzahlung mit PagBrasil via Formular-Schnittstelle
Zahlungen mit PagBrasil erfolgen über die standardmäßige Paygate-Schnittstelle für Kreditkartenzahlungen. Um eine SSL-Kreditkartenzahlung mit PagBrasil über ein Paygate-Formular auszuführen, rufen Sie folgende URL auf:
Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.
Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
TransID | ans..64 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ans..30 | M | Eindeutige Referenznummer des Händlers |
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. BRL Centavos). Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Currency | a3 | M | Währung, drei Zeichen DIN / ISO 4217. Nur BRL zulässig. |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
URLSuccess | ans..256 | M | 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. |
URLFailure | ans..256 | M | Vollständige URL, die das Paygate aufruft, 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. |
Response | a7 | O | Die Status-Rückmeldung, die das Paygate an URLSuccess und URLFailure sendet, sollte verschlüsselt werden. Dazu übergeben Sie den Parameter Response=encrypt. |
URLNotify | ans..256 | M | 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. |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop |
Capture | ans..6 | O | Bestimmt Art und Zeitpunkt der Buchung (engl. Capture). AUTO: Buchung sofort nach Autorisierung (Standardwert). MANUAL: Buchung erfolgt durch den Händler. <Zahl>: Verzögerung in Stunden bis zur Buchung (ganze Zahl; 1 bis 696). Für Transaktionen mit der Hipercard ist nur AUTO möglich. |
CreditCardHolder | ans..60 | M | Name des Karteninhabers |
Name | ans..128 | O | Name des Kunden. Wenn der Name nicht angegeben ist, wird der CreditCardHolder übergeben. |
AddrStreet | ans..46 | M | Straßenname des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen) |
AddrCity | ans..40 | M | Ortsname des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen) |
AddrZip | ans..8 | M | Postleitzahl des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen) |
AddrState | a2 | M | Abkürzung des Bundesstaats des Kunden. Siehe nachfolgende Tabelle Bundesstaaten Brasiliens. (Optional, wenn mit PagBrasil und Computop abgesprochen) |
TaxNumber | n11/n14 | M | 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 (Optional, wenn mit PagBrasil und Computop abgesprochen) |
ans..128 | M | E-Mail-Adresse des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen) | |
Phone | ans..40 | M | Telefonnummer des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen) |
ChDesc | ans..12 | M | Text, der auf der Kreditkartenabrechnung des Kunden neben dem Zahlungsempfänger („PAGBRASIL“) steht. |
OrderDesc | ans..768 | M | Beschreibung der gekauften Waren, Einzelpreise usw. |
ArticleList | ans..254 | O | Beschreibung der gekauften Waren. Beispiel: Produktname;Anzahl+Produktname;Anzahl Das Produkt und die Anzahl werden auf der Abrechnung des Kunden angezeigt. |
ReqID | ans..32 | O | Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion mit derselben ReqID erneut eingereicht wird, führt das Paygate keine Zahlung aus sondern gibt nur den Status der ursprünglichen Transaktion zurück. Bitte beachten Sie, dass das Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. |
InstallmentNumber | n..2 | O | Anzahl Monate der Ratenzahlung (1-12), Standard=1. |
Plain | ans..50 | O | Ein von Händler zu setzender Wert, um Informationen wieder unverschlüsselt zurückzugeben, z.B. die MID |
Custom | ans..1024 | O | Der Händler kann mehrere Werte durch | getrennt übergeben, die unverschlüsselt durch & getrennt zurückgegeben werden. Custom=session=123|id=456 wird in der Antwort zu Session=123&id=456 |
IPAddr | ans..45 | O | IP-Adresse des Gerätes des Kunden |
DeviceID | ans..128 | O | DeviceId des Gerätes des Kunden |
Parameter für Kreditkartenzahlungen mit PagBrasil
Um das Layout der SSL-Seite an den Shop anzupassen, können Sie mit den folgenden unverschlüsselten Parametern Farben, Schriften und Bilder konfigurieren:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
Template | ans..20 | M | 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“. |
Background | ans..256 | M | Formular Hintergrundumgebung: - URL für ein Hintergrundbild - HTML-Farbwert für Hintergrundfarbe als HEX-Wert oder - HTML-Farbname |
BGColor | ans..7 | M | Formular Hintergrundfarbe: - HTML-Farbwert für Hintergrundfarbe als HEX-Wert oder - HTML-Farbname |
BGImage | ans..256 | M | Formular Hintergrundbild: - URL für ein Hintergrundbild Beachten Sie bitte, dass dieser Wert „BGColor“ überschreibt. |
FColor | ans..6 | M | Textfarbe: - HTML-Farbwert als HEX-Wert oder - HTML-Farbname |
FFace | a..10 | M | HTML-Name der Schriftart |
FSize | n2 | M | Zahl für die Schriftgröße |
Language | a2 (enum) | M | 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, <tr> türkisch, <sp> spanisch, <se> schwedisch, <sk> slowakisch, <sl> slowenisch, <tr> türkisch, <zh> Simplified Chinese |
CCSelect | a..10 | M | Bestimmt die vorausgewählte Kartenmarke im Formular: VISA, MasterCard, AMEX, DINERS, JCB, CBN, Hipercard, Elo, Aura, Dankort, Airplus, ComfortCard, CUP oder Maestro |
URLBack | ans..256 | M | URL für Schaltfläche „Abbrechen“ |
Center | n1 | M | Standardmäßig ist das Formular vertikal und horizontal zentriert. Der Wert <1> justiert es oben mittig. |
tWidth | ans..4 | M | Breite der Tabelle für die Eingabe der Kreditkartendaten als Prozent- (50%) oder Pixelwerte (320) |
tHeight | ans..4 | M | Höhe der Tabelle für die Eingabe der Kreditkartendaten als Prozent- (70%) oder Pixelwerte (480) |
Layout-Parameter für Paygate-Formulare bei Kreditkartenzahlungen mit PagBrasil
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate an Ihre URLSuccess, URLFailure oder URLNotify übergibt. Wenn Sie den Parameter Response=encrypt angegeben haben, werden die folgenden Parameter mit Blowfish verschlüsselt an Ihr System übergeben:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien |
XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
TransID | ans..64 | M | Transaktionsnummer des Händlers |
OrderID | ans15 | MC | Nicht an URLNotify: Entspricht der RefNr oder TransID, je nachdem ob eine RefNr übergeben wurde oder nicht. |
Status | a..30 | M | OK oder AUTHORIZE_REQUEST auf der URLSuccess-Seite und FAILED auf der URLFailure-Seite OK oder FAILED an URLNotify |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
RefNr | ans..30 | O | Referenznummer des Händlers |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. |
PCNr | n..16 | O | Pseudo Card Number: Vom 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 können Sie wie eine reale Kartennummer für Autorisierung, Buchung und Gutschriften verwenden. |
CCBrand | a..22 | O | In Verbindung mit PCNr: Bezeichnung der Kreditkartenmarke wie VISA, MasterCard, AMEX, DINERS, Elo, Aura oder Hipercard |
CCExpiry | n6 | O | In Verbindung mit PCNr: Ablaufdatum der Kreditkarte im Format YYYYMM |
MaskedCCNr | an..19 | OC | Maskierte Kartennummer 6X4 |
Plain | ans..50 | O | Ein von Händler zu setzender Wert, um Informationen wieder unverschlüsselt zurückzugeben, z.B. die MID |
Custom | ans..1024 | O | Der Händler kann mehrere Werte durch | getrennt übergeben, die unverschlüsselt durch & getrennt zurückgegeben werden. Custom=session=123|id=456 wird in der Antwort zu Session=123&id=456 |
Ergebnis-Parameter für URLSuccess, URLFailure und URLNotify bei PagBrasil
Folgende Tabelle gibt die Bundesstaaten Brasiliens sowie deren offiziele brasilianische Abkürzung an, wie sie im Übergabe-Parameter AddrState verwendet werden muss.
Bundesstaat | Abkürzung |
---|---|
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 |
Bundesstaaten Brasiliens
Kreditkartenzahlung per Server-zu-Server-Verbindung
Um eine SSL-Kreditkartenzahlung mit PagBrasil (Brasilien) über eine Server-zu-Server-Verbindung auszuführen, rufen Sie folgende URL auf:
Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.
Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
TransID | ans..64 | M | Transaktionsnummer des Händlers |
RefNr | ans..30 | M | Referenznummer des Händlers |
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. BRL Centavos). Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Currency | a3 | M | Währung, drei Zeichen DIN / ISO 4217. Nur BRL zulässig. |
Capture | ans..6 | O | Bestimmt Art und Zeitpunkt der Buchung (engl. Capture). AUTO: Buchung sofort nach Autorisierung (Standardwert). MANUAL: Buchung erfolgt durch den Händler. <Zahl>: Verzögerung in Stunden bis zur Buchung (ganze Zahl; 1 bis 696). Für Transaktionen mit der Hipercard ist nur AUTO möglich. |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop |
URLNotify | ans..256 | O | 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. |
CCNr | n..19 | M | Kreditkartennummer mind. 12stellig numerisch ohne Leerzeichen. Optional können Sie auch eine Pseudokartennummer übergeben. |
CCCVC | n..4 | O | Kartenprüfnummer: Die letzten 3 Ziffern auf dem Unterschriftsfeld der Kreditkarte. Bei AMEX 4 Ziffern. |
CCExpiry | n6 | M | Ablaufdatum der Kreditkarte (YYYYMM), z.B. 201607 |
CCBrand | a..22 | M | Kartenmarke: VISA, MasterCard, AMEX, DINERS, Elo, Aura oder Hipercard. Bitte beachten Sie die Schreibweise! |
CreditCardHolder | ans..60 | M | Name des Karteninhabers |
Name | ans..128 | O | Name des Kunden. Wenn der Name nicht angegeben ist, wird CreditCardHolder übergeben. |
AddrStreet | ans..46 | M | Straßenname des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen) |
AddrCity | ans..40 | M | Ortsname des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen) |
AddrZip | ans..8 | M | Postleitzahl des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen) |
AddrState | a2 | M | Abkürzung des Bundesstaats des Kunden. Siehe obige Tabelle Bundesstaaten Brasiliens. (wenn mit PagBrasil und Computop abgesprochen) |
TaxNumber | n11/n14 | M | 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 (Optional, wenn mit PagBrasil und Computop abgesprochen) |
ans..128 | M | E-Mail-Adresse des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen) | |
Phone | ans..40 | M | Telefonnummer des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen) |
ChDesc | ans..12 | M | Text, der auf der Kreditkartenabrechnung des Kunden neben dem Zahlungsempfänger („PAGBRASIL“) steht. |
OrderDesc | ans..768 | M | Beschreibung der gekauften Waren, Einzelpreise usw. |
ArticleList | ans..254 | O | Beschreibung der gekauften Waren. Beispiel: Produktname;Anzahl+Produktname;Anzahl Das Produkt und die Anzahl werden auf der Abrechnung des Kunden angezeigt. |
ReqID | ans..32 | O | Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion mit derselben ReqID erneut eingereicht wird, führt das Paygate keine Zahlung aus sondern gibt nur den Status der ursprünglichen Transaktion zurück. Bitte beachten Sie, dass das Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. |
InstallmentNumber | n..2 | O | Anzahl Monate der Ratenzahlung (1-12), Standard=1. |
IPAddr | ans..45 | O | IP-Adresse des Gerätes des Kunden |
DeviceID | ans..128 | O | DeviceId des Gerätes des Kunden |
Parameter für Kreditkartenzahlungen mit PagBrasil über Socket-Verbindung
Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung. Wichtig für spätere Referenzierung |
XID | an32 | M | Vom Paygate vergebene ID für die Transaktion der Zahlung |
TransID | ans..64 | M | Transaktionsnummer des Händlers |
OrderID | an15 | M | Entspricht der RefNr oder TransID, je nachdem ob eine RefNr übergeben wurde oder nicht. |
Status | a..30 | M | OK oder FAILED |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
RefNr | ans..30 | O | Eindeutige Referenznummer des Händlers |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. |
PCNr | n..16 | O | Pseudo Card Number; vom Paygate generierte Zufallszahl, die eine reale Kreditkartennummer repräsentiert. Die Pseudokartennummer (PKN) beginnt mit 0, und die letzten 3 Stellen entspre-chen denen der realen Kartennummer. Die PKN können Sie wie eine reale Kartennummer für Autorisierung, Buchung und Gutschriften verwenden. |
CCBrand | a..22 | O | In Verbindung mit PCNr: Bezeichnung der Kreditkartenmarke wie VISA, MasterCard, AMEX, DINERS, Elo, Aura oder Hipercard |
CCExpiry | n6 | O | In Verbindung mit PCNr: Ablaufdatum der Kreditkarte im Format YYYYMM |
MaskedCCNr | an..19 | OC | Maskierte Kartennummer 6X4 |
Ergebnis-Parameter der Socket-Verbindung für PagBrasil
Zusätzlich zur Antwort auf die Sitzung der Zahlungsanfrage sendet das Paygate abhängig von der Kartenmarke und den Konfigurationseinstellungen des Händlers eine Benachrichtigung an die im Paygate hinterlegte bzw. im Parameter [URLNotify] angegebene URL. Dies ist generell der Fall, wenn es sich um Zahlungen mit einer Karte der Marke Hipercard (Itau) handelt.
Zudem sendet das Paygate Chargeback-Benachrichtigungen für alle unterstützten Kartenmarken an die URLNotify, wenn der betreffende Händler im Paygate entsprechend konfiguriert ist. Die Chargeback-Benachrichtigung enthält zusätzlich die Parameter
action=CHARGEBACK&chargebackamount={Wert}.
Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung. Wichtig für spätere Referenzierung |
XID | an32 | M | Vom Paygate vergebene ID für die Transaktion der Zahlung |
TransID | ans..64 | M | Transaktionsnummer des Händlers |
RefNr | ans..30 | O | Eindeutige Referenznummer des Händlers |
Status | a..30 | M | OK oder FAILED |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. |
Ergebnis-Parameter an URLNotify für PagBrasil-Zahlungen mit Hipercard
PagBrasilOTF Online-Überweisung
Um eine Zahlung mit PagBrasilOTF auszuführen, rufen Sie folgende URL auf:
Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.
Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
TransID | ans..64 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ans..30 | M | Eindeutige Referenznummer |
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. BRL Centavos). Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Currency | a3 | M | Währung, drei Zeichen DIN / ISO 4217. Nur BRL zulässig. |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
URLSuccess | ans..256 | M | 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. |
URLFailure | ans..256 | M | Vollständige URL, die das Paygate aufruft, 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. |
Response | a7 | O | Die Status-Rückmeldung, die das Paygate an URLSuccess und URLFailure sendet, sollte verschlüsselt werden. Dazu übergeben Sie den Parameter Response=encrypt. |
URLNotify | ans..256 | M | 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. |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop |
ReqID | ans..32 | O | Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion mit derselben ReqID erneut eingereicht wird, führt das Paygate keine Zahlung aus sondern gibt nur den Status der ursprünglichen Transaktion zurück. Bitte beachten Sie, dass das Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. |
Name | ans..128 | O | Name des Kunden |
AddrStreet | ans..46 | M | Straßenname des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen, jedoch nicht bei BankCode = U) |
AddrCity | ans..40 | M | Ortsname des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen, jedoch nicht bei BankCode = U) |
AddrZip | ans..8 | M | Postleitzahl des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen, jedoch nicht bei BankCode = U) |
AddrState | a2 | M | 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 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 (Optional, wenn mit PagBrasil und Computop abgesprochen, jedoch nicht bei BankCode = U) |
ans..128 | M | E-Mail-Adresse des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen, jedoch nicht bei BankCode = U) | |
Phone | ans..40 | M | Telefonnummer des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen, jedoch nicht bei BankCode = U) |
OrderDesc | ans..768 | M | Beschreibung der gekauften Waren, Einzelpreise usw. |
ArticleList | ans..254 | M | Beschreibung der gekauften Waren. Beispiel: Produktname;Anzahl+Produktname;Anzahl Das Produkt und die Anzahl werden auf der Abrechnung des Kunden angezeigt. |
BankCode | enum | M | Identifikation des Finanzinstituts des Kunden R = Bradesco Comércio Eletrônico E = Banco do Brasil Comércio Eletrônico S = Banricompras U = Itaú Shopline |
Plain | ans..50 | O | Ein von Händler zu setzender Wert, um Informationen wieder unverschlüsselt zurückzugeben, z.B. die MID |
Custom | ans..1024 | O | Der Händler kann mehrere Werte durch | getrennt übergeben, die unverschlüsselt durch & getrennt zurückgegeben werden. Custom=session=123|id=456 wird in der Antwort zu Session=123&id=456 |
Parameter für Online-Überweisungen mit PagBrasil
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate an Ihre URLSuccess, URLFailure und URLNotify übergibt. Wenn Sie den Parameter Response=encrypt angegeben haben, werden die folgenden Parameter mit Blowfish verschlüsselt an Ihr System übergeben:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien |
XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
TransID | ans..64 | M | Transaktionsnummer des Händlers |
OrderID | an15 | MC | Nicht an URLNotify: Entspricht der RefNr oder TransID, je nachdem ob eine RefNr übergeben wurde oder nicht. |
Status | a..30 | M | OK oder FAILED |
Description | ans..1024 | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! | |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
RefNr | ans..30 | O | Eindeutige Referenznummer des Händlers |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. |
Plain | ans..50 | O | Ein von Händler zu setzender Wert, um Informationen wieder unverschlüsselt zurückzugeben, z.B. die MID |
Custom | ans..1024 | O | Der Händler kann mehrere Werte durch | getrennt übergeben, die unverschlüsselt durch & getrennt zurückgegeben werden. Custom=session=123|id=456 wird in der Antwort zu Session=123&id=456 |
Rückgabeparameter für URLSuccess, URLFailure sowie URLNotify bei PagBrasilOTF
Barzahlung mit PagBrasil Boleto Bancário
Um eine Barzahlung mit PagBrasil Boleto Bancário (Brasilien) über eine Server-zu-Server-Verbindung auszuführen, rufen Sie folgende URL auf:
Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.
Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
TransID | ans..64 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ans..30 | M | Eindeutige Referenznummer. Das Format muss vorher mit Computop abgestimmt werden! |
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. BRL Centavos). Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Currency | a3 | M | Währung, drei Zeichen DIN / ISO 4217. Nur BRL zulässig. |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop |
URLNotify | ans..256 | O | 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. |
Name | ans..128 | M | Name des Kunden |
AddrStreet | ans..46 | M | Straßenname des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen) |
AddrCity | ans..40 | M | Ortsname des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen) |
AddrZip | ans..8 | M | Postleitzahl des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen) |
AddrState | a2 | M | Abkürzung des Bundesstaats des Kunden. Siehe obige Tabelle Bundesstaaten Brasiliens. (Optional, wenn mit PagBrasil und Computop abgesprochen) |
TaxNumber | n11/n14 | M | 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 (Optional, wenn mit PagBrasil und Computop abgesprochen) |
ans..128 | M | E-Mail-Adresse des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen) | |
Phone | ans..40 | M | Telefonnummer des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen) |
OrderDesc | ans..768 | M | Beschreibung der gekauften Waren, Einzelpreise usw. |
ArticleList | ans..254 | M | Beschreibung der gekauften Waren. Beispiel: Produktname;Anzahl+Produktname;Anzahl Das Produkt und die Anzahl werden auf der Abrechnung des Kunden angezeigt. |
Expiration | n..3 | O | Anzahl der Tage, wie lange der Zahlschein gilt |
ReqID | ans..32 | O | Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion mit derselben ReqID erneut eingereicht wird, führt das Paygate keine Zahlung aus sondern gibt nur den Status der ursprünglichen Transaktion zurück. Bitte beachten Sie, dass das Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. |
Custom | ans..1024 | O | Der Händler kann mehrere Werte durch | getrennt übergeben, die unverschlüsselt durch & getrennt zurückgegeben werden. Custom=session=123|id=456 wird in der Antwort zu Session=123&id=456 |
Parameter für Zahlungen mit Boleto Bancário über Socket-Verbindung
Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien |
XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
TransID | ans..64 | M | Transaktionsnummer des Händlers |
OrderID | an15 | M | Entspricht der RefNr oder TransID, je nachdem ob eine RefNr übergeben wurde oder nicht. |
Status | a..30 | M | OK oder FAILED |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
RefNr | ans..30 | O | Referenznummer des Händlers |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. |
PaymentSlipLink | ans..256 | M | Vollständige URL (URL-encoded) für die Seite, die den Zahlschein darstellt |
Ergebnis-Parameter der Socket-Verbindung für Boleto Bancário
Die folgende Tabelle beschreibt die Parameter, die das Paygate an URLNotify übergibt:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien |
XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
TransID | ans..64 | M | Transaktionsnummer des Händlers |
Status | a..30 | M | OK oder FAILED |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
RefNr | ans..30 | O | Referenznummer des Händlers |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. |
PaymentSlipLink | ans..256 | M | Vollständige URL (URL-encoded) für die Seite, die den Zahlschein darstellt |
AmountAuth | n..10 | M | Autorisierter Betrag in der kleinsten Währungseinheit (z.B. BRL Centavos) |
AmountCap | n..10 | M | 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 | Gutgeschriebener Betrag in der kleinsten Währungseinheit (z.B. BRL Centavos) |
Custom | ans..1024 | O | Der Händler kann mehrere Werte durch | getrennt übergeben, die unverschlüsselt durch & getrennt zurückgegeben werden. Custom=session=123|id=456 wird in der Antwort zu Session=123&id=456 |
PaymentDate | dttm | M | Datum, wann der Kunde mit Boleto Bancário bezahlt hat. Format: JJJJ-MM-TT. |
Rückgabeparameter an URLNotify für Zahlungen mit Boleto Bancário
Barzahlung mit PagBrasil PEC Flash
Um eine Barzahlung mit PagBrasil PEC Flash auszuführen, rufen Sie folgende URL auf:
Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.
Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
TransID | ans..64 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ans..30 | M | Eindeutige Referenznummer |
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. BRL Centavos). Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Currency | a3 | M | Währung, drei Zeichen DIN / ISO 4217. Nur BRL zulässig. |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop |
URLNotify | ans..256 | O | 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. |
Name | ans..128 | M | Name des Kunden |
AddrStreet | ans..46 | C | Straßenname des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen) |
AddrCity | ans..40 | C | Ortsname des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen) |
AddrZip | ans..8 | C | Postleitzahl des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen) |
AddrState | a2 | C | Abkürzung des Bundesstaats des Kunden. Siehe obige Tabelle Bundesstaaten Brasiliens. (Optional, wenn mit PagBrasil und Computop abgesprochen) |
TaxNumber | n11/n14 | C | 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 (Optional, wenn mit PagBrasil und Computop abgesprochen) |
ans..128 | C | E-Mail-Adresse des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen) | |
Phone | ans..40 | C | Telefonnummer des Kunden (Optional, wenn mit PagBrasil und Computop abgesprochen) |
OrderDesc | ans..768 | M | Beschreibung der gekauften Waren, Einzelpreise usw. |
ArticleList | ans..254 | M | Beschreibung der gekauften Waren. Beispiel: Produktname;Anzahl+Produktname;Anzahl Das Produkt und die Anzahl werden auf der Abrechnung des Kunden angezeigt. |
Expiration | n..3 | O | 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. |
ReqID | ans..32 | O | Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion mit derselben ReqID erneut eingereicht wird, führt das Paygate keine Zahlung aus sondern gibt nur den Status der ursprünglichen Transaktion zurück. Bitte beachten Sie, dass das Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. |
Custom | ans..1024 | O | Der Händler kann mehrere Werte durch | getrennt übergeben, die unverschlüsselt durch & getrennt zurückgegeben werden. Custom=session=123|id=456 wird in der Antwort zu Session=123&id=456 |
Parameter für Zahlungen mit PEC Flash
Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien |
XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
TransID | ans..64 | M | Transaktionsnummer des Händlers |
Status | a..30 | M | OK oder FAILED |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
RefNr | ans..30 | O | Referenznummer des Händlers |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. |
OrderID | an15 | M | Entspricht der RefNr oder TransID, je nachdem ob eine RefNr übergeben wurde oder nicht |
TransactionID | ans..17 | O | 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. |
CompanyID | ans..10 | O | Firmencode zur Verwendung auf der Bestätigungsseite für den Käufer als Teil der Zahlungsinformationen für das Lotteriegeschäft |
Note | ans..254 | O | 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. |
Rückgabeparameter für Zahlungen mit PEC Flash
Die folgende Tabelle beschreibt die Parameter, die das Paygate an URLNotify übergibt:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien |
XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
TransID | ans..64 | M | Transaktionsnummer des Händlers |
Status | a..30 | M | OK oder FAILED |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
RefNr | ans..30 | O | Referenznummer des Händlers |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop. |
TransactionID | ans..17 | O | 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. |
CompanyID | ans..10 | O | Firmencode zur Verwendung auf der Bestätigungsseite für den Käufer als Teil der Zahlungsinformationen für das Lotteriegeschäft |
Note | ans..254 | O | 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. |
Custom | ans..1024 | O | Der Händler kann mehrere Werte durch | getrennt übergeben, die unverschlüsselt durch & getrennt zurückgegeben werden. Custom=session=123|id=456 wird in der Antwort zu Session=123&id=456 |
AmountAuth | n..10 | M | Autorisierter Betrag in der kleinsten Währungseinheit (z.B. BRL Centavos) |
AmountCap | n..10 | M | 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 | Gutgeschriebener Betrag in der kleinsten Währungseinheit (z.B. BRL Centavos) |
PaymentDate | dttm | M | Datum, wann der Kunde mit PEC Flash bezahlt hat. Format: JJJJ-MM-TT. |
Rückgabeparameter an URLNotify für Zahlungen mit PEC Flash
Aktualisieren einer Zahlung mit PEC Flash
Um einen Zahlschein für PEC Flash über eine Server-zu-Server-Verbindung zu verlängern, verwenden Sie bitte folgende URL:
Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.
Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung |
Expiration | n1 | M | Anzahl der Tage, die zum aktuellen Ablaufdatum hinzugefügt werden sollen (maximal 5) |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
Parameter für Aktualisierung von Zahlungen mit PEC Flash
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien |
XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
TransID | ans..64 | M | Transaktionsnummer des Händlers |
Status | a..30 | M | OK oder FAILED |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
OrderID | an15 | M | Entspricht der RefNr oder TransID, je nachdem ob eine RefNr übergeben wurde oder nicht |
PaymentSlipLink | ans..256 | C | Vollständige URL zum PDF-Dokument, welches den Zahlschein mit dem Barcode darstellt. Nur bei Boleto Bancário. |
Ergebnis-Parameter für die Aktualisierung von Zahlungen mit PEC Flash
Buchung einer Kreditkartenzahlung mit PagBrasil
Buchungen sind über eine Server-zu-Server-Kommunikation möglich. Um eine Buchung (Capture) für eine PagBrasil-Kreditkartenzahlung über eine Server-zu-Server-Verbindung auszuführen, verwenden Sie bitte folgende URL:
Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.
Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
PayID | an32 | M | Vom Paygate vergebene ID für die zu buchende Transaktion |
TransID | ans..64 | M | Vom Händler initial vergebene ID für den zu buchenden Zahlungsvorgang |
RefNr | ans..30 | O | Eindeutige Referenznummer |
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. BRL Centavos) Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Currency | a..3 | M | Währungskürzel, drei Zeichen DIN / ISO 4217. Nur BRL zulässig. |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
ReqID | ans..32 | O | Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion mit derselben ReqID erneut eingereicht wird, führt das Paygate keine Zahlung aus sondern gibt nur den Status der ursprünglichen Transaktion zurück. Bitte beachten Sie, dass das Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. |
Parameter für Buchungen von PagBrasil, PagBrasilOTF sowie Boleto Bancário
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien |
XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
TransID | ans..64 | M | Transaktionsnummer des Händlers |
Status | a..30 | M | OK oder FAILED |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
RefNr | ans..30 | O | Referenznummer des Händlers |
OrderID | an15 | MC | Entspricht der RefNr oder TransID, je nachdem ob eine RefNr übergeben wurde oder nicht. |
Ergebnis-Parameter für Buchungen von PagBrasil, PagBrasilOTF sowie Boleto Bancário
Gutschrift mit Referenz
Gutschriften sind über eine Server-zu-Server-Kommunikation möglich. Bei einer Gutschrift mit Bezug auf eine Buchung ist die Höhe der Gutschrift auf die Höhe der vorangegangen Buchung beschränkt.
Gutschriften sind bei Kreditkarten bis zu 90 Tagen auf die bei der Zahlung angegebene Kreditkarte und bei Debitkarten nur am selben Tag möglich. Später ist eine Gutschrift nur mit den optionalen Parametern AccNr, AccBankName und AccBIC möglich. Diese müssen vom Kunden erfragt werden, da bei der Zahlung keine Daten für eine Gutschrift vorhanden sind. Bei Gutschriften für Zahlungen mit PagBrasilOTF sowie Boleto Bancário liegen ebenfalls keine Daten für eine Gutschrift vor. Auch hier müssen die Angaben vom Kunden erfragt und in den Parametern AccNr, AccBankName und AccBIC übergeben werden.
Um eine Gutschrift (Credit) mit Referenztransaktion auszuführen, verwenden Sie bitte folgende URL:
Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.
Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
PayID | an32 | M | Vom Paygate vergebene ID für die gutzuschreibende Transaktion |
TransID | ans..64 | M | Vom Händler initial vergebene ID für den gutzuschreibenden Zahlungsvorgang |
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. BRL Centavos) Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Currency | a..3 | M | Währungskürzel, drei Zeichen DIN / ISO 4217. Bei PagBrasilOTF und BoletoBancário ist nur BRL zulässig. |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
CredNo | ans.. | OC | Nicht bei PagBrasilOTF/Boleto Bancário: Kreditnummer. Wird auf den Wert „0“ gesetzt, falls nicht übermittelt. |
RefNr | ans..30 | OC | Nur bei PagBrasilOTF und Boleto Bancário: Referenznummer (z.B. Rechnungsnummer), die für jede Retoure eindeutig sein muss |
AccBankName | ans..40 | O | Bankname des Kunden |
AccNr | ans..12 | O | Kontonummer des Kunden (muss Bindestrich enthalten, z.B. 12345-6) |
AccBIC | ans..12 | O | Bankleitzahl bzw. Filialnummer der Bank |
ReqID | ans..32 | O | Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion mit derselben ReqID erneut eingereicht wird, führt das Paygate keine Zahlung aus sondern gibt nur den Status der ursprünglichen Transaktion zurück. Bitte beachten Sie, dass das Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. |
Parameter für Gutschrift von Zahlungen mit PagBrasil, PagPrasilOTF sowie Boleto Bancário
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien |
XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
TransID | ans..64 | M | Transaktionsnummer des Händlers |
Status | a..30 | M | OK oder FAILED |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
RefNr | ans..30 | OC | Nur bei PagBrasilOTF und Boleto Bancário: Referenznummer des Händlers |
OrderID | an15 | MC | Entspricht der RefNr oder TransID, je nachdem ob eine RefNr übergeben wurde oder nicht. |
Antwort-Parameter für Gutschrift von Zahlungen mit PagBrasil, PagPrasilOTF sowie Boleto Bancário
Batch-Nutzung der Schnittstelle
Grundsätzliche Informationen zur Arbeit mit Batch-Dateien sowie zu deren Aufbau erfahren Sie im separaten Handbuch zum Batchmanager. Im Batch-Verfahren sind nicht alle Funktionen verfügbar, die für die Online-Schnittstelle verfügbar sind.
Dieses Kapitel beschreibt die Parameter, die Sie im Datensatz (Record) für die Ausführung von Zahlungen / Gutschriften mit PagBrasil, PagBrasilOTF sowie Boleto Bancário übergeben müssen und welche Informationen Sie der Antwort-Datei über den Status des Zahlungsvorgangs entnehmen können.
Folgende Tabelle gibt eine Übersicht der pro Aktion jeweils möglichen Batch-Versionen und ihrer Besonderheiten:
Aktion | Version | Beschreibung |
---|---|---|
Credit | 1.0 / 2.0 | Standardversion ohne Rückgabe von Code |
| 1.x / 2.x | mit RefNr (gilt für alle Versionen außer 1.0) |
Beschreibung der möglichen Batch-Versionen
Der Aufbau für eine Zahlung mit PagBrasil in einer einzureichenden Batch-Datei sieht folgendermaßen aus:
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> |
Beispiel für Master MID Funktion:
HEAD,[Master]MerchantID,Date,2.x Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action) FOOT,CountRecords,SumAmount |
Die folgende Tabelle beschreibt die einzelnen Felder und Werte, die im Datensatz (Record) innerhalb der Batch-Datei verwendet werden:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
Type | a..11 | M | 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 | 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. |
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent) Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Currency | a3 | M | Währungskürzel, drei Zeichen DIN / ISO 4217 |
TransID | ans..64 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ns..30 | O | eindeutige Referenznummer |
PayID | an32 | M | Vom Paygate vergebene ID für diese Transaktion |
AccBankName | ans..40 | M | Bankname des Kunden |
AccNr | ans..12 | M | Kontonummer des Kunden (muss Bindestrich enthalten, z.B. 12345-6) |
AccBIC | ans..12 | M | Bankleitzahl bzw. Filialnummer der Bank |
Beschreibung der Felder im Datensatz von Batch-Dateien
Der Record-Bereich in der Antwort-Datei zu Batch-Transaktionen sieht folgendermaßen aus:
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> |
Die folgende Tabelle beschreibt die Antwort-Parameter, die der Batch-Manager im Record-Bereich zu jeder Transaktion speichert (hier nicht erklärte Standardparameter wie etwa <TransID> oder <RefNR> und Aufrufparameter, werden unverändert zum Aufruf wieder zurückgegeben und sind vorstehend beschrieben):
Parameter | Format | CND | Beschreibung |
---|---|---|---|
Action | a..20 | M | Der Action-Parameter definiert die Art der Transaktion: Capture (Buchung) Credit (Gutschrift) |
PayID | an32 | M | Vom Paygate vergebene ID für diese Transaktion |
Status | a..50 | M | OK oder FAILED |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
Beschreibung der Ergebnis-Parameter im Datensatz von Batch-Dateien