O pagamento de Boletos e Boletos na plataforma Bit Capital possui provedor próprio e exclusivo para execução das API's.

Usado para

Pagar um Boleto emitido na plataforma da Bit Capital;
Pagar boleto emitido por concessionárias e parceiros financeiros;
Pagar um Boleto emitido por outras Instituições Financeiras ( bancos );

Provedores disponíveis

Provider	status	provider name
Celcoin	disponível na versão Beta desde 2.7.x	celcoin
Dock	deprecated since 2.2.x	dock

Request

POST {{BASE_URL}}/boletos/payment/pay

Body Request

{
    "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"
    }
}'

campo	tipo	descrição
source	string	WalletId que será debitada os valores do boleto
digitableLine	string ( 44 \| 47 ) chars	Linha digitável do boleto/fatura
amount	string	Valor do boleto/fatura Se a fatura tiver atraso, o valor corrigido da fatura deve ser atualizada neste campo
asset	string	Asset da wallet no qual irá descontar (padrão BRLP)
extra.dueDate	string	Data de vencimento do boleto/fatura

Response

{
    "id": "a8544ed8-97f6-4931-845c-f23adfb2c767",
    "type": "payment",
    "status": "AUTHORIZED",
    "createdAt": "2022-03-11T21:29:08.416Z",
    "updatedAt": "2022-03-11T21:29:08.416Z",
    "banking": null,
    "payments": [
        {
            "id": "cd2d6cd02-528e-4ed2-bd2f-e573730b6b5",
            "type": "boleto",
            "status": "settled",
            "createdAt": "2022-03-11T21:29:08.428Z",
            "updatedAt": "2022-03-11T21:29:16.355Z",
            "scheduleFor": null,
            "amount": "59.42",
            "destination": {
                "id": "51aa376e-7a9b-41c2-9341-93f9d295e220",
                "stellar": {
                    "publicKey": "GAJEYXWSENJX7NWROOTOBBFEMGCOVKHME4CZFTQ33L4MZOVQL46KIKEY"
                },
                "updatedAt": "2021-09-22T16:39:44.314Z",
                "createdAt": "2021-09-22T16:39:44.314Z",
                "deletedAt": null,
                "additionalData": {
                    "transitoryAccountType": "boleto_payment",
                    "isTransitoryAccount": true
                }
            },
            "asset": {
                "id": "936bdcd0-4d95-4108-83e4-cb3caa53e44a",
                "name": "BRL Parati",
                "code": "BRLP",
                "root": true,
                "provider": "parati-provider",
                "required": true,
                "createdAt": "2020-03-23T06:47:10.274Z",
                "updatedAt": "2020-03-23T06:47:10.274Z"
            }
        }
    ],
    "source": {
        "id": "be527a4b-cadb-4c63-9a09-965ddfaa7972",
        "stellar": {
            "publicKey": "GBLGNXVKOFXSCDBZXDQZAWF2NRVYVMD3XYDJFFMUUV4HLCNUUIHRAYCY"
        },
        "updatedAt": "2020-03-23T07:20:37.486Z",
        "createdAt": "2020-03-23T07:20:37.486Z",
        "deletedAt": null,
        "user": {
            "id": "9cbb59e9-4638-4f2e-b244-52c7ebe02e6e",
            "name": "Bit Capital Ltda. Bit Capital Ltda",
            "firstName": "Bit Capital Ltda.",
            "lastName": "Bit Capital Ltda",
            "email": "[email protected]",
            "role": "mediator",
            "twoFactorRequired": "not_required",
            "createdAt": "2020-03-23T07:20:37.288Z",
            "updatedAt": "2020-11-18T22:19:35.763Z"
        },
        "additionalData": {}
    },
    "states": [
        {
            "id": "e71960d7-8d3b-4bed-b0b2-fc174a1939d6",
            "status": "AUTHORIZED",
            "createdAt": "2022-03-11T21:29:08.434Z",
            "updatedAt": "2022-03-11T21:29:08.434Z",
            "additionalData": {
                "authorized": [],
                "skipped": []
            }
        },
        {
            "id": "a743e5ac-8ed1-4741-9a27-5380d4c5dc7f",
            "status": "pending",
            "createdAt": "2022-03-11T21:29:08.422Z",
            "updatedAt": "2022-03-11T21:29:08.422Z",
            "additionalData": {}
        }
    ],
    "additionalData": {},
    "paymentInfo": {
        "type": "Dealership",
        "providerBoletoId": "9174181",
        "initeHour": "07:00",
        "endHour": "21:00",
        "settleDate": "11/03/2022",
        "nextSettle": "N",
        "maxValue": "",
        "minValue": "",
        "assignor": "Generica CC",
        "dueDate": "",
        "digitableLine": "836800000009594201110006001010202115935966727874"
    }
}

campo	tipo	descrição
id
type
status
destination.id
destination.user.name
source.user.name
payments[]
payments.id
payments.status
payments.type
payments.asset.code
paymentInfo
paymentInfo.type
paymentInfo.providerBoletoId
paymentInfo.settleDate
paymentInfo.assignor
paymentInfo.digitableLine

Informações

Este procedimento paga um Boleto ou fatura na plataforma;
A carteira de origem, deve ser e ter fundos suficientes para pagar o Boleto/Fatura;
A plataforma Bit Capital reconhecerá se é Boleto ou fatura, dependendo do número de caracteres do campo digitableLine
Um Boleto só pode ser pago se já estiver registrado na CIP;
Um Boleto só pode ser pago se a data de vencimento não estiver vencida;
Uma fatura pode ser paga após a data de vencimento, todas as taxas de atraso recorrentes serão incluídas na próxima fatura;

👍
Melhores Práticas

Antes de enviar uma solicitação de pagamento de um Boleto ou Conta, uma validação de registro de seu Boleto na CIP deve reduzir muito o número de erros possíveis. No link "Validando um Boleto" você encontra mais informações sobre.

Lista de todos os convênios ativos na plataforma

Como existem centenas de empresas conveniadas aptas a serem pagas na plataforma, foi disponibilizado uma planilha compartilhada com as informações de todos os convênios possíveis.

LISTA DE CONVÊNIOS

⚠️ Observações

❗️
Importante!
Todos os pagamentos devem ser efetuados seguindo o calendário oficial da FEBRABAN. Aqui você pode ver todas as datas indisponíveis para pagar Boleto.
Clique aqui -> calendário da FEBRABAN

Validation response descriptions

Here we describe a table with all response errors knew in the Bit Capital Platform.

Type means the kind os Boleto.

There are 2 types of Boleto decribed in the Platform

Compensation
Dealership

Dealership

type	message
Compensation	In CIP query return (Field maxValue) if the value entered for the realization is less than the maximum allowed
Compensation	In CIP query return (Field minValue) if the value entered for the realization is less than the minimum allowed
All	If you inserted an identifier id of the transaction invalid.
Dealership, Compensation	Returns if it entered an illegal value in operation
All	It occurs when the User enters a value that is not allowed for the transaction.
Dealership e Compensation	Returns if the payment has already been made
Dealership e Compensation	If payment has any payment rule infringed the error is returned. Example: Payment can only be made in a specific bank.
Dealership e Compensation	Problem with the errorCode bars.
Dealership e Compensation	If the document is expired and its rule restricts payment
Compensation	Returns if the payment can not be accepted in Celcoin.
Dealership e Compensation	If the specific ticket only be accepted on own units
Compensation	Returns if a ticket contains the rule, not allowing payment after a specified number of days overdue
Compensation	In a bill payment to return the indication lets you change value = false, it will be necessary to enter the running total value returned in the query. If you enter a different value, the error is returned
All	May be related to some momentary problem, it is necessary to signal that the User try again.
Dealership e Compensation	Returns to arrangements which are not accepted. (It is possible to transmit to the stand to check the ability to pay)
All	It is usually connected to blink next to our partner.
Dealership e Compensation	Returns if created a second execution without having confirmed the first.
Compensation	In CIP query return (Field minValue) if the value entered for the realization is less than the minimum allowed
Compensation	In CIP query return (Field maxValue) if the value entered for the realization is greater than the maximum allowed
Compensation	Returns if the payment deadline has expired
Compensation	Returns if there is any restriction of the User with the recipient
Compensation	Returns if the User violates the partial payment rule established by the beneficiary
Compensation	Returns if the User violates any rule related to partial payments established by the beneficiary
Compensation	Returns if the User violates any rule related to partial payments established by the beneficiary
Compensation	Returns if the billet exceeded value for partial payment
Compensation	If the originator of the ticket (eg: American stores) meets restrictions on issuing bank payment slip (eg Itau Bank), it will not be possible to continue paying
Compensation	If the originator of the ticket (eg American stores) meets restrictions on issuing bank payment slip (eg Itau Bank), it will not be possible to continue paying
Compensation	Returned in the event of an attempt to pay after the deadline returned in the query
Compensation	Returns if the bar errorCode contains an error
Compensation	Problem with the record in the CIP, for this scenario it is necessary to contact the favored
Compensation	Problem with the record in the CIP, for this scenario it is necessary to contact the favored
Dealership e Compensation	Related error if the query identifier Id has already been used
Dealership e Compensation	Related error if the query has not been performed on the day of the payment creation.
Dealership e Compensation	Returns if the execution is created with the identifier id of the divergent query typeful line consulted
Compensation	Returned in the event of attempting to pay with a different value returned in the field totalAtualizado
All	It is usually connected to blink next to our partner.
All	Invalid Credentials

Pagamento de boletos e contas

Usado para

Provedores disponíveis

Request

Body Request

Response

Informações

👍
Melhores Práticas

Lista de todos os convênios ativos na plataforma

⚠️ Observações

❗️
Importante!

Validation response descriptions

Dealership

Usado para

Provedores disponíveis

Request

Body Request

Response

Informações

👍Melhores Práticas

Lista de todos os convênios ativos na plataforma

⚠️ Observações

❗️Importante!

Validation response descriptions

Dealership

👍
Melhores Práticas

❗️
Importante!