Introdução a API

Autenticação

Cartões para testes

Estabelecimentos

Usuários

Consumidores

Cartão

Links de pagamento

Códigos de Erro

Split de Pagamento

Produtos

Cupons de Desconto

Vendas

Assinaturas

Financeiro

Webhooks

Nesta página

GET Filtrar Ordem de Pagamento

https://api.premepay.com/v1/stores/:id/orders/search

Com a API da Primefy e a rota acima você pode visualizar os detalhes de uma ordem de pagamento, utilizando os parâmetros abaixo como filtro no próprio endpoint. Abaixo alguns exemplos:

Filtro: identificationNumber

https://api.premepay.com/v1/stores/:id/orders/search?identificationNumber={identification-number}

Filtro: name. Este filtro considera o nome e o sobrenome do consumidor, mesmo que parcial.

https://api.premepay.com/v1/stores/:id/orders/search?name={nome-ou-sobrenome-do-consumidor}

Filtro: name e number

https://api.premepay.com/v1/stores/:id/orders/search?name={nome-ou-sobrenome-do-cosumidor&number={orderNumber}

Lista de Parâmetros

Parâmetro Tipo Descrição Obrigatório
name string Nome do consumidor Não
identificationNumber string Cpf ou CNPJ do consumidor Não
email string Email do Consumidor Não
number string Número da ordem Não
pageSize integer Número de registros por página Não
pageIndex integer Número da página Não

Respostas

Conteúdo Relacionado

<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/52c5ff42-e8bf-45d3-81d1-b6e05786a688/POST.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/52c5ff42-e8bf-45d3-81d1-b6e05786a688/POST.png" width="40px" /> POST - Criar Ordem de Pagamento

</aside>

<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/a22a31f7-bd92-40af-8042-7685c0c0859a/GET.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/a22a31f7-bd92-40af-8042-7685c0c0859a/GET.png" width="40px" /> GET - Listar Vendas

</aside>