Referência
Gere um QRCode Pix e um código copia-e-cola para o seu cliente
Estrutura
Uma cobrança via QRCode Pix é representada em nossa API pela seguinte estrutura:
Atributos:
id:
id:
id : string.
Identificador único da cobrança.
amount:
amount:
amount : number.
Valor da cobrança em centavos (ex: 4000 = R$ 40,00)
status:
status:
status : string.
Status da cobrança. Pode ser PENDING, EXPIRED, CANCELLED, PAID, REFUNDED.
| Status | Descrição |
|---|---|
PENDING | A cobrança está com o pagamento pendente |
EXPIRED | O tempo limite de pagamento foi excedido |
CANCELLED | A cobrança foi cancelada por você |
PAID | A cobrança foi paga com sucesso pelo cliente |
REFUNDED | O valor foi devolvido ao cliente |
devMode:
devMode:
devMode : boolean.
Indica se a cobrança está em ambiente de testes (true) ou produção (false).
method:
method:
method : string.
Método de pagamento.
brCode:
brCode:
brCode : string.
Código PIX (copia-e-cola) para pagamento.
brCodeBase64:
brCodeBase64:
brCodeBase64 : string.
Código PIX no formato Base64 (útil para exibição em imagens).
platformFee:
platformFee:
platformFee : number.
Taxa da plataforma em centavos. Exemplo: 80 significa R$ 0,80.
description:
description:
description : string.
Descrição da cobrança.
createdAt:
createdAt:
createdAt : date-time.
Data e hora da criação da cobrança.
updatedAt:
updatedAt:
updatedAt : date-time.
Última atualização da cobrança.
expiresAt:
expiresAt:
expiresAt : date-time.
Data e hora de expiração do QRCode.