Payout Object

Estrutura completa do objeto Payout retornado pela API.

Propriedades

Propriedade	Tipo	Descrição
`id`	string	Identificador único e opaco do saque. Formato: `co_` seguido de 12 caracteres alfanuméricos aleatórios (ex: `co_n4hpw7zqr2xs`). Use este ID para consultar o status do saque. Não é sequencial.
`status`	string	Status do saque (`pending`, `processing`, `completed`, `failed`)
`amount`	integer	Valor bruto solicitado em centavos
`fee_amount`	integer	Total de taxas cobradas em centavos (fee_fixed + fee_variable calculado)
`fee_fixed`	integer \| null	Parte fixa da taxa em centavos (se aplicável)
`fee_variable`	number	Parte variável da taxa em percentual (ex: 3.99 = 3,99%)
`net_amount`	integer	Valor líquido transferido em centavos (amount - fee_amount)
`currency`	string	Moeda (BRL)
`description`	string \| null	Descrição informada no momento do saque (opcional)
`payout_method`	object	Método de saque utilizado (`id`, `type`)
`created_at`	string	Data de criação (ISO 8601, fuso America/Sao_Paulo)
`updated_at`	string	Data de atualização (ISO 8601, fuso America/Sao_Paulo)

Exemplo Completo

{
  "success": true,
  "data": {
    "id": "co_n4hpw7zqr2xs",
    "status": "completed",
    "amount": 10050,
    "fee_amount": 401,
    "fee_fixed": null,
    "fee_variable": 3.99,
    "net_amount": 9649,
    "currency": "BRL",
    "description": "Saque mensal",
    "payout_method": {
      "id": 1,
      "type": "pix"
    },
    "created_at": "2025-11-28T20:30:00-03:00",
    "updated_at": "2025-11-28T20:35:00-03:00"
  }
}