PIX-OUT

Enviar um pagamento

 Importante

A requisição a seguir tem como objetivo enviar um pagamento via PIX para uma chave denominada pixKey com o tipo de chave denominada pixKeyType.

Requisição

Tipos aceitos em pixKeyType: cpf | email | telefone | aleatoria

recipient identifica o titular da chave Pix. Nome, tipo e numero do documento sao obrigatorios no saque automatico via Sync ou CNPAY.

idempotencyKey deve ser unica por saque (8 a 100 caracteres). Repetir a mesma chave com os mesmos dados retorna a transacao existente, sem enviar outro Pix.

Tambem sao aceitos os tipos cnpj e phone. O callback deve usar uma URL HTTP ou HTTPS valida.

Se o saque automatico estiver desativado para a conta, a solicitacao ficara pendente para aprovacao administrativa. A URL informada em baasPostbackUrl sera preservada e recebera o resultado final.

{
    "token": "TOKEN",
    "secret": "SECRET",
    "amount": 10,
    "pixKey": "52998224725",
    "pixKeyType": "cpf",
    "recipient": {
        "name": "Nome do jogador",
        "document": {
            "type": "cpf",
            "number": "52998224725"
        }
    },
    "idempotencyKey": "withdraw-pedido-123456",
    "baasPostbackUrl": "https:\/\/seudominio.com\/callback\/withdrawal"
}

Resposta

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo. 
{
    "id": "ID DA TRANSAÇÃO",
    "reference_id": "ID DA TRANSACAO",
    "idempotencyKey": "withdraw-pedido-123456",
    "amount": 10,
    "pixKey": "52998224725",
    "pixKeyType": "cpf",
    "withdrawStatusId": "PendingProcessing",
    "createdAt": "2026-07-04T14:00:31-03:00",
    "updatedAt": "2026-07-04T14:00:31-03:00"
}
{
    "error": "Token ou Secret ausentes",
    "message": "Você precisa fornecer tanto o token quanto o secret."
}
{
    "status": "error",
    "message": "Saldo Insulficiente."
}
{
    "required": "Este campo é obrigatório",
    "string": "Este campo deve ser uma string",
    "in": "Valor inválido para o campo :attribute"
}