API Reference

Initiate a payment using billet data.

post
https://secureapi.treealhmg-hmg.onz.software/billets/payments

This endpoint allows requesting a billet (brazilian boleto) payment order (cash-out) using billet code (Linha digitável).
1 - Payment will always be made using an adjusted amount (interest and fines).
2 - Billets whose payment amount can be changed by the payer can only be paid via the web (Finance).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Numeric representation of billet's barcode (Linha digitável). Only numbers.

string
required
string
enum
Defaults to INSTANT

Default value is INSTANT.

  • INSTANT - Payment will happen immediately
  • APPROVAL_REQUIRED - Payment only will happen when the order was approved.
Allowed:
payment
object
Headers
string
required

Unique request identifier to support idempotency.

Responses

503

Service unavailable

504

Gateway timeout

Updated over 1 year ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago