Skip to main content
POST
/
transparents
/
create
Criar Checkout Transparente
curl --request POST \
  --url https://api.abacatepay.com/v2/transparents/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "PIX",
  "data": {
    "amount": 123,
    "expiresIn": 123,
    "description": "<string>",
    "externalId": "<string>",
    "metadata": {},
    "utm": {
      "source": "<string>",
      "medium": "<string>",
      "campaign": "<string>",
      "term": "<string>",
      "content": "<string>"
    }
  }
}
'
{
  "data": {
    "id": "bole_k8pqr2mnvx",
    "amount": 25000,
    "status": "PENDING",
    "devMode": false,
    "barCode": "23793.38128 60007.827263 37000.963779 4 10010000025000",
    "url": "https://app.abacatepay.com/pay/bole_k8pqr2mnvx/boleto",
    "brCode": "00020126580014BR.GOV.BCB.PIX0136d2b4e5f6-7890-abcd-ef12-34567890abcd5204000053039865802BR5914Mariana Costa6009SAO PAULO62070503***6304F1C2",
    "brCodeBase64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
    "platformFee": 250,
    "expiresAt": "2024-11-07T03:00:00.000Z",
    "createdAt": "2024-11-04T14:22:10.381Z",
    "updatedAt": "2024-11-04T14:22:10.381Z",
    "metadata": {
      "faturaId": "fatura-456",
      "plano": "pro"
    }
  },
  "error": null,
  "success": {
    "message": "Checkout transparente criado com sucesso"
  }
}

Documentation Index

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

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

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

CampoTipoDescrição
methodstringDeve ser "PIX"
data.amountnumberValor em centavos (ex: 10000 = R$ 100,00)
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).
CampoTipoDescrição
utm.sourcestringOpcional
utm.mediumstringOpcional
utm.campaignstringOpcional
utm.termstringOpcional
utm.contentstringOpcional
Quando enviados, podem ser consultados no dashboard. Não alteram valores, vencimento nem status da cobrança.

​
Exemplos mínimos (PIX)

Sem utm: 
{
  "method": "PIX",
  "data": {
    "amount": 10000
  }
}
Com utm: 
{
  "method": "PIX",
  "data": {
    "amount": 10000,
    "utm": {
      "source": "newsletter",
      "medium": "email",
      "campaign": "lancamento_q1",
      "term": "pix",
      "content": "cta_hero"
    }
  }
}

​
Requisição

{
  "method": "PIX",
  "data": {
    "amount": 10000,
    "description": "Cobrança PIX no checkout transparente",
    "expiresIn": 3600,
    "customer": {
      "name": "Daniel Lima",
      "email": "daniel_lima@abacatepay.com",
      "taxId": "123.456.789-01",
      "cellphone": "(11) 4002-8922"
    },
    "metadata": {
      "pedidoId": "pedido-123"
    }
  }
}

​
Resposta

{
  "data": {
    "id": "pix_char_abc123xyz",
    "amount": 10000,
    "status": "PENDING",
    "devMode": false,
    "brCode": "00020160014BR.GOV.BCB.PIX070503***6304ABCD",
    "brCodeBase64": "data:image/png;base64,iVBORw0KG...",
    "platformFee": 100,
    "createdAt": "2024-11-04T18:38:28.573Z",
    "updatedAt": "2024-11-04T18:38:28.573Z",
    "expiresAt": "2024-11-04T19:38:28.573Z",
    "metadata": {
      "pedidoId": "pedido-123"
    }
  },
  "success": true,
  "error": null
}
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