v1

latestOpenAPI 3.1.02026-07-24890394.2 KB
Protestar cobrança

este recurso abre um protesto em uma cobrança.
post/charges/{charge_uuid}/protest
Path parameters

charge_uuidstring required
uuid da cobrança.
Response

200
Example response

{
  "data": {
    "id": "0e683d5d-61ce-445b-928e-3cc3340c0eda",
    "type": "charge",
    "attributes": {
      "createdAt": "2023-12-07T13:27:23.653-03:00",
      "updatedAt": "2023-12-07T13:27:23.653-03:00",
      "status": "pending",
      "paymentMethod": "boleto",
      "dueDate": "2023-12-10",
      "value": 50,
      "discount": {
        "range": "2023-12-08",
        "discountType": "percentage",
        "discountValue": 5
      },
      "abatementValue": 5.2,
      "interestType": "percentage",
      "interestValue": 2,
      "applicableFine": 2,
      "payer": {
        "data": {
          "type": "payer",
          "attributes": {
            "name": "Han Solo",
            "documentNumber": "12345679891",
            "email": "han.solo@dunder-mifflin.paper",
            "address": {
              "street": "Rua Dr. Albuquerque Lins",
              "number": "2222",
              "complement": "Apt 222",
              "zipCode": "01230-000",
              "neighborhood": "Santa Cecília",
              "city": "São Paulo",
              "state": "SP"
            },
            "phone": {
              "countryCode": "55",
              "areaCode": "51",
              "number": "995562211"
            }
          }
        }
      },
      "grantor": {
        "data": {
          "type": "grantor",
          "attributes": {
            "name": "Harrison Ford",
            "documentNumber": "88650081000116",
            "address": {
              "street": "Avenida Vinte de Setembro",
              "number": "456",
              "complement": "Apto 987",
              "zipCode": "93819-300",
              "neighborhood": "São Jacó",
              "city": "Sapiranga",
              "state": "RS"
            }
          }
        }
      },
      "boleto": {
        "data": {
          "id": "a55b20c8-7896-44a2-8b42-53137cd09208",
          "type": "boleto",
          "attributes": {
            "ourNumber": "00000004321",
            "ourNumberDv": 8,
            "pdf": "https://pagamentos.grafeno.be/charges/0e683d5d-61ce-445b-928e-3cc3340c0eda/download_boleto",
            "yourNumber": "11119998",
            "registrationMethod": "online",
            "messagingRuleId": "589f899a-9650-45ce-aeda-937f49c27156",
            "observation": "Sr(a) caixa, não receber o boleto após o vencimento"
          }
        }
      },
      "clientControlNumber": "7543649847645556555553425",
      "origin": "api",
      "receiptNumber": "51080701212344000127550010000000981364117781",
      "expiresAfter": 90,
      "titleType": "monthly_tuition"
    }
  }
}