Ao realizar a chamada, teremos uma resposta da API retornando 10 últimos registros devido a paginação.
Paginação : A paginação consiste em trazer de 10 em 10 registros para evitar sobrecarregamento de dados e erros de memória em montagem de telas, para passar para a próxima página, basta apenas passar o parâmetro em URL page=1 (teste.com.br/establishments?page=1), abaixo, temos o exemplo de como cada filtro deverá ser enviado. Todos devem estar em um array filters[chave] = VALOR_BUSCADO, pelo método ser GET lógicamente os parâmetros serão passados pela URL.

Filtros

Regras de negócio:

        Dados Iniciais:
        Se o tipo pessoa for "Pessoa Física" (people_type_id = 1).
        Os dados obrigatórios são: name, last_name, document, rg, telephone, email, birth, nationality (company).
        Os dados não cadastrável: social_reason, document (cnpj), branch_type_id, cnpj_matriz (company_details).

        Se o tipo pessoa for "Pessoa Jurídica" (people_type_id = 2).
        Os dados obrigatórios são: name, last_name, document, rg, telephone, email, birth, nationality (company).
social_reason, document (cnpj), branch_type_id, cnpj_matriz (company_details).

        Se o tipo pessoa for "Pessoa Jurídica" (people_type_id = 2), e o Tipo de Pessoa Jurídica for "Matriz" (branch_type_id = 1).
        Os dados para ser preenchido são: document e social_reason (company_details).

        Se o tipo pessoa for "Pessoa Jurídica" (people_type_id = 2), e o Tipo de Pessoa Jurídica for "Filial" (branch_type_id = 2).
        Os dados para ser preenchido são: document, social_reason e cnpj_matriz (company_details).

        Dados Bancários:
        Se o dado bancário for "Cartão Pré-Pago" (bank_given_type_id = ”2”),
        Os dados obrigatórios são: Dados do Cartão (prepaid_card), number_card, printed_name e cpf.
        Os dados não cadastrável: Dados bancários (bank_given), titular da conta (bank_given_holder).

        Se o dado bancário for "Conta Bancária" (bank_given_type_id = ”1”),
        Os dados obrigatórios são: Dados bancários (bank_given), bank_given_type_id, bank_id, agency, account, titular da conta (bank_given_holder), os dados não cadastrável: Dados do cartão (prepaid_card).

        Se o dado bancário for "Conta Bancária" (bank_given_type_id = ”1”) e se o titular da conta for "Pessoa Física – Representante" (holder_type_id = ”1”), os dados são preenchido automaticamente através dos campos company.

        Se o tipo pessoa for "Pessoa Jurídica" (people_type_id = "2"), e se o dado bancário for "Conta Bancária" (bank_given_type_id = ”1”) e se o titular da conta for "Pessoa Jurídica - Empresa" (holder_type_id = ”2”), os dados são preenchido automaticamente através do campos company.company_details.

        Se o dado bancário for "Conta Bancária" (bank_given_type_id = ”1”) e se o titular da conta for "Terceira Pessoa Física" (holder_type_id = “3”), os dados para ser preenchido são: name, document (bank_given_holder).

        Se o dado bancário for "Conta Bancária" (bank_given_type_id = ”1”) e se o titular da conta for "Terceira Pessoa Jurídica" (holder_type_id = “4”), os dados para ser preenchido são: name e document (bank_given_holder).

        Para dados bancários do tipo Conta Interna (bank_given_type_id == 3), se faz necessário enviar os parâmetros de configurações da conta interna


Exportar Produtos Exportar Mccs

Ao chamar a API realiza listagem de uma única AFILIADO

Regras de negócio:

        Dados Iniciais:
        O campo tipo pessoa (people_type_id), independente se é "Pessoa Física ou Pessoa Jurídica", não é possivel de alterar.

        Se o tipo pessoa for "Pessoa Física" (people_type_id = 1).
        Campos impossíveis de se alterar: document (company).

        Os dados obrigatórios são: name, last_name, document, rg, telephone, email, birth, nationality (company).
        Os dados não cadastrável: social_reason, document (cnpj), branch_type_id, cnpj_matriz (company_details).

        Se o tipo pessoa for "Pessoa Jurídica" (people_type_id = "2").
        Campos impossíveis de se alterar: document (company_details).

        Os dados obrigatórios são: name, last_name, document, rg, telephone, email, birth, nationality (company).
social_reason, document (cnpj), branch_type_id, cnpj_matriz (company_details).

        Dados Bancários:
        O campo dado bancário (bank_given_type_id), independente se é "Dado Bancário ou Cartão Pré-Pago", é possivel de alterar.

        Se o dado bancário for "Cartão Pré-Pago" (bank_given_type_id = ”2”),
        Os dados obrigatórios são: Dados do Cartão (prepaid_card), number_card, printed_name e cpf.
        Os dados não cadastrável: Dados bancários (bank_given), titular da conta (bank_given_holder).

        Se o dado bancário for "Conta Bancária" (bank_given_type_id = ”1”),
        Os dados obrigatórios são: Dados bancários (bank_given), bank_given_type_id, bank_id, agency, account, titular da conta (bank_given_holder), os dados não cadastrável: Dados do cartão (prepaid_card).

        Se o dado bancário for "Conta Bancária" (bank_given_type_id = ”1”) e se o titular da conta for "Pessoa Física – Representante" (holder_type_id = ”1”), os dados são preenchido automaticamente através dos campos company.

        Se o tipo pessoa for "Pessoa Jurídica" (people_type_id = "2"), e se o dado bancário for "Conta Bancária" (bank_given_type_id = ”1”) e se o titular da conta for "Pessoa Jurídica - Empresa" (holder_type_id = ”2”), os dados são preenchido automaticamente através do campos company.company_details.

        Se o dado bancário for "Conta Bancária" (bank_given_type_id = ”1”) e se o titular da conta for "Terceira Pessoa Física" (holder_type_id = “3”), os dados para ser preenchido são: name, document (bank_given_holder).

        Se o dado bancário for "Conta Bancária" (bank_given_type_id = ”1”) e se o titular da conta for "Terceira Pessoa Jurídica" (holder_type_id = “4”), os dados para ser preenchido são: name e document (bank_given_holder).
        Para dados bancários do tipo Conta Interna (bank_given_type_id == 3), se faz necessário enviar os parâmetros de configurações da conta interna

Ao chamar a API bloqueia e desbloqueia o estabelecimento

Ao chamar essa rota, trará todos os estabelecimentos ativos com seu status de pagamento correspondente

Rota designada para listagem de logs de pagamento

A rota é designada para realizar alteração de status de pagamento