9. Requesting information about a recurrence
- Diego Lopes
- PagBrasil
9.1. Sending the request
Your POST must be sent to https://sandbox.pagbrasil.com/api/pix/rec/get setting the content-type of the request header and body as "x-www-form-urlencoded".
Please note that this URL shall only be used for integration and testing procedures. Once the Payment Service Agreement is signed, you will receive the production environment's URL when you request your account to go live.
Request parameters:
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 |
pix_rec_id | Recurrence identifier. | Yes | 64 |
9.2. Reading the response
PagBrasil's response will be an XML with the following elements:
Field | Description | Length |
|---|---|---|
pix_rec_id | Recurrence identifier. | 64 |
product_name | Product name. | 254 |
payer_name | Customer's name. | 128 |
payer_taxid | CPF if an individual, or CNPJ if the customer is a company. | 14 |
pix_rec_description | Text that uniquely identifies the subscription within the customer's banking app. | 19 |
pix_rec_cycle | One the following values: “weekly”, “monthly”, “quarterly”, “semiannual”, “annually”. | 10 |
pic_rec_expiration | Recurrence end date. | 10 |
pix_rec_minimum_amount | Minimum amount for recurring charges. | 7.2 |
CONFIDENTIAL