Pagar um Boleto

O Pagamento de Contas na plataforma Bit Capital possui provedor próprio e exclusivo para execução das API's. Essa funcionalidade permite realizar pagamentos das mais diversas modalidades, incluindo contas de água, luz, gás, telefone, internet, multas, tributos e boletos.

Como realizar um pagamento de conta

ENDPOINT: https://kaizen.bt-staging.app/boletos-payment/pay

Esse endpoint utiliza o método POST.

Modelo de requisição:

{
	"source": "be527a4b-cadb-4c63-9a09-965ddfaa7972",
	"digitableLine": "83680000000 9 59420111000 6 00101020211 5 93596672787 4",
	"amount": "59.42",
	"asset": "BRLP",
	"extra": {
		"dueDate": "2022-02-15"
	}
}

curl --location --request POST 'https://{{APIURL}}/boletos/payment/pay' \
--header 'x-idempotence-key: ALGUMASTRINGS' \
--header 'Content-Type: application/json' \
--data-raw '{
	"source": "be527a4b-cadb-4c63-9a09-965ddfaa7972",
	"digitableLine": "83680000000 9 59420111000 6 00101020211 5 93596672787 4",
	"amount": "59.42",
	"asset": "BRLP",
	"extra": {
		"dueDate": "2022-02-15"
	}
}'

Descrição dos campos:

Modelo de Resposta

{
    "id": "bcc6dd6e-ee79-4d47-8a1c-7e6c8e258ad7",
    "type": "payment",
    "status": "executed",
    "createdAt": "2022-11-03T19:04:25.692Z",
    "updatedAt": "2022-11-03T19:04:28.668Z",
    "banking": null,
    "paymentInfo": {
        "payer": "PAGADOR AMBIENTE HOMOLOGACAO",
        "maxValue": 191.96,
        "minValue": 0.1,
        "recipient": "BENEFICIARIO AMBIENTE HOMOLOGACAO",
        "payDueDate": "2022-12-22T00:00:00",
        "totalUpdated": 96.03,
        "discountValue": 2.97,
        "documentPayer": "96.906.497/0001-00",
        "originalValue": 99,
        "dueDateRegister": "2022-11-23T00:00:00",
        "nextBusinessDay": null,
        "allowChangeValue": true,
        "documentRecipient": "21.568.259/0001-00",
        "totalWithDiscount": 2.97,
        "fineValueCalculated": 0,
        "totalWithAdditional": 0,
        "interestValueCalculated": 0
    },
    "payments": [
        {
            "amount": "99",
            "type": "payment",
            "status": "executed",
            "asset": {
                "name": "BRL Parati",
                "code": "BRLP",
                "root": true,
                "provider": "parati-provider",
                "required": true
            }
        }
    ],
    "payer": {
        "name": "PAGADOR AMBIENTE HOMOLOGACAO",
        "taxId": "96.906.497/0001-00"
    },
    "beneficiary": {
        "name": "BENEFICIARIO AMBIENTE HOMOLOGACAO",
        "taxId": "21.568.259/0001-00"
    },
    "additionalData": {}
}

curl --location --request POST 'https://kaizen.bt-staging.app/boletos-payment/pay' \
--header 'x-idempotence-key: 80095ac1-3df9-46b3-8df6-d5191c95caf6' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtRE1HODVUSjc4YXk0amRKbEJreFpDd3pINF9vV3cwV0FxWjF1ODR3MUVjIn0.eyJleHAiOjE2Njc1MzY2MzgsImlhdCI6MTY2NzUwMDYzOCwianRpIjoiODM3MDk2Y2UtZjk4MC00ZWFmLWI0YWQtNjI1YWQ5MDExM2RkIiwiaXNzIjoiaHR0cDovL2tleWNsb2FrLmtleWNsb2FrOjgxODAvYXV0aC9yZWFsbXMvZGlnaXRhbC1hY2NvdW50IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjIzYTUzNTllLWZkMTUtNGM2NS1iMjEyLTlkZDlkMGU1NjViNyIsInR5cCI6IkJlYXJlciIsImF6cCI6IjM0OWQzNWNhLWQ2MjMtMTFlYy05ZDY0LTAyNDJhYzEyMDAwMiIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiIl0sInJlYWxtX2FjY2VzcyI6eyJyb2xlcyI6WyJvZmZsaW5lX2FjY2VzcyIsInVtYV9hdXRob3JpemF0aW9uIiwiZGVmYXVsdC1yb2xlcy1kaWdpdGFsLWFjY291bnQiXX0sInJlc291cmNlX2FjY2VzcyI6eyJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJzY29wZSI6ImVtYWlsIHByb2ZpbGUiLCJjbGllbnRIb3N0IjoiMTAuMTk3LjcuMTI2IiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJjbGllbnRJZCI6IjM0OWQzNWNhLWQ2MjMtMTFlYy05ZDY0LTAyNDJhYzEyMDAwMiIsInByZWZlcnJlZF91c2VybmFtZSI6InNlcnZpY2UtYWNjb3VudC0zNDlkMzVjYS1kNjIzLTExZWMtOWQ2NC0wMjQyYWMxMjAwMDIiLCJjbGllbnRBZGRyZXNzIjoiMTAuMTk3LjcuMTI2In0.ZIkegxSiiizbXbACGCap1BbtktbzLcDxZuxoyhnroh0qCO9s_MK2vOy4Y0gXfDDIGDy-UdfeyjSAfSwYte4rKQbW31pRWjLjRS4bW21g14X3XPdB6GPtwJcb6vlJ0GlK0HRgQfUhTTkWZTylqgiXus1zgTqLKr5xaqRlKaMxHE6LEQ7MmIH3QD1nh4E-Xh_oHSuuuY0sgn5XMLgDpGIC1eGK_aNzF6Zx0qu7JTpHGgwGDmTT7Pm-LMzycjI_CVD4vaMuww5LW1CDpGRTeQY8rvP3B9q4f8tMugx466E4YrPTbK0QDkfrQkpbYqhwz0_r3SNbNY4a2_xoWnKngcMiIw' \
--header 'Content-Type: application/json' \
--data-raw '    {
        "source": "a410c3de-9997-4138-a22e-62cf2737efcb",
        "digitableLine": "00190000090283633605305416182177190730000009900",
        "amount": "99.00",
        "asset": "BRLP",
        "extra": {
            "dueDate": "2022-11-03"
        }
    }'

Descrição dos campos:

🚧

Informação Importante

Antes de enviar uma solicitação de pagamento de um Boleto ou Conta, uma validação de registro de Boleto na CIP se faz necessário, isso irá reduzir muito o número de erros possíveis. No link "Validar um Boleto" você encontra mais informações sobre.

👍

Lista de Convênio de Pagamento de Boletos

LISTA DE CONVÊNIOS ACEITOS

📘

Massa para teste de Pagamento de Contas

Para utilizar o ambiente de homologação (staging) para testar o pagamento de contas, é necessário utilizar boletos padrões, disponibilizados abaixo:

Caso base, sem multa, sem juros, sem desconto

Ação
Apresentar ao usuário o valor retornado no campo “registerData.totalUpdated”, o qual representa o valor atualizado para pagamento.

Caso com Desconto

Ação
Apresentar ao usuário os valores retornados nos campos “registerData.totalUpdated” (o qual representa o valor atualizado do pagamento), "registerData.originalValue" (valor original da cobrança) e o “registerData.totalWithDiscount” (representando o valor do desconto).

Caso com Multa e Juros

Ação
Apresentar ao usuário os valores retornados nos campos “registerData.totalUpdated” (o qual representa o valor atualizado do pagamento), "registerData.originalValue" (valor original da cobrança) e os campos de multa (registerData.fineValueCalculated) e juros (registerData.interestValueCalculated).

Caso de Multa e Vencido

Ação
Apresentar ao usuário o valor retornado no campo “registerData.totalUpdated” (o qual representa o valor atualizado do pagamento), "registerData.originalValue" (valor original da cobrança) e o campo de multa (registerData.fineValueCalculated) além de indicar o vencimento da conta.

Caso de Juros e Vencimento

Ação
Apresentar ao usuário o valor retornado no campo “registerData.totalUpdated” (o qual representa o valor atualizado do pagamento), "registerData.originalValue" (valor original da cobrança) e o campo de juros (registerData.interestValueCalculated) além de indicar o vencimento da conta.

Caso de Valor Máximo e Mínimo

Ação
Apresentar ao usuário um range o qual retornamos nos campos "registerData.minValue" e "registerData.maxValue", permitindo-o alterar o valor que será pago, desde que esteja dentro do intervalo apresentado.

Caso de Valor Máximo e Mínimo com Juros

Ação
Apresentar ao usuário o valor original do pagamento (registerData.originalValue) e o de juros (registerData.interestValueCalculated), além de permitir o usuário final alterar o valor do pagamento, respeitando o intervalo apresentado nos campos "registerData.minValue" e "registerData.maxValue".

Caso de Valor Máximo e Mínimo com Desconto

Ação
Apresentar ao usuário o valor original do pagamento (registerData.originalValue) e o de desconto (registerData.totalWithDiscount), além de permitir o usuário final alterar o valor do pagamento, respeitando o intervalo apresentado nos campos "registerData.minValue" e "registerData.maxValue".

Caso de Valor Máximo e Mínimo com Juros e Multa

Ação
Apresentar ao usuário os valores original do pagamento (registerData.originalValue), de multa (registerData.fineValueCalculated) e juros (registerData.interestValueCalculated), além de permitir o usuário final alterar o valor do pagamento, respeitando o intervalo apresentado nos campos "registerData.minValue" e "registerData.maxValue".

Caso de Valor Máximo e Mínimo com Juros e Desconto

Ação
Apresentar ao usuário os valores original do pagamento (registerData.originalValue), de desconto (registerData.fineValueCalculated) e juros (registerData.interestValueCalculated), além de permitir o usuário final alterar o valor do pagamento, respeitando o intervalo apresentado nos campos "registerData.minValue" e "registerData.maxValue".

Caso de Valor Máximo e Mínimo com Multa e Desconto

Ação
Apresentar ao usuário os valores original do pagamento (registerData.originalValue), de multa (registerData.fineValueCalculated) e juros (registerData.interestValueCalculated), além de permitir o usuário final alterar o valor do pagamento, respeitando o intervalo apresentado nos campos "registerData.minValue" e "registerData.maxValue".

Caso de Valor Máximo e Mínimo com Multa, Desconto e Juros

Ação
Apresentar ao usuário os valores original do pagamento (registerData.originalValue), de multa (registerData.fineValueCalculated), de desconto (registerData.fineValueCalculated) e juros (registerData.interestValueCalculated), além de permitir o usuário final alterar o valor do pagamento, respeitando o intervalo apresentado nos campos "registerData.minValue" e "registerData.maxValue".

Caso de Valor Máximo e Mínimo com Vencimento

Ação
Apresentar ao usuário um range o qual retornamos nos campos "registerData.minValue" e "registerData.maxValue", permitindo-o alterar o valor que será pago, desde que esteja dentro do intervalo apresentado e sinalizar o vencimento da conta em questão.

Caso de Valor Máximo e Mínimo com Juros e Vencimento

Ação
Apresentar ao usuário o valor original do pagamento (registerData.originalValue) e o de juros (registerData.interestValueCalculated), além de permitir o usuário final alterar o valor do pagamento, respeitando o intervalo apresentado nos campos "registerData.minValue" e "registerData.maxValue", sinalizando também o vencimento da conta em questão.

Caso de Valor Máximo e Mínimo com Multa e Vencimento

Ação
Apresentar ao usuário o valor original do pagamento (registerData.originalValue) e o de multa (registerData.fineValueCalculated), além de permitir o usuário final alterar o valor do pagamento, respeitando o intervalo apresentado nos campos "registerData.minValue" e "registerData.maxValue", sinalizando também o vencimento da conta em questão.

Caso de Valor Máximo e Mínimo com Desconto e Vencimento

Ação
Apresentar ao usuário o valor original do pagamento (registerData.originalValue) e o de desconto (registerData.totalWithDiscount), além de permitir o usuário final alterar o valor do pagamento, respeitando o intervalo apresentado nos campos "registerData.minValue" e "registerData.maxValue", sinalizando também o vencimento da conta em questão.

Caso com valor máximo de 999999999999.99

Ação
Apresentar o valor nominal ao usuário, permitindo-o alterar o valor e realizando uma verificação se o valor inserido comporta o intervalo apresentado nos campos "registerData.maxValue" e "registerData.minValue".

Erros de pagamento:

A tabela abaixo lista alguns possíveis erros que podem acontecer no fluxo de pagamento de contas: