Consultar Vendas

get

https://gateway-sandbox.cyclopay.com/v1/charges

Consultar todas as vendas

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Paginação, ordenação e filtros

📘
Como utilizar as paginações utilizando query param:

Paginas: Use size e page para controlar a paginação.

Ordenação: sort permite especificar o campo de referencia e dir a direção (ascendente ou descendente).

Filtros: é possivel utilizar todos os filtros listados na seção dessa página Query Parameters

Informações gerais

📘
Formato e padrões de campos

Campos de data seguem formato DateTime, no padrão "YYYY-MM-DDTHH:MM:SS" ou "YYYY-MM-DD HH:MM:SS"

Campos devalores monetários seguem o formato de valores em centavos. Ex.: 1000 = R$ 10,00.

Query Params

uuid

string

Filtrar por UUID.

type

string

enum

Tipo de venda.

Allowed:

status

string

enum

Status da transação.

Allowed:

order_id

string

Filtrar por ID da venda.

customer_mail

string

Filtrar por email do cliente

customer_document_number

string

Filtrar por número do documento do comprador

original_amount_start

integer

Minimo do valor original.

original_amount_end

string

Máximo do valor original.

amount_start

integer

Minimo valor da transação.

amount_end

integer

Maximo valor da transação.

paid_start

integer

Minimo do valor pago.

paid_end

integer

Máximo do valor pago.

refunded_start

integer

Minimo do valor reembolsado.

refunded_end

integer

Máximo do valor reembolsado.

due_date_start

date-time

Data de vencimento inicial.

due_date_end

date-time

Data de vencimento final.

expiry_date_start

date-time

Data de expiração inicial.

expiry_date_end

date-time

Data de expiração final.

created_at_start

date-time

Data de criação inicial.

created_at_end

date-time

Data de criação final.

updated_at_start

date-time

Data de atualização inicial.

updated_at_end

date-time

Data de atualização final.

size

integer

Número de registros por página

page

string

Página atual

sort

string

Campo para ordenação

dir

string

enum

Defaults to desc

Direção da ordenação

Allowed:

Headers

api_key

string

required

Responses

Paginação, ordenação e filtros

Informações gerais

200200

400400