Geração de uma forma de pagamento

stable

Este endpoint permite a geração de uma forma de pagamento para uma fatura específica, por meio do seu identificador único (id).

📘

Nota

Para gerar uma forma de pagamento, a fatura já deve estar fechada (cycleType = Closed).

As formas de pagamento podem ser:

• Total
• Parcial:
  • Pagamento mínimo
  • Pagamento em atraso

👍

Dica

Para mais informações sobre as formas de pagamento de uma fatura, consulte a Visão geral desta documentação.

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que o cliente do parceiro Bankly:

• Tenha sido aprovado na análise de crédito;
• Tenha pelo menos um um cartão emitido.

Requisição

Requisição HTTP

HTTP

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

cURL

--request POST \ 
--url 'https://api-mtls.sandbox.bankly.com.br/cards/invoices/{statementId}/payment' \ 
--header 'Authorization:  Bearer {Token}'\ 
--header 'accept: application/json' \ 
--header 'api-version: 1' \ 
--header 'content-type: application/json'
--data '{
     "paymentType": "Partial", 
     "value": 0.0, 
     "paymentOptionId": 0 
} '

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:

Scope	Descrição
invoice.write	Concede acesso para gerar uma forma de pagamento de uma fatura.

Cabeçalhos (Headers)

Nome	Descrição
api-version	Obrigatório. Versão da API. Atualmente estamos na versão 1.0.
Authorization	Obrigatório. Token de autorização do tipo Bearer.
idempotency-key	Obrigatório. Chave de idempotência, sendo uma nova a cada requisição. Em caso de retry, deve-se enviar o mesma.
x-correlation-id	Informe um GUID, sendo um novo cada requisição.

Parâmetros da rota (Path)

No path desta requisição, envie o seguinte campo:

Nome	Tipo	Descrição
statementId	path	Obrigatório. Identificador único da fatura.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

Nome	Tipo	Descrição
paymentType	string	Obrigatório. Opção de pagamento, que pode ser: “Cash” (à vista), “Partial” (parcial), “InstallmentWithEntry” (parcelado com entrada) e “InstallmentWithoutEntry” (parcelado sem entrada).
value	number	Valor a ser pago. Este campo é obrigatório somente se o tipo de pagamento escolhido for “Partial”.
paymentOptionId	integer	Identificador da opção de pagamento. Este campo é obrigatório somente se o tipo de pagamento escolhido for “InstallmentWithEntry”. O identificador poderá ser obtido por meio do endpoint de consulta das opções de pagamento.

JSON

{ 
     "paymentType": "Partial", 
     "value": 0.0, 
     "paymentOptionId": 0 
} 

ℹ️

Nota

Um pagamento pode ser efetivado em até dois dias úteis, devido ao tempo de liquidação do boleto.

Resposta (Response)

O status code 202 indicará que a forma de pagamento está sendo criada e retornará um objeto com os dados da forma de pagamento escolhida.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição
status	string	Situação do pagamento, que pode ser “Pending” (pendente) ou “Paid” (pago).
digitableLine	string	Linha digitável do boleto de pagamento.
authenticationCode	string	Identificador da forma de pagamento.

JSON

{ 
  "status": "Pending", 
  "digitableLine": "string", 
  "authenticationCode": "string" 
} 

👍

Dica

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

Erros

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

Status Code	Código	Mensagem	Descrição
406	STATEMENT_IS_NOT_CLOSED	Statement is not closed!	A fatura não está fechada.
406	PAYMENT_TYPE_VALUE_NOT_ALLOWED	The partial payment amount must be less than the invoice amount!	O valor do pagamento parcial deve ser menor que o valor da fatura.
406	PAYMENT_TYPE_AMOUNT_MINIMAL_NOT_ALLOWED	The partial payment amount cannot be less than the minimum amount configured for issuing a bank slip.	O valor do pagamento parcial não pode ser inferior ao valor mínimo configurado para emissão de boleto bancário.

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).

Eventos

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

Nome do evento	Descrição
INVOICE_PAYMENT_OPTION_CREATED	Opção de pagamento de fatura criada.