[BV] Baixa de fatura por meio de pagamentos externos

A baixa de fatura permite aos parceiros a flexibilidade de disponibilizar seus próprios meios de pagamento de fatura aos seus clientes.

Ou seja, os parceiros que não utilizam core bancário do Bankly podem efetuar o recebimento dos valores de pagamento de uma fatura emitida através de seu próprio sistema financeiro e sinalizar esse pagamento ao Bankly, por meio do endpoint de baixa de fatura, para que seja possível realizar a baixa.

Fluxo da baixa de fatura

A baixa de fatura ocorre por meio dos seguintes passos:

1. Junto ao Bankly, o parceiro configura em seu token de segurança a utilização da funcionalidade de baixa de fatura por meio de pagamentos externos;
2. O parceiro disponibiliza um meio de pagamento de fatura ao seu cliente (Pix ou boleto);
3. O cliente realiza o pagamento da fatura;
4. Ao receber o pagamento, o parceiro envia ao Bankly as informações da fatura paga, bem como de seu valor, por meio do endpoint de baixa de fatura.

🚧

Importante

Só é permitido realizar a baixa de fatura caso não exista um ciclo posterior de fatura já fechado.

Este endpoint permite que o parceiro possa realizar a baixa total ou parcial de uma fatura emitida por meio de seu próprio sistema financeiro.

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que:

• O parceiro tenha configurado previamente em seu token de segurança a utilização da funcionalidade de baixa de fatura;
• Não haja um ciclo posterior de fatura já fechado. 

Requisição (Request)

Requisição HTTP

POST https://api-mtls.sandbox.bankly.com.br/cards/invoices/{statementId}/settlement

--request POST
--url'https://api-mtls.sandbox.bankly.com.br/cards/invoices/{statementId}/settlement' \
--header 'Authorization: Bearer {{Token}}' \
--header 'Idempotency-key: {{IdempotencyKey}}' \
--header 'api-version: 1.0' \
--header 'x-bkly-version: 01-04-2023' \
--header 'x-correlation-id: 1e15fdb6-592f-4cbd-9403-e3f28694be82' \
--header 'Content-Type: application/json' \
--data '{
    "type": "Billet",
    "liquidateDate": "2023-11-20 00:00:00.000",
    "paymentDate": "2023-11-9 00:00:00.000",
    "externalId": "0000015",
    "amount": {
        "value": 100.00,
        "currency": "BRL"
    },
    "paymentOptionId" : 1234
}'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:

Cabeçalhos (Headers)

Parâmetros da rota (Path)

No path desta requisição envie os seguintes campos:

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

🚧

Importante

Para ativar os planos de parcelamento com entrada personalizada, é necessário enviar tanto o campo paymentOptionId quanto o objeto amount e suas propriedades. Se somente o objeto amount for informado na requisição, ela será processada apenas como um pagamento, e o parcelamento não será ativado.

{
    "type": "Billet",
    "liquidateDate": "2023-11-20 00:00:00.000",
    "paymentDate": "2023-11-9 00:00:00.000",
    "externalId": "0000015",
    "amount": {
        "value": 100.00,
        "currency": "BRL"
    },
    "paymentOptionId" : 1234
}

Resposta (Response)

O status code 202 indicará que a solicitação foi aceita com sucesso e que o pagamento será processado.

🚧

Importante

A confirmação do lançamento do pagamento na fatura ocorrerá através do evento [INVOICE_PAYMENT_PROCESSED](https://docs.bankly.com.br/docs/eventos-faturas#invoice_payment_processed).

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

Eventos

Caso o parceiro deseje receber mensagens referentes aos eventos relacionados a esse endpoint, é preciso configurar o webhook. Os eventos são: