Sign in

v1

latestOpenAPI 3.0.02026-07-2671191208.7 KB
Boletos

Criar boleto

post/v1/marketplace/billets

Headers

integration-keystring required

Chave de integração.

x-tokenstring required

x-token utilizado para autenticação. Pode ser encontrado em nosso portal, na guia de integração com a api pública.

Request body

amountnumber required

Valor do documento.

expirationstring required

Data de vencimento.

payment_limit_datestring

Data limite para pagamento.

rechargeboolean

Recarga por boleto?

Example request

{
  "reference_id": "ABC-123",
  "instruction": {
    "late_fee": {
      "amount": 2.5
    },
    "interest": {
      "amount": 2.5
    },
    "discount": {
      "amount": 2.5
    }
  }
}

Response

_idstring required

Identificador do boleto.

typestring required

Tipo do boleto.

gateway_keystring required

Chave do boleto.

establishment_idstring required

Identificador do estabelecimento.

descriptionstring required

Descrição do boleto.

amountnumber required

Valor bruto do boleto.

original_amountnumber required

Valor líquido do boleto.

barcodestring required

Código de barras do boleto.

digitable_linestring required

Linha digitável do boleto.

urlstring required

URL para download do boleto.

status'PROCESSING' | 'CREATED' | 'PENDING' | 'CANCELED' | 'PAID' | 'FAILED' required

Status do boleto.

expiration_atstring required

Data de vencimento do boleto.

payment_limit_datestring required

Data limite para pagamento do boleto.

feesnumber required

Taxa do boleto.

rechargeboolean required

Boleto de recarga.

pix_emvstring required

Pix copia e cola.

Example response

{
  "reference_id": "ABC-123"
}