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âmetroTipoDescrição
idstringID ú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

CampoTipoDescrição
idstringIdentificador único do Payout na plataforma
externalIdstring | nullID gerado pela adquirente
statusstringStatus atual — veja todos os status
amountintegerValor bruto solicitado em centavos
currencystringMoeda — sempre BRL
pixKeystringChave PIX do beneficiário
pixKeyTypestringTipo da chave: CPF, CNPJ, EMAIL, PHONE ou EVP
referenceIdstring | nullID no seu sistema
beneficiaryNamestring | nullNome do beneficiário
beneficiaryDocumentstring | nullCPF ou CNPJ do beneficiário
feeAmountinteger | nullTaxa cobrada em centavos
netAmountinteger | nullValor líquido transferido em centavos
bankReceiptobject | nullComprovante bancário — disponível apenas quando status é COMPLETED
bankReceipt.endToEndIdstringIdentificador E2E do SPB (Sistema de Pagamentos Brasileiro)
bankReceipt.transactionIdstringID da transação na adquirente
bankReceipt.processedAtstring (ISO 8601)Data e hora do processamento efetivo
createdAtstring (ISO 8601)Data e hora de criação
updatedAtstring (ISO 8601)Data e hora da última atualização

Erros

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