Boleto1

OVERVIEW

  1. Monitor the payment status of Boleto with Boleto1.
  2. When registering monitoring via API, the billet status is set to pending.
  3. If the Boleto status is identified with confirmed, Boleto1 will send JSON data in the callback URL (status confirmed).
  4. If the Boleto status is identified with expired, Boleto1 will send JSON data in the callback URL (status expired).

Billet confirmation within 1 hour. Whether from Itaú, Bradesco, Santander, Banco do Brasil, Caixa or other banks with Boleto1, you will know when the ticket is paid in less than an hour.

No matter which institution you use to issue your ticket, Boleto1 warns you as soon as you get paid.

Send via API the line of code and once paid we will return the paid status.

That simple.


POST MONITORING INVOICE
{{base_url}}/f1boleto/monitoring

API AUTHENTICATION All Boleto1 API calls require authentication. You can authenticate your app by providing 1 parameters: authorization.


ERRORS

Most common API error responses described below. Error response must be identified by HTTP status and reason attribute in your application.
HTTP Status Reason Message
401 (Unauthorized) BadCredentials API Credentials is not valid or empty
404 (Not Found) Not found Page, action or record not found
404 (Not Found) Results not found Results not found
422 (Unauthorized) Illegal Conditions Parameters not valid
423 (Unauthorized) Illegal Conditions Error on uploading file
425 (Unauthorized) Illegal Conditions Invalid file extension
429 (Too Many Requests) Rate Limit Exception API request limit is exceeded
500 (Internal Server Error) InternalServerError Something wrong in Boleto1
HEADERS

authorization
{{authorization}}
Content-Type
application/x-www-form-urlencoded
BODY urlencoded

order_id
6659635895
bar_code
03399879351230000045719901901017180980000005329


Example Request
curl --location --request POST '{{base_url}}/f1boleto/monitoring' \
--header 'authorization: {{authorization}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'order_id=6659635895' \
--data-urlencode 'bar_code=03399879351230000045719901901017180980000005329'
curl --location --request POST '{{base_url}}/f1boleto/monitoring' \
--header 'authorization: {{authorization}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'order_id=6659635895' \
--data-urlencode 'bar_code=03399879351230000045719901901017180980000005329'
Example Response
200 - OK
200 - OK
{
  "order_id": "6659635895",
  "invoice": "03399879353210000045719901901017180980000005329",
  "amount": "53.29",
  "create_monitor": "2019-10-06 17:55:30",
  "invoice_due": "2019-10-09",
  "invoice_paid": "",
  "status": "pending"
}
{
  "message": "order_id already registred",
  "reason": "Illegal Conditions"
}
GET GET INVOICE
{{base_url}}/f1boleto/monitoring/03399116956880000024916098001015280580000295300

Monitor Statuses


Statuses by priority:
  1. pending
  2. confirmed
  3. canceled
Status Description
Pending Awaiting payment of the Boleto.
Confirmed Payment confirmed by Boleto1.
Canceled Payment Cancel.
HEADERS

authorization
{{authorization}}


Example Request
GET INVOICE
curl --location --request GET '{{base_url}}/f1boleto/monitoring/03399116956880000024916098001015280580000295300' \
--header 'authorization: {{authorization}}'
Example Response
200 - OK
200 - OK
{
  "order_id": "6659635895",
  "invoice": "03399879353210000045719901901017180980000005329",
  "amount": "53.29",
  "create_monitor": "2019-10-06 17:55:30",
  "invoice_due": "2019-10-09",
  "invoice_paid": "2019-10-06 18:15:14",
  "status": "confirmed"
}
{
  "message": "order_id already registred",
  "reason": "Illegal Conditions"
}
Example Response
200 - OK
200 - OK
{
  "order_id": "6659635895",
  "invoice": "03399879353210000045719901901017180980000005329",
  "amount": "53.29",
  "create_monitor": "2019-10-06 17:55:30",
  "invoice_due": "2019-10-09",
  "invoice_paid": "",
  "status": "canceled"
}
{
  "message": "order_id already registred",
  "reason": "Illegal Conditions"
}