v1

latestOpenAPI 3.1.02026-07-24890394.2 KB

Visualizar cobrança

Este recurso retorna informações de uma cobrança existente.

get/charges/{charge_uuid}

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-07T15:02:02.101-03:00",
      "status": "paid",
      "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,
      "updateStatus": "completed_with_errors",
      "updateDetails": [
        {
          "field": "dueDate",
          "status": "success",
          "previousValue": "2026-01-11",
          "newValue": "2026-02-22"
        }
      ],
      "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"
            }
          }
        }
      },
      "fees": {
        "data": [
          {
            "id": "109598",
            "type": "event",
            "attributes": {
              "kind": "charge_boleto_online_canceled_cost",
              "value": 1.99
            }
          }
        ]
      },
      "boleto": {
        "data": {
          "id": "a55b20c8-7896-44a2-8b42-53137cd09208",
          "type": "boleto",
          "attributes": {
            "ourNumber": 13102,
            "ourNumberDv": "8",
            "barCode": "27498956000000050000001010000001310281246950",
            "emv": "00020101021226970014br.gov.bcb.pix2575qr-h.cornerpix.com.br/11581339/v2/cobv/2215fe22-32f4-401b-b423-896bba43e97f5204000053039865802BR5914BMP MONEY PLUS6009SAO PAULO62070503***63043C6D",
            "image": "iVBORw0KGgoAAAANSUhEUgAAAhIAAAISAQAAAACxRhsSAAAFCUlEQVR4nO2dTW7jOBCFXw0FeEkBOUCOQt0syJH6BtJRfIABpGUACTWLYpG0k3E30I5ao3lcBLFofRCBQql+HmlR/O6Y/vptBEAGGWSQQQYZZJBBBhmVIXl0EJEOmPpNRPpN6gSATWQAIMPil4cnPwcZZDxkJFVVnQEgrmUyKBBVkXSFSA/oe7+Jjgiqqqq3jGc8BxlkPGQsxTveDNVrZ9YJM1sf7mOf/RxkkPFrjEUEaQ5q/039JvJ2zTYpg//5/ucgg4x/Z+gYVYGlg46oNhlUx6UDsHT4NI66FjLOw4AFmjk+DYo0w0y0Tti1HL3m7zW3jUdZCxmnZ0wiItIDAILK2xxUhsaBBpUBQZGuHWRALgQ8/znIIOProXdjBICka3agSdWSfpv48o6jrIWMszNE+pLCxxXAclFMPczR1qhUR6tabWIeeHjyc5BBxiOGe9EPQZrbaR3jCh2jT6TrRduS1JOfgwwyvh7F4rYOWF5U0o8eADZB0q2TNG/I/jQqJI0rdBoAAYI3BI6yFjLOy8hpveXxupbgc4Wl/zXBH71RlSe8KcX4lIy9GKrXDpia1j5QO6gyAJC368U6qHbHiFJdPdZayDgjo4k0JenWAQgq6cdFBfHvDlgEOr2uUCybWGgABEiqTdSjrIWM/wmjpvUAdPSmlKVQ02txpfFD9F189phrIeNUjKYa6r2nHHzWjy6QWr1RZeEq+1Fk7MYwDyqIM3SSsObXe5yb7wgASBoBWCxgd2ydPu85yCDj4fAuVFBLnKoDHaM3pYp7ddVp0Nyyoj8lYxdGKzexUtOMxjqrxVpAkEqtamRdioz9GMWfuqQvK6fgnjX6R1hnKpdTs/OlnZKxCyNHm2l+WSVHooAgrl2OVP2aYukg6Sr5G40S9ShrIeP0jOn1Q/LLv+j5px64rwEUL4pmG8rB1kLGCRnmFBXLRQXLSy6RTv0MJAXqNUFcoVh6AMvLijQCzPfJ2JUh0m+SG6WWM21i/hRxtRK/6ry5MDquub86PPk5yCDjMSOurjVFUNOfAsjXTOu3dPhKk3q8tZBxPobn+zFv08+VVADVvdbmqap6idX+Y75Pxi4Md4qLAJO91zdRABAsnQeuCKtk/WlQa08hzsyjyNiLUfzp6vXT2WdSM/HpjytW6U/J2INxo0OZgaow9WqUC6PNgGudH+B7n4y9GI2A386SavwkgJsaQNC6B7Vu4qedkvH9jHajyQhkf2qV/PKiL1bsYoDSQaWdkrELw+10hveeGleqjRI1m/J9+k87JWMPRqNDySOqVrmJy6eKaMrqUrf3HmUtZJyX0ew39TAUAIqarxZRLZm6KbYyjyJjJ8Ztvh/Uj0Bb23TJrs2hPRaN8SkZOzLa936NT4v+NJepYikJwLdGNfceZS1knJdR9Pyu2G8KUeonmyePT13oD/iB6LRTMvZg3J++1wpOY/mon+qnbXHgKGsh47wMz6NseOleq03OoZltN0mVghXtlIy9GCUqzT+60wMir1rCAFU7XWIEUCWqPGeCjJ0YHp/OQPu2rykUcBOpVucbuS+ajD/G0HERU/bru1xyBPDeb5LNdvHTzvMJ6N/1HGSQ8ZBhxVEz1g/fWbJc1A9BLVLq6OWs466FjNMwPv3eSW1FFbmJS/qyIqXZzs/3Phn7MO7z/eZ3I8uPSXgNAG6nN50B2ikZ388Q/fl3fjKmo6yFDDLIIIMMMsggg4z/PuMfAvavWpCR+BgAAAAASUVORK5CYII=",
            "quickPdfUrl": "https://grafeno-pagamentos-carrierwave-staging.s3.amazonaws.com/uploads/bmp/boleto/28903/file/10-12-2023_-_VIVI_ATUAL__NF__-_Han_Solo_-_53832.pdf?X-Amz-Expires=259200&X-Amz-Date=20231207T181431Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA6GUDBFRJDLS2JG7S%2F20231207%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=26efceaf31071ec7ef468671e581f1e67a1b4d1edfa409b7ae33508ec87da8b7",
            "lineCode": "27490001011000000131202812469506895600000005000",
            "registrationStatus": "registered",
            "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"
          }
        }
      },
      "payments": {
        "data": [
          {
            "id": "b5ecfee0-5726-40b1-903e-42330fee9d64",
            "type": "payment",
            "attributes": {
              "value": 50,
              "receivedAt": "2023-12-07",
              "processedAt": "2023-12-07T15:02:01.953-03:00"
            }
          }
        ]
      },
      "clientControlNumber": "7543649847645556555553425",
      "origin": "api",
      "receiptNumber": "51080701212344000127550010000000981364117781",
      "expiresAfter": 90,
      "titleType": "monthly_tuition"
    }
  }
}