Dados Boleto
Esse endpoint consulta todos os dados do boleto para o cliente efetuar pagamento.
Exemplo de Resposta - Endpoint
{
"id": "A0233...",
"transaction_id": "A0233...",
"account_id": "9F83...",
"your_number": "123",
"our_number": "0000056...",
"type": "BANKSLIP_PIX",
"due_date": "2025-10-22T00:00:00.000000Z",
"amount": "1000",
"payer_name": "teste",
"payer_document": "00000000000",
"payer_email": "teste@teste.com",
"payer_phone_prefix": "11",
"payer_phone_number": "111111111",
"payer_address_zipcode": "13482300",
"payer_address_public_place": "Rua Antonio Palermo",
"payer_address_neighborhood": "Parque Residencial Stahlberg",
"payer_address_number": "123",
"payer_address_complement": null,
"payer_address_city": "Limeira",
"payer_address_state": "SP",
"discount_type": "fixed",
"discount_date": null,
"discount_amount": null,
"late_fine_type": "fixed",
"late_fine_date": null,
"late_fine_amount": null,
"late_payment_type": "fixed",
"late_payment_date": null,
"late_payment_amount": null,
"webhook_url": null,
"qr_code": "0002010...",
"bar_code": "43599...",
"digitable_line": "435900...",
"created_at": "2025-10-17T19:57:39.493000Z",
"updated_at": "2025-10-17T19:57:41.863000Z",
"transaction": {
"id": "A02336...",
"status": "created" | "paid" | "canceled",
"amount": "1000",
"original_amount": "1000",
"description": null,
"external_id": "a023...",
"payment_type": "bolepix",
"refunded": "0",
"voided": "0",
"captured": "0",
"account_id": "9F83...",
"deleted_at": null,
"created_at": "2025-10-17T19:57:39.463000Z",
"updated_at": "2025-10-17T19:57:41.843000Z",
"webhook_url": null,
"transactions_pix_cash_in_id": "A0233...",
"end_to_end_id": null,
"payer_name": null,
"payer_national_registration": null,
"payer_type": null,
"gateway": "9",
"transactions_bank_slip_id": null,
"transaction_type": "4",
"payment_link_id": null,
"payer_email": null,
"in_infraction": false,
"token_used": null,
"refund_id": null,
"bank_ispb": null,
"end_to_end_refund_id": null,
"is_threeds": false,
"iid": "80..."
},
"account": {
"id": "9F83E...",
"documentNumber": "00000000000000",
"businessName": "Desenvolvimentos Porto",
"contactNumber": "+5511777777777",
"businessEmail": "teste@teste.com",
"address": {
"id": 222,
"postalCode": "580...",
"street": "Rua Praia Formosa",
"number": "5",
"addressComplement": null,
"neighborhood": "Mangabeira",
"account_id": "9F83EC...",
"city": "João Pessoa",
"state": "PB",
"approved": true,
"deleted_at": null,
"created_at": "2025-07-30T15:32:31.863000Z",
"updated_at": "2025-07-30T15:34:09.827000Z",
"state_id": 15,
"city_id": 2652
}
}
}
Header Parameters
Colocar no formato Bearer TOKEN
application/json
application/json
Path Parameters
Response
What made this section unhelpful for you?
Base URL
Production:
Sandbox: