Listar todos boletos pagos
Siga nosso passo a passo para listar todos os boletos pagos a partir de uma conta especifica.
Listar boletos pagos
1 - Esse endpoint lista todos os boletos pagos de uma conta especifica(account)
lembre-se de sempre enviar o token(Authorization) no header da requisição.
endpoint: {{base_url}}/partner/baas/account/billet_payments
verbo http GET
{{base_url}} será substituida pela URL da sua empresa.
{{account}} será substituida pela conta a ser utilizada para listar os boletos pagos.
2 - Para listar todos os boletos pagos é necessário o envio dos seguintes parâmetros.
| CHAVE | VALOR | DESCRIÇÂO |
|---|---|---|
| account | {{account}} | conta para busca de boletos pagos. |
3 - Se tudo ocorrer bem, você receberá uma resposta com Status 200 OK.
Corpo da resposta com sucesso:
{
"data": [
{
"id": "1",
"type": "billet_payments",
"attributes": {
"user_id": 1,
"type": "BilletPayment",
"status": "waiting",
"cancel_reason": null,
"reverse_reason": null,
"auth_code": null,
"date": "08/03/2022",
"value": "8.0",
"agency": "4298",
"account": "{{account}}",
"tags": [],
"ticket_code": null,
"updated_at": "2022-03-08T10:32:38.518-03:00",
"created_at": "2022-03-08T10:32:38.518-03:00",
"scheduled_at": null,
"ticketed_at": null,
"canceled_at": null,
"late_at": null,
"done_at": null,
"reversed_at": null,
"ticket_auth_code": null,
"ticket_cancel_reason": null,
"errors": null,
"display_amount": "8.0",
"financial_institution_id": null,
"approved_by": "NOME DO PAGADOR",
"created_by": "NOME DO PAGADOR",
"cancelable_by_user?": false,
"user": {
"name": "NOME DO PAGADOR",
"account": "{{account}}",
"document": "12345678978954",
"holder": 1,
"phone": "99996589",
"uid": "[email protected]",
"payment_max_value": "999999999.99",
"info_email": null,
"set_password": false,
"set_short_password": false
},
"liquidation_disponibility_id": null,
"late_reason": null,
"pix_favored": null,
"document_number": "341756864801899204900168710002800000000000000",
"discount": "0.0",
"rebate": "0.0",
"interest": "0.0",
"other_value": "0.0",
"total": "8.0",
"bank_name": "ITAÚ UNIBANCO S.A.",
"assignor": null,
"assignor_document": null,
"fee_amount": "0.0",
"segmento": null,
"favored": null,
"transfer_reason": null,
"bank": null,
"history": null,
"phoneddd": "",
"phonenumber": "",
"carrier": "",
"provider_id": null,
"pix_transaction_id": null,
"description": null,
"pix_transaction_account_id": null,
"competence": null,
"identifier": null,
"social_security_code_description": null,
"pix_initiation_method": "pix_key",
"pix_purpose": "instant_payment",
"pix_purchase_amount": "0.0"
}
},
{
"id": "2",
"type": "billet_payments",
"attributes": {
"user_id": 1,
"type": "BilletPayment",
"status": "waiting",
"cancel_reason": null,
"reverse_reason": null,
"auth_code": null,
"date": "18/03/2022",
"value": "9.0",
"agency": "4298",
"account": "{{account}}",
"tags": [],
"ticket_code": null,
"updated_at": "2022-03-08T10:35:01.858-03:00",
"created_at": "2022-03-08T10:35:01.858-03:00",
"scheduled_at": null,
"ticketed_at": null,
"canceled_at": null,
"late_at": null,
"done_at": null,
"reversed_at": null,
"ticket_auth_code": null,
"ticket_cancel_reason": null,
"errors": null,
"display_amount": "9.0",
"financial_institution_id": null,
"approved_by": "NOME DO PAGADOR",
"created_by": "NOME DO PAGADOR",
"cancelable_by_user?": false,
"user": {
"name": "NOME DO PAGADOR",
"account": "{{account}}",
"document": "12345678978954",
"holder": 1,
"phone": "99996589",
"uid": "[email protected]",
"payment_max_value": "999999999.99",
"info_email": null,
"set_password": false,
"set_short_password": false
},
"liquidation_disponibility_id": null,
"late_reason": null,
"pix_favored": null,
"document_number": "341756864801899204900168710002800000000000000",
"discount": "0.0",
"rebate": "0.0",
"interest": "0.0",
"other_value": "0.0",
"total": "9.0",
"bank_name": "ITAÚ UNIBANCO S.A.",
"assignor": null,
"assignor_document": null,
"fee_amount": "0.0",
"segmento": null,
"favored": null,
"transfer_reason": null,
"bank": null,
"history": null,
"phoneddd": "",
"phonenumber": "",
"carrier": "",
"provider_id": null,
"pix_transaction_id": null,
"description": null,
"pix_transaction_account_id": null,
"competence": null,
"identifier": null,
"social_security_code_description": null,
"pix_initiation_method": "pix_key",
"pix_purpose": "instant_payment",
"pix_purchase_amount": "0.0"
}
},
{
"id": "3",
"type": "billet_payments",
"attributes": {
"user_id": 1,
"type": "BilletPayment",
"status": "waiting",
"cancel_reason": null,
"reverse_reason": null,
"auth_code": null,
"date": "31/03/2022",
"value": "25.0",
"agency": "4298",
"account": "{{account}}",
"tags": [],
"ticket_code": null,
"updated_at": "2022-03-08T10:48:06.045-03:00",
"created_at": "2022-03-08T10:48:06.045-03:00",
"scheduled_at": null,
"ticketed_at": null,
"canceled_at": null,
"late_at": null,
"done_at": null,
"reversed_at": null,
"ticket_auth_code": null,
"ticket_cancel_reason": null,
"errors": null,
"display_amount": "25.0",
"financial_institution_id": null,
"approved_by": "NOME DO PAGADOR",
"created_by": "NOME DO PAGADOR",
"cancelable_by_user?": false,
"user": {
"name": "NOME DO PAGADOR",
"account": "{{account}}",
"document": "12345678978954",
"holder": 1,
"phone": "99996589",
"uid": "[email protected]",
"payment_max_value": "999999999.99",
"info_email": null,
"set_password": false,
"set_short_password": false
},
"liquidation_disponibility_id": null,
"late_reason": null,
"pix_favored": null,
"document_number": "341756864801899204900168710002800000000000000",
"discount": "0.0",
"rebate": "0.0",
"interest": "0.0",
"other_value": "0.0",
"total": "25.0",
"bank_name": "ITAÚ UNIBANCO S.A.",
"assignor": null,
"assignor_document": null,
"fee_amount": "0.0",
"segmento": null,
"favored": null,
"transfer_reason": null,
"bank": null,
"history": null,
"phoneddd": "",
"phonenumber": "",
"carrier": "",
"provider_id": null,
"pix_transaction_id": null,
"description": null,
"pix_transaction_account_id": null,
"competence": null,
"identifier": null,
"social_security_code_description": null,
"pix_initiation_method": "pix_key",
"pix_purpose": "instant_payment",
"pix_purchase_amount": "0.0"
}
},
{
"id": "4",
"type": "billet_payments",
"attributes": {
"user_id": 1,
"type": "BilletPayment",
"status": "waiting",
"cancel_reason": null,
"reverse_reason": null,
"auth_code": null,
"date": "24/03/2022",
"value": "160.31",
"agency": "4298",
"account": "{{account}}",
"tags": [
"Teste"
],
"ticket_code": null,
"updated_at": "2022-03-22T09:24:48.163-03:00",
"created_at": "2022-03-14T09:47:49.732-03:00",
"scheduled_at": null,
"ticketed_at": null,
"canceled_at": null,
"late_at": null,
"done_at": null,
"reversed_at": null,
"ticket_auth_code": null,
"ticket_cancel_reason": null,
"errors": null,
"display_amount": "12312.31",
"financial_institution_id": null,
"approved_by": "NOME DO PAGADOR",
"created_by": "NOME DO PAGADOR",
"cancelable_by_user?": false,
"user": {
"name": "NOME DO PAGADOR",
"account": "{{account}}",
"document": "12345678978954",
"holder": 1,
"phone": "99996589",
"uid": "[email protected]",
"payment_max_value": "999999999.99",
"info_email": null,
"set_password": false,
"set_short_password": false
},
"liquidation_disponibility_id": null,
"late_reason": null,
"pix_favored": null,
"document_number": "341756864801899204900168710002800000000000000",
"discount": "0.0",
"rebate": "0.0",
"interest": "0.0",
"other_value": "0.0",
"total": "150.50",
"bank_name": "ITAÚ UNIBANCO S.A.",
"assignor": null,
"assignor_document": null,
"fee_amount": "0.0",
"segmento": null,
"favored": null,
"transfer_reason": null,
"bank": null,
"history": null,
"phoneddd": "",
"phonenumber": "",
"carrier": "",
"provider_id": null,
"pix_transaction_id": null,
"description": null,
"pix_transaction_account_id": null,
"competence": null,
"identifier": null,
"social_security_code_description": null,
"pix_initiation_method": "pix_key",
"pix_purpose": "instant_payment",
"pix_purchase_amount": "0.0"
}
}
]
}
Execute um teste em nosso sandbox Clique aqui
Updated 9 months ago