Buscar Pedido

Retorna o status e os detalhes de um pedido. Use para monitorar o andamento após a confirmação.

GET /benefits/v1/orders/{orderId}

Resposta (200):

CampoDescrição
idID do pedido
statusStatus atual (veja tabela abaixo)
paymentMethodForma de pagamento: BILLET (boleto) ou BALANCE (FlashCash)
billIdID do boleto gerado (disponível após faturamento)
creditDateData prevista para o saldo chegar aos colaboradores
totalAmountValor total dos depósitos em centavos
totalFeeTotal de taxas em centavos

Ciclo de vida do pedido

StatusSituação
requestedPedido aberto, aguardando depósitos
confirmedConfirmado, em processamento
billedBoleto gerado, aguardando pagamento
waiting_approvalFlashCash — aguardando aprovação no painel
paidPago, saldo sendo creditado
availableSaldo disponível nos cartões ✅
canceledCancelado

Erros comuns

CódigoCausa
404Pedido não encontrado
403Sem permissão