[POST] /payments

Gera uma cobrança via Bolepix

Essa funcionalidade permite que os clientes consigam criar cobranças para seus clientes, essas cobranças são em Boleto Registrado e em Pix Cobrança (Bolepix).

Endpoint de produçãoCopied!

Método POST

https://bank-slip-api.firebanking.com.br/payments

RequisiçãoCopied!

Headers

Campo	Valor	Tipo	Descrição
Content-Type	application/json	string	Define o conteúdo como JSON
apiKey	123	string	Sua chave API

Campos a serem enviados no Body

Campo	Tipo	Obrigátorio	Descrição
amount	number	sim	Valor do boleto em reais. Deve ser um número decimal positivo com até duas casas decimais.
dueDate	string	sim	Data de vencimento do boleto no formato YYYY-MM-DD. O boleto deve ser pago até esta data para evitar juros e multas.
payer	object	sim	Objeto que contém as informações do pagador do boleto.
payer.city	string	sim	Nome da cidade onde o pagador está localizado.
payer.state	string	sim	Sigla do estado (UF) onde o pagador está localizado.
payer.number	string	sim	Número do imóvel no endereço do pagador.
payer.postalCode	string	sim	Código postal (CEP) do endereço do pagador. Deve ser informado sem pontos ou traços.
payer.neighborhood	string	sim	Bairro onde o pagador está localizado.
payer.publicArea	string	sim	Nome da rua, avenida ou logradouro do endereço do pagador.
externalId	string	não	Identificador único externo do boleto, utilizado para rastrear o boleto no sistema do cliente.
description	string	não	Pode conter informações sobre a finalidade do pagamento.
instructions	object	não	Objeto que define as instruções de juros e multas aplicáveis ao boleto caso o pagamento ocorra após o vencimento.
instructions.fine	object	não	Definição de multa aplicada ao boleto caso seja pago após o vencimento.
instructions.fine.type	string	sim, se enviado instructions.fine	Tipo de multa aplicada. Atualmente, apenas "PERCENTAGE" (percentual sobre o valor do boleto) é permitido.
instructions.fine.value	number	sim, se enviado instructions.fine	Valor percentual da multa cobrada em caso de pagamento após o vencimento.
instructions.interest	object	não	Definição de juros aplicáveis ao boleto após o vencimento.
instructions.interest.type	string	sim, se enviado instructions.interest	Tipo de juros aplicado. Atualmente, apenas "PERCENTAGE" (percentual sobre o valor do boleto) é permitido.
instructions.interest.value	number	sim, se enviado instructions.interest	Valor percentual do juro cobrado por dia de atraso.

Geração de cobrança via boletoCopied!

Exemplo de Objeto JSON a ser enviado no Body

{
    "amount": 1899.75,
    "payer": {
        "city": "SÃO PAULO",
        "document": "315.472.689-01",
        "name": "CARLOS EDUARDO MENDES",
        "neighborhood": "VILA MARIANA",
        "number": "1024",
        "postalCode": "04119001",
        "publicArea": "RUA DOMINGOS DE MORAIS",
        "state": "SP"
    },
    "dueDate": "2025-04-15",
    "description": "Pagamento referente à mensalidade do serviço contratado",
    "externalId": "a7c1e3b5-8f42-45d6-9b3c-1d5f98a0d123",
    "instructions": {
        "interest": {
            "type": "PERCENTAGE",
            "value": 10
        },
        "fine": {
            "type": "PERCENTAGE",
            "value": 0.20
        }
    }
}

cURL

curl --location 'https://bank-slip-api.firebanking.com.br/payments' \
--header 'x-api-key: <sua-chave-api>' \
--header 'Content-Type: application/json' \
--data '{
    "amount": 1899.75,
    "payer": {
        "name": "CARLOS EDUARDO MENDES",
        "document": "315.472.689-01",
        "city": "SÃO PAULO",
        "state": "SP",
        "number": "1024",
        "postalCode": "04119001",
        "neighborhood": "VILA MARIANA",
        "publicArea": "RUA DOMINGOS DE MORAIS"
    },
    "dueDate": "2025-04-15",
    "description": "Pagamento referente à mensalidade do serviço contratado",
    "externalId": "a7c1e3b5-8f42-45d6-9b3c-1d5f98a0d123",
    "instructions": {
        "interest": {
            "type": "PERCENTAGE",
            "value": 10
        },
        "fine": {
            "type": "PERCENTAGE",
            "value": 0.20
        }
    }
}'

Exemplo de respostaCopied!

Campos a serem recebidos

Campo	Tipo	Descrição
id	string	Identificador único gerado para cobrança/transação

JSON

{
    "id": "3f73ad66-04cb-4c2d-9520-e41e41c576cc"
}