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": {}
  }
}
'
{
  "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"
  }
}

Requer a permissão CHECKOUT:READ.
Cria um checkout transparente via Boleto. A API devolve a linha digitável (barCode), uma URL para visualização e impressão do boleto (url), e o PIX alternativo (brCode/brCodeBase64) para a mesma cobrança — tudo em uma única chamada.
Para cobrar via PIX, veja Criar cobrança PIX.

​
Campos obrigatórios

CampoTipoDescrição
methodstringDeve ser "BOLETO"
data.amountnumberValor em centavos (ex: 25000 = R$ 250,00)
data.customer.namestringNome completo do pagador
data.customer.taxIdstringCPF ou CNPJ do pagador

​
Requisição

{
  "method": "BOLETO",
  "data": {
    "amount": 25000,
    "description": "Fatura de serviço mensal",
    "customer": {
      "name": "Mariana Costa",
      "taxId": "987.654.321-00",
      "email": "mariana.costa@empresa.com.br",
      "cellphone": "(21) 99876-5432"
    },
    "metadata": {
      "faturaId": "fatura-456",
      "plano": "pro"
    }
  }
}

​
Resposta

{
  "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-34567890abcd5204000053039865802BR5913Mariana 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"
    }
  },
  "success": true,
  "error": null
}
Abra url para exibir o boleto para impressão. Use barCode para o cliente digitar a linha digitável no app do banco. Use brCode/brCodeBase64 para oferecer PIX como alternativa sem nenhum esforço adicional.

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