8. Requesting a retry for a recurring charge
8.1. Sending the request
Your POST must be sent to https://sandbox.pagbrasil.com/api/pix/rec/retry 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.
When this request is submitted, the system automatically schedules a retry for the next calendar day. The request will succeed only if the pix_rec_retry field was previously set during the consent, payment and consent for charges stages. Settlements are scheduled within a maximum of seven calendar days, provided they do not exceed the last day of the current cycle or the end of the recurrence, and they may occur on no more than three separate dates.
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 |
order | Order number. See note "a" | Yes | 64 |
a) The order number must be unique for a specific customer. If you try to submit two different transactions with the same order number but a different customer_taxid, our server will respond with the message "Duplicated order.". Our server will also respond with "Duplicated order." if you try to re-submit an order that is already paid. If parameters order and customer_taxid are equal to a previously submitted unpaid order, the previous order will be updated with the new information provided and the response will be the URL that you will need to redirect the customer to (see note "d").
Characters allowed in the parameter order (regular expression): [a-zA-Z0-9\.\-\_\/]
CONFIDENTIAL