Cobranças

Este recurso permite a criação, consulta e alteração de cobranças.

Com a API de cobranças Grafeno, é possível emitir cobranças com as formas de pagamento Boleto Bancário Simples, Boleto Bancário Híbrido e PIX, além de ser possível editar as cobranças criadas e enviar para protesto as cobranças que não foram pagas.

A API de cobranças Grafeno possui suporte a webhooks, ou seja, notificaremos a sua aplicação sempre que suas cobranças sofrerem alguma alteração de status.

🚧

Integração de Cobranças - Vórtx

Atualmente a Grafeno utiliza dois agentes bancarizadores: BMP (274) e Vórtx (310).

Estruturalmente não existem diferenças na integração via API Grafeno entre os dois bancarizadores, ou seja, a API de cobranças Grafeno deve funcionar para a criação de cobranças independente do bancarizador da conta (274 ou 310).

O que muda são algumas regras de negócios entre a Grafeno - BMP e Grafeno - Vórtx, seguem as regras que se aplicam para a integração Grafeno - Vórtx:

1 - Nosso Número: O cálculo do dígito do NN é o mesmo utilizado no layout BMP (274), a única diferença é na seleção do dígito. A Vórtx não utiliza o dígito P, logo, por via de regra, se o resto da divisão for menor do que 2, o dígito será 0 (ZERO).

Se o resto da divisão for 0 (zero), ou se o resultado da subtração for 10 ou 11, o dígito de auto conferência será 0 (zero). Exemplo: Se a soma fosse 77, e 77÷11 tivesse resto 0, então o dígito verificador seria 0.

2 - Regras de negócios relacionadas às cobranças do banco Vórtx (310):

  • Não é possível alterar ou incluir uma definição de abatimento em cobranças já registradas;
  • Não é possível alterar a data de vencimento de uma cobrança que tenha regra de desconto definida;
  • Não é possível alterar o campo de multa de cobranças Vórtx registradas;
  • Não é possível alterar o campo de juros de cobranças Vórtx registradas;
  • Só existe um tipo de registro de boletos na Vórtx, neste caso é o registro online (imediato);
  • É possível alterar o dado "seu número" via API para cobranças Vórtx;
  • É possível alterar a data de vencimento de uma cobrança caso a mesma não tenha nenhuma regra de desconto definida.

3 - Código de barras / linha digitável: Diferente do banco BMP (274), na Vórtx (310), o número da conta na linha digitável do boleto bancário é informado com o dígito da conta.

4 - Carteira: A carteira Vórtx (310) é a 21, o banco é 310VORTX e a agência é a 0001.

5 - Modalidades de cobranças: Atualmente via Vórtx, só é possível gerar cobranças na modalide "Boleto Simples". As modalidades "PIX Cobrança" e "Boleto Híbrido" ainda não estão disponíveis.

Estrutura de uma cobrança

ParâmetroDescriçãoFormatoObrigatório
paymentMethodMétodo de pagamento da cobrança, valores possíveis: boleto, pix, boleto híbrido.StringNão (se omitido, o valor padrão será boleto.)
dueDateDat de vencimento da cobrança.Date (YYYY-MM-DD)Sim
valueValor da cobrança.DoubleSim
abatementValueValor do abatimento da cobrança em reais.DoubleNão
abatementValor do abatimento da cobrança em percentual.DoubleNão
interestTypeTipo de juros que será aplicado a cobrança. Valores possíveis: fixed_value ou percentage.StringNão
interestValueValor de juros que será aplicado a cobrança.DoubleNão
applicableFineMulta por atraso.DoubleNão
clientControlNumberIdentificador próprio definido pelo cliente.StringNão
expiresAfterDias para baixa automática da cobrança após a data de vencimento.IntNão
receiptNumberNúmero da nota fiscal vinculada a cobrança.StringNão
discount.rangeData limite para aplicação de desconto na cobrança.Date (YYYY-MM-DD)Não
discount.discountTypeTipo de desconto. Valores possíveis fixed e percentage.StringNão
discount.discountValueValor do desconto.DoubleNão
payer.nameNome do pagador.StringSim
payer.documentNumberCPF ou CNPJ do pagador.StringSim
payer.emailE-mail do pagador.StringSim
payer.phone.numberNúmero de telefone do pagador.StringNão
payer.phone.areaCodeCódigo de área do telefone do pagador.StringNão
payer.phone.countryCodeCódigo de país do telefone do pagador.StringNão
payer.address.streetEndereço do pagador: rua.StringSim
payer.address.numberEndereço do pagador: número.StringSim
payer.address.complementEndereço do pagador: complemento.StringNão
payer.address.neighborhoodEndereço do pagador: bairro.StringSim
payer.address.cityEndereço do pagador: cidade.StringSim
payer.address.stateEndereço do pagador: estado.StringSim
payer.address.zipCodeEndereço do pagador: CEP.StringSim
payer.address.countryEndereço do pagador: país.StringNão
boletoDetails.registrationMethodMétodo de registro do boleto bancário. Valores possíveis: online e offline.StringNão (se omitido, o valor padrão será offline.)
boletoDetails.titleTypeNatureza da cobrança. Clique aqui para obter os valores possíveis.StringNão (se omitido, o valor padrão será several.)
boletoDetails.messagingRuleIdRégua de cobrança que será utilizada.StringNão
boletoDetails.ourNumberNosso número do boleto bancário.StringNão
boletoDetails.yourNumberSeu número do boleto bancário.StringNão
boletoDetails.observationInstruções do boleto bancário.StringNão
grantor.nameNome do sacador / avalista.StringNão
grantor.documentNumberCPF ou CNPJ do sacador / avalista.StringNão
grantor.address.streetEndereço do sacador / avalista: rua.StringNão
grantor.address.numberEndereço do sacador / avalista: número.StringNão
grantor.address.complementEndereço do sacador / avalista: complemento.StringNão
grantor.address.neighborhoodEndereço do sacador / avalista: bairro.StringNão
grantor.address.cityEndereço do sacador / avalista: cidade.StringNão
grantor.address.stateEndereço do sacador / avalista: estado.StringNão
grantor.address.zipCodeEndereço do sacador / avalista: CEP.StringNão
grantor.address.countryEndereço do sacador / avalista: país.StringNão