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_idstring required

Response

Estado do saque.

payout_idstring
customer_refstring nullable
statusstring

processing, sent, failed ou refunded; use extrato para conciliar saldo. Estados novos devem ser tolerados.

amount_centsinteger

Valor que o destinatário recebe.

fee_centsinteger nullable

Total fees beyond amount_cents: fee_service_total_cents + fee_provider_cents. Includes partner commission already; do not add it again.

fee_service_centsinteger nullable

Lunium-only service fee in recorded cents; accounting component. For customer UI and notifications use fee_service_total_cents.

fee_provider_centsinteger nullable

Tarifa do provedor: fee_cents menos fee_service_cents menos fee_partner_cents.

pix_keystring
pix_key_type'cpf' | 'cnpj' | 'phone' | 'email' | 'random'
tax_numberstring nullable

Documento do beneficiário mascarado, quando informado; opcional no pedido.

external_idstring 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.

errorstring nullable

Motivo quando failed/refunded.

e2estring nullable

EndToEndId do PIX enviado.

receiver_namestring nullable

Nome obtido após o pagamento quando disponível. null quando não obtido.

receiver_tax_numberstring nullable
paid_atstring date-time nullable
sent_atstring date-time nullable
verify_urlstring nullable

Verificação pública do PIX (GET /v1/verificar/{e2e}).

created_atstring date-time nullable
updated_atstring date-time nullable
sandboxboolean

True for fictitious sandbox operations.

simulationobject
fee_partner_centsinteger nullable

Sub fee do parceiro debitada do saldo neste saque (centavos). Parte de fee_cents.

fee_service_total_centsinteger 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.

Changes

No recorded changes to this operation across all 3 revisions of this API.