Skip to main content
POST
https://api.pronttus.com.br
/
v1
/
banking
/
cash-out
/
pix
curl -X POST https://api.pronttus.com.br/v1/banking/cash-out/pix \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer seu_token" \
  -H "x-idempotency-key: bd07ea0c-1347-4830-a402-0a33ef3ab903" \
  -d '{
    "type": "pix_key",
    "description": "Pagamento a fornecedor",
    "amount": "500",
    "details": {
      "name": "João Silva",
      "document": "12345678900",
      "key": "[email protected]"
      "keyType": "CPF"
    }
  }'

{
  "transactionId": "4c73de37-15e3-4bdb-bcad-83a906e2409e",
  "amount": 500,
  "status": "PROCESSING",
  "createdAt": "2025-10-15T04:06:05.814Z",
  "x-idempotency-key": "bd07ea0c-1347-4830-a402-0a33ef3ab903"
}

​
Visão Geral

Este endpoint permite criar uma transferência PIX para qualquer chave PIX cadastrada no sistema brasileiro de pagamentos.
Caso o campo document seja informado, será possível apenas realizar a transação para o CPF/CNPJ especificado. Se a transação for efetuada para uma chave PIX de outro documento, será enviado um webhook com o status FAILED.

​
Autenticação

​
Authorization
string
required
Token Bearer obtido no endpoint de autenticação Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...
​
x-idempotency-key
string
required
Código único de idempotência para evitar transferências duplicadasImportante: Deve ser um UUID válido no formato xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. Use um UUID único para cada operação.

​
Parâmetros do Body

​
type
string
default:"pix_key"
required
Tipo de transferência. Por enquanto, apenas pix_key é suportado
​
description
string
required
Descrição da transferência Exemplo: “Pagamento a fornecedor”
​
amount
string
required
Valor da transferência em centavos (500 = R$ 5,00) Nota: Enviado como string, não número
​
details
object
required
Detalhes do destinatário
curl -X POST https://api.pronttus.com.br/v1/banking/cash-out/pix \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer seu_token" \
  -H "x-idempotency-key: bd07ea0c-1347-4830-a402-0a33ef3ab903" \
  -d '{
    "type": "pix_key",
    "description": "Pagamento a fornecedor",
    "amount": "500",
    "details": {
      "name": "João Silva",
      "document": "12345678900",
      "key": "[email protected]"
      "keyType": "CPF"
    }
  }'

{
  "transactionId": "4c73de37-15e3-4bdb-bcad-83a906e2409e",
  "amount": 500,
  "status": "PROCESSING",
  "createdAt": "2025-10-15T04:06:05.814Z",
  "x-idempotency-key": "bd07ea0c-1347-4830-a402-0a33ef3ab903"
}

​
Campos da Resposta

​
transactionId
string
UUID único da transação gerada
​
amount
integer
Valor da transferência em centavos
​
status
string
Status da transação: PROCESSING, COMPLETED, FAILED
​
createdAt
string
Data e hora de criação da transferência (ISO 8601)
​
x-idempotency-key
string
Chave de idempotência utilizada

​
Tipos de Chave PIX Aceitos

TipoFormatoExemplo
CPF11 dígitos12345678900
CNPJ14 dígitos12345678000190
E-mailE-mail válido[email protected]
Telefone+55 + DDD + número+5511999999999
AleatóriaUUIDa1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8
Configure webhooks para receber notificações automáticas sobre o status da transferência. Veja a seção Webhooks para mais detalhes.