Listar todas as regras de pré-split

🔼
GET `urlServidor/v1/marketplace/establishments/establishment_id/split-pre

Obs: A palavra urlServidor deve ser substituída pela url do servidor.

Exemplo de header da requisição

curl--request GET \
--location 'GET /v1/marketplace/establishments/{establishment_id}/split-pre' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'Authorization: Bearer {{bearer_token}}' \

Parâmetros da Requisição

Headers

Nome	Tipo	Obrigatório	Descrição
`integration-key`	string	Sim	Chave de integração.
`x-token`	string	Sim	Token de autenticação. Pode ser encontrado em nosso portal na guia de integração.
`Authorization`	Auth Type Bearer Token	Sim	Inserir o Bearer Token, gerado na rota Auth

Parâmetros de Path

Nome	Tipo	Obrigatório	Descrição
`establishment_id`	string	Sim	ID do estabelecimento para o qual listar regras

✅ Exemplo de Resposta

{
    "total": 2,
    "perPage": 20,
    "page": 1,
    "lastPage": 1,
    "data": [
        {
            "id": 3,
            "title": "Comissão Sandbox Atualizado",
            "modality": "PIX",
            "channel": "ALL",
            "division": "PERCENTAGE",
            "installment": 2,
            "establishment_id": 415585,
            "active": 1,
            "__meta__": {
                "ecs_count": 3
            }
        },
        {
            "id": 2,
            "title": "Comissão SAndbox",
            "modality": "CREDIT",
            "channel": "ONLINE",
            "division": "PERCENTAGE",
            "installment": 3,
            "establishment_id": 415585,
            "active": 1,
            "__meta__": {
                "ecs_count": 1
            }
        }
    ]
}

📋 Explicação de Atributos da Resposta

Nome	Tipo	Obrigatório	Descrição
`total`	number	Sim	Número total de registros encontrados para os filtros aplicados.
`perPage`	number	Sim	Quantidade de registros retornados por página.
`page`	number	Sim	Página atual da resposta.
`lastPage`	number	Sim	Última página disponível com base na paginação.
`id`	number	Sim	Identificador único da regra de Split Pré.
`title`	string	Sim	Título ou nome descritivo da regra.
`modality`	string	Sim	Modalidade da transação que a regra se aplica (`ALL`, `CREDIT`, `DEBIT`, `PIX`).
`channel`	string	Sim	Canal de venda (`ALL`, `CHIP`, `TAP`, `SMART`, `ONLINE`).
`division`	string	Sim	Tipo de divisão da regra (`PERCENTAGE` ou `CURRENCY`).
`installment`	number	Não	Número de parcelas. Aplicável quando a modalidade for `CREDIT`.
`establishment_id`	number	Sim	ID do estabelecimento principal (criador da regra).
`active`	boolean	Sim	Indica se a regra está ativa (`true`) ou inativa (`false`).
`__meta__.ecs_count`	number	Sim	Número de estabelecimentos participantes ativos associados à regra.

⚠️ Observações

Uma regra de Split Pré define a divisão automática de valores entre estabelecimentos no momento da criação da transação.

É possível configurar múltiplas regras desde que não sejam conflitantes (ex: mesma modalidade e canal).

Códigos de Resposta

Consulte a página com os status: Status de respostas

Para mais detalhes sobre os parâmetros e funcionamento da API, acesse a documentação oficial da Paytime.