Skip to main content
GET
/
charge
/
{id}
Buscar cobrança por ID
curl --request GET \
  --url https://api.clickpay.app.br/charge/{id} \
  --header 'Authorization: Bearer <token>'
{
  "status": 123,
  "message": "<string>",
  "data": {
    "id": "charge_123456",
    "total": 100000,
    "url": "https://pay.clickpay.app.br/c/charge_123456",
    "status": "OPEN",
    "paymentStatus": "PROCESSING",
    "devMode": false,
    "needShipping": false,
    "expiresAt": "2024-12-04T09:30:00.000Z",
    "company": {
      "taxId": "36062381000180",
      "name": "Empresa Bola Ltda"
    },
    "paymentDate": "2024-12-03T10:30:00.000Z",
    "successUrl": "https://example.com/success",
    "failedUrl": "https://example.com/failed",
    "brCode": "00020101021226950014br.gov.bcb.pix...",
    "brCodeBase64": "data:image/png;base64,iVBORw0KGgoAAA...",
    "items": [
      {
        "productId": "prod_123456",
        "companyId": "company_123456",
        "quantity": 2,
        "product": {
          "id": "prod_01F4Z8Z5Y6X7W8V9U0T1S2R3Q4",
          "name": "Produto Bola",
          "description": "Produto muito bom para uso diário",
          "price": 1990,
          "needShipping": false,
          "companyId": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
          "status": "ACTIVE",
          "sku": "SKU-ABCD-123",
          "imageUrl": "https://example.com/image.png"
        }
      }
    ],
    "customer": {
      "name": "João da Silva",
      "taxId": "053.054.053-64",
      "email": "[email protected]",
      "phone": "41999999999"
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

ID da cobrança

Response

Cobrança encontrada

status
number
required
message
string
required
data
object
required