Schemas

Referência completa de enums e objetos usados pela API.

Enums

Status possíveis de uma transação.

Valor	Descrição
`PENDING`	Aguardando pagamento ou processamento
`COMPLETED`	Concluída com sucesso
`CANCELED`	Cancelada
`WAITING_FOR_REFUND`	Aguardando estorno
`REFUNDED`	Estorno concluído
`EXPIRED`	Expirou antes do pagamento

Fluxo típico — Depósito:

PENDING → COMPLETED
PENDING → CANCELED
PENDING → EXPIRED
COMPLETED → WAITING_FOR_REFUND → REFUNDED

Fluxo típico — Saque:

PENDING → COMPLETED
PENDING → CANCELED

Valor	Descrição
`DEPOSIT`	Cobrança Pix (cash-in)
`WITHDRAW`	Saque Pix (cash-out)
`TEF`	Transferência eletrônica (uso interno)

Tipo da regra de taxa aplicada à transação.

Valor	Descrição
`FIXED`	Valor fixo em reais
`PERCENTAGE`	Percentual sobre o valor da transação

Tipo de chave Pix.

Valor	Formato esperado
`cpf`	11 dígitos numéricos
`cnpj`	14 dígitos numéricos
`email`	Endereço de e-mail válido
`phone`	Número com DDD e código do país (ex: `+5511999999999`)
`evp`	Chave aleatória — 36 caracteres com hífens

Objeto retornado em GET /v1/pix, GET /v1/account/transactions e nos webhooks.

Campo	Tipo	Descrição
`id`	`string`	ID CUID da transação
`status`	`TransactionStatus`	Status atual
`type`	`TransactionType`	Tipo da transação
`amount`	`number`	Valor em reais
`taxValue`	`number`	Valor da taxa cobrada
`taxType`	`TaxType`	Tipo da taxa aplicada
`callbackUrl`	`string \| null`	URL de callback registrada na criação
`qrCodeText`	`string \| null`	Payload Pix Copia e Cola (depósitos)
`qrCodeUrl`	`string \| null`	URL da imagem PNG do QR Code
`qrCodeBase64`	`string \| null`	QR Code em Base64 PNG (depósitos)
`payerName`	`string \| null`	Nome do pagador — preenchido após pagamento
`payerDocument`	`string \| null`	CPF/CNPJ do pagador — preenchido após pagamento
`receiverName`	`string \| null`	Nome do recebedor (saques)
`receiverDocument`	`string \| null`	Documento do recebedor (saques)
`withdrawPixKey`	`string \| null`	Chave Pix de destino do saque
`withdrawPixType`	`PixType` \| `null`	Tipo da chave Pix de destino
`endToEndId`	`string \| null`	ID fim a fim Pix — presente após liquidação
`createdAt`	`string`	Data de criação (ISO 8601 UTC)
`updatedAt`	`string`	Data da última atualização (ISO 8601 UTC)

Payload enviado à callbackUrl em cobranças Pix.

Payload enviado à callbackUrl em saques.

Retornado por POST /v1/pix/qr-code/read.

Campo	Tipo	Descrição
`qrCodeType`	`"DYNAMIC" \| "STATIC"`	Tipo do QR Code
`amount`	`number \| null`	Valor. `null` em QR estático sem valor fixo
`name`	`string \| null`	Nome do recebedor
`document`	`string \| null`	Documento do recebedor
`additionalInfo`	`string \| null`	Informação adicional
`expiresIn`	`integer`	Segundos até expiração (apenas DYNAMIC)
`txid`	`string`	ID da transação no sistema do recebedor (apenas DYNAMIC)
`createdAt`	`string`	Data de criação (apenas DYNAMIC)