1. Transações
PushPag API
  • Bem-vindo à PushPag API
  • Autenticação
    • Gerar Token de Acesso
      POST
  • Transações
    • Criar Cobrança PIX
      POST
    • Consultar Status da Transação
      GET
  • Utilitários
    • Verificar Token
      GET
  • Raiz
  • Esquemas
    • AuthRequest
    • AuthResponse
    • CreateTransactionRequest
    • CustomerRequest
    • ItemRequest
    • TransactionResponse
    • Transaction
    • PixData
    • CustomerResponse
    • ItemResponse
    • Error
    • ValidationErrorResponse
  1. Transações

Criar Cobrança PIX

POST
/transactions
Cria uma nova cobrança PIX. A resposta contém o QR Code e o código copia-e-cola para exibir ao seu cliente.

Valor mínimo#

R$5,00 → 500 centavos

Exibindo o QR Code#

Use data.pix.qrcode para gerar a imagem. Exemplo em PHP com endroid/qr-code:

Detectando o pagamento#

Após criar a cobrança, inicie polling em GET /transactions/{id} a cada 3–5 segundos até status === "PAID" ou status === "EXPIRED".

Requisição

Authorization
Bearer Token
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
or
Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201
application/json
Cobrança criada — exiba pix.qrcode ao cliente
Body

🟠401Unauthorized
🟠422ValidationError
🔴502GatewayError
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl -X POST https://api.pushpag.com/v1/transactions \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 1990,
    "method": "PIX",
    "metadata": { "sellerExternalRef": "pedido-00123" },
    "customer": {
      "name": "Maria Silva",
      "email": "maria@email.com",
      "phone": "11999998888",
      "documentType": "CPF",
      "document": "26841949048"
    },
    "items": [{
      "title": "Acesso Premium",
      "amount": 1990,
      "quantity": 1,
      "tangible": false,
      "externalRef": "plan-premium"
    }],
    "postbackUrl": "https://meusite.com/webhooks/pushpag"
  }'
Response Response Example
201 - Sucesso
{
    "status": true,
    "data": {
        "id": "f1da0134-1c97-4b55-b791-1ebc657b62ef",
        "amount": 1990,
        "feeAmount": 0,
        "netAmount": 0,
        "status": "PENDING",
        "method": "PIX",
        "pix": {
            "id": "de79cd76-6870-4174-b805-edf1a0f426f9",
            "qrcode": "00020101021226870014br.gov.bcb.pix2565pix.basspago.com.br/qr/v3/at/b2b79ff3-bc21-4fc2-bad5-ec0833e908b95204000053039865802BR5918WARM_UP_ASSESSORIA6007NITEROI62070503***63048CBF",
            "qrcodeUrl": "00020101021226870014br.gov.bcb.pix2565pix.basspago.com.br/qr/v3/at/b2b79ff3-bc21-4fc2-bad5-ec0833e908b95204000053039865802BR5918WARM_UP_ASSESSORIA6007NITEROI62070503***63048CBF",
            "copyPaste": "00020101021226870014br.gov.bcb.pix2565pix.basspago.com.br/qr/v3/at/b2b79ff3-bc21-4fc2-bad5-ec0833e908b95204000053039865802BR5918WARM_UP_ASSESSORIA6007NITEROI62070503***63048CBF",
            "expirationDate": "2025-12-12T03:00:00.000Z",
            "createdAt": "2025-12-11T14:06:03.000Z",
            "updatedAt": "2025-12-11T14:06:03.000Z",
            "transactionId": "f1da0134-1c97-4b55-b791-1ebc657b62ef"
        },
        "customer": {
            "id": "514caf9c-aadf-46ec-aec4-d3ede47a5949",
            "name": "Maria Silva",
            "email": "maria@email.com",
            "phone": "11999998888",
            "documentType": "CPF",
            "document": "26841949048",
            "externalRef": null,
            "createdAt": "2025-12-11T14:06:00.000Z"
        },
        "items": [
            {
                "id": "691ed38d-c4bd-4ea1-9215-5d1ee14cea35",
                "title": "Acesso Premium — 1 mês",
                "amount": 1990,
                "quantity": 1,
                "tangible": false,
                "externalRef": "plan-premium-monthly",
                "transactionId": "f1da0134-1c97-4b55-b791-1ebc657b62ef",
                "createdAt": "2025-12-11T14:06:01.000Z",
                "updatedAt": "2025-12-11T14:06:01.000Z"
            }
        ],
        "metadata": {
            "sellerExternalRef": "pedido-00123"
        },
        "postbackUrl": "https://meusite.com/webhooks/pushpag",
        "boleto": null,
        "card": null,
        "description": null,
        "installments": null,
        "paidAt": null,
        "end2endId": null,
        "createdAt": "2025-12-11T14:06:00.000Z"
    }
}
Modificado em 2026-04-06 06:57:52
Página anterior
Gerar Token de Acesso
Próxima página
Consultar Status da Transação
Built with