{"type":"doc","content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"6.1. Sending the request","type":"text"}]},{"type":"paragraph","content":[{"text":"Your POST must be sent to ","type":"text"},{"text":"https://sandbox.pagbrasil.com/api/pagstream/subscription/get","type":"text","marks":[{"type":"strong"}]},{"text":" setting the content-type of the request header and body as \"x-www-form-urlencoded\".","type":"text"}]},{"type":"paragraph","content":[{"text":"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.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request parameters:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"8a2d8ee6-5949-483c-bd60-7926a12b429d"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"#292b2c","rowspan":1,"colwidth":[84.0]},"content":[{"type":"paragraph","content":[{"text":"Field","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ffffff"}},{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"#292b2c","rowspan":1,"colwidth":[580.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ffffff"}},{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"#292b2c","rowspan":1,"colwidth":[52.0]},"content":[{"type":"paragraph","content":[{"text":"Required","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ffffff"}},{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"#292b2c","rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"Length","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ffffff"}},{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[84.0]},"content":[{"type":"paragraph","content":[{"text":"secret","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[580.0]},"content":[{"type":"paragraph","content":[{"text":"Secret phrase as defined in the PagBrasil Dashboard","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[52.0]},"content":[{"type":"paragraph","content":[{"text":"Yes","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"128","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[84.0]},"content":[{"type":"paragraph","content":[{"text":"pbtoken","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[580.0]},"content":[{"type":"paragraph","content":[{"text":"Token assigned to your merchant account. Your token is displayed at the PagBrasil Dashboard, menu Account > Settings.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[52.0]},"content":[{"type":"paragraph","content":[{"text":"Yes","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"32","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[84.0]},"content":[{"type":"paragraph"},{"type":"paragraph","content":[{"text":"status","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[580.0]},"content":[{"type":"paragraph","content":[{"text":"0 = Waiting for first payment","type":"text"},{"type":"hardBreak"},{"text":"1 = Active ","type":"text"},{"type":"hardBreak"},{"text":"2 = Pending payment ","type":"text"},{"type":"hardBreak"},{"text":"3 = Inactive/Cancelled","type":"text"},{"type":"hardBreak"},{"text":"4 = Expired","type":"text"},{"type":"hardBreak"},{"text":"5 = Paused","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[52.0]},"content":[{"type":"paragraph"},{"type":"paragraph","content":[{"text":"No","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph"},{"type":"paragraph","content":[{"text":"1","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[84.0]},"content":[{"type":"paragraph","content":[{"text":"page","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[580.0]},"content":[{"type":"paragraph","content":[{"text":"Selected page. When page is not provided, the page with the last 50 results is returned.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[52.0]},"content":[{"type":"paragraph","content":[{"text":"No","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"Unlimited","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[84.0]},"content":[{"type":"paragraph","content":[{"text":"response_type","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[580.0]},"content":[{"type":"paragraph","content":[{"text":"XML (default) or JSON.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[52.0]},"content":[{"type":"paragraph","content":[{"text":"No","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"4","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"6.2. Reading the response","type":"text"}]},{"type":"paragraph","content":[{"text":"PagBrasil's response will be an XML or JSON with multiple item nodes having the following structure:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"85b61d72-3f3a-422a-bc4c-c5542891f353"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"#292b2c","rowspan":1,"colwidth":[88.0]},"content":[{"type":"paragraph","content":[{"text":"Field","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ffffff"}},{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"#292b2c","rowspan":1,"colwidth":[637.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ffffff"}},{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"#292b2c","rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"Length","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ffffff"}},{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[88.0]},"content":[{"type":"paragraph","content":[{"text":"subscription","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[637.0]},"content":[{"type":"paragraph","content":[{"text":"Subscription identification","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"9","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[88.0]},"content":[{"type":"paragraph"},{"type":"paragraph","content":[{"text":"status","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[637.0]},"content":[{"type":"paragraph","content":[{"text":"0 = Waiting for first payment","type":"text"},{"type":"hardBreak"},{"text":"1 = Active ","type":"text"},{"type":"hardBreak"},{"text":"2 = Pending payment ","type":"text"},{"type":"hardBreak"},{"text":"3 = Inactive/Cancelled","type":"text"},{"type":"hardBreak"},{"text":"4 = Expired","type":"text"},{"type":"hardBreak"},{"text":"5 = Paused","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph"},{"type":"paragraph","content":[{"text":"1","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[88.0]},"content":[{"type":"paragraph","content":[{"text":"amount_brl","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[637.0]},"content":[{"type":"paragraph","content":[{"text":"Amount in Brazilian Real of the recurring charge.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"7.2","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[88.0]},"content":[{"type":"paragraph","content":[{"text":"next_billing_date","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[637.0]},"content":[{"type":"paragraph","content":[{"text":"Next billing date.","type":"text"},{"type":"hardBreak"},{"text":"Format: YYYY-MM-DD","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[48.0]},"content":[{"type":"paragraph","content":[{"text":"10","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Sample:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n\n\t\n\t\t\n\t\t\t32736721764588\n\t\t\t1\n\t\t\t52.65\n\t\t\t2022-04-23\n\t\t\n\t\t\n\t\t\t32736678576364\n\t\t\t1\n\t\t\t145.00\n\t\t\t2022-04-22\n\t\t\n\t\t\n\t\t\t32736613171436\n\t\t\t1\n\t\t\t145.00\n\t\t\t2022-04-22\n\t\t\n\t\t\n\t\t\t32736590889196\n\t\t\t1\n\t\t\t145.00\n\t\t\t2022-04-22\n\t\t\n\t\t\n\t\t\t32736572866796\n\t\t\t1\n\t\t\t145.00\n\t\t\t2022-05-20\n\t\t\n\t\n","type":"text"}]},{"type":"paragraph"}],"version":1}

Browser not supported