/gateway/bolepix - Preâmbulo Bank Conta Digital

Requisição

Parâmetros Header

Authorization

string

requerido

Exemplo:

Bearer {Token JWT}

Parâmetros Bodyapplication/json

amount

number

requerido

Valor do boleto.

dueDate

string <date>

requerido

Data de vencimento.

additionalInformation

string

opcional

Informações adicionais.

payer

object

requerido

Dados do pagador.

name

string

requerido

Nome do pagador.

document

string

requerido

Documento do pagador.

string

requerido

Email do pagador.

address

object

requerido

Dados de endereço do pagador.

discount

object | null

opcional

Desconto.

amount

number

requerido

Valor do desconto.

type

enum<string>

requerido

Tipo de desconto

Valores permitidos:

fixedpercentual

date

string <date>

requerido

Data limite para aplicação do desconto.

rebate

object | null

opcional

Rebate.

amount

integer

requerido

Valor do rebate.

type

enum<string>

requerido

Valores permitidos:

fixedpercentual

fine

object | null

opcional

Multa.

amount

number

requerido

Valor da multa.

type

enum<string>

requerido

Tipo da multa.

Valores permitidos:

fixedpercentual

date

string <date>

requerido

Data de aplicação da multa.

interest

object | null

opcional

Juros.

amount

number

requerido

Valor do juros.

type

enum<string>

requerido

Tipo do juros.

Valores permitidos:

daily_fixeddaily_percentual

date

string <date>

requerido

Data de inicio da cobrança dos juros.

Exemplo

{
    "amount": 10,
    "dueDate": "2024-12-05",
    "additionalInformation": "Informações adicionais",
    "payer": {
        "name": "João da Silva",
        "document": "12345678910",
        "email": "joaosilva@email.com",
        "address": {
            "street": "Rua Jardins",
            "number": "10",
            "neighborhood": "Centro",
            "city": "Porto Alegre",
            "state": "RS",
            "postalCode": "999999999",
            "extra": "APTO 101"
        }
    },
    "discount": {
        "amount": 1.5,
        "type": "fixed",
        "date": "2024-12-04"
    },
    "fine": null,
    "interest": null,
    "rebate": null
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200Success

application/json

Body

retorno

object | null

opcional

string

requerido

Id.

amount

number

requerido

Valor

status

string

requerido

Status.

createdAt

string <date-time>

requerido

Data de criação.

dueDate

string <date>

requerido

Data de vencimento.

link

string

requerido

URL da cobrança.

payer

object

requerido

Pagador

discount

object | null

opcional

Desconto.

fine

object | null

opcional

Multa.

interest

object | null

opcional

Juros.

rebate

object | null

opcional

Rebate.

pixQrcode

object

requerido

Dados para pagamento por PIX.

bankSlip

object

requerido

Dados para pagamento por boleto.

alertas

array [object {2}]

opcional

mensagem

string | null

opcional

tipo

enum<integer> <int32>

opcional

Valores permitidos:

123456789

erros

array [object {4}]

opcional

mensagem

string | null

opcional

tipo

enum<integer> <int32>

opcional

Valores permitidos:

123456789

campoNome

string | null

opcional

elemento

string | null

opcional

Exemplo

{
    "retorno": {
        "id": "string",
        "amount": 0,
        "status": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "dueDate": "2019-08-24",
        "link": "string",
        "payer": {
            "name": "string",
            "document": "string",
            "email": "string",
            "address": {
                "street": "string",
                "number": "string",
                "neighborhood": "string",
                "city": "string",
                "state": "string",
                "postalCode": "string",
                "extra": "string"
            }
        },
        "discount": {
            "amount": 0,
            "type": "fixed_amount",
            "date": "2019-08-24"
        },
        "fine": {
            "amount": 0,
            "type": "fixed_amount",
            "date": "2019-08-24"
        },
        "interest": {
            "amount": 0,
            "type": "fixed_amount",
            "date": "2019-08-24"
        },
        "rebate": {
            "amount": 0,
            "type": "percentual"
        },
        "pixQrcode": {
            "key": "string"
        },
        "bankSlip": {
            "number": "string",
            "barCode": "string",
            "digitableLine": "string"
        }
    },
    "alertas": [
        {
            "mensagem": "string",
            "tipo": 1
        }
    ],
    "erros": [
        {
            "mensagem": "string",
            "tipo": 1,
            "campoNome": "string",
            "elemento": "string"
        }
    ]
}

🟠401Unauthorized

🟠400Bad Request

🟠422Unprocessable Entity

🔴500Internal Server Error