Listar Vouchers
Vouchers do parceiro em ordem decrescente de created_at. Não desconta saldo. after e before são mutuamente exclusivos; combiná-los retorna invalid_filter.
Authorizations
Token Bearer com prefixo czk_live_. Gere a chave no portal em https://certificados.zapsign.com.br/reseller/api-keys.
Path Parameters
Identificador público do parceiro (Partner ID), exibido no portal.
1 - 64Query Parameters
Filtra por estado do voucher.
Estado atual do voucher no ciclo de vida.
issued, redeemed, expired, declined Limite inferior (inclusivo) de created_at. Formato ISO-8601 com timezone explícito (Z ou ±HH:MM). Datas sem hora ou sem timezone são rejeitadas com invalid_filter.
Limite superior (inclusivo) de created_at. Mesma regra de formato de created_after.
Quantos itens devolver por página. Mínimo 1, máximo 100. Quando omitido, o servidor usa 20.
1 <= x <= 100Cursor exclusivo: voucher_id da última linha da página atual. A próxima página começa logo depois desse id (ele NÃO é repetido). Mutuamente exclusivo com before. Um id desconhecido devolve data: [] sem erro.
1Cursor exclusivo no sentido inverso: voucher_id do primeiro item da página atual. A página anterior termina logo antes desse id (ele NÃO é repetido). Mutuamente exclusivo com after. Um id desconhecido devolve data: [] sem erro.
1Response
Página de vouchers do parceiro, ordenada por created_at decrescente.
Página de vouchers do parceiro. Envelope { object: "list", has_more, data }.
Discriminador do envelope. Sempre "list".
"list""list"
Indica se ainda existem páginas no sentido em que o cliente paginou. Quando true, use o voucher_id do último item de data em ?after= para a próxima página.
true
Vouchers da página atual, ordenados por created_at decrescente. Vazia quando não há resultados.
