Skip to main content
POST
/
api
/
transactions
Criar QR Code PIX
curl --request POST \
  --url https://api.example.com/api/transactions \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer": {
    "name": "<string>",
    "document": "<string>",
    "documentType": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "address": {
      "street": "<string>",
      "streetNumber": "<string>",
      "complement": "<string>",
      "neighborhood": "<string>",
      "zipCode": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "<string>"
    }
  },
  "payment": {
    "amountCents": 123,
    "product": "<string>",
    "quantity": 123,
    "expirationDays": 123
  }
}
'
{
  "data.id": "<string>",
  "data.pixCode": "<string>",
  "data.expirationDate": "<string>",
  "data.status": "<string>"
}

Criar QR Code PIX

Cria uma nova transação PIX e retorna o código copia-e-cola para pagamento. Se uma transação idêntica (mesmo cliente, valor e produto) já estiver pendente, a transação existente será retornada em vez de criar uma nova.

Autenticação

Authorization: Bearer sk_test_xxx

Request Body

customer
object
required
payment
object
required

Response (201)

{
  "success": true,
  "message": "Transaction created successfully",
  "data": {
    "id": "clx7a8b9c0d1e2f3g4h5",
    "externalId": "ext_123456",
    "pixCode": "00020126580014br.gov.bcb.pix...",
    "expirationDate": "2026-01-17T10:00:00.000Z",
    "status": "waiting_payment",
    "amountCents": 10000,
    "product": "Plano Premium",
    "quantity": 1,
    "isSandbox": false,
    "createdAt": "2026-01-16T10:00:00.000Z",
    "updatedAt": "2026-01-16T10:00:00.000Z"
  }
}
data.id
string
ID da transação. Use para consultar status e simular pagamento.
data.pixCode
string
Código PIX copia-e-cola. Exiba ao cliente ou converta em QR Code.
data.expirationDate
string
Data/hora de expiração do PIX (ISO 8601).
data.status
string
Status inicial: waiting_payment.

Erros

HTTPCódigoDescrição
400ERR_VALIDATION_001Body inválido
401ERR_AUTH_009Token inválido
403ERR_UNAUTHORIZED_DOMAINDomínio de origem não registrado
403FRAUD_DETECTEDLimite de transações excedido para este cliente
409ERR_TRANSACTION_010Transação duplicada em processamento
429ERR_RATE_LIMIT_001Muitas requisições
503ERR_ALL_GATEWAYS_FAILEDFalha temporária no processamento

Precisa de ajuda?

Nossa equipe está disponível para auxiliar no processo de desenvolvimento. Entre em contato pelo e-mail [email protected].