Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space ENWORK and version Documentation
Table of Contents


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.


Page properties
Logo

Image Modified nullImage Added

Info
Excerpt

Payments with the Brazilian credit cards Hipercard, Elo and Aura can be processed via the

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
.
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
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
Multiexcerpt
MultiExcerptNameCard Scheme
Card Scheme
VISA
MasterCard
AMEX

Diners

Elo
Aura
Hipercard

Process flow chart

Multiexcerpt
MultiExcerptNameProcessFlow_PagBrasilOTF

draw.io Diagram
bordertrue
diagramNamePagBrasil_CT
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1389

PagBrasilOTF process flow


Multiexcerpt
MultiExcerptNameProcessFlow_BoletoBancario

draw.io Diagram
bordertrue
diagramNamePagBrasil_Boleto_CT
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1389

PagBrasil Boleto Bancário process flow



Multiexcerpt
MultiExcerptNameProcessFlow_PIX

draw.io Diagram
bordertrue
diagramNamePagBrasil_PIX_CT
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1389

PagBrasil PIX process flow


Multiexcerpt-include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
interface

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameDefinition
PageWithExcerptDefinition EN


Credit card payment with PagBrasil via form interface

Payments with PagBrasil are made via the standard

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
form interface for credit card payments. In order to execute an SSL credit card payment with PagBrasil via a
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
form, please use the following URL:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
payssl.aspx

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1660056573998_1768188480
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepagbrasil_payssl_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1660056574000_-484546997
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

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

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameURLSuccess
pageURLSuccess
typepage

Table Excerpt Include
statictrue
nameURLFailure
pageURLFailure
typepage

Table Excerpt Include
statictrue
nameResponse
pageResponse
typepage

Table Excerpt Include
statictrue
nameURLNotify
pageURLNotify
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Table Excerpt Include
statictrue
nameCapture
pageCapture
typepage

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgesprochen)

AddrCity

ans..40

M

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

Ortsname des Kunden (Optional, wenn mit PagBrasil und

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgesprochen)

AddrZip

ans..8

M

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

Postleitzahl des Kunden (Optional, wenn mit PagBrasil und

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
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

(Optional, if agreed with PagBrasil and

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgesprochen)

eMail

ans..128

M

Customer's email address (Optional, if

eMail

ans..128

M

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgesprochen)

Phone

ans..40

M

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

Telefonnummer des Kunden (Optional, wenn mit PagBrasil und

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
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.

Table Excerpt Include
statictrue
namePlain
pagePlain
typepage

Table Excerpt Include
statictrue
nameCustom
pageCustom
typepage

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


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameLayout_Intro
PageWithExcerptReuse API

Table Filter
inversefalse
sparkNameSparkline
hidePanetrue
separatorPoint (.)
ddSeparatorstrue
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
datepatterndd M yy
id1660040633035_-1663448458
worklog365|5|8|y w d h m|y w d h m
isORAND
order0
Multiexcerpt
MultiExcerptNamepayssl_layout
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1660040633037_288686471
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameTemplate
pageTemplate
typepage

Table Excerpt Include
statictrue
nameBackground
pageBackground
typepage

Table Excerpt Include
statictrue
nameBGColor
pageBGColor
typepage

Table Excerpt Include
statictrue
nameBGImage
pageBGImage
typepage

Table Excerpt Include
statictrue
nameFColor
pageFColor
typepage

Table Excerpt Include
statictrue
nameFFace
pageFFace
typepage

Table Excerpt Include
statictrue
nameFSize
pageFSize
typepage

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

Table Excerpt Include
statictrue
nameURLBack
pageURLBack
typepage

Table Excerpt Include
statictrue
nameCenter
pageCenter
typepage

Table Excerpt Include
statictrue
nametWidth
pagetWidth
typepage

Table Excerpt Include
statictrue
nametHeight
pagetHeight
typepage

Table Excerpt Include
statictrue
nameCustomField[n]
pageCustomField[n]
typepage

Layout parameters for

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
forms for credit card payments with PagBrasil


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_IntroURL
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1660057553903_1884817258
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepagbrasil_payssl_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1660057553905_658963217
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

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

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
namePCNr
pagePCNr
typepage

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

Table Excerpt Include
statictrue
namePlain
pagePlain
typepage

Table Excerpt Include
statictrue
nameCustom
pageCustom
typepage

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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
direct.aspx

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1660194415332_170907478
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepagbrasil_direct_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1660194415334_1154801178
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

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

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Key

Format

CND

Description

Beschreibung

URLNotify

ans..256

O

Complete URL which 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
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
    Multiexcerpt include
    SpaceWithExcerptEN
    MultiExcerptNamePlatform-Kurz
    PageWithExcerptWording
  • 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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePlatform-Kurz
PageWithExcerptDE:Wording
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
    Multiexcerpt include
    SpaceWithExcerptDE
    MultiExcerptNamePlatform-Kurz
    PageWithExcerptDE:Wording
    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.

Table Excerpt Include
statictrue
nameURLNotify
pageURLNotify
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Table Excerpt Include
statictrue
nameCapture
pageCapture
typepage

)

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

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgesprochen)

AddrCity

ans..40

M

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

Ortsname des Kunden (Optional, wenn mit PagBrasil und

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgesprochen)

AddrZip

ans..8

M

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

Postleitzahl des Kunden (Optional, wenn mit PagBrasil und

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
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(Optional, if agreed with PagBrasil and multiexcerpt-include

SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording

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, wenn mit PagBrasil und if agreed with PagBrasil and

Multiexcerpt include
SpaceWithExcerptDEEN
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgesprochen)

eMail

ans..128

M

Customer's email address (Optional, if agreed with PagBrasil and multiexcerpt-include

SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgesprochen)

Phone

ans..40

M

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

Telefonnummer des Kunden (Optional, wenn mit PagBrasil und

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
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


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1660196066594_1559368545
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepagbrasil_direct_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1660196066596_-1248266242
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

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.

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
namePCNr
pagePCNr
typepage

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,

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
sends a notification to the URL deposited in
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
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,

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
sends chargeback notifications to the URLNotify for all supported card brands, if the merchant in question is correspondingly configured in
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
. The chargeback notification contains these parameters

action=CHARGEBACK&chargebackamount={value}.

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1660197739527_2106088351
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepagbrasil_direct_notify
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1660197739529_-536892225
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
BrazilOTF.aspx

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1660198958199_150027158
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepagbrasil_otf_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1660198958202_-219980262
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

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

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameURLSuccess
pageURLSuccess
typepage

Table Excerpt Include
statictrue
nameURLFailure
pageURLFailure
typepage

Table Excerpt Include
statictrue
nameResponse
pageResponse
typepage

Table Excerpt Include
statictrue
nameURLNotify
pageURLNotify
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

, but not for BankCode = U)

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
, but not for BankCode = U)

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgesprochen, jedoch nicht bei BankCode = U)

AddrCity

ans..40

M

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
, but not for BankCode = U)

Ortsname des Kunden (Optional, wenn mit PagBrasil und

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgesprochen, jedoch nicht bei BankCode = U)

AddrZip

ans..8

M

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
, but not for BankCode = U)

Postleitzahl des Kunden (Optional, wenn mit PagBrasil und

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
, but not for BankCode = U)

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
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(Optional, if agreed with PagBrasil and multiexcerpt-include

SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgesprochen, jedoch nicht bei BankCode = U)

eMail

ans..128

M

Customer's email address (Optional, if

eMail

ans..128

M

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
, but not for BankCode = U)

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgesprochen, jedoch nicht bei BankCode = U)

Phone

ans..40

M

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
, but not for BankCode = U)

Telefonnummer des Kunden (Optional, wenn mit PagBrasil und

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
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

Table Excerpt Include
statictrue
namePlain
pagePlain
typepage

Table Excerpt Include
statictrue
nameCustom
pageCustom
typepage

Parameters for online transfers with PagBrasil


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_IntroURL
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1660199489208_1156184708
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepagbrasil_otf_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1660199489212_-2115976033
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

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.

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
namePlain
pagePlain
typepage

Table Excerpt Include
statictrue
nameCustom
pageCustom
typepage

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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
BoletoBancario.aspx

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1662388124319_560409889
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepagbrasil_boleto_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1662388124321_1006564547
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ans..30

M

Unique reference number. Format must be mutually agreed beforehand with

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
!

Eindeutige Referenznummer. Das Format muss vorher mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgestimmt werden!

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

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

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
nameURLNotify
pageURLNotify
typepage

)

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgesprochen)

AddrCity

ans..40

M

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

Ortsname des Kunden (Optional, wenn mit PagBrasil und

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgesprochen)

AddrZip

ans..8

M

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

Postleitzahl des Kunden (Optional, wenn mit PagBrasil und

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
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(Optional, if agreed with PagBrasil and

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording

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, wenn mit PagBrasil und if agreed with PagBrasil and

Multiexcerpt include
Customer's email address (Optional, if agreed with PagBrasil and
Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgesprochen)

eMail

ans..128

M

SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgesprochen)

Phone

ans..40

M

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

Telefonnummer des Kunden (Optional, wenn mit PagBrasil und

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
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..34ONumber of days for which the payment form is validAnzahl der Tage, wie lange der Zahlschein giltdas Zahlungsformular gültig ist

Table Excerpt Include
statictrue
nameCustom
pageCustom
typepage

Parameters for payments with Boleto Bancário via socket connection


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1662389006952_-1819681736
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepagbrasil_boleto_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1662389006955_-984789042
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

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.

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
transfers to URLNotify:

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1662389975928_1614834066
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepagbrasil_boleto_notify
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1662389975930_1944203823
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

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.

Table Excerpt Include
statictrue
nameCustom
pageCustom
typepage

Response parameters to URLNotify for payments with Boleto Bancário

 


PIX

Cash

payment with PagBrasil

PEC Flash

In order to execute a cash PIX payment with PagBrasil PEC Flashvia a server-to-server connection, please use the following URL:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
PECFlashpix.aspx

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id16624569781051669701341262_489799282705190437
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepagbrasil_pecflashpix_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id16624569781081669701341264_2124974776-891914210
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

name
Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage
Table Excerpt Include
statictrue

Key

Format

CND

Description

Beschreibung

RefNr

ans..30

M

Unique reference number. Format must be mutually agreed beforehand with

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
!

Eindeutige Referenznummer. Das Format muss vorher mit

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgestimmt werden!

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

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

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
nameURLNotify
pageURLNotify
typepage

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgesprochen)

AddrCity

ans..40

M

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

Ortsname des Kunden (Optional, wenn mit PagBrasil und

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgesprochen)

AddrZip

ans..8

M

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

Postleitzahl des Kunden (Optional, wenn mit PagBrasil und

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgesprochen)

Phone

ans..40

M

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

Telefonnummer des Kunden (Optional, wenn mit PagBrasil und

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
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..4ONumber of minutes for which the payment form is valid. the value can be from 1 to 7200.Anzahl der Minuten, wie lange der Zahlschein gilt. Der Wert kann zwischen 1 und 7200 liegen.

Table Excerpt Include
statictrue
nameCustom
pageCustom
typepage

Parameters for payments with PIX via PagBrasil via socket connection


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1669701379014_677475736
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepagbrasil_pix_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1669701379017_393457513
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

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.

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Key

Format

CND

Description

Beschreibung

QRCodeUrlans..80CPix QR Code image linkLink zum Bild des Pix QR-Codes
QRCodeIDans..254CAlternative code for mobile users to complete the payment when they cannot scan the codeAlternativer Code für mobile Benutzer, um die Zahlung abzuschließen, wenn sie den Code nicht scannen können
ExpirationDateans10C

Last date to pay the PagBrasil Pix.

Format: MM/DD/YYYY

Letzter Tag zur Zahlung des PagBrasil Pix.

Format: MM/TT/JJJJ

ExpirationTimeans5C

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

Format: HH:MM.

Maximale Uhrzeit am Ablaufdatum, bis wann PagBrasil Pix bezahlt werden kann.

Format: HH:MM.

Results parameters for socket connection for PIX via PagBrasil


The following table describes the parameters which the

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
transfers to URLNotify:

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1669701423810_-400994883
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepagbrasil_pix_notify
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1669701423813_-1666081960
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Key

Format

CND

Description

Beschreibung

QRCodeUrlans..80CPix QR Code image linkLink zum Bild des Pix QR-Codes
QRCodeIDans..254CAlternative code for mobile users to complete the payment when they cannot scan the codeAlternativer Code für mobile Benutzer, um die Zahlung abzuschließen, wenn sie den Code nicht scannen können
ExpirationDateans10C

Last date to pay the PagBrasil Pix.

Format: MM/DD/YYYY

Letzter Tag zur Zahlung des PagBrasil Pix.

Format: MM/TT/JJJJ

ExpirationTimeans5C

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

Format: HH:MM.

Maximale Uhrzeit am Ablaufdatum, bis wann PagBrasil Pix bezahlt werden kann.

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 PagBrasil Pix was paid by the customer. Format: YYYY-MM-DD.Datum, wann der Kunde mit PagBrasil Pix bezahlt hat. Format: JJJJ-MM-TT.

Table Excerpt Include
statictrue
nameCustom
pageCustom
typepage

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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
PECFlash.aspx

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1662456978105_489799282
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepagbrasil_pecflash_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1662456978108_2124974776
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameAmount
pagerefnr
typepage
Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

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

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
nameURLNotify
pageURLNotify
typepage

PageWithExcerpt)

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgesprochen)

AddrCity

ans..40

C

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

Ortsname des Kunden (Optional, wenn mit PagBrasil und

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgesprochen)

AddrZip

ans..8

C

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

Postleitzahl des Kunden (Optional, wenn mit PagBrasil und

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
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(Optional, if agreed with PagBrasil and

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
Wording

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

12312312312

CNPJ: 14 Zeichen, ohne Trennzeichen, z.B. 12345678000123(Optional, wenn mit PagBrasil und

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgesprochen)

eMail

ans..128

C

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

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

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
abgesprochen)

Phone

ans..40

C

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
)

Telefonnummer des Kunden (Optional, wenn mit PagBrasil und

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePartner-Name
PageWithExcerptDE:Wording
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.

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Table Excerpt Include
statictrue
nameCustom
pageCustom
typepage

Parameters for payments with PEC Flash


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1662457370562_-65282537
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepagbrasil_pecflash_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1662457370564_1739522658
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
transfers to URLNotify:

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1662457612240_1661096763
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamepagbrasil_pecflash_notify
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1662457612242_-397911099
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

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.

Table Excerpt Include
statictrue
nameCustom
pageCustom
typepage

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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
PagBrasilUpdate.aspx

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1660043497689_1768188480
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameupdate_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1660043497691_-484546997
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

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)

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Parameters for updating payments with PEC Flash


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1660043621064_-69479331
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameupdate_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1660043621066_1474681449
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
capture.aspx

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1660038493530_584384591
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecapture_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1660038493533_-664211356
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
namePayID_Capture
pagePayID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

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

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

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

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1660038661254_-1060532319
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecapture_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1660038661256_-1749737691
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
credit.aspx

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1660036349235_-782154819
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecredit_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1660036349237_-599559298
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
namePayID_Credit
pagePayID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

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

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

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

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1660036625882_-592594173
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamecredit_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1660036625885_1134988777
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBatch_Intro
PageWithExcerptReuse API

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:

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1660041060805_-907735430
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamebatch_versions
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1660041060808_-1976360185
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

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:

Multiexcerpt
MultiExcerptNamebatch_structure
shouldDisplayInlineCommentsInIncludesfalse
Code Block
languagexml
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:

Multiexcerpt
MultiExcerptNamebatch_MasterMid
shouldDisplayInlineCommentsInIncludesfalse
Code Block
languagexml
HEAD,[Master]MerchantID,Date,2.x
Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action)
FOOT,CountRecords,SumAmount


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBatch_Request_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1660041246531_1917292575
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamebatch_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1660041246534_-697401465
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

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.

Table Excerpt Include
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
namePayID_Batch
pagePayID
typepage

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:

Multiexcerpt
MultiExcerptNamebatch_structure_response
shouldDisplayInlineCommentsInIncludesfalse
Code Block
languagexml
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>


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBatch_Response_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1660041504943_-1656731550
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamebatch_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1660041504945_-720818895
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

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)

Table Excerpt Include
statictrue
namePayID_Batch
pagePayID
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Description of result parameters within the record for Batch files