State of a PIX charge

Changed on

Consulta estado do PIX e do crédito/entrega separadamente. paid não significa sozinho cripto entregue ou saldo disponível. settlement_status=sent conclui o crédito/entrega; em custódia confira disponível/bloqueado no saldo. delayed representa retenção pelo provedor; paid com liberar_em pode estar sob retenção local. Não peça novo pagamento porque a entrega ainda não concluiu. Prefira webhook; polling deve respeitar o rate limit da chave.

get/cashin/{cashin_id}/status

Request

  • Base URL: https://api.luniumpay.com
  • URL: https://api.luniumpay.com/cashin/{cashin_id}/status
  • Auth: API key in header X-API-Key

Path parameters

cashin_idstring required

Response

Estado atual com linha do tempo carimbada pelo servidor.

cashin_idstring

Identificador da cobrança (ci_…).

status'pending' | 'delayed' | 'under_review' | 'paid' | 'expired' | 'refunded' | 'failed'

Estado do PIX. paid não comprova sozinho crédito/entrega; leia settlement_status.

settlement_status'pending' | 'sending' | 'entregando' | 'sent' | 'incerto' | 'failed' | 'null' nullable

Estado do crédito/entrega: sent concluiu; incerto exige conciliação. PIX pago e entrega são estados distintos.

amount_centsinteger

Valor do PIX em centavos.

depix_received_centsinteger nullable

Valor recebido do liquidante antes da dedução das taxas de depósito da chave; não é o crédito líquido de custódia.

usdt_amountstring nullable

Campo legado de quantidade retornado pela liquidação; interprete junto de asset e dos campos específicos da rota.

settlement_tx_hashstring nullable

Hash on-chain da entrega (ou id interno quando a entrega é pela corretora).

settlement_tx_urlstring nullable

Link do explorador para o hash acima, quando existe.

payout_addressstring nullable

Carteira que recebe a cripto (destino=cripto).

payout_tagstring nullable

Memo/tag da carteira de destino em redes coletivas (destino=cripto).

chainstring

Rede de entrega (id de GET /cashin/catalog).

assetstring

Ativo entregue (usdt, usdc, btc, …).

payer_tax_numberstring

CPF/CNPJ do pagador — quem deve pagar o QR. PIX de outro documento é devolvido (refund_reason PAYER_MISMATCH).

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.

expires_atstring date-time nullable

Validade da própria cobrança; leia este timestamp, inclusive para validade estendida pelo bot.

paid_atstring date-time nullable
settled_atstring date-time nullable
destino'cripto' | 'saldo'

cripto (entrega on-chain) ou saldo (credita a custódia BRL da chave, usável em POST /payouts e POST /saldo/sacar-cripto).

held_hoursinteger

Retenção solicitada ao provedor. Pode ser zero enquanto existe retenção local (hold_hours/liberar_em).

heldboolean

true quando held_hours > 0. Isoladamente não revela retenção local.

delay_untilstring date-time nullable

Instante de liberação informado para retenção do provedor, quando disponível.

liberar_emstring date-time nullable

Quando o crédito no saldo sai da carência. null quando já entra disponível (padrão desde 16/09/2026).

e2estring nullable

EndToEndId do PIX recebido (Banco Central).

payer_namestring nullable

Nome do pagador quando informado ou identificado pelo banco.

customer_refstring nullable

Sua referência do cliente final (subconta no saldo).

refund_reasonstring nullable

Motivo da devolução quando status=refunded (ex.: PAYER_MISMATCH = pagou outro documento; TEST_AMOUNT = valor de teste; PROVIDER_REJECTED).

refund_reason_detailstring nullable

Explicação legível do motivo da devolução.

created_atstring date-time nullable
trilhostring

Trilho desta operação: casa, corretora, saldo ou liquid. Não é promessa de prazo.

timelineobject[]
tempos_tipicosobject

Mediana medida (segundos) de cada etapa, por trilho — para mostrar ao cliente quanto costuma demorar.

sandboxboolean

True for fictitious sandbox operations.

simulationobject
delivery_mode'full' | 'split'

Só em chain="liquid": como o DePix foi entregue. Ausente nas outras redes.

net_centsinteger

Só em chain="liquid" com delivery_mode="split": quanto o destinatário recebe em DePix, já sem a taxa. É este valor que a Lunium envia on-chain.

fee_total_centsinteger

Só em chain="liquid" com delivery_mode="split": tudo que saiu do bruto (taxa fixa + percentual). net_cents + fee_total_cents == amount_cents.

settlement_proof'none' | 'broadcast' | 'confirmed' | 'reported' | 'simulated'

Evidência de entrega separada do PIX: none=sem envio concluído; broadcast=tx informada sem confirmação registrada; confirmed=recibo confirmado registrado; reported=conclusão reportada sem prova on-chain (inclui custódia/transferência interna); simulated=teste sem dinheiro real. Ausência de confirmação não prova falha; a cobertura do verificador depende da rede e do período.

settlement_confirmed_atstring date-time nullable

Quando a confirmação on-chain foi registrada. Só preenchido em settlement_proof=confirmed.

settlement_blockstring nullable

Número do bloco confirmado como string, preservando precisão.

lunium_fee_centsinteger

Parte da taxa em centavos para depósito Pix em saldo BRL; calculada com os valores congelados da cobrança.

partner_fee_centsinteger

Parte da taxa em centavos para depósito Pix em saldo BRL; calculada com os valores congelados da cobrança.

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status