Pular para o conteúdo principal
GET
/
charge
/
{chargeId}
curl -X GET "https://api.gates2b.com/charge/{chargeId}" \
  -H "Authorization: Bearer {seu-token}"

{
  "id": "chr_abc123",
  "grossAmount": "10.50",
  "currency": "BRL",
  "status": "PENDING",
  "description": "Cobrança de teste",
  "externalReference": "pedido-123",
  "createdAt": "2026-01-15T14:00:00.000Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.gates2b.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Authorization
string
obrigatório
Token de autenticação no formato Bearer.
​
chargeId
string
obrigatório
ID da cobrança.

​
Response

​
id
string
ID único da cobrança.
​
grossAmount
string
Valor bruto da cobrança.
​
currency
string
Moeda da cobrança.
​
status
string
Status atual da cobrança (PENDING, PAID, EXPIRED, CANCELED).
​
description
string
Descrição da cobrança.
​
externalReference
string
Referência externa.
​
createdAt
string
Data de criação (ISO 8601).
curl -X GET "https://api.gates2b.com/charge/{chargeId}" \
  -H "Authorization: Bearer {seu-token}"

{
  "id": "chr_abc123",
  "grossAmount": "10.50",
  "currency": "BRL",
  "status": "PENDING",
  "description": "Cobrança de teste",
  "externalReference": "pedido-123",
  "createdAt": "2026-01-15T14:00:00.000Z"
}

​
Outras consultas disponíveis

​
Listar Cobranças

GET /charge/list?page=1&limit=10 Retorna a lista paginada de cobranças do usuário autenticado.
ParâmetroTipoDescrição
pagenumberNúmero da página (padrão: 1)
limitnumberRegistros por página (padrão: 10)

​
Buscar por Referência Externa

GET /charge?externalReference=pedido-123 Busca uma cobrança pela referência externa do seu sistema.
ParâmetroTipoDescrição
externalReferencestringReferência externa usada na criação

​
Listar Tentativas de uma Cobrança

GET /charge/{chargeId}/attempts Retorna todas as tentativas de pagamento associadas a uma cobrança. Cada tentativa contém:
CampoTipoDescrição
idstringID da tentativa
chargeIdstringID da cobrança
paymentMethodstringMétodo usado (PIX, CREDIT_CARD, INTERNATIONAL)
statusstringStatus da tentativa
checkoutMetaobjectMetadados do gateway

​
Buscar Tentativa Específica

GET /charge/attempts/{attemptId} Retorna os detalhes de uma tentativa específica, incluindo status do gateway e checkoutMeta.