Saques Solicitar cashout

Solicitar cashout

Endpoint para transferência de valores através de PIX.

ATENÇÃO

Para utilizar esse endpoint, é necessário cadastrar o IP do seu servidor de onde vai vir as requisições, pois somente será permitido PIX de saída pela API com o IP cadastrado.

Para cadastrar o IP, vai até o menu ESCOPOS no seu APP e abra GERENCIAMENTO DE IPs.

Solicite um cashout

Para criar um pedido de cashout via API, basta enviar uma requisição POST para a rota /v2/cashout. Em resposta, você receberá o objeto com os dados do seu pedido.

CASHOUT OU SAQUE?

Se for utilizar esse endpoint para enviar pagamento PIX para sua própria conta utilize o endpoint SAQUE.

Solicite o pedido

SEGURANÇA!

Ao solicitar um cashout e o status retornar como awaiting_moderation você tem 4 horas para aprovar o cashout via painel para o que mesmo não seja cancelado automáticamente.

Para solicitar um cashout você precisa criar a transação, informando os detalhes do valor, chave pix, tipo de chave pix e id de referência.

POST /v2/cashout

Requer autorização para o escopo: sake.write

Parâmetros de requisição

HEADER

~~Authorization~~ Bearer obrigatório

Token de autorização gerado a partir do APP_ID e APP_TOKEN.

BODY

~~amount~~ float obrigatório

Valor a receber via Pix.

~~key~~ string obrigatório

Chave pix que vai receber o Pix.

~~type_key~~ string obrigatório

Valores aceitos: EMAIL, CPF, CNPJ, CELULAR, ALEATORIA

~~reference_id~~ int

Campo opcional no formato [INT], únicio o sistema não aceita IDS duplicados. O mesmo serve para consultar o status do cashout!

PD9waHAKJEFjY2Vzc1Rva2VuID0gJ3tBQ0NFU1NfVE9LRU59JzsKJGhlYWRlcnMgPSBhcnJheSgKCSdBdXRob3JpemF0aW9uOiBCZWFyZXIgJy4kQWNjZXNzVG9rZW4sCgknQ29udGVudC1UeXBlOiBhcHBsaWNhdGlvbi9qc29uJywKKTsKCiRkYXRhID0gKHNtbUFycmF5UEhQKTsKCiRjaCA9IGN1cmxfaW5pdCgpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfVVJMLCAne0FQSV9VUkx9L3YyL2Nhc2hvdXQnKTsKY3VybF9zZXRvcHQoJGNoLCBDVVJMT1BUX0hUVFBIRUFERVIsICRoZWFkZXJzKTsKY3VybF9zZXRvcHQoJGNoLCBDVVJMT1BUX1JFVFVSTlRSQU5TRkVSLCBUUlVFKTsKY3VybF9zZXRvcHQoJGNoLCBDVVJMT1BUX0NVU1RPTVJFUVVFU1QgLCAnUE9TVCcpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfUE9TVCAsIHRydWUpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfUE9TVEZJRUxEUyAsICRkYXRhKTsKY3VybF9zZXRvcHQoJGNoLCBDVVJMT1BUX1NTTF9WRVJJRllQRUVSLCBGQUxTRSk7CiRyZXNwb25zZSA9IGN1cmxfZXhlYygkY2gpOwkKY3VybF9jbG9zZSgkY2gpOwoKZWNobyAkcmVzcG9uc2U7Cj8+

Respostas possíveis

201 401 422 404

/* Esse exemplo de resposta ocorre quando o cashout foi gerado com sucesso! */
{
  "access": "granted",
  "cashout": {
    "id": "APP-00000000000000",
    "amount": "27.29",
    "original_amount": "27.85",
    "key": "[email protected]",
    "type_key": "EMAIL",
    "state": "pending",
    "create_time": "2025-04-17 15:07:35",
    "reference_id": "379",
    "pix": []
  }
}

/* Esse exemplo de resposta ocorre quando você informou o campo BODY com parâmetros incorretos*/
{
  "access": "unauthorized",
  "cashout": {
    "error": "Não indentificamos a chave pix ou o tipo da chave",
    "error_code": 104,
    "error_status": 401
  }
}

/* Esse exemplo de resposta ocorre quando a chave pix não bate com o formato enviado! */
{
  "access": "unprocessable-entity",
  "cashout": {
    "error": "Formato de chave incorreta para o tipo de chave CPF",
    "error_code": 106,
    "error_status": 422
  }
}

/* Esse exemplo de resposta ocorre quando IP não está na whitelist! */
{
  "access": "bad-request",
  "cashout": {
    "error": "IP: 00.000.000.000 não está na whitelist",
    "error_code": 134,
    "error_status": 404
  }
}

A tabela abaixo descreve os atributos presentes no JSON retornado.

access

Retorna granted informado sobre o sucesso da solicitação.

cashout Sem resultados retorna um objeto vazio.

id ID do cashout atual para buscar o status. string
amount Valor que vai receber via PIX. float
original_amount Valor original debidato do seu Saldo. float
key Chave PIX recebedora. string
type_key Tipo da chave PIX recebedora. string
state Estado do cashout. string
create_time Data e hora que o pagamento foi gerado. date_time
reference_id ID de referência que foi passado no pedido do saque. int
pix Objeto vazio por padrão. objeto

Status do cashout

O status do cashout sempre é exibido no campo state informando o status atual do cashout!

Status	Descrição
awaiting_moderation	Aguardando moderação via painel.
pending	Estamos processando seu PIX.
completed	PIX transferido.
canceled	PIX cancelado.

Última atualização em 29 de nov. de 2024