Obter Payout

Retorna todos os dados de um saque específico, incluindo o comprovante transacional emitido pela instituição processante quando o status for COMPLETED.

GET https://api.legacyecombr.com.br/payout/{id}

Parâmetros de rota

Parâmetro	Tipo	Descrição
`id`	`string`	ID único do Payout (ex.: `payout_1A2B3C`)

Exemplo de requisição

GET /payout/payout_1A2B3C
Host: api.holdinglegacy.io
Authorization: Basic base64(pk_live_xxxx:sk_live_yyyy)

Resposta `200 OK` — Payout concluído

{
  "id": "payout_1A2B3C",
  "externalId": "ext_001abc",
  "status": "COMPLETED",
  "amount": 250000,
  "currency": "BRL",
  "pixKey": "[email protected]",
  "pixKeyType": "EMAIL",
  "referenceId": "comissao-parceiro-001",
  "beneficiaryName": "Maria Silva",
  "beneficiaryDocument": "83416281085",
  "feeAmount": 150,
  "netAmount": 249850,
  "bankReceipt": {
    "endToEndId": "E0000000020260302163000000001",
    "transactionId": "T123456789",
    "processedAt": "2026-03-02T16:35:00.000Z"
  },
  "createdAt": "2026-03-02T16:25:00.000Z",
  "updatedAt": "2026-03-02T16:35:00.000Z"
}

Resposta `200 OK` — Payout pendente

{
  "id": "payout_1A2B3D",
  "externalId": null,
  "status": "PROCESSING",
  "amount": 50000,
  "currency": "BRL",
  "pixKey": "00.000.000/0001-00",
  "pixKeyType": "CNPJ",
  "referenceId": "repasse-fornecedor-003",
  "beneficiaryName": null,
  "beneficiaryDocument": null,
  "feeAmount": null,
  "netAmount": null,
  "bankReceipt": null,
  "createdAt": "2026-03-02T17:00:00.000Z",
  "updatedAt": "2026-03-02T17:00:00.000Z"
}

Campos da resposta

Campo	Tipo	Descrição
`id`	`string`	Identificador único do Payout na plataforma
`externalId`	`string \| null`	ID gerado pela adquirente
`status`	`string`	Status atual — veja todos os status
`amount`	`integer`	Valor bruto solicitado em centavos
`currency`	`string`	Moeda — sempre `BRL`
`pixKey`	`string`	Chave PIX do beneficiário
`pixKeyType`	`string`	Tipo da chave: `CPF`, `CNPJ`, `EMAIL`, `PHONE` ou `EVP`
`referenceId`	`string \| null`	ID no seu sistema
`beneficiaryName`	`string \| null`	Nome do beneficiário
`beneficiaryDocument`	`string \| null`	CPF ou CNPJ do beneficiário
`feeAmount`	`integer \| null`	Taxa cobrada em centavos
`netAmount`	`integer \| null`	Valor líquido transferido em centavos
`bankReceipt`	`object \| null`	Comprovante bancário — disponível apenas quando `status` é `COMPLETED`
`bankReceipt.endToEndId`	`string`	Identificador E2E do SPB (Sistema de Pagamentos Brasileiro)
`bankReceipt.transactionId`	`string`	ID da transação na adquirente
`bankReceipt.processedAt`	`string (ISO 8601)`	Data e hora do processamento efetivo
`createdAt`	`string (ISO 8601)`	Data e hora de criação
`updatedAt`	`string (ISO 8601)`	Data e hora da última atualização

Erros

Status	Descrição
`401`	Credenciais inválidas ou ausentes
`404`	Payout não encontrado ou não pertence à sua conta

Parâmetros de rota

Exemplo de requisição

Resposta 200 OK — Payout concluído

Resposta 200 OK — Payout pendente

Campos da resposta

Erros

Resposta `200 OK` — Payout concluído

Resposta `200 OK` — Payout pendente