Obter detalhes de uma regra de pré-split

Esta rota permite consultar os detalhes completos de uma regra de Split Pré cadastrada por um estabelecimento. Útil para revisar os critérios da divisão de valores entre os estabelecimentos participantes.

🔼
GET urlServidor/v1/marketplace/establishments/{establishment_id}/split-pre/{split_id}

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/1234/split-pre/1' \
--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 a ser consultado
`split_id`	string	Sim	ID da regra de split a ser consultada.

✅ Exemplo de Resposta

{
    "id": 3,
    "title": "Comissão Sandbox Atualizado",
    "modality": "PIX",
    "channel": "ALL",
    "division": "PERCENTAGE",
    "installment": 2,
    "active": 1,
    "establishment_percentage": 20,
    "establishment": {
        "id": 155085,
        "first_name": "EC Cobranças",
        "last_name": null,
        "document": "10068114001"
    },
    "establishments": [
        {
            "value": 30,
            "priority": 1,
            "active": 1,
            "establishment": {
                "id": 155082,
                "first_name": "Webhooks Integrações",
                "last_name": "API Integrações",
                "document": "60274849000185"
            }
        },
        {
            "value": 30,
            "priority": 2,
            "active": 1,
            "establishment": {
                "id": 155099,
                "first_name": "Atacadão dos Programadores",
                "last_name": "Atacadão DEV",
                "document": "37603116000125"
            }
        },
        {
            "value": 20,
            "priority": 3,
            "active": 1,
            "establishment": {
                "id": 155100,
                "first_name": "Teste Sandbox",
                "last_name": "Solucoes",
                "document": "11299221000129"
            }
        }
    ],
    "__meta__": {
        "ecs_count": 3
    }
}

📋 Explicação de Atributos da Resposta

Campo	Tipo	Obrigatório	Descrição
`id`	number	Sim	Identificador único da regra de Split Pré.
`title`	string	Sim	Título descritivo da regra de split.
`modality`	string	Sim	Modalidade da transação. Ex: `ALL`, `CREDIT`, `DEBIT`, `PIX`.
`channel`	string	Sim	Canal da transação. Ex: `ALL`, `CHIP`, `TAP`, `SMART`, `ONLINE`.
`division`	string	Sim	Tipo de divisão aplicada. Ex: `PERCENTAGE` ou `CURRENCY`.
`installment`	number	Não	Quantidade de parcelas, se aplicável.
`active`	boolean	Sim	Indica se a regra está ativa (`true`) ou não (`false`).
`establishment_percentage`	number	Sim	Porcentagem atribuída ao estabelecimento principal.
`establishment.id`	number	Sim	ID do estabelecimento principal.
`establishment.first_name`	string	Sim	Nome ou razão social do estabelecimento principal.
`establishment.last_name`	string	Sim	Nome fantasia do estabelecimento principal.
`establishment.document`	string	Sim	CPF ou CNPJ do estabelecimento principal.
`establishments`	array	Sim	Lista de estabelecimentos participantes secundários.
`establishments[].value`	number	Sim	Valor ou porcentagem atribuído ao participante.
`establishments[].priority`	number	Sim	Ordem de prioridade da regra de split.
`establishments[].active`	boolean	Sim	Indica se o participante está ativo.
`establishments[].establishment.id`	number	Sim	ID do estabelecimento secundário.
`establishments[].establishment.first_name`	string	Sim	Nome ou razão social do estabelecimento secundário.
`establishments[].establishment.last_name`	string	Sim	Nome fantasia do estabelecimento secundário.
`establishments[].establishment.document`	string	Sim	CPF ou CNPJ do estabelecimento secundário.
`__meta__.ecs_count`	number	Sim	Quantidade de estabelecimentos ativos na regra.

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.

Updated 6 months ago

Did this page help you?