Listar um boleto pago

1 - Esse endpoint lista um boleto pago 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/:id

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.

{{id}} será substituido pelo identificador do do pagamento do boleto

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.
id	{{id}}	identificador do pagamento do boleto

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/12/2022",
					"value": "8.0",
					"agency": "0001",
					"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": "0123456789987",
							"holder": 1,
							"phone": "999999995",
							"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": "341756864801899204900168710002800000000001456",
					"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"
			}
	}
}

📘
Execute um teste em nosso sandbox Clique aqui