Changelog API Grafeno: 2024-09-03

Added: [API de Cobranças] Inclusão do recurso de múltiplos descontos na API de cobranças

A partir de agora será possível criar cobranças na Grafeno informando uma regra de até 3 faixas de descontos. Esta feature possibilitará maior flexibilidade para suas cobranças.

Parâmetros

Parâmetro	Tipo	Descrição
discountUntil	Date (YYYY-MM-DD)	Data máxima para aplicação de desconto.
discountType	Enum, valores possíveis: fixed e percentage	Tipo de desconto, podendo ser valor percentual ou fixo (real).
discountValue	Double	Valor do desconto.

Estrutura

Para criar uma cobrança com múltiplas regras de desconto, basta utilizar a seguinte estrutura no JSON de criação de cobranças:

"discounts": [
    {
      "discountUntil": "2024-09-01",
      "discountType": "fixed",
      "discountValue": 5
    },
    {
      "discountUntil": "2024-10-01",
      "discountType": "percentage",
      "discountValue": 10.1
    },
    {
      "discountUntil": "2024-10-25",
      "discountType": "fixed",
      "discountValue": 2.99
    }
  ]

{
  "paymentMethod": "boleto",
  "discounts": [
    {
      "discountUntil": "2024-09-01",
      "discountType": "fixed",
      "discountValue": 5
    },
    {
      "discountUntil": "2024-10-01",
      "discountType": "percentage",
      "discountValue": 10.1
    },
    {
      "discountUntil": "2024-10-25",
      "discountType": "fixed",
      "discountValue": 2.99
    }
  ],
  "payer": {
    "address": {
      "street": "Dr Albuquerque Lins",
      "neighborhood": "Santa Cecília",
      "number": "4321",
      "state": "SP",
      "city": "São Paulo",
      "zipCode": "01230000",
      "complement": "ap 206",
      "country": "BR"
    },
    "phone": {
      "number": "988776655",
      "areaCode": "11",
      "countryCode": "55"
    },
    "name": "Andy Bernard",
    "documentNumber": "12345679891",
    "email": "[email protected]"
  },
  "boletoDetails": {
    "registrationMethod": "online",
    "titleType": "several",
    "ourNumber": "225700008091",
    "yourNumber": "43212025",
    "observation": "Pagar somente na rede bancária."
  },
  "grantor": {
    "name": "Erin Hannon",
    "documentNumber": "88771518460",
    "address": {
      "street": "Dr Albuquerque Lins",
      "neighborhood": "Santa Cecília",
      "number": "444",
      "state": "SP",
      "city": "São Paulo",
      "zipCode": "01230000",
      "complement": "ap 206",
      "country": "BR"
    }
  },
  "dueDate": "2025-01-01",
  "value": 978.9,
  "abatementValue": 2,
  "interestType": "fixed_value",
  "interestValue": 25.99,
  "applicableFine": 1.5,
  "clientControlNumber": "CHARGE-00001",
  "expiresAfter": 60,
  "receiptNumber": "32191105570714000825550010059146622233082968"
}

Regras de negócio

A modalidade de cobranças do tipo PIX Cobrança não possuí suporte a regra de múltiplos descontos;
Os valores de descontos, não podem ser maiores ou iguais ao valor da cobrança e devem ser maior do que zero;
O prazo máximo para aplicação de desconto não pode ser maior do que a data de vencimento da cobrança, podendo ser igual a data de vencimento;
O limite máximo de regras de desconto de uma cobrança é de até 3 (três) regras;
Na API V2, existe uma estrutura de desconto chamada "discount", esta estrutura ainda não foi removida da API e permite a inclusão de apenas uma regra de desconto, por via de regra, não é possível utilizar na mesma cobrança ambas as estruturas (discount e discounts).

A correção já consta em nossa documentação técnica, para acessar, clique aqui.