Skip to main content
POST
Criar Checkout Transparente

Requer a permissão CHECKOUT:READ.
Cria um checkout transparente via PIX. A API devolve o QR Code em imagem (brCodeBase64) e o código copia e cola (brCode) — o cliente nunca sai do seu site.
Para cobrar via Boleto, veja Criar cobrança Boleto.

Campos obrigatórios

Todos os outros campos são opcionais mas recomendados para melhor rastreabilidade.

data.utm — campanha / UTM (opcional)

No corpo data com method: "PIX", o objeto utm usa o mesmo esquema do PIX QR Code v1 (PixQrCodeV1): objeto opcional; cada campo interno também é opcional (string). Quando enviados, podem ser consultados no dashboard. Não alteram valores, vencimento nem status da cobrança.

Exemplos mínimos (PIX)

Sem utm:
Com utm:

Requisição


Resposta

Use brCodeBase64 para renderizar a imagem do QR Code diretamente na sua página. Use brCode (copia e cola) para enviar por WhatsApp, Telegram ou e-mail.

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Body

application/json
method
enum<string>
default:PIX
required

Método de pagamento.

Available options:
PIX,
BOLETO
Example:

"PIX"

data
object
required

Dados da cobrança.

Response

Checkout transparente criado com sucesso

data
object

Dados da cobrança retornados pelo checkout transparente. Os campos brCode e brCodeBase64 são sempre retornados (PIX direto ou PIX alternativo do boleto). Para boleto também retornam barCode e url.

error
string | null
Example:

null

success
boolean

Se a requisição obteve sucesso ou não.

Example:

true