ABabacatepay

Criar Checkout Transparente

Changed on

Cria um checkout transparente. Use "method": "PIX" para gerar um QR Code, "method": "BOLETO" para emitir um boleto com PIX alternativo incluído ou "method": "CARD" para cobrar cartão de crédito com o token gerado pelo abacatepay.js (token) ou com um cartão salvo (cardToken).

post/transparents/create

Request

  • Base URL
    https://api.abacatepay.com/v2
  • URL
    https://api.abacatepay.com/v2/transparents/create
  • Auth
    HTTP bearer

Request body

method'PIX' | 'BOLETO' | 'CARD' required

Método de pagamento.

Example request

{
  "method": "PIX",
  "data": {
    "dueDate": "2026-08-15",
    "customer": {
      "name": "Daniel Lima",
      "taxId": "111.444.777-35",
      "email": "daniel_lima@abacatepay.com",
      "cellphone": "(11) 4002-8922"
    },
    "interest": {
      "value": 100
    },
    "fine": {
      "value": 200,
      "type": "PERCENTAGE"
    },
    "token": "ctok_9fK2mQ7xLp4vR8sT1wYz3nBc",
    "cardToken": "dev_card_4242",
    "splits": [
      {
        "subAccountId": "sacc_9f8Kq2LmX4vTzR7pWn3bYc1H",
        "amount": 7000
      }
    ]
  }
}

Response

Checkout transparente criado com sucesso

errorstring nullable
successboolean

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

Example response

{
  "data": {
    "id": "bole_k8pqr2mnvx",
    "amount": 25000,
    "status": "PENDING",
    "brCode": "00020126580014BR.GOV.BCB.PIX0136d2b4e5f6-7890-abcd-ef12-34567890abcd5204000053039865802BR5913Daniel Lima6009SAO PAULO62070503***6304F1C2",
    "brCodeBase64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
    "barCode": "23793.38128 60007.827263 37000.963779 4 10010000025000",
    "url": "https://app.abacatepay.com/pay/bole_k8pqr2mnvx/boleto",
    "platformFee": 250,
    "interest": {
      "value": 100
    },
    "fine": {
      "value": 200,
      "type": "PERCENTAGE"
    },
    "expiresAt": "2024-11-07T03:00:00.000Z",
    "createdAt": "2024-11-04T14:22:10.381Z",
    "updatedAt": "2024-11-04T14:22:10.381Z",
    "cardToken": "dev_card_4242",
    "brand": "VISA",
    "lastFour": "4242",
    "installmentCount": 3,
    "installmentAmount": 10000,
    "installmentNumber": 1,
    "installmentGroupId": "cinst_Qe5tY7uI9oP1aS3dF5gH7jK9"
  },
  "success": true
}

Changes

  • 8be803988b57Revision changes
    • info

      added the new optional request property /

  • 6d06095aaa9bRevision changes
    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new CARD enum value to the request property

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status