Introduction

Authentication

Test cards

Establishments

Users

Customers

Cards

Payment links

Error codes

Payment Split

Products

Discount Coupons

Sales

Signatures

Webhooks

Financial


On this page:


GET Filter sales

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

With the Primefy API and the route above, you can view the details of a payment order, using the parameters below as a filter in the endpoint itself. Below some examples:

Filter: identificationNumber

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

Filter: name. This filter considers the consumer's first and last name, even if partial.

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

Filter: name and number

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

Parameter List

Parameter Type Description Mandatory
name string Customer name No
identificationNumber string CPF or CNPJ of the consumer No
email string Customer email No
number string Order number No
pageSize integer Number of records per page No
pageIndex integer Page number No

Responses


Related Contend

<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 - Create a credit card sale

</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 - List sales

</aside>