Skip to main content
POST
https://api.pronttus.com.br
/
v1
/
banking
/
cash-in
/
pix
curl -X POST https://api.pronttus.com.br/v1/banking/cash-in/pix \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer seu_token" \
  -d '{
    "amount": 500,
    "description": "Pagamento de produto",
    "customer": {
      "name": "João Silva",
      "document": "12345678900",
      "email": "[email protected]",
      "phone": "11999999999"
    },
    "externalId": "ORDER_12345",
    "expiration": 3600,
    "split": {
        "amount": 100,
        "mode": "FIXED",
        "wallet_id": "550e8400-e29b-41d4-a716-446655440000"
      }
  }'

{
  "transactionId": "6d2fd101-7dae-4259-bcf0-b8851c9868fb",
  "amount": 500,
  "status": "WAITING_PAYMENT",
  "pixCode": "00020101021226840014br.gov.bcb.pix2562qrcode.pronttus.com.br/pix/095B80A4B3FD45EBA43B169811D2FC5F5204000053039865802BR5925Pronttus Payment Solution6010PIRACICABA62070503***630409FB",
  "qrCode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOQAAADkCAYAAACIV4iNAAAAAklEQVR4AewaftIAAAxgSURBV...",
  "createdAt": "2025-10-15T04:01:34.762Z"
}

​
Visão Geral

Este endpoint é responsável por criar uma cobrança PIX imediata, gerando um QR Code que pode ser escaneado pelo cliente para realizar o pagamento.
A cobrança PIX é gerada instantaneamente e fica aguardando o pagamento até expirar.

​
Autenticação

​
Authorization
string
required
Token Bearer obtido no endpoint de autenticação Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...

​
Parâmetros do Body

​
amount
integer
required
Valor da cobrança em centavos (500 = R5,00)Exemplo:‘500‘paraR 5,00) Exemplo: `500` para R 5,00
​
description
string
required
Descrição da cobrança que aparecerá para o cliente Exemplo: “Pagamento de produto”
​
customer
object
required
Dados do cliente que realizará o pagamento
​
externalId
string
ID da sua aplicação para identificação e rastreamento
​
expiration
integer
default:"86400"
Tempo de expiração da cobrança em segundos (padrão: 86400 = 24 horas)
​
split
array
Array de objetos para divisão do valor da transação entre diferentes wallets
A funcionalidade de split precisa ser ativada pelo suporte da Pronttus. Entre em contato para habilitar esta funcionalidade.
curl -X POST https://api.pronttus.com.br/v1/banking/cash-in/pix \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer seu_token" \
  -d '{
    "amount": 500,
    "description": "Pagamento de produto",
    "customer": {
      "name": "João Silva",
      "document": "12345678900",
      "email": "[email protected]",
      "phone": "11999999999"
    },
    "externalId": "ORDER_12345",
    "expiration": 3600,
    "split": {
        "amount": 100,
        "mode": "FIXED",
        "wallet_id": "550e8400-e29b-41d4-a716-446655440000"
      }
  }'

{
  "transactionId": "6d2fd101-7dae-4259-bcf0-b8851c9868fb",
  "amount": 500,
  "status": "WAITING_PAYMENT",
  "pixCode": "00020101021226840014br.gov.bcb.pix2562qrcode.pronttus.com.br/pix/095B80A4B3FD45EBA43B169811D2FC5F5204000053039865802BR5925Pronttus Payment Solution6010PIRACICABA62070503***630409FB",
  "qrCode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOQAAADkCAYAAACIV4iNAAAAAklEQVR4AewaftIAAAxgSURBV...",
  "createdAt": "2025-10-15T04:01:34.762Z"
}

​
Split de Transações

O objeto split permite dividir o valor da transação entre diferentes wallets de merchants. Esta funcionalidade é ideal para:
  • Marketplaces: Dividir comissões entre vendedores
  • Franquias: Separar recebimentos por unidade
  • E-commerce: Distribuir valores entre diferentes contas

​
Tipos de Split

​
Split Fixo (FIXED)

Divide um valor específico em centavos para uma wallet. 
{
  "amount": 1000,
  "mode": "FIXED",
  "wallet_id": "550e8400-e29b-41d4-a716-446655440000"
}

​
Split Percentual (PERCENTAGE)

Divide uma porcentagem do valor total da transação. 
{
  "amount": 15,
  "mode": "PERCENTAGE",
  "wallet_id": "660e8400-e29b-41d4-a716-446655440001"
}

​
Exemplo Prático

Para uma transação de R$ 100,00 (10000 centavos) com split: 
{
  "amount": 10000,
  "split": [
    {
      "amount": 2000,
      "mode": "FIXED",
      "wallet_id": "wallet-vendedor-1"
    },
    {
      "amount": 10,
      "mode": "PERCENTAGE",
      "wallet_id": "wallet-comissao"
    }
  ]
}
Resultado:
  • Wallet do vendedor: R$ 20,00 (fixo)
  • Wallet de comissão: R10,00(10 10,00 (10% de R 100,00)
  • Conta principal: R$ 70,00 (restante)
A funcionalidade de split precisa ser ativada pelo suporte da Pronttus. Entre em contato para habilitar esta funcionalidade.

​
Campos da Resposta

​
transactionId
string
UUID único da transação gerada
​
amount
integer
Valor da cobrança em centavos
​
status
string
Status da cobrança: WAITING_PAYMENT, PAID, EXPIRED, CANCELLED
​
pixCode
string
Código PIX copia e cola (string EMV) que pode ser usado pelo cliente
​
qrCode
string
Imagem do QR Code em base64 pronta para exibição
​
createdAt
string
Data e hora de criação da cobrança (ISO 8601)