---
title: "State of a payout"
method: GET
path: "/payouts/{payout_id}"
---

# State of a payout

`GET /payouts/{payout_id}`

## Request

- Base URL: `https://api.luniumpay.com`
- URL: `https://api.luniumpay.com/payouts/{payout_id}`
- Auth: API key in header `X-API-Key`

## Path parameters

- `payout_id` string, required

## Response `200`

Estado do saque.

- Payout: Saque PIX (PIX→PIX) debitado do saldo custodial da chave.
  - `payout_id` string
  - `customer_ref` string, nullable
  - `status` string: processing, sent, failed ou refunded; use extrato para conciliar saldo. Estados novos devem ser tolerados.
  - `amount_cents` integer: Valor que o destinatário recebe.
  - `fee_cents` integer, nullable: Total fees beyond amount_cents: fee_service_total_cents + fee_provider_cents. Includes partner commission already; do not add it again.
  - `fee_service_cents` integer, nullable: Lunium-only service fee in recorded cents; accounting component. For customer UI and notifications use fee_service_total_cents.
  - `fee_provider_cents` integer, nullable: Tarifa do provedor: fee_cents menos fee_service_cents menos fee_partner_cents.
  - `pix_key` string
  - `pix_key_type` 'cpf' | 'cnpj' | 'phone' | 'email' | 'random'
  - `tax_number` string, nullable: Documento do beneficiário mascarado, quando informado; opcional no pedido.
  - `external_id` string, nullable: Identificador idempotente de até 64 caracteres. Mantenha o mesmo identificador e todos os parâmetros nos retries. A comparação de divergência varia por rota; não use o replay para alterar uma operação. 409 external_id_divergente sinaliza conflito detectado.
  - `error` string, nullable: Motivo quando failed/refunded.
  - `e2e` string, nullable: EndToEndId do PIX enviado.
  - `receiver_name` string, nullable: Nome obtido após o pagamento quando disponível. null quando não obtido.
  - `receiver_tax_number` string, nullable
  - `paid_at` string, date-time, nullable
  - `sent_at` string, date-time, nullable
  - `verify_url` string, nullable: Verificação pública do PIX (GET /v1/verificar/{e2e}).
  - `created_at` string, date-time, nullable
  - `updated_at` string, date-time, nullable
  - `sandbox` boolean: True for fictitious sandbox operations.
  - `simulation` object
  - `fee_partner_cents` integer, nullable: Sub fee do parceiro debitada do saldo neste saque (centavos). Parte de fee_cents.
  - `fee_service_total_cents` integer, nullable: Combined customer service fee: recorded Lunium fee plus partner commission. Preserves original cent rounding and historical pricing; null when the legacy house component is unknown. Included in payout responses and payout.* webhook data, production and sandbox. Add fee_provider_cents once to get fee_cents; do not add fee_partner_cents again.

## Other responses

- `401`: X-API-Key ausente, desconhecida ou incorreta.
- `404`: Not found

---

[API](https://skmtc.dev/luniumpay/apis/lunium-crypto-pix-settlement-brazil.md) · [All operations](https://skmtc.dev/luniumpay/apis/lunium-crypto-pix-settlement-brazil/llms.txt) · [OpenAPI document](https://skmtc.dev/luniumpay/apis/lunium-crypto-pix-settlement-brazil/revisions/0b5a340fa9dd?raw)