API v1
Cobranças

Consultar cobrança

GET/v1/charges/{chargeId}charges:read

Ciclo de vida

  1. CREATINGPENDINGQR pronto
  2. PENDINGPAIDcharge.paid
  3. PENDINGEXPIRED · CANCELED · FAILEDvence em expires_at
  4. PAIDREVERSEDMED

Cabeçalhos

Authorizationstringobrigatório

Bearer seguido da sua chave: gw_test_ em teste, gw_live_ em produção.

Parâmetros de caminho

chargeIduuidobrigatório

Resposta 200

Cobrança encontrada

iduuid
external_idstring
method

PIX ou CARD (checkout no cartão).

PIXCARD
statusstring
CREATINGPENDINGPAIDFAILEDCANCELEDEXPIREDUNDER_REVIEWREVERSED
amount_centsinteger

Valor inteiro em centavos.

exemplo 4990 = R$ 49,90
fee_centsinteger

Valor inteiro em centavos.

exemplo 149 = R$ 1,49
net_amount_centsinteger

Valor inteiro em centavos.

exemplo 4841 = R$ 48,41
pixPixArtifact | null
3 campos
copy_pastestring
qr_code_urlurl | null
qr_code_base64string | null
cardobject | nullNOVO

Só em cobranças CARD. O link do checkout aparece enquanto a cobrança está PENDING. O valor pago fica a liberar até a liberação da venda no cartão.

2 campos
checkout_urlurl | null
checkout_expires_atdatetime | null
expires_atdatetime | null
paid_atdatetime | null
created_atdatetime
updated_atdatetime
settlementobject
3 campos
modestring | null
D0D1
sourcestring | null
GLOBALMERCHANTLEGACY
withdrawable_atdatetime | null
descriptionstring | nullNOVO
metadataobject · até 20 chavesNOVO

Pares chave-valor seus, até 20 chaves e 2 KB. Gravados uma vez na criação e devolvidos em toda consulta e webhook. Não guarde dados pessoais aqui.

product_iduuid | nullNOVO

Produto do catálogo que esta cobrança vendeu, quando criada a partir de um.

payerobject | nullNOVO

Quem você informou que pagaria, com o documento mascarado.

2 campos
namestring | null
document_maskedstring | null

Ex.: ***.456.789-**

paid_byobject | nullNOVO

Quem pagou, segundo o banco. Pode ser diferente de payer. null até o pagamento.

3 campos
namestring | null
document_maskedstring | null

Ex.: ***.456.789-**

bankstring | null
end_to_end_idstring | nullNOVO

ID fim a fim do Pix no Banco Central. null até o pagamento.

reversed_atdatetime | nullNOVO

Códigos de resposta

HTTPQuando acontece
200Cobrança encontrada
400Requisição ou cursor inválido
401Chave ausente, inválida ou sem o escopo exigido
404Recurso não encontrado para o estabelecimento autenticado
429Limite de requisições excedido
503Serviço temporariamente indisponível

Cada código de erro está explicado em Erros.