Consultar cobrança por correlationID

GET

/api/charges/{{correlationID}}

Autenticação

Esta rota exige Bearer Token (sua API Key) no header. Envie EXATAMENTE assim:

Substitua o valor após Bearer pela sua API Key real (vk_live_* produção, vk_test_* sandbox). Crie a chave em https://app.dotfy.com.br/dashboard/chaves-api. Sem o header → 401. Com chave inválida/revogada → 401. Com chave sem o escopo necessário → 403 insufficient_scope.

Retorna o estado atual de uma cobrança pelo correlationID (retornado em POST /api/charges). Escopo: charges:read.

Esta rota busca o estado canônico no banco do Dotfy. Para forçar refresh com o adquirente upstream (Woovi/Treeal/etc), use GET /api/charges/detail/{id}.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Respostas

🟢200

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff '/api/charges/{{correlationID}}' \
--header 'Authorization: Bearer <token>'

Response Example

{
  "success": true,
  "data": {
    "id": "clcharge0001",
    "correlationID": "dotfy-1714000000000-abc12345",
    "transactionID": "E18236120202605071435s00abc12345",
    "status": "COMPLETED",
    "value": 2990,
    "valueFormatted": "R$ 29,90",
    "description": "Pedido #1234 - Plano Pro",
    "brCode": "00020126360014BR.GOV.BCB.PIX0114+5511999998888...",
    "qrCodeImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUg...",
    "paymentLink": "https://app.dotfy.com.br/checkout/dotfy-1714000000000-abc12345",
    "expiresAt": "2026-05-07T15:30:00.000Z",
    "createdAt": "2026-05-07T14:30:00.000Z",
    "paidAt": "2026-05-07T14:35:12.000Z",
    "payer": {
      "name": "Maria Silva",
      "email": "maria@exemplo.com",
      "phone": "+5511999998888",
      "document": "12345678901"
    },
    "isPaid": true,
    "isExpired": false,
    "isActive": false
  }
}

Modificado em 2026-07-02 06:57:27

Página anterior

Listar cobranças

Próxima página

Histórico de webhooks de uma cobrança

Consultar cobrança por correlationID

Autenticação#

Requisição

Respostas

Autenticação