Saques Consultar cashout

Consultar cashout

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

Buscando um cashout

Para buscar um saque e o seu status envie um GET para a rota /v2/cashout/{ID}. Em resposta, você receberá o objeto com as informações do pagamento solicitado.

GET /v2/cashout/:id

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

PD9waHAKCiRBY2Nlc3NUb2tlbiA9ICd7QUNDRVNTX1RPS0VOfSc7CiRTYXF1ZUlEID0gJ3tJRH0nOwokaGVhZGVycyA9IGFycmF5KAoJJ0F1dGhvcml6YXRpb246IEJlYXJlciAnLiRBY2Nlc3NUb2tlbiwKCSdDb250ZW50LVR5cGU6IGFwcGxpY2F0aW9uL2pzb24nLAopOwokY2ggPSBjdXJsX2luaXQoKTsKY3VybF9zZXRvcHQoJGNoLCBDVVJMT1BUX1VSTCwgJ3tBUElfVVJMfS92Mi9jYXNob3V0LycuJFNhcXVlSUQpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfSFRUUEhFQURFUiwgJGhlYWRlcnMpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfUkVUVVJOVFJBTlNGRVIsIFRSVUUpOwpjdXJsX3NldG9wdCgkY2gsIENVUkxPUFRfQ1VTVE9NUkVRVUVTVCAsICdHRVQnKTsKY3VybF9zZXRvcHQoJGNoLCBDVVJMT1BUX1NTTF9WRVJJRllQRUVSLCBGQUxTRSk7CiRyZXNwb25zZSA9IGN1cmxfZXhlYygkY2gpOwkKY3VybF9jbG9zZSgkY2gpOwoKZWNobyAkcmVzcG9uc2U7Cj8+

Status do saque

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

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

Respostas possíveis

200 200 403 404

/* Esse exemplo de resposta ocorre quando o saque foi concluído com sucesso! */
{
  "access": "granted",
  "cashout": {
    "id": "APP-00000000000000",
    "amount": "27.29",
    "original_amount": "27.85",
    "key": "[email protected]",
    "type_key": "EMAIL",
    "state": "awaiting_moderation",
    "create_time": "2025-04-17 15:09:56",
    "reference_id": "379",
    "pix": {
      "id": "E0000000000000000000000000000000",
      "name": "JHON DOE",
      "doc": "***.000.000-**",
      "date": "2025-04-17 15:13:56"
    }
  }
}

/* Esse exemplo de resposta ocorre quando o saque foi cancelado! */
{
  "access": "granted",
  "cashout": {
    "id": "APP-00000000000000",
    "amount": "27.29",
    "original_amount": "27.85",
    "key": "[email protected]",
    "type_key": "EMAIL",
    "state": "awaiting_moderation",
    "create_time": "2025-04-17 15:09:56",
    "reference_id": "379",
    "pix": {
      "error": "Chave Pix inválida",
      "date": "2025-04-17 15:11:56"
    }
  }
}

/* Esse exemplo de resposta ocorre quando o app está sem permissão para usar esse endpoint! */
{
  "access": "forbidden",
  "cashout": {
    "error": "App sem permissão para usar este endpoint",
    "error_code": 141,
    "error_status": 403
  }
}

/* Esse exemplo de resposta ocorre quando o app está sem permissão para usar esse endpoint! */
{
  "access": "not-found",
  "cashout": {
    "error": "Cashout ID não encontrado",
    "error_code": 143,
    "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 saque 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 saque. 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 Resultado da transferência. objeto

id Identificador da transação PIX. string

name Nome do recebedor do PIX. string

doc CPF/CNPJ do recebedor do PIX. string

date Data de execução. date_time

Última atualização em 26 de dez. de 2024