Page tree

Search

Skip to end of metadata
Go to start of metadata


Über Boleto Bancário

Allgemeines zu Boleto Bancário


Logo
Info

Boleto Bancário ist die bevorzugte brasilianische Zahlungsmethode, die als eine 'Pro-forma Rechnung' funktioniert. Brasilianische Kunden können ihre Online-Käufe durch Barzahlung in einem Geschäft oder mittels Online-Banking abschließen.

TypZahlungen per Bargeld / Rechnung


Diagramm zum Prozessablauf

Boleto Bancário Prozessablauf


Paygate-Schnittstelle

Definitionen

Datenformate:

FormatBeschreibung

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:

AbkürzungBeschreibung

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.


Zahlung mit Boleto Bancário via Formular-Schnittstelle

Um in Brasilien eine Zahlung mit Boleto Bancário abzuwickeln, 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, die eindeutig sein muss

RefNr

ans..40

O

Eindeutige Referenznummer. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt.

Amount

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. USD Cent).

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

OrderDesc

ans..768

M

Beschreibung der Waren, Einzelpreise usw., Verwendungszweck auf dem Kontoauszug

SellingPoint

ans..50

O

Verkaufsstelle

Service

ans..50

O

verkaufte Produkte oder Dienstleistung

Channel

ans..64

O

Konfigurationskanal des PPRO-Vertrags (Account und ContractID sind im System hinterlegt). Wenn vorhanden, überschreibt er eventuell im System hinterlegten Channel.

Languagea2O2-stelliger Sprachcode (z.B. de), der für die Zahlungsseiten für den Kunden bevorzugt werden soll

AccOwner

ans..50

M

Name des Kontoinhabers

Email

ans..100

M

E-Mail-Adresse des Kontoinhabers

SocialSecurityNumber

ans..30

M

Sozialversicherungsnummer

CustomerID

ans..20

M

Kundennummer: Nummer zur Identifizierung des Kunden

DateOfBirth

n8

O

Geburtsdatum des Kunden im Format YYYYYMMDD

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 Zahlungen mit Boleto Bancário


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

RefNr

ans..40

O

Referenznummer des Händlers. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt.

Status

a..30

M

OK bei URLSuccess und AUTHORIZE_REQUEST oder FAILED bei URLFailure

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

UserData

ans..1024

O

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

PaymentPurpose

ans..26

M

Zahlungszweck

PaymentGuarantee

a..12

C

NONE = keine Zahlungsgarantie,

VALIDATED = Kundenkonto valide, aber keine Zahlungsgarantie,

FULL = Zahlungsgarantie

Hinweis: Dieser Parameter wird nur zurückgegeben, falls der Status=OK ist.

ErrorText

ans..256

C

Detaillierte PPRO Fehlermeldung.

Hinweis: Wird nur bei Status=FAILED zurückgegeben. Nutzung nur in Abstimmung mit dem Computop Support möglich.

TransactionID

an..20

O

Eindeutige Transaktionsnummer bei PPRO

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

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

TransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

ans..40

O

Referenznummer des Händlers. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt.

Amount

n..10

M

Betrag in der kleinsten Währungseinheit (z.B. USD Cent)

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

MAC

an64

M

Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus

ReqIDans..32OUm 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 Boleto Bancário über Socket-Verbindungen


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

O

Referenznummer des Händlers. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt.

ErrorText

ans..256

O

detaillierte PPRO Fehlermeldung

TransactionID

an..20

O

Eindeutige Transaktionsnummer bei PPRO

Antwort-Parameter für Gutschrift von Zahlungen mit Boleto Bancário über Socket-Verbindungen