Documentação da API PixPlayBr

Endpoint: Saque

A seguir, a documentação completa para o endpoint de saque (saque.php), detalhando o processo de criação de uma solicitação de retirada de fundos via Pix que requer aprovação manual.

---

1. Visão Geral

O endpoint de saque permite que um usuário inicie uma solicitação de retirada de fundos. A transação é registrada no banco de dados com o status pendente e debita o saldo do usuário. A transferência para a chave Pix do destinatário não é processada automaticamente, aguardando a aprovação manual.

• URL: https://api.pixplaybr.com/api/v1/saque.php
• Método: POST

2. Autenticação

A requisição deve incluir um token de autenticação no cabeçalho.

• Cabeçalho: Authorization
• Valor: Bearer SEU_TOKEN_DE_AUTENTICACAO

3. Corpo da Requisição (JSON Body)

A requisição deve enviar um objeto JSON com os seguintes campos:

Campo	Tipo	Obrigatório	Descrição
valor	String	Sim	O valor do saque. Deve ser uma string, por exemplo, "100.00".
chave_pix	String	Sim	A chave Pix do destinatário. Pode ser um e-mail, CPF, telefone ou chave aleatória.
tipo_chave	String	Sim	O tipo da chave Pix. Os valores aceitos são: "email", "cpf", "cnpj", "telefone", "aleatoria".
external_reference	String	Sim	Uma referência única para a transação, fornecida pelo desenvolvedor. Ajuda a evitar transações duplicadas.

Exemplo de Requisição

{
  "valor": "50.00",
  "chave_pix": "joao.silva@exemplo.com",
  "tipo_chave": "email",
  "external_reference": "saque_app_12345"
}

4. Respostas da API

Resposta de Sucesso (201 Created)

Indica que a solicitação de saque foi recebida e registrada no banco de dados com sucesso. O status da transação está como pendente, aguardando a aprovação manual.

{
  "id_transacao": 123,
  "external_reference": "saque_app_12345",
  "status": "pendente",
  "mensagem": "Solicitação de saque enviada para aprovação. O status será atualizado em breve."
}

Respostas de Erro (400 Bad Request)

Ocorre quando há um problema com os dados enviados.

Código HTTP	Mensagem de Erro	Descrição
400	{ "error": "JSON mal formatado. Código do erro: ..." }	O corpo da requisição não é um JSON válido.
400	{ "error": "Dados de entrada incompletos." }	Um ou mais campos obrigatórios (valor, chave_pix, tipo_chave, external_reference) estão ausentes.
400	{ "error": "Saldo insuficiente." }	O usuário não tem saldo suficiente para realizar o saque.

Outros Erros

• 405 Method Not Allowed: Ocorre quando um método HTTP diferente de POST é utilizado.
• 500 Internal Server Error: Erro interno no servidor.

5. Fluxo de Saque (Resumo)