Ciclos

GET https://www.sellerpay.com.br/api/v1/ciclos

Lista os repasses

🔒 Limite de requisição: 60 requisições por minuto.

Descrição

Retorna a lista de ciclos importados:
Exemplo: https://www.sellerpay.com.br/api/v1/ciclos?pagina=1&dataInicioRegistro=2024-01-01&dataFimRegistro=2024-01-31&limite=100

Parâmetros de Entrada

Campo Descrição Tipo Obrigatório
pagina Número da pagina integer não
dataRepasseInicio e dataRepasseFim Pesquisa por período do repasse. Padrão YYYY-MM-DD data não
dataInicioRegistro e dataFimRegistro Pesquisa por período da criação do ciclo. Padrão YYYY-MM-DD data não
limite Quantidade máxima de registros por página. Valor máximo 200. Se não informado, o padrão é 50. integer não

Resposta de Sucesso

200 OK 
{
    "info": {
        "totalRegistros": 1,
        "limitePorPagina": 20,
        "paginaAtual": 1,
        "totalPaginas": 1
    },
    "ciclos": [
        {
            "idCiclo": 0,
            "canal": "",
            "dataHora": "",
            "dataRepasse": "",
            "valorRepasse": 0,
            "eventos": [
                {
                    "evento": "",
                    "total": 0,
                    "local": ""
                }
            ]
        }
    ]
}

Dados de Resposta

Campo Descrição Tipo Tamanho
info Informações detalhadas sobre o retorno da consulta object
totalRegistros Número total de registros que correspondem ao filtro aplicado. integer
limitePorPagina Quantidade máxima de registros exibidos por página. integer
paginaAtual Número da página atualmente exibida. integer
totalPaginas Número total de páginas que correspondem ao filtro aplicado. integer
ciclos Lista de Eventos object
idCiclo Identificador único do ciclo. integer
canal Nome do canal relacionado ao ciclo. string 80
dataHora Data da criação do ciclo date
dataRepasse Data em que a informação do repasse foi registrada. date
valorRepasse Valor total do repasse numeric
Eventos Lista de eventos object
evento Nome do evento string
total Valor total do evento numeric
local Local onde o evento foi processado string

Resposta de Erro

400 Bad Request 
{
    "mensagem": ""
}
Campo Descrição Tipo Tamanho
mensagem Mensagem de retorno.
Exemplo:
Json não informado
Loja não ativa		 string 255