Changelog API Grafeno: 2024-10-29

Improved: [API de Cobranças] Inclusão dos dados de tarifas (fees) e pagamentos (payments) na listagem de cobranças na API V2

Agora, o recurso Listar Cobranças da API V2 retorna informações completas sobre as tarifas aplicadas a cada cobrança, bem como os dados de pagamento das cobranças quitadas. Essa melhoria foi implementada para assegurar maior transparência e completude nas informações fornecidas.

Exemplo de nova estrutura de retorno

{
  "data": [
    {
      "id": "0387e30e-c9a9-4df4-bce8-9fd977b72b97",
      "type": "charge",
      "attributes": {
        "createdAt": "2023-09-01T14:13:42.365-03:00",
        "updatedAt": "2023-09-01T14:26:09.188-03:00",
        "origin": "api",
        "status": "paid",
        "dueDate": "2023-09-07",
        "expiresAfter": 90,
        "value": 251.11,
        "paymentMethod": "boleto",
        "clientControlNumber": null,
        "paidAt": "2023-09-01",
        "payer": {
          "data": {
            "type": "payer",
            "attributes": {
              "name": "Charge Test",
              "documentNumber": "12345679891",
              "email": "[email protected]",
              "address": {
                "street": "Av Brigadeiro Faria Lima",
                "number": "1355",
                "complement": "Apt 222",
                "zipCode": "01452-011",
                "neighborhood": "Jardim Paulistano",
                "city": "SÃO PAULO",
                "state": "SP"
              },
              "phone": {
                "countryCode": "55",
                "areaCode": "51",
                "number": "995562211"
              }
            }
          }
        },
        "fees": {
          "data": [
            {
              "id": "101529",
              "type": "event",
              "attributes": {
                "kind": "charge_boleto_online_canceled_cost",
                "value": 1.99
              }
            },
            {
              "id": "101524",
              "type": "event",
              "attributes": {
                "kind": "charge_boleto_online_register_cost",
                "value": 0.0
              }
            }
          ]
        },
        "payments": {
          "data": [
            {
              "id": "fb12b259-f069-492c-9278-b03823a02dba",
              "type": "payment",
              "attributes": {
                "value": 251.11,
                "receivedAt": "2023-09-01",
                "processedAt": "2023-09-01T14:26:09.110-03:00",
                "paymentBankCode": null,
                "paymentAgency": null
              }
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "search": {
      "statusEq": "paid"
    },
    "pagination": {
      "currentPage": 1,
      "previousPage": null,
      "nextPage": 2,
      "perPage": 25,
      "totalPages": 7,
      "totalCount": 152
    }
  }
}