Cash Out

Consultar Cashout

GET/v1/cashout/:cashoutId

Recupera os detalhes de um cashout específico em formato JSON, incluindo valor, status, e2e e os dados do destinatário. Apenas o criador do cashout pode consultá-lo.

Parâmetros de URL

Campo	Tipo	Descrição
`cashoutId`obrigatório	`string (UUID)`	ID único do cashout retornado no momento da criação.

Campos da Resposta

Campo	Tipo	Descrição
`id`	`string`	Identificador único do cashout (UUID)
`external_id`	`string \| null`	ID do cashout no provedor de pagamento
`external_reference`	`string \| null`	Referência externa informada na criação
`e2e`	`string \| null`	Identificador end-to-end (E2E) do PIX
`status`	`string`	Status atual do cashout
`amount`	`number`	Valor do saque em BRL
`fee_amount`	`number \| null`	Taxa cobrada no saque em BRL
`client`	`object`	Dados do cliente que solicitou o saque
`client.name`	`string`	Nome do cliente
`receiver`	`object \| null`	Dados do destinatário do saque
`receiver.pix_key`	`string \| null`	Chave PIX do destinatário
`receiver.pix_type`	`string \| null`	Tipo da chave PIX (email, cpf, cnpj, phone, evp)
`receiver.owner_account_name`	`string \| null`	Nome do titular da conta destinatária
`receiver.bank_name`	`string \| null`	Nome do banco do destinatário
`created_at`	`string (ISO 8601)`	Data e hora de criação do cashout
`updated_at`	`string (ISO 8601)`	Data e hora da última atualização

Exemplo em JavaScript

Node.js (axios)javascript

const axios = require('axios');

async function consultarCashout(cashoutId) {
  const response = await axios.get(
    `${BASE_URL}/v1/cashout/${cashoutId}`,
    {
      headers: { 'api-secret': process.env.API_SECRET }
    }
  );

  return response.data; // JSON com os dados do cashout
}

Regras de Negócio

Apenas o usuário que criou o cashout pode consultá-lo
O cashoutId deve ser um UUID válido
O API Secret deve pertencer ao criador do cashout
Os dados do destinatário são retornados em receiver (pode ser null quando indisponível)

Erros Possíveis

401API Secret ausente ou inválido

404"Cashout not found." — cashout não encontrado para o ID informado

GEThttps://api.payroyal.com.br/v1/cashout/{cashoutId}

Headers

api-secret: seu_api_secret_aqui
Content-Type: application/json

cURL

curl -X GET "https://api.payroyal.com.br/v1/cashout/f4124c64-78f4-40f0-b0f3-b9d910865dd5" \
  -H "api-secret: seu_api_secret_aqui" \
  -H "Content-Type: application/json"

Response 200

{
  "id": "f4124c64-78f4-40f0-b0f3-b9d910865dd5",
  "external_id": null,
  "external_reference": null,
  "e2e": "E00000000202401151030abcdef123456",
  "status": "completed",
  "amount": 250.00,
  "fee_amount": 2.50,
  "client": {
    "name": "João Silva"
  },
  "receiver": {
    "pix_key": "joao.silva@exemplo.com",
    "pix_type": "email",
    "owner_account_name": "João Silva",
    "bank_name": "Banco Exemplo S.A."
  },
  "created_at": "2024-01-15T10:30:00.000Z",
  "updated_at": "2024-01-15T10:30:05.000Z"
}