...
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 "c" | Yes | 64 |
payment_link | Set "1" to create the Payment Link. | Yes | 1 |
payment_option | Defines the payment methods to be included in the Payment Link. If not present all payment methods available will be included. C = Credit card Separate multiple payment methods by comma (e.g. "C,B,P"). | No | Unlimited |
payment_link_expiration | Number of days (0 - 999) the Payment Link is valid for. If you don't use this parameter, our system will use the default value set at the PagBrasil Dashboard, menu Account > Settings. | No | 3.0 |
url_return | URL you want the customer to be redirected to after they complete the payment. You may include any parameters in the URL (i.e. order number) so that you can display the proper page when the customer is redirected to "url_return". | No | 254 |
product_name | Product name. See note "d" | Yes | 254 |
customer_name | Customer's full name if an individual, or "razão social" if the customer is a company. See note "e" | Yes | 128 |
customer_taxid | CPF if an individual, or CNPJ if the customer is a company. See note "f" | 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_number | Customer's street address number | No | 10 |
address_number_complement | Customer's street address complement (e.g. suite) | No | 40 |
address_neighborhood | Customer's neighborhood | No | 40 |
address_zip | Customer's postal code (in Brazil called CEP). | Yes | 8 |
address_city | Customer's city | Yes | 40 |
address_state | Customer's state. See note "g" | Yes | 2 |
amount_brl | Amount in Brazilian Real | Yes | 57.2 |
param_url | A string that can be concatenated to the URL our server posts the response to. See note "h" | No | 254 |
...