Create payment preview
POST {{baseUrl}}/{{version}}/payment-preview
Create a payment preview to get information from a payment.
| Parameters | Value Type | Description |
|---|---|---|
| id | REQUIRED | Main identification of the payment. This should be the BR Code for Pix payments and lines or bar codes for payment slips. Example: '34191.09008 63571.277308 71444.640008 5 81960000000062'. |
| scheduled | OPTIONAL | Intended payment date. Right now, this parameter only has effect on BrcodePreviews. Example: '2020-03-10' |
Request Body
{"previews"=>[{"id"=>"00020101021226890014br.gov.bcb.pix2567invoice-h.sandbox.starkbank.com/v2/1094f0b604b64b3580b7edd4c4d20e395204000053039865802BR5915Stark Bank S.A.6009Sao Paulo62070503***630496F0", "scheduled"=>"2021-08-04"}, {"id"=>"34191.09107 25509.487309 71444.640008 2 87050000000283"}, {"id"=>"81660000005065157010074119002551100010601813"}, {"id"=>"83660000003196200470074119002551100010601813"}]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
| `` | null |
RESPONSES
status: OK
{"previews":[{"scheduled":"2021-08-04","type":"brcode-payment","id":"00020101021226890014br.gov.bcb.pix2567invoice-h.sandbox.starkbank.com/v2/1094f0b604b64b3580b7edd4c4d20e395204000053039865802BR5915Stark Bank S.A.6009Sao Paulo62070503***630496F0","payment":{"status":"active","branchCode":"0001","name":"Stark Bank S.A.","accountNumber":"6341320293482496","allowChange":false,"taxId":"20.018.183/0001-80","nominalAmount":219,"reductionAmount":0,"amount":219,"fineAmount":0,"accountType":"checking","reconciliationId":"1094f0b604b64b3580b7edd4c4d20e39","bankCode":"20018183","discountAmount":0,"interestAmount":0}},{"scheduled":"2021-08-04","type":"boleto-payment","id":"34191.09107 25509.487309 71444.640008 2 87050000000283","payment":{"status":"active","discountAmount":14,"name":"Stark Bank S.A.","receiverName":"Anthony Mayes","receiverTaxId":"65.699.488/0001-32","barCode":"34192870500000002831091025509487307144464000","taxId":"20.018.183/0001-80","due":"2021-08-08T02:59:59.999999+00:00","amount":269,"expiration":"2021-08-18T02:59:59.999999+00:00","fineAmount":0,"line":"34191.09107 25509.487309 71444.640008 2 87050000000283","payerTaxId":"587.567.336-23","interestAmount":0,"payerName":"Steven Harris"}},{"scheduled":"2021-08-04","type":"tax-payment","id":"81660000005065157010074119002551100010601813","payment":{"name":"PREFEITURA DE SÃO PAULO","barCode":"81660000005065157010074119002551100010601813","amount":50651,"line":"81660000005 2 06515701007 8 41190025511 7 00010601813 8","description":"Pagamento de ISS - PREFEITURA DE SÃO PAULO"}},{"scheduled":"2021-08-04","type":"utility-payment","id":"83660000003196200470074119002551100010601813","payment":{"name":"AMAZONAS ENERGIA ANTIGA ELETRONORTE","barCode":"83660000003196200470074119002551100010601813","amount":31962,"line":"83660000003 5 19620047007 4 41190025511 7 00010601813 8","description":"Pagamento de Concessionária - AMAZONAS ENERGIA ANTIGA ELETRONORTE"}}]}