Page Comparison

3.1. Sending the request

...

Field	Description	Required	Length
secret	Secret phrase as defined in the PagBrasil Dashboard	Yes	128
pbtoken	Token assigned to your merchant account. Your token is displayed at the PagBrasil Dashboard, menu Account > Settings.	Yes	32
products	JSON structure with the list of products or service in the subscription. See note “h“	Yes	Unlimited
product_name	Product name. See note "c".	Yes	254
customer_name	Customer's full name if an individual, or "razão social" if the customer is a company. See note "d"	Yes	128
customer_taxid	CPF if an individual, or CNPJ if the customer is a company. See note "e"	Yes	14
customer_email	Customer's e-mail address	Yes	128
customer_phone	Customer's phone number (including the 2-digit area code)	Yes	40
address_street	Customer's street address	Yes	200
address_zip	Customer's postal code (in Brazil called CEP). Only digits, do not include the dash.	Yes	8
address_city	Customer's city	Yes	40
address_state	Customer's state. See note "f"	Yes	2
amount_brl	Amount in Brazilian Real of the recurring charge.	Yes	57.2
limit	Maximum subscription renewals (0 or empty is unlimited).	No	3
next_billing_date	Start date for the first recurring charge. Format: YYYY-MM-DD	Yes	10
frequency	Interval between the subscription renewals. Customized intervals may be defined at the PagBrasil Dashboard. Pre-defined intervals: W = Weekly M = Monthly Q = Quaterly S = Semiannually Y = Yearly	Yes	1
response_type	XML (default) or JSON.	No	4
cc_installments	Number of installments (1 to 12). See note "g".	No*	2
cc_holder	Credit card holder's name	No*	30
cc_number	Credit card number	No*	14 - 19
cc_expiration	Credit card expiration date. Format: MM/YY.	No*	5
cc_cvv	Card verification value (security code).	No*	3 - 4

...

Anchor

	3.1.g
	3.1.g

g) The minimum amount of an installment is BRL 5. For example, a purchase amount of BRL 20 can be paid to a maximum of 4 installments. If e.g. an amount of BRL 20 is submitted to be charged in 5 installments, the transaction will always be declined by the credit card company.

...

Anchor

	3.1.h
	3.1.h

h) The 'products' parameter identifies the products or services in the subscription and must be sent in JSON format. It should include values such as “sku”, “amount”, “quantity” and “discount” as shown in the example below:

Code Block
{ “sku“: “productSKU“,“amount“:0.00,“quantity“:0,“discount“:0 }

3.2. Reading the response

PagBrasil's response will be an XML or JSON with the following structure:

Field	Description	Length
subscription	Subscription identification	9
status	0 = Waiting for first payment 1 = Active 2 = Pending payment 3 = Inactive/Cancelled 4 = Expired 5 = Paused	1
amount_brl	Amount in Brazilian Real of the recurring charge	57.2
next_billing_date	Start date for the first recurring charge. Format: YYYY-MM-DD	10

...

Versions Compared

Old Version 11

New Version Current

Key

3.1. Sending the request

3.2. Reading the response