Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

order

Order number. See note "e"   

Yes

64

payment_method

X = PagBrasil Pix

Yes

1

product_name

Product name. See note "m"

Yes

254

products

JSON structure with the list of products or service in the subscription. See note “l“

Yes

Unlimited

customer_name

Customer's full name if an individual, or "razão social" if the customer is a company. See note "k"   

Yes

128

customer_taxid

CPF if an individual, or CNPJ if the customer is a company. See note "j"   

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 "i"   

Yes

2

amount_brl

Amount in Brazilian Real. See note "c"   

Yes

7.2

pix_rec_id

Recurrence identifier.

Yes

64

pix_rec_recurrence_date

Recurring charge date. See note “f”
Format: YYYY-MM-DD

Yes

10

pix_rec_retry

Set “1” to indicate it’s a recurring charge retry. See note “g”

No

1

param_url

A string that can be concatenated to the URL our server posts the response to. See note "h"   

No

254

...