Skip to main content
GET
Listar pedidos.

Authorizations

Authorization
string
header
required

Cabeçalho de autenticação Bearer no formato Bearer <token> onde <token> é seu TOKEN de autenticação

Query Parameters

status
integer<int32>

Filtrar por status do pedido. Campo opcional.

Valores possíveis:

  • 0 - Indefinido
  • 1 - Em análise
  • 2 - Aprovado
  • 3 - Saldo indisponível
  • 4 - Análise expirada
  • 5 - Pagamento pendente
  • 6 - Biometria recusada
  • 7 - Biometria aprovada
  • 8 - Pagamento recusado
  • 9 - Comprado
  • 10 - Não autorizado
  • 11 - Autorização pendente
  • 12 - Aguardando cadastro
  • 13 - Venda não iniciada
  • 14 - Cancelado
  • 15 - Faturamento
  • 16 - Concluído
  • 17 - Congelado
  • 18 - Confirmação de pagamento pendente
documentoCliente
string

CPF do cliente (somente números). Campo opcional.

Example:

"12345678901"

dataInicio
string<date-time>

Data de início do filtro no formato ISO-8601. Campo opcional.

Example:

"2025-01-01T00:00:00-03:00"

dataFim
string<date-time>

Data de fim do filtro no formato ISO-8601. Campo opcional.

Example:

"2025-12-31T23:59:59-03:00"

numero
integer<int64>

Número do pedido. Campo opcional.

Example:

1001

documentoLoja
string

CNPJ do estabelecimento (somente números). Campo opcional.

Example:

"12345678000195"

descricao
string

Filtrar por descrição do pedido. Campo opcional.

Response

OK

id
string<uuid>
numero
integer<int64>
status
object

Status do pedido. Consulte a legenda completa em Webhooks → Legenda do EnumStatus.

total
number<double> | null
nomeCliente
string | null
documentoCliente
string
prazo
integer<int32> | null
razaoSocialEstabelecimento
string
documentoEstabelecimento
string
descricao
string | null
valorAprovado
number<double> | null
desembolsado
boolean | null
criadoEm
string<date-time>
desembolsadoEm
string<date-time> | null
valorSolicitado
number<double> | null