v10

latestOpenAPI 3.1.1raw.githubusercontent.com2026-06-261653109.3 KB

Saques

Solicitar saque

Solicita um novo saque do seu saldo disponivel para a chave PIX informada.

post/v1/cashouts

Request body

amountinteger required

Valor do saque em centavos. Exemplo: R$ 500,00 = 50000.

pixKeyType'CPF' | 'CNPJ' | 'Email' | 'Phone' | 'Random' required

Tipo da chave PIX de destino.

pixKeystring required

Chave PIX de destino.

externalIdstring nullable

ID externo no seu sistema para referencia cruzada.

callbackUrlstring nullable

URL para receber webhooks de atualizacao de status do saque.

Example request

{
  "amount": 50000,
  "pixKeyType": "CPF",
  "pixKey": "12345678901",
  "externalId": "saque_001",
  "callbackUrl": "https://seusite.com.br/webhook/cashout"
}

Response

Saque solicitado com sucesso

messagestring nullable

Example response

{
  "data": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
    "externalId": "saque_001",
    "amount": 50000,
    "fee": 200,
    "netAmount": 49800,
    "currency": "BRL",
    "status": "Pending",
    "environment": "Sandbox",
    "pix": {
      "pixKeyType": "CPF",
      "pixKey": "***456789**"
    },
    "requestedAt": "2025-01-15T16:00:00Z",
    "createdAt": "2025-01-15T16:00:00Z"
  },
  "error": {
    "message": "Token invalido ou expirado.",
    "code": "unauthorized"
  }
}