--- title: "State of a PIX charge" method: GET path: "/cashin/{cashin_id}/status" --- # State of a PIX charge `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` 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. ## Path parameters - `cashin_id` string, required ## Response `200` Estado atual com linha do tempo carimbada pelo servidor. - StatusCobranca: Estado da cobrança; GET pode acrescentar trilho, timeline e tempos_tipicos. Lista e webhook usam o objeto-base. - `cashin_id` string: 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_cents` integer: Valor do PIX em centavos. - `depix_received_cents` integer, 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_amount` string, nullable: Campo legado de quantidade retornado pela liquidação; interprete junto de asset e dos campos específicos da rota. - `settlement_tx_hash` string, nullable: Hash on-chain da entrega (ou id interno quando a entrega é pela corretora). - `settlement_tx_url` string, nullable: Link do explorador para o hash acima, quando existe. - `payout_address` string, nullable: Carteira que recebe a cripto (destino=cripto). - `payout_tag` string, nullable: Memo/tag da carteira de destino em redes coletivas (destino=cripto). - `chain` string: Rede de entrega (id de GET /cashin/catalog). - `asset` string: Ativo entregue (usdt, usdc, btc, …). - `payer_tax_number` string: CPF/CNPJ do pagador — quem deve pagar o QR. PIX de outro documento é devolvido (refund_reason PAYER_MISMATCH). - `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. - `expires_at` string, date-time, nullable: Validade da própria cobrança; leia este timestamp, inclusive para validade estendida pelo bot. - `paid_at` string, date-time, nullable - `settled_at` string, 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_hours` integer: Retenção solicitada ao provedor. Pode ser zero enquanto existe retenção local (hold_hours/liberar_em). - `held` boolean: true quando held_hours > 0. Isoladamente não revela retenção local. - `delay_until` string, date-time, nullable: Instante de liberação informado para retenção do provedor, quando disponível. - `liberar_em` string, 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). - `e2e` string, nullable: EndToEndId do PIX recebido (Banco Central). - `payer_name` string, nullable: Nome do pagador quando informado ou identificado pelo banco. - `customer_ref` string, nullable: Sua referência do cliente final (subconta no saldo). - `refund_reason` string, nullable: Motivo da devolução quando status=refunded (ex.: PAYER_MISMATCH = pagou outro documento; TEST_AMOUNT = valor de teste; PROVIDER_REJECTED). - `refund_reason_detail` string, nullable: Explicação legível do motivo da devolução. - `created_at` string, date-time, nullable - `trilho` string: Trilho desta operação: casa, corretora, saldo ou liquid. Não é promessa de prazo. - `timeline` object[] - `tempos_tipicos` object: Mediana medida (segundos) de cada etapa, por trilho — para mostrar ao cliente quanto costuma demorar. - `sandbox` boolean: True for fictitious sandbox operations. - `simulation` object - `delivery_mode` 'full' | 'split': Só em chain="liquid": como o DePix foi entregue. Ausente nas outras redes. - `net_cents` integer: 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_cents` integer: 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_at` string, date-time, nullable: Quando a confirmação on-chain foi registrada. Só preenchido em settlement_proof=confirmed. - `settlement_block` string, nullable: Número do bloco confirmado como string, preservando precisão. - `lunium_fee_cents` integer: Parte da taxa em centavos para depósito Pix em saldo BRL; calculada com os valores congelados da cobrança. - `partner_fee_cents` integer: Parte da taxa em centavos para depósito Pix em saldo BRL; calculada com os valores congelados da cobrança. ## Other responses - `401`: X-API-Key ausente, desconhecida ou incorreta. - `404`: Not found ## Changes - **2026-10-19** `fc06c3b824b1`: 2 info - added the optional property `lunium_fee_cents` to the response with the `200` status - added the optional property `partner_fee_cents` to the response with the `200` status [Operation history](https://skmtc.dev/luniumpay/apis/lunium-crypto-pix-settlement-brazil/changes/cashin/:cashin_id/status/get.md) --- [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)