Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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

Info


Excerpt

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

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


TypTypePayments by Credit Card EN




Process flow chart


PagBrasilOTF process flow

 


PagBrasil Boleto Bancário process flow


Paygate interface

Multiexcerpt include
SpaceWithExcerptDOCCT
MultiExcerptNameDefinition
PageWithExcerptDefinition EN


Credit card payment with PagBrasil via Paygate form interface

Payments with PagBrasil are made via the standard Paygate form interface for credit card payments. In order to execute an SSL credit card payment with PagBrasil via a Paygate form, visit the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ans..30

M

Merchant’s unique reference number

Amount

n..10

M

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

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

Currency

a3

M

Currency, three digits DIN / ISO 4217. Only BRL permitted.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

URLSuccess

ans..256

M

Complete URL which calls up Paygate if payment has been successful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

URLFailure

ans..256

M

Complete URL which calls up Paygate if payment has been unsuccessful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

Response

a7

O

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

URLNotify

ans..256

M

Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead.

UserData

ans..1024

O

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

Capture

ans..6

O

Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696). For transactions with Hipercard only AUTO is possible.

CreditCardHolder

ans..60

M

Name of the card holder

Name

ans..128

O

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

AddrStreet

ans..46

M

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

AddrCity

ans..40

M

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

AddrZip

ans..8

M

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

AddrState

a2

M

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

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

eMail

ans..128

M

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

Phone

ans..40

M

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

ChDesc

ans..12

M

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

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

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.

ReqID

ans..32

O

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

InstallmentNumber

n..2

O

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

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Parameters for credit card payments with PagBrasil


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

Parameter

Format

CND

Description

Template

ans..20

M

Name of XSLT-file with your own layout for the pay form. If you want to use the redesigned and downwards compatible Computop template, please transfer the template name “ct_compatible”. If you want to use the responsive Computop template for mobile devices, please transfer the template name “ct_responsive”.

Background

ans..256

M

Background ambiance of form:

URL for a background image

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

- HTML-colour name

BGColor

ans..7

M

Form background colour:

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

- HTML-colour name

BGImage

ans..256

M

Form background image:

URL for a background image

Please note that this value supersedes “BGColor”.

FColor

ans..6

M

Text colour:

- HTML-colour value as HEX value or

- HTML-colour name

FFace

a..10

M

HTML-name for the font

FSize

n2

M

Number for font size

Language

a2

(enum)

M

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

CCSelect

a..10

M

Determines preselected card type in the form: VISA, MasterCard, AMEX, DINERS, JCB, CBN, Hipercard, Elo, Aura, Dankort, Airplus, ComfortCard, CUP or Maestro

URLBack

ans..256

M

URL for "Cancel" button

Center

n1

M

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

tWidth

ans..4

M

Width of table for input of the credit card data as percent- (50%) or pixel values (320).

tHeight

ans..4

M

Height of table for input of the credit card data as percent- (70%) or pixel values (480).

Layout parameters for Paygate forms for credit card payments with PagBrasil


The following table describes the result parameters that the Paygate transmits to your URLSuccess, URLFailure or URLNotify. If you have specified the Response=encrypt parameter, the following parameters are forwarded Blowfish encrypted to your system:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

OrderID

ans15

MC

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

Status

a..30

M

OK or AUTHORIZE_REQUEST on the URLSuccess-page and FAILED on the URLFailure-page

OK or FAILED on URLNotify

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

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

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

RefNr

ans..30

O

Merchant’s unique reference number

UserData

ans..1024

O

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

PCNr

n..16

O

Pseudo Card Number: Random number generated by Paygate which represents a genuine credit card number. The pseudo card number (PCN) starts with 0 and the last 3 digits correspond to those of the real card number. You can use the PCN like a genuine card number for authorisation, capture and credits.

CCBrand

a..22

O

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

CCExpiry

n6

O

In combination with PCNr: Expiry date of the credit card in the format YYYYMM.

MaskedCCNr

an..19

OC

Masked card number 6X4

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

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 an SSL credit card payment with PagBrasil (Brazil) via a server-to-server connection, call the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..30

M

Merchant’s unique reference number

Amount

n..10

M

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

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

Currency

a3

M

Currency, three digits DIN / ISO 4217. Only BRL permitted.

Capture

ans..6

O

Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696). For transactions with Hipercard only AUTO is possible.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

UserData

ans..1024

O

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

URLNotify

ans..256

O

Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead.

The URL is called only if it is a payment with Hipercard, since in this case the reply from the acquirer is sent with a time delay.

Alternatively the payment status can be queried via inquire.aspx.

CCNr

n..19

M

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

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.

CCExpiry

n6

M

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

CCBrand

a..22

M

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

CreditCardHolder

ans..60

M

Name of the card holder

Name

ans..128

O

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

AddrStreet

ans..46

M

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

AddrCity

ans..40

M

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

AddrZip

ans..8

M

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

AddrState

a2

M

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

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

eMail

ans..128

M

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

Phone

ans..40

M

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

ChDesc

ans..12

M

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

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

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.

ReqID

ans..32

O

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

InstallmentNumber

n..2

O

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

Parameters for credit card payments with PagBrasil via socket connection


The following table gives the parameters with which the Paygate responds:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment Important for future reference

XID

an32

M

ID assigned by Paygate for the payment transaction

TransID

ans..64

M

Merchant’s transaction number

OrderID

an15

M

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

Status

a..30

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

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

RefNr

ans..30

O

Merchant’s unique reference number

UserData

ans..1024

O

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

PCNr

n..16

O

Pseudo Card Number; random number generated by Paygate which represents a genuine credit card number. The pseudo card number (PCN) starts with 0 and the last 3 digits correspond to those of the real card number. You can use the PCN like a genuine card number for authorisation, capture and credits.

CCBrand

a..22

O

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

CCExpiry

n6

O

In combination with PCNr: Expiry date of the credit card in the format YYYYMM.

MaskedCCNr

an..19

OC

Masked card number 6X4

Results parameters for socket connection for PagBrasil


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

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

action=CHARGEBACK&chargebackamount={value}.

The following table gives the parameters with which the Paygate responds:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment Important for future reference

XID

an32

M

ID assigned by Paygate for the payment transaction

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

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

UserData

ans..1024

O

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

Response parameters to URLNotify for PagBrasil payments with Hipercard



PagBrasilOTF online transfer

In order to make a payment with PagBrasilOTF, go to the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ans..30

M

Unique reference number

Amount

n..10

M

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

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

Currency

a3

M

Currency, three digits DIN / ISO 4217. Only BRL permitted.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

URLSuccess

ans..256

M

Complete URL which calls up Paygate if payment has been successful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

URLFailure

ans..256

M

Complete URL which calls up Paygate if payment has been unsuccessful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

Response

a7

O

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

URLNotify

ans..256

M

Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead.

UserData

ans..1024

O

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

ReqID

ans..32

O

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

Name

ans..128

O

Name of the customer

AddrStreet

ans..46

M

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

AddrCity

ans..40

M

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

AddrZip

ans..8

M

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

AddrState

a2

M

Abbreviation of the customer’s Federal State. See the table aove for the Federal States of Brazil. (Optional, if agreed with PagBrasil and Computop, but not for 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 Computop, but not for BankCode = U)

Email

ans..128

M

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

Phone

ans..40

M

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

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

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.

BankCode

enum

M

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

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Parameters for online transfers with PagBrasil


The following table gives the result parameters which the Paygate transmits to URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are forwarded Blowfish encrypted to your system:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

OrderID

an15

MC

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

Status

a..30

M

OK or FAILED

Description

ans..1024


Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

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

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

RefNr

ans..30

O

Merchant’s unique reference number

UserData

ans..1024

O

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

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Response parameters for URLSuccess, URLFailure and URLNotify with PagBrasilOTF



Cash payment with PagBrasil Boleto Bancário

In order to execute a cash payment with PagBrasil Boleto Bancário (Brazil) via a server-to-server connection, please use the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

MerchantID

ans..30

M

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

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ans..30

M

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

Amount

n..10

M

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

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

Currency

a3

M

Currency, three digits DIN / ISO 4217. Only BRL permitted.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

UserData

ans..1024

O

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

URLNotify

ans..256

O

Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead.

Name

ans..128

M

Name of the customer

AddrStreet

ans..46

M

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

AddrCity

ans..40

M

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

AddrZip

ans..8

M

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

AddrState

a2

M

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

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

eMail

ans..128

M

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

Phone

ans..40

M

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

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

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.

Expiration

n..3

O

Number of days for which the payment form is valid

ReqID

ans..32

O

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

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Parameters for payments with Boleto Bancário via socket connection


The following table gives the parameters with which the Paygate responds:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

OrderID

an15

M

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

Status

a..30

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

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

RefNr

ans..30

O

Merchant’s unique reference number

UserData

ans..1024

O

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

PaymentSlipLink

ans..256

M

Complete URL (URL-encoded) for the page which presents the payment form

Results parameters for socket connection for Boleto Bancário


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

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

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

RefNr

ans..30

O

Merchant’s unique reference number

UserData

ans..1024

O

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

PaymentSlipLink

ans..256

M

Complete URL (URL-encoded) for the page which presents the payment form

AmountAuth

n..10

M

Authorized amount in the smallest currency unit (e.g. 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.

AmountCred

n..10

M

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

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

PaymentDatedttmMDate when the Boleto Bancário was paid by the customer. Format: YYYY-MM-DD.

Response parameters to URLNotify for payments with Boleto Bancário



Cash payment with PagBrasil PEC Flash

In order to execute a cash payment with PagBrasil PEC Flash, please use the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Beschreibung

MerchantID

ans..30

M

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

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ans..30

M

Unique reference number

Amount

n..10

M

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

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

Currency

a3

M

Currency, three digits DIN / ISO 4217. Only BRL permitted.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

UserData

ans..1024

O

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

URLNotify

ans..256

O

Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead.

Name

ans..128

M

Name of the customer

AddrStreet

ans..46

C

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

AddrCity

ans..40

C

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

AddrZip

ans..8

C

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

AddrState

a2

C

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

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

eMail

ans..128

C

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

Phone

ans..40

C

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

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

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.

Expiration

n..3

O

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

ReqID

ans..32

O

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

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Parameters for payments with PEC Flash


The following table gives the parameters with which the Paygate responds:

Parameter

Format

CND

Beschreibung

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

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

RefNr

ans..30

O

Merchant’s unique reference number

UserData

ans..1024

O

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

OrderID

an15

M

Corresponds to RefNr or TransID, depending on whether RefNr is transmitted or not
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.

CompanyIDans..10OCompany code to be used in the order confirmation page for the shopper, as part of payment instruction information to the lottery store
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).

Response parameters for PEC Flash


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

Parameter

Format

CND

Beschreibung

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

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

RefNr

ans..30

O

Merchant’s unique reference number

UserData

ans..1024

O

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

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.

CompanyIDans..10OCompany code to be used in the order confirmation page for the shopper, as part of payment instruction information to the lottery store
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).
Customans..1024O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

AmountAuthn..10MAuthorized amount in the smallest currency unit (e.g. BRL Centavos)
AmountCapn..10MCaptured amount in the smallest currency unit (e.g. BRL Centavos). Used to check whether the total amount has been captured.
AmountCredn..10MCredited amount in the smallest currency unit (e.g. BRL Centavos)
PaymentDatedttmMDate when the PEC Flash was paid by the customer. Format: YYYY-MM-DD.

Response parameters to URLNotify for payments with PEC Flash



Updating a payment with PEC Flash

In order to extend a payment slip for PEC Flash via a server-to-server connection, please use the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Beschreibung

MerchantID

ans..30

M

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

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

Expirationn1M

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

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

Parameters for updating payments with PEC Flash


The following table gives the parameters with which the Paygate responds:

Parameter

Format

CND

Beschreibung

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

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

OrderID

an15

M

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

PaymentSlipLinkans..256C

Complete URL to the PDF document, which presents the payment slip with barcode. Only with Boleto Bancário.

Response parameters for updating payments with PEC Flash



Capture of a credit card payment with PagBrasil

Captures are possible via a Server-to-Server connection. To carry out a Capture for a PagBrasil credit card payment via a Server-to-Server connection please use the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

PayID

an32

M

ID assigned by Paygate for the payment to be captured

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ans..30

O

Unique reference number

Amount

n..10

M

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

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

Currency

a..3

M

Currency code, three digits DIN / ISO 4217. Only BRL permitted.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

ReqIDans..32OTo avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

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


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

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

RefNr

ans..30

O

Merchant’s unique reference number

OrderID

an15

MC

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

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



Credit with reference

Credits (refunds) are possible via a Server-to-Server connection. For a Credit with reference to a capture the amount of the Credit is limited to the amount of the previous capture.

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

To carry out a credit with a reference transaction, please use the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

PayID

an32

M

ID assigned by Paygate for the payment to be credited

TransID

ans..64

M

TransactionID which should be unique for each payment

Amount

n..10

M

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

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

Currency

a..3

M

Currency code, three digits DIN / ISO 4217. For PagBrasilOTF and Boleto Bancário only BRL is permitted.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

ReqIDans..32OTo avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

CredNo

ans..

OC

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

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

AccBankName

ans..40

O

Bank name of the customer

AccNr

ans..12

O

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

AccBIC

ans..12

O

Bank sort code or rather branch number of the bank

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


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

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

RefNr

ans..30

OC

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

OrderID

an15

MC

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

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



Batch processing via the interface

Basic information about using Batch files and about their structure can be found in the Batch Manager manual. Within batch processing not alle functions are available which are usually available for the online interface.

This section describes the parameters which must be transferred within the data set (Record) for executing payments / credits with PagBrasil, PagBrasilOTF and Boleto Bancário and which information can be found within the response file about the payment status.

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

Action

Version

Description

Credit

1.0 / 2.0

Standard version without return of parameter Code

 

1.x / 2.x

with RefNr (valid for all versions other than 1.0)

Description of the possible batch versions


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

HEAD,<MerchantID>,<Date>,<Version>

PagBraCC,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>

PagBraCC,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<AccBankName>,<AccNr>,<AccBIC>

PagBraBB,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<AccBankName>,<AccNr>,<AccBIC>

PagBraOTF,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<AccBankName>,<AccNr>,<AccBIC>

FOOT,<CountRecords>,<SumAmount>


Example for Master MID Funktion:

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


The following table describes the individual fields and values used within the data set (record) within the batch file:

Parameter

Format

CND

Description

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

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.

Amount

n..10

M

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

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

Currency

a3

M

Currency code, three digits DIN / ISO 4217

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ns..30

O

Unique reference number

PayID

an32

M

ID for this transaction given by Paygate

AccBankName

ans..40

M

Bank name of the customer

AccNr

ans..12

M

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

AccBIC

ans..12

M

Bank sort code or rather branch number of the bank

Description of fields within the record for Batch files

The record area within the response file for Batch transactions looks as follows:

HEAD,<MerchantID>,<Date>,<Version>

PagBraCC,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>

PagBraCC,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<AccBankName>,<AccNr>,<AccBIC>,<Status>,<Code>

PagBraBB,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<AccBankName>,<AccNr>,<AccBIC>,<Status>,<Code>

PagBraOTF,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<AccBankName>,<AccNr>,<AccBIC>,<Status>,<Code>

FOOT,<CountRecords>,<SumAmount>

 

The following table describes the response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> and request parameters are returned unchanged and correspond to the call as specified before):

Parameter

Format

CND

Description

Action

a..20

M

The parameter Action defines the type of transaction:

Capture

Credit

PayID

an32

M

ID for this transaction given by Paygate

Status

a..50

M

OK or FAILED

Code

n8

M

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

Description of result parameters within the record for Batch files