Documentação

Versão: feat/temp-schedule-work

Adquirente

GET

LISTAGEM
/acquirers

Detalhes

Ao chamar a API realiza a listagem dos Adquirentes

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAÇÃO
/acquirers

Detalhes

Ao chamar a API realiza a criação do Adquirente

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	COMMERCIAL_NAME, CODE_ESTABLISHMENT, SOCIAL_REASON, DOCUMENT, CEP, ADDRESS, NUMBER, DISTRICT, CITY, STATE_ID, COUNTRIE_ID, CONTACT_TYPE_ID, NAME, VALUE
Body	{ "commercial_name" : "Nome Comercial", "code_establishment" : "213456", "company" : { "company_details": { "social_reason": "Razao Social", "document": "56814311000149", } }, "localization" : { "cep": "88902-378", "address": "Rua Alessandro de Souza Social", "number": "571", "district": "Polícia Rodoviária", "city": "Araranguá", "state_id": "1", "countrie_id": "1", "complement": "Casa" }, "contacts" : [{ "contact_type_id": "2", "name": "José", "value": "social@hotmail.com" }, { "contact_type_id": "1", "name": "João", "value": "988544324" }] }

Retornos

Código	Mensagem
201	CRIADO
401	Campo commercial_name é obrigatório O Tamanho Máximo para o campo commercial_name é de 255 caracteres Campo code_establishment é obrigatório O Tamanho Máximo para o campo code_establishment é de 255 caracteres Campo company.company_details.document é obrigatório Campo company.company_details.document é Inválido Campo company.company_details.social_reason é obrigatório Campo localization.cep é obrigatório O Campo localization.cep é Inválido Campo localization.number é obrigatório Campo localization.number deve conter apenas Números Campo localization.address é obrigatório O Tamanho Máximo para o campo localization.address é de 255 caracteres Campo localization.district é obrigatório O Tamanho Máximo para o campo localization.district é de 255 caracteres Campo localization.city é obrigatório O Tamanho Máximo para o campo localization.city é de 255 caracteres Campo localization.state_id deve conter apenas Números Campo localization.state_id é Inválido Campo localization.countrie_id deve conter apenas Números Campo localization.countrie_id é Inválido O Tamanho Máximo para o campo localization.complement é de 255 caracteres Adquirente já cadastrado
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR POR ID
/acquirers/{id}

Detalhes

Ao chamar a API realiza listagem de um único Adquirente

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ATUALIZAÇÃO
/acquirers/{id}

Detalhes

Ao chamar a API recebe os dados do Adquirente e realiza a atualização

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	COMMERCIAL_NAME, CODE_ESTABLISHMENT, SOCIAL_REASON, DOCUMENT, CEP, ADDRESS, NUMBER, DISTRICT, CITY, STATE_ID, COUNTRIE_ID, CONTACT_TYPE_ID, NAME, VALUE
Body	{ "commercial_name" : "Nome Comercial Atualizado", "code_establishment" : "9090", "company" : { "company_details": { "social_reason": "Razao Atualizado", "document": "56814311000149", } }, "localization" : { "cep": "88902-378", "address": "Rua Alessandro de Souza Atualizado", "number": "571", "district": "Polícia Rodoviária", "city": "Araranguá", "state_id": "1", "countrie_id": "1", "complement": "Casa" }, "contacts" : [{ "contact_type_id": "2", "name": "José", "value": "Atualizado@hotmail.com" }, { "contact_type_id": "1", "name": "João", "value": "988544324" }] }

Retornos

Código	Mensagem
200	OK
401	Campo commercial_name é obrigatório O Tamanho Máximo para o campo commercial_name é de 255 caracteres Campo code_establishment é obrigatório O Tamanho Máximo para o campo code_establishment é de 255 caracteres Campo company.company_details.document é obrigatório Campo company.company_details.document é Inválido Campo company.company_details.social_reason é obrigatório Campo localization.cep é obrigatório O Campo localization.cep é Inválido Campo localization.number é obrigatório Campo localization.number deve conter apenas Números Campo localization.address é obrigatório O Tamanho Máximo para o campo localization.address é de 255 caracteres Campo localization.district é obrigatório O Tamanho Máximo para o campo localization.district é de 255 caracteres Campo localization.city é obrigatório O Tamanho Máximo para o campo localization.city é de 255 caracteres Campo localization.state_id deve conter apenas Números Campo localization.state_id é Inválido Campo localization.countrie_id deve conter apenas Números Campo localization.countrie_id é Inválido O Tamanho Máximo para o campo localization.complement é de 255 caracteres Adquirente já cadastrado Não é possível alterar o documento Adquirente não existente
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

DELETE

DELETAR
/acquirers/{id}

Detalhes

Ao chamar a API ativa ou inativa o Adquirente desejado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Antecipacao

POST

ALTERAÇÃO DE ESTABELECIMENTO
anticipation/establishment

Detalhes

Aqui, poderemos alterar o status de Antecipação de um Estabelecimento, pare bloqueado, ou liberado para realizar antecipações.

Para atualizar um Estabelecimento, basta enviar o id do estabelecimento e o status de antecipação sendo as possibilidades :

1 - Liberado POS
2 - Liberado E-Commerce
3 - Liberado Geral
4 - Bloqueado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	ESTABLISHMENT_ID, ANTICIPATION_STATUS_ID
Body	{ "establishment_id" : "1", "anticipation_status_id" : "2" }

Retornos

Código	Mensagem
401	Dados inconsistente Estabelecimento não encontrado Não é possível alterar um Estabelecimento Não Operante
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

BUSCA DE PARCELAS
anticipation/installments

Detalhes

Aqui, poderemos buscar as parcelas que estão para vencer a partir do dia de amanhã

É importante ressaltar, que se o afiliado for liberado POS, ele só poderá visualizar as Parcelas de transações que são do meio de captura POS. E a mesma regra se aplica para E-Commerce

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DOCUMENT, DATE
Body	{ "document" : "45246008177", "date" : "2021-08-26" }

Retornos

Código	Mensagem
401	Dados inconsistente Estabelecimento não encontrado Não é possível alterar um Estabelecimento Não Operante O dia definido para antecipação não pode ser hoje Estabelecimento bloqueado para antecipação Não foram encontradas parcelas para antecipar
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

REALIZAR ANTECIPAÇÃO
anticipation

Detalhes

Finalmente, chegamos no ultimo passo, que é a realização do processo de antecipação.

É importante ressaltar que o campo data, leva em consideração feriados do sistema e finais de semana, que caso seja informada uma data que seja feriado, ou final de semana, acusará problema na data.

Parcelas com data de antecipação posteriores a data de vencimento original também não são antecipadas.

E também, a tarifa informada, leva em consideração o que estiver estipulado na tela de parâmetros.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DATE, ANTICIPATION_TARIFF, INSTALLMENTS, DOCUMENT
Body	{ "document" : "61559733934", "date" : "2019-12-20", "anticipation_tariff" : "1", "installments" : [1,2,3,4,5] }

Retornos

Código	Mensagem
401	Dados inconsistente Estabelecimento não encontrado Por favor, informe um dia útil A Tarifa informada é maior do que a permitida
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

REALIZAR ANTECIPAÇÃO DE TODAS AS PARCELAS
anticipation/anticipate_all

Detalhes

Método para antecipar todas as parcelas para uma data específica.

.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DATE, ANTICIPATION_TARIFF, DOCUMENT
Body	{ "document" : "61559733934", "date" : "2019-12-20", "anticipation_tariff" : "1" }

Retornos

Código	Mensagem
401	Dados inconsistente Estabelecimento não encontrado Por favor, informe um dia útil A Tarifa informada é maior do que a permitida
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Antecipacao Automatica

GET

LISTAGEM DE ESTABELECIMENTOS
/establishment_automatic_anticipations

Detalhes

Ao chamar a API realiza a listagem das Antecipação Automáticas

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR ESTABELECIMENTO POR ID
/establishment_automatic_anticipations/{id}

Detalhes

Ao chamar a API realiza listagem de um único Estabelecimento

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

CONFIGURAR ANTECIPAÇÃO AUTOMÁTICA PARA ESTABELECIMENTOS
/establishment_automatic_anticipations/{id}

Detalhes

Ao chamar a API Configura a Antecipação Automática

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	ANTICIPATION_APPLICATION_MODE_ID, ANTICIPATION_MODE_ID, VALUE
Body	{ "anticipation_application_mode_id" : "1", "anticipation_mode_id" : "1", "value" : "20" }

Retornos

Código	Mensagem
200	OK
401	Campo anticipation_application_mode_id é obrigatório Campo anticipation_mode_id é obrigatório Campo value é obrigatório
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

DELETE

DELETAR CONFIGURAÇÃO
/establishment_automatic_anticipations/{id}

Detalhes

Ao chamar a API apaga a configuração de Antecipação Automática desejada

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM DE GRUPOS ECONÔMICOS
/economic_group_automatic_anticipations

Detalhes

Ao chamar a API realiza a listagem das Antecipação Automáticas

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR GRUPO ECONÔMICO POR ID
/economic_group_automatic_anticipations/{id}

Detalhes

Ao chamar a API realiza listagem de um único grupo econômico

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

CONFIGURAR ANTECIPAÇÃO AUTOMÁTICA PARA GRUPO ECONÔMICO
/economic_group_automatic_anticipations/{id}

Detalhes

Ao chamar a API Configura a Antecipação Automática

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	ANTICIPATION_APPLICATION_MODE_ID, ANTICIPATION_MODE_ID, VALUE
Body	{ "anticipation_application_mode_id" : "1", "anticipation_mode_id" : "1", "value" : "20" }

Retornos

Código	Mensagem
200	OK
401	Campo anticipation_application_mode_id é obrigatório Campo anticipation_mode_id é obrigatório Campo value é obrigatório
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

DELETE

DELETAR
/economic_group_automatic_anticipations/{id}

Detalhes

Ao chamar a API apaga a configuração de Antecipação Automática desejado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Aprovação Manual

GET

LISTAR APROVAÇÃO MANUAL
/moneylender/approvations

Detalhes

Ao realizar a chamada, a API irá apresentar uma lista com as Aprovações Manuais do sistema.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

DETALHAR APROVAÇÃO MANUAL
/moneylender/approvations/{id}

Detalhes

Ao realizar a chamada, será apresentado as informações sobre a Aprovação Manual desejada.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Aprovações

GET

LISTAGEM AFILIADO EM PROCESSAMENTO
establishment/proccessing

Detalhes

Ao chamar a API realiza paginação dos Estabelecimentos em Processamento.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM AFILIADO APROVADO
establishment/approvations

Detalhes

Ao chamar a API realiza a listagem do afiliado aprovado.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

AFILIADO PRÉ APROVADO
establishment/approve/{id}

Detalhes

Ao chamar a API realiza aprovação do afiliado para a checagem OFAC.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	REASON
Body	{ "reason" : "lorem ipsum dolor" }

Retornos

Código	Mensagem
200	OK
401	Estabelecimento não encontrado Estabelecimento não está aguardando uma aprovação Houve um erro ao integrar ao serviço OFAC
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

FORÇAR APROVAÇÃO AFILIADO
establishment/force_approve/{id}

Detalhes

Ao chamar a API realiza a aprovação forçadamente do afiliado.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	REASON
Body	{ "reason" : "lorem ipsum dolor" }

Retornos

Código	Mensagem
200	OK
401	Estabelecimento não encontrado Estabelecimento não está em processamento
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Arquivo Conciliação

GET

BUSCAR TRANSAÇÕES COM DETERMINADO PARAMETROS
/conciliations/first_data/{id}/{option}

Detalhes

É preciso passar dois parametros na rota: ID( id da compania ) e option( Grupo Econômico ou Estabelecimento ), após ser chamado é realizado a listagem das transações e parcelas.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAÇÃO DE LOG NO ARQUIVO DE CONCILIAÇÂO.
/conciliations/firstDataConciliationLog/{id}

Detalhes

Ao chamar a API realiza a criação de logs do arquivo conciliação.
OBS: o parametro "id" é usado para caso de erro.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
500	Houve um erro interno

Bancos

GET

LISTAGEM
/banks

Detalhes

Ao realizar a chamada, a API irá retornar uma lista com os bancos cadastrados.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

EDITAR BANCO
/banks/{id}

Detalhes

Ao realizar a chamada, a API irá editar o banco com os dados informados.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "code" : "123", "name" : "BANCO TESTE" }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

DELETE

DELETAR BANCO
/banks/{id}

Detalhes

Ao realizar a chamada, teremos uma resposta da API, deletando um dos bancos cadastrados no sistema.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAR BANCO
/products

Detalhes

Ao realizar a chamada, teremos uma resposta da API retornando a criação de um banco no sistema.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "code" : "3214", "name" : "BANCO TESTE 5" }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Bandeiras

GET

LISTAGEM
/brands

Detalhes

Ao realizar a chamada, teremos uma resposta da API retornando as bandeiras cadatradas no sistema.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

EDITAR BANDEIRA
/brands/{id}

Detalhes

Ao realizar a chamada, será feito a edição da bandeira com as informações informadas nos campos.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "name" : "Maestro" }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

DELETE

DELETAR BANDEIRA
/brands/{id}

Detalhes

Ao realizar a chamada, a API irá deletar a bandeira selecionada

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Cancelamento

GET

LISTAR CANCELAMENTOS
/manual_cancellation

Detalhes

Ao realizar a chamada, será apresentado uma lista com os Cancelamentos feitos no sistema.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

REALIZAR CANCELAMENTO
/manual_cancellation/{id}

Detalhes

Ao realizar a chamada, a API irá realizar o cancelamento de uma transação.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Cancelamento Manual

GET

LISTAGEM DE TRANSAÇÕES
/manual_cancellation

Detalhes

Ao chamar a API exibe a listagem de transações

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

CANCELAMENTO MANUAL DE TRANSAÇÕES
/manual_cancellation/{id}

Detalhes

Ao chamar a API cancela a transação manualmente.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Transação não pode ser cancelada. Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM DE ANTECIPAÇÕES
/anticipation_manual_cancellation

Detalhes

Ao chamar a API exibe a listagem de antecipações

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

CANCELAMENTO MANUAL DE ANTECIPAÇÕES
/anticipation_manual_cancellation/{id}

Detalhes

Ao chamar a API cancela a antecipação manualmente.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Transação não pode ser cancelada. Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Cashback

GET

Cashback
/cashback

Detalhes

Ao realizar a chamada, a API irá retornar uma lista com as Transações cadastrados.
id: ID da transação.
integration_transaction_id: ID da Transação SPR.
transaction_date: Data da transação.

Paginação : A paginação consiste em trazer de 50 em 50 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/cashback?page=1).

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	EXEMPLO. "data": { "transaction": [ { "transaction_id": 1, Tipo integer/ ID da transação. "integration_transaction_id": "207", Tipo integer / ID da Transação SPR. "total_value": "1.00", Tipo integer / Valor total da transação. "installments" Tipo integer / Parcelas. "expiry_date": "2022-09-02", Tipo date / Data prevista de pagamento. "installment_number": 1, Tipo integer / Número da parcela. "installment_id": "1", Tipo integer / ID da parcela. "net_amount": "1.00", Tipo integer / Valor liquido da parcela. "tariffs": Tipo integer / Tarifas. { "mdr_value": "0.00", Tipo integer / Valor mdr. "mdr_tax": "0.00", Tipo integer / Taxa dmr (%) } } ] }
401	A pesquisa não retornou nenhum dado.
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno.

Comissoes

GET

LISTAGEM
/commissions

Detalhes

Ao chamar a API realiza a listagem das comissões

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR POR ID
/commissions/{id}

Detalhes

Ao chamar a API realiza listagem de uma única comissão

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAR COMISSÃO
/commissions

Detalhes

Ao chamar a API cria a comissão
Para criar comissão para preposto é necessário enviar o campo "company_type_id" = 3 e alterar o campo "distributor" para "preposterou: Preposto".

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	NAME, VALIDITY, COMPANY_TYPE_ID, SUBSEQUENT, COMMISSION_TYPE_ID, DISTRIBUTOR
Body	{ "commission_basic" : { "name": "Exemplo", "validity": "2021-05-18", "company_type_id": "2", "subsequent": "1", "commission_type_id": "1" }, }

Retornos

Código	Mensagem
200	OK
401	Campo name é obrigatório Campo validity é obrigatório Campo company_type_id é obrigatório Campo subsequent é obrigatório Campo commission_type_id é obrigatório Campo distributor é obrigatório
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

EDITAR COMISSÃO
/commissions/update/{id}

Detalhes

Ao chamar a API edita a comissão
Para editar comissão para preposto é necessário enviar o campo "company_type_id" = 3 e alterar o campo "distributor" para "preposterou: Preposto".

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	NAME, VALIDITY, COMPANY_TYPE_ID, SUBSEQUENT, COMMISSION_TYPE_ID, DISTRIBUTOR, COMMISSION_SERVICE_ID, TARIFF_ID, AMOUNT, INITIAL_INSTALLMENT, FINAL_INSTALLMENT, MKT, ROYALTY, COMMISSION_VALUE, COMMISSION_MINIMUM_VALUE
Body	{ "commission_basic" : { "name": "Exemplo", "validity": "2021-05-18", "company_type_id": "2", "subsequent": "1", "commission_type_id": "1" } , "commission_detail" : { "commission_service_id": "1", "tariff_id": "25", "amount": "10", "initial_installment": "1", "final_installment": "12" } , "commission_model_tax" : { "mkt": "10", "royalty": "100" } , "commission_credentials" : { "commission_value": "1.50", "commission_minimum_value": "10.20" } }

Retornos

Código	Mensagem
200	OK
401	Campo name é obrigatório Campo validity é obrigatório Campo company_type_id é obrigatório Campo subsequent é obrigatório Campo commission_type_id é obrigatório Campo distributor é obrigatório
402	Data de vigência incorreta. Registro não encontrado. Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM EXTRATO
/commission_reports

Detalhes

Ao chamar a API realiza listagem de extratos

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM DE COMISSÕES
/commission_upload

Detalhes

Ao chamar a API realiza listagem de comissoes

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR COMISSÃO POR ID
/commission_upload/show/{id}

Detalhes

Ao chamar a API realiza listagem de uma comissão em específico

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

UPLOAD DE NOTA FISCAL
/commission_upload/upload/{id}

Detalhes

Ao chamar a API realiza o upload de nota fiscal".

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	NFE
Body	{ "files" : { "nfe": "{}" }, }

Retornos

Código	Mensagem
200	OK
401	Campo nfe é obrigatório
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM EXTRATO
/commission_companies

Detalhes

Ao chamar a API realiza listagem de comissões

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

ATUALIZAR DIA DE PAGAMENTO
/commission_companies/update_payday

Detalhes

Ao chamar a API atualiza o dia de pagamento".

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	PAYDAY, IDCOMISSION
Body	{ "payday" : "2021-05-18", "idComission" : "1" }

Retornos

Código	Mensagem
200	OK
401	Campo payday é obrigatório Campo idComission é obrigatório
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM
/commision_models

Detalhes

Ao chamar a API realiza a listagem dos modelos de comissões

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR POR ID
/commision_models/show/{id}

Detalhes

Ao chamar a API realiza listagem de uma única comissão

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAR MODELO DE COMISSÃO
/commision_models

Detalhes

Ao chamar a API cria o modelo de comissão

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DESCRIPTION
Body	{ "description" : "EXEMPLO" }

Retornos

Código	Mensagem
200	OK
401	Campo description é obrigatório
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

EDITAR COMISSÃO
/commision_models/update/{id}

Detalhes

Ao chamar a API edita o modelo de comissão

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DESCRIPTION
Body	{ "description" : "EXEMPLO" }

Retornos

Código	Mensagem
200	OK
401	Campo description é obrigatório
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM
/commision_services

Detalhes

Ao chamar a API realiza a listagem dos serviço de comissões

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR POR ID
/commision_services/show/{id}

Detalhes

Ao chamar a API realiza listagem de um único serviço de comissão

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAR SERVIÇO
/commision_services

Detalhes

Ao chamar a API cria o serviço de comissão

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DESCRIPTION
Body	{ "description" : "EXEMPLO" }

Retornos

Código	Mensagem
200	OK
401	Campo description é obrigatório
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

EDITAR SERVIÇO
/commision_models/update/{id}

Detalhes

Ao chamar a API edita o serviço de comissão

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DESCRIPTION
Body	{ "description" : "EXEMPLO" }

Retornos

Código	Mensagem
200	OK
401	Campo description é obrigatório
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Configurar Giro

GET

LISTAGEM
/moneylender_configurations

Detalhes

Ao chamar a API realiza a listagem do Giro

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

Configurar Giro
/moneylender_configurations/{id}

Detalhes

Ao chamar a API Configura o Giro

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	MINIMAL_USE_TIMING, MINIMAL_INVOICING_TIMING, MEDIUM_VALUE_INVOICE_PERIOD, MAX_MONTHS, MAX_LACK_DAYS, MAX_DELAY_TO_OVERDUE, PRE_APPROVED_MEDIUM_VALUE, RESPONSIBLE_MAIL, INTEREST_RATES, RANGES_TAX
Body	{ "minimal_use_timing" : "10", "minimal_invoicing_timing" : "10", "medium_value_invoice_period" : "10", "max_months" : "12", "max_lack_days" : "10", "max_delay_to_overdue" : "10", "pre_approved_medium_value" : "10", "responsible_mail" : "email@exemplo.com,email_dois@exemplo.com", "interest_rates" : [ { "until_amount": "150", "interest_rate": "10" }, { "until_amount": "180", "interest_rate": "15" }] , "ranges_tax" : [{ "until_amount": "150", "tax": "10" }, { "until_amount": "180", "tax": "15" }] }

Retornos

Código	Mensagem
200	OK
401	Campo minimal_use_timing é obrigatório Campo minimal_invoicing_timing é obrigatório Campo medium_value_invoice_period é obrigatório Campo max_months é obrigatório Campo max_lack_days é obrigatório Campo max_delay_to_overdue é obrigatório Campo pre_approved_medium_value é obrigatório Campo responsible_mail é obrigatório Campo interest_rates é obrigatório Campo ranges_tax é obrigatório
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM DE GRUPO ECONÔMICOS
/economic_group_moneylender_configurations/economic_group

Detalhes

Ao chamar a API realiza a listagem dos Grupos Econômicos

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR GRUPO ECONÔMICO POR ID
/economic_group_moneylender_configurations/economic_group/{id}

Detalhes

Ao chamar a API realiza listagem de um único Grupo Econômico

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

CONFIGURAR GIRO PARA GRUPO ECONÔMICO
/economic_group_moneylender_configurations/update_economic_group/{id}

Detalhes

Ao chamar a API Configura o Giro

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	MINIMAL_USE_TIMING, MINIMAL_INVOICING_TIMING, MEDIUM_VALUE_INVOICE_PERIOD, MAX_MONTHS, MAX_LACK_DAYS, MAX_DELAY_TO_OVERDUE, PRE_APPROVED_MEDIUM_VALUE, RESPONSIBLE_MAIL, INTEREST_RATES, RANGES_TAX
Body	{ "minimal_use_timing" : "10", "minimal_invoicing_timing" : "10", "medium_value_invoice_period" : "10", "max_months" : "12", "max_lack_days" : "10", "max_delay_to_overdue" : "10", "pre_approved_medium_value" : "10", "responsible_mail" : "email@exemplo.com,email_dois@exemplo.com", "interest_rates" : [ { "until_amount": "150", "interest_rate": "10" }, { "until_amount": "180", "interest_rate": "15" }] , "ranges_tax" : [{ "until_amount": "150", "tax": "10" }, { "until_amount": "180", "tax": "15" }] }

Retornos

Código	Mensagem
200	OK
401	Campo minimal_use_timing é obrigatório Campo minimal_invoicing_timing é obrigatório Campo medium_value_invoice_period é obrigatório Campo max_months é obrigatório Campo max_lack_days é obrigatório Campo max_delay_to_overdue é obrigatório Campo pre_approved_medium_value é obrigatório Campo responsible_mail é obrigatório Campo interest_rates é obrigatório Campo ranges_tax é obrigatório
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

DELETE

DELETAR CONFIG. PARA GRUPO ECONÔMICO
/establishments_moneylender_configurations/delete_establishment/{id}

Detalhes

Ao chamar a API exclui a configuração do grupo desejado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM DE ESTABELECIMENTOS
/establishments_moneylender_configurations/establishment

Detalhes

Ao chamar a API realiza a listagem dos estabelecimentos

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR GRUPO ECONÔMICO POR ID
/establishments_moneylender_configurations/establishment/{id}

Detalhes

Ao chamar a API realiza listagem de um único Estabelecimento

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

CONFIGURAR GIRO PARA ESTABELECIMENTO
/establishments_moneylender_configurations/update_establishment/{id}

Detalhes

Ao chamar a API Configura o Giro

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	MINIMAL_USE_TIMING, MINIMAL_INVOICING_TIMING, MEDIUM_VALUE_INVOICE_PERIOD, MAX_MONTHS, MAX_LACK_DAYS, MAX_DELAY_TO_OVERDUE, PRE_APPROVED_MEDIUM_VALUE, RESPONSIBLE_MAIL, INTEREST_RATES, RANGES_TAX
Body	{ "minimal_use_timing" : "10", "minimal_invoicing_timing" : "10", "medium_value_invoice_period" : "10", "max_months" : "12", "max_lack_days" : "10", "max_delay_to_overdue" : "10", "pre_approved_medium_value" : "10", "responsible_mail" : "email@exemplo.com,email_dois@exemplo.com", "interest_rates" : [ { "until_amount": "150", "interest_rate": "10" }, { "until_amount": "180", "interest_rate": "15" }] , "ranges_tax" : [{ "until_amount": "150", "tax": "10" }, { "until_amount": "180", "tax": "15" }] }

Retornos

Código	Mensagem
200	OK
401	Campo minimal_use_timing é obrigatório Campo minimal_invoicing_timing é obrigatório Campo medium_value_invoice_period é obrigatório Campo max_months é obrigatório Campo max_lack_days é obrigatório Campo max_delay_to_overdue é obrigatório Campo pre_approved_medium_value é obrigatório Campo responsible_mail é obrigatório Campo interest_rates é obrigatório Campo ranges_tax é obrigatório
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Configuração de Jobs

GET

LISTAR CONFIGURAÇÃO DE JOBS
/job_configurations

Detalhes

Ao realizar a chamada, a API irá apresentar uma lista com as Configurações de Jobs.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Conta Interna

GET

LISTAGEM DE ESTABELECIMENTOS
/internal_account/extract

Detalhes

Ao chamar a API exibe a listagem de estabelecimentos

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR EXTRATOS POR ID
/internal_account/extract/{id}

Detalhes

Ao chamar a API realiza listagem de um único estabelecimento

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM DE ESTABELECIMENTOS
/internal_account/proof

Detalhes

Ao chamar a API exibe a listagem de estabelecimentos

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR COMPROVANTE POR ID
/internal_account/proof/show/{id}

Detalhes

Ao chamar a API realiza listagem de comprovantes de um único Estabelecimento

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM DE REPASSES MANUAIS
/manual_transfer

Detalhes

Ao chamar a API exibe a listagem de repasses manuais

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR POR ID
/manual_transfer/{id}

Detalhes

Ao chamar a API realiza listagem de um repasse manual específico

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

TRANSFERENCIA PARA TERCEIROS
/internal_account/store/third

Detalhes

Ao chamar a API realiza um TED para terceiros

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "TED PARA TERCEIROS" : { "people_type_id": "1", "bank_id": "6", "agency": "111111111", "digit_agency": "11", "account": "111111111", "digit_account": "11", "amount": "4.44", "observation": "a", "holder_document": "02889437329", "holder": "aaa", "favorite_id": null }, }

Retornos

Código	Mensagem
206	OK
401	Campo people_type_id é obrigatório Campo bank_id é obrigatório Campo agency é obrigatório Campo account é obrigatório Campo amount é obrigatório Campo holder_document é obrigatório Campo holder é obrigatório
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

TRANSFERENCIA PARA CONTA INTERNA
/internal_account/store/internal

Detalhes

Ao chamar a API realiza um Transferencia para Conta Interna

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "TRANSFERENCIA PARA CONTA INTERNA" : { "amount": "33", "document": "08198905880", "establishment_id": "5", "favorite_id": "", "name_estab": "Leonardo Silva", "observation": "a" }, }

Retornos

Código	Mensagem
206	OK
401	Estabelecimento destino não encontrado Campo amount é obrigatório Estabelecimento não utiliza conta interna ou está inativa
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

TED ESTABELECIMENTO
/internal_account/store

Detalhes

Ao chamar a API realiza um TED para terceiros

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "TED ESTABELECIMENTO" : { "people_type_id": "2", "bank_id": "16", "agency": "123", "digit_agency": "1", "account": "283643", "digit_account": "1", "amount": "4.44", "observation": "aaa", "holder_document": "88113866000150", "holder": "aa", "_token": "oFtkHpGeRLN5tdF3GGa2SF1WLAJ6U0uE8m8BKasi" }, }

Retornos

Código	Mensagem
206	OK
401	Campo people_type_id é obrigatório Campo bank_id é obrigatório Campo agency é obrigatório Campo amount é obrigatório Campo holder_document é obrigatório Campo holder é obrigatório Campo account é obrigatório
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM DE FAVORITOS
/internal_account/favorite_bank

Detalhes

Ao chamar a API realiza a listagem dos favoritos

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

ESPECÍFICO FAVORITOS
/internal_account/favorite_bank/show/{id}

Detalhes

Ao chamar a API realiza a especifico dos favoritos

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

ALTERAR STATUS FAVORITO
/internal_account/favorite_bank/status/{id}

Detalhes

Ao chamar a API realiza a especifico dos favoritos

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAÇÃO DE FAVORITO CONTA INTERNA
/internal_account/favorite_bank/store

Detalhes

Ao chamar a API cria um favorito para conta interna

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "CRIAÇÃO DE FAVORITO CONTA INTERNA" : { "document": "08198905880", "name": "Leonardo Silva" }, }

Retornos

Código	Mensagem
201	OK
401	É necessario preencher o nome e o documento para cadastrar novo favorito
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAÇÃO DE FAVORITO PARA TERCEIROS
/internal_account/favorite_bank/store

Detalhes

Ao chamar a API cria um favorito para terceiros

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "CRIAÇÃO DE FAVORITO PARA TERCEIROS" : { "bank_id": "6", "agency": "231324415", "digit_agency": "12", "account": "233333333", "digit_account": "33", "document": "79598351106", "name": "Ricardão" }, }

Retornos

Código	Mensagem
201	OK
401	É necessario preencher o nome e o documento para cadastrar novo favorito
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ATUALIZAÇÃO DE FAVORITO PARA TERCEIROS
/internal_account/favorite_bank/{id}

Detalhes

Ao chamar a API cria um favorito para terceiros

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "ATUALIZAÇÃO DE FAVORITO" : { "bank_id": "18", "agency": "444444444", "digit_agency": "15", "account": "666666666", "digit_account": "67" }, }

Retornos

Código	Mensagem
201	OK
401	É necessario preencher o nome e o documento para cadastrar novo favorito
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Credito

GET

LISTAGEM
/establishment_credit

Detalhes

Ao chamar a API realiza a listagem dos Estabelecimentos

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR POR ID
/establishment_credit/{id}

Detalhes

Ao chamar a API realiza listagem de um único Estabelecimento

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ATUALIZAÇÃO
/establishment_credit/{id}

Detalhes

Ao chamar a API recebe os dados do Estabelecimento e realiza a Configuração

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	VALUE, EXPIRY_DATE, DESCRIPTION
Body	{ "value" : "10.50", "expiry_date" : "2021-05-10", "description" : "Exemplo de Descrição" }

Retornos

Código	Mensagem
200	OK
401	Campo value é obrigatório Campo expiry_date é obrigatório Campo description é obrigatório
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

DELETE

DELETAR
/establishment_credit/{id}

Detalhes

Ao chamar a API exclui o crédito desejado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Customização Layout

GET

PAGINAÇÃO DE DISTRIBUIDORES
/custom_layouts/distributors

Detalhes

Ao chamar a API realiza paginação dos Distribuidores

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR POR CONFIGURAÇÕES DE LAYOUT DO DISTRIBUIDOR
/custom_layouts/distributors/{id}

Detalhes

Ao chamar a API realiza listagem das configurações do Distribuidor

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ATUALIZAÇÃO LAYOUT PRO DISTRIBUIDOR
/custom_layouts/distributors/update/{id}

Detalhes

Ao chamar a API recebe os dados do layout e realiza a atualização

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	HOST
Body	{ "host" : "distribuidor.slg-web-ec", "title" : "Distribuidor", "font_login" : "arial", "background_login" : "#01007c", "background_panel_login" : "#191952", "background_buttom_login" : "#191952", "color_buttom_login" : "#ffffff", "background_menu" : "#01007c", "background_lateral_menu" : "#01007c", "color_lateral_menu" : "#ffffff", "background_lateral_hover_menu" : "#7877ff", "buttom_color_primary" : "#5553ff", "buttom_color_danger" : "#f23636", "buttom_color_warning" : "#ffd145" }

Retornos

Código	Mensagem
200	OK
401	Campo host é obrigatório O Tamanho Máximo para o campo host é de 255 caracteres O Tamanho Máximo para o campo title é de 255 caracteres
402	Token não encontrado. Token expirado. Token é inválido.
406	Verifique os dados e tente novamente
500	Houve um erro interno

GET

VISUALIZAÇÃO DO ARQUIVO
/custom_layouts/documents/{file}

Detalhes

É preciso o nome do arquivo. Portanto as chamadas são feitas pelo admin através da função de findFile e retornará url do arquivo para o findFile.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

DOWNLOAD DO ARQUIVO
/custom_layouts/downloadFile/{file}

Detalhes

É possível fazer a requisição via API, porém é preciso o nome do arquivo. Portanto as chamadas são feitas pelo admin através da função de download e retornará url do arquivo para o download.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

DELETE

DELETAR ARQUIVO DO LAYOUT
/custom_layouts/deleteFile/{file}

Detalhes

Ao chamar a API deleta o arquivo desejado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Customização Layout Email

GET

PAGINAÇÃO DE DISTRIBUIDORES
/custom_layout_emails/distributors

Detalhes

Ao chamar a API realiza paginação dos Distribuidores

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR POR CONFIGURAÇÕES DE LAYOUT DO DISTRIBUIDOR
/custom_layout_emails/distributors/{id}

Detalhes

Ao chamar a API realiza listagem de layout email do Distribuidor

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ATUALIZAÇÃO LAYOUT PRO DISTRIBUIDOR
/custom_layout_emails/distributors/{id}

Detalhes

Ao chamar a API recebe os dados do layout e realiza a atualização

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	HOST
Body	{ "font" : "sans-serif", "font_size" : "10", "font_size_title" : "7", "header_height" : "50", "header_width" : "100", "header_background" : "#ffffff", "header_title_text" : "Título", "footer_height" : "50", "footer_width" : "100", "footer_background" : "#ffffff", "footer_font" : "sans-serif", "footer_line_1" : "linha 1 rodapé", "footer_line_2" : "linha 2 rodapé", "header_title_color" : "#000000", "footer_line_color" : "#000000" }

Retornos

Código	Mensagem
200	OK
401	Campo host é obrigatório O Tamanho Máximo para o campo host é de 255 caracteres O Tamanho Máximo para o campo title é de 255 caracteres
402	Token não encontrado. Token expirado. Token é inválido.
406	Verifique os dados e tente novamente
500	Houve um erro interno

Dashboard

GET

Dados do Dashboard
dashboard

Detalhes

Todos os dados utilizados no dashboard, são carregados através dessa rota

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Distribuidores

GET

LISTAGEM
/distributors

Detalhes

Ao chamar a API realiza listagem de Distribuidor

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAÇÃO
/distributors

Detalhes

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	COMMERCIAL_NAME, NAME, LAST_NAME, RG, DOCUMENT, PEOPLE_TYPE_ID, BANK_GIVEN_TYPE_ID, SOCIAL_REASON, CNPJ_MATRIZ, BRANCH_TYPE_ID, CEP, ADDRESS, NUMBER, DISTRICT, CITY, STATE_ID, COUNTRIE_ID, BANK_ACCOUNT_TYPE_ID, HOLDER_TYPE_ID, BANK_ID, AGENCY, ACCOUNT, OPERATOR_COMPANIE_ID, NUMBER_CARD, PRINTED_NAME, CPF, EMAIL
Body	{ "commercial_name" : "Nome comercial", "company" : { "name": "Nome", "last_name": "SobreNome", "rg": "384858107", "document": "88216378084", "people_type_id": "2", "email": "email@exemplo.com.br", "bank_given_type_id": "2", "company_details": { "social_reason": "Razao", "document": "56814311000149", "cnpj_matriz":"56814311000149", "branch_type_id": "2" } }, "localization" : { "cep": "59078-190", "address": "Avenida Passeio dos Girassóis", "number": "123", "district": "Capim Macio", "city": "Natal", "state_id": "1", "countrie_id": "1", "complement": "Casa" }, "contacts" : [{ "contact_type_id": "2", "name": "João", "value": "Joao@gmail.com" }, { "contact_type_id": "1", "name": "Maria", "value": "942115040" }], "prepaid_card" : { "operator_companie_id": "1", "number_card": "444433332111", "printed_name": "Roberto", "cpf": "96223316020" }, "bank_given" : { "bank_account_type_id": "1", "holder_type_id": "1", "bank_id": "1", "agency": "21", "digit_agency": "21", "account": "21", "digit_account": "11" } , "commission" : { "commission_activation": "1", "commission_payment": "0", "commission_model_id": "1", "validity": "2021-05-10" } , "max_date" : "2021-05-10" }

Retornos

Código	Mensagem
201	CRIADO
401	Campo commercial_name é obrigatório O Tamanho Máximo para o campo commercial_name é de 255 caracteres Campo company.name é obrigatório O Tamanho Máximo para o campo company.name é de 255 caracteres Campo company.last_name é obrigatório O Tamanho Máximo para o campo company.last_name é de 255 caracteres Campo company.rg é obrigatório O Tamanho Máximo para o campo company.rg é de 255 caracteres Campo company.document é obrigatório Campo company.document é Inválido Campo company.city_insc deve conter apenas Números O Tamanho Máximo para o campo company.city_insc é de 255 caracteres Campo company.state_insc deve conter apenas Números O Tamanho Máximo para o campo company.state_insc é de 255 caracteres Campo company.people_type_id é obrigatório Campo company.people_type_id deve conter apenas Números O Tamanho Máximo para o campo company.people_type_id é de 11 caracteres Campo company.bank_given_type_id é obrigatório Campo company.bank_given_type_id deve conter apenas Números O Campo company.bank_given_type_id é Inválido Campo localization.cep é obrigatório Campo localization.cep é Inválido Campo localization.address é obrigatório O Tamanho Máximo para o campo localization.address é de 255 caracteres Campo localization.number é obrigatório Campo localization.number deve conter apenas Números Campo localization.district é obrigatório O Tamanho Máximo para o campo localization.district é de 255 caracteres Campo localization.city é obrigatório O Tamanho Máximo para o campo localization.city é de 255 caracteres Campo localization.state_id deve conter apenas Números Campo localization.state_id é Inválido Campo localization.countrie_id deve conter apenas Números Campo localization.countrie_id é Inválido O Tamanho Máximo para o campo localization.complement é de 255 caracteres Campo bank_given.agency é obrigatório Campo bank_given.agency deve conter apenas Números Campo bank_given.digit_agency deve conter apenas Números Campo bank_given.account excedeu o número máximo de digitos suportado. Campo bank_given.account é obrigatório Campo bank_given.account deve conter apenas Números Campo bank_given.digit_account deve conter apenas Números Campo bank_given.bank_account_type_id é obrigatório Campo bank_given.bank_account_type_id deve conter apenas Números Campo bank_given.bank_account_type_id é Inválido Campo bank_given.bank_id é obrigatório Campo bank_given.bank_id deve conter apenas Números Campo bank_given.bank_id é Inválido Campo bank_given.holder_type_id é obrigatório Campo bank_given.holder_type_id deve conter apenas Números Campo bank_given.holder_type_id é Inválido Campo prepaid_card.operator_companie_id é obrigatório Campo prepaid_card.operator_companie_id deve conter apenas Números Campo prepaid_card.operator_companie_id é Inválido Campo prepaid_card.number_card é obrigatório Campo prepaid_card.number_card deve conter apenas Números O Tamanho Máximo para o campo prepaid_card.number_card é de 16 caracteres Campo prepaid_card.printed_name é obrigatório O Tamanho Máximo para o campo prepaid_card.printed_name é de 255 caracteres Campo prepaid_card.cpf é obrigatório Campo prepaid_card.cpf é Inválido Campo company.company_details.document é obrigatório Campo company.company_details.document é Inválido Campo company.company_details.social_reason é obrigatório O Tamanho Máximo para o campo company.company_details.social_reason é de 255 caracteres Campo company.company_details.cnpj_matriz é obrigatório Campo company.company_details.cnpj_matriz é Inválido Campo company.company_details.branch_type_id é Inválido Campo company.company_details.branch_type_id é obrigatório Distribuidor já cadastrado Distribuidor não existente Para o tipo de Pessoa PF, não é permitido enviar os detalhes da empresa Para o tipo de Pessoa PJ, os detalhes da empresa devem ser enviados Para o tipo de Dado Bancário selecionado, não é permitido o envio de Cartão Pré Pago Para o tipo de Dado Bancário selecionado, é necessário o envio dos Dados Bancários Para o tipo de titular selecionado, não é permitido o envio dos dados do mesmo Esse tipo de títular do dado bancário não é permitido para estabelecimento PF Para o tipo de titular selecionado, é necessário o envio dos dados do mesmo Para o tipo de Dado Bancário selecionado, não é permitido o envio dos Dados Bancários Para o tipo de Dado Bancário selecionado, é necessário o envio de Cartão Pré Pago Campo company.people_type_id é Inválido Para Matrizes, o campo company.company_details.cnpj_matriz não deverá ser enviado
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR POR ID
/distributors/{id}

Detalhes

Ao chamar a API realiza listagem de um único Distribuidor

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ATUALIZAÇÃO
/distributors/{id}

Detalhes

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).

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, 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 a Comissão for ativa (commission_activation = "1"), será necessário enviar os dados de Comissão.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	COMMERCIAL_NAME, NAME, LAST_NAME, RG, DOCUMENT, PEOPLE_TYPE_ID, BANK_GIVEN_TYPE_ID, SOCIAL_REASON, CNPJ_MATRIZ, BRANCH_TYPE_ID, CEP, ADDRESS, NUMBER, DISTRICT, CITY, STATE_ID, COUNTRIE_ID, BANK_ACCOUNT_TYPE_ID, HOLDER_TYPE_ID, BANK_ID, AGENCY, ACCOUNT, OPERATOR_COMPANIE_ID, NUMBER_CARD, PRINTED_NAME, CPF, EMAIL
Body	{ "commercial_name" : "Nome comercial Atualizado", "company" : { "name": "Nome Atualizado", "last_name": "SobreNome Atualizado", "rg": "384858107", "document": "88216378084", "people_type_id": "2", "email": "email@exemplo.com.br", "bank_given_type_id": "2", "company_details": { "social_reason": "Razao Atualizado", "document": "56814311000149", "cnpj_matriz":"56814311000148", "branch_type_id": "2" } }, "localization" : { "cep": "59078-190", "address": "Avenida Passeio dos Girassóis Atualizado", "number": "123", "district": "Capim Macio", "city": "Natal", "state_id": "1", "countrie_id": "1", "complement": "Casa" }, "contacts" : [{ "contact_type_id": "2", "name": "João", "value": "atualiado@gmail.com" }, { "contact_type_id": "1", "name": "Maria", "value": "942105060" }], "prepaid_card" : { "operator_companie_id": "1", "number_card": "444433332111", "printed_name": "Roberto Atualizado", "cpf": "96223316020" }, "bank_given" : { "bank_account_type_id": "1", "holder_type_id": "1", "bank_id": "1", "agency": "21", "digit_agency": "21", "account": "21", "digit_account": "11" } , "commission" : { "commission_activation": "1", "commission_payment": "0", "commission_model_id": "1", "validity": "2021-05-10" } , "max_date" : "2021-05-10" }

Retornos

Código	Mensagem
200	OK
401	Campo commercial_name é obrigatório O Tamanho Máximo para o campo commercial_name é de 255 caracteres Campo company.name é obrigatório O Tamanho Máximo para o campo company.name é de 255 caracteres Campo company.last_name é obrigatório O Tamanho Máximo para o campo company.last_name é de 255 caracteres Campo company.rg é obrigatório O Tamanho Máximo para o campo company.rg é de 255 caracteres Campo company.document é obrigatório Campo company.document é Inválido Campo company.city_insc deve conter apenas Números O Tamanho Máximo para o campo company.city_insc é de 255 caracteres Campo company.state_insc deve conter apenas Números O Tamanho Máximo para o campo company.state_insc é de 255 caracteres Campo company.people_type_id é obrigatório Campo company.people_type_id deve conter apenas Números O Tamanho Máximo para o campo company.people_type_id é de 11 caracteres Campo company.bank_given_type_id é obrigatório Campo company.bank_given_type_id deve conter apenas Números O Campo company.bank_given_type_id é Inválido Campo localization.cep é obrigatório Campo localization.cep é Inválido Campo localization.address é obrigatório O Tamanho Máximo para o campo localization.address é de 255 caracteres Campo localization.number é obrigatório Campo localization.number deve conter apenas Números Campo localization.district é obrigatório O Tamanho Máximo para o campo localization.district é de 255 caracteres Campo localization.city é obrigatório O Tamanho Máximo para o campo localization.city é de 255 caracteres Campo localization.state_id deve conter apenas Números Campo localization.state_id é Inválido Campo localization.countrie_id deve conter apenas Números Campo localization.countrie_id é Inválido O Tamanho Máximo para o campo localization.complement é de 255 caracteres Campo bank_given.agency é obrigatório Campo bank_given.agency deve conter apenas Números Campo bank_given.digit_agency deve conter apenas Números Campo bank_given.account excedeu o número máximo de digitos suportado. Campo bank_given.account é obrigatório Campo bank_given.account deve conter apenas Números Campo bank_given.digit_account deve conter apenas Números Campo bank_given.bank_account_type_id é obrigatório Campo bank_given.bank_account_type_id deve conter apenas Números Campo bank_given.bank_account_type_id é Inválido Campo bank_given.bank_id é obrigatório Campo bank_given.bank_id deve conter apenas Números Campo bank_given.bank_id é Inválido Campo bank_given.holder_type_id é obrigatório Campo bank_given.holder_type_id deve conter apenas Números Campo bank_given.holder_type_id é Inválido Campo prepaid_card.operator_companie_id é obrigatório Campo prepaid_card.operator_companie_id deve conter apenas Números Campo prepaid_card.operator_companie_id é Inválido Campo prepaid_card.number_card é obrigatório Campo prepaid_card.number_card deve conter apenas Números O Tamanho Máximo para o campo prepaid_card.number_card é de 16 caracteres Campo prepaid_card.printed_name é obrigatório O Tamanho Máximo para o campo prepaid_card.printed_name é de 255 caracteres Campo prepaid_card.cpf é obrigatório Campo prepaid_card.cpf é Inválido Campo company.company_details.document é obrigatório Campo company.company_details.document é Inválido Campo company.company_details.social_reason é obrigatório O Tamanho Máximo para o campo company.company_details.social_reason é de 255 caracteres Campo company.company_details.cnpj_matriz é obrigatório Campo company.company_details.cnpj_matriz é Inválido Campo company.company_details.branch_type_id é Inválido Campo company.company_details.branch_type_id é obrigatório Distribuidor não existente É impossível alterar o tipo de pessoa Não é possível alterar o documento Distribuidor não existente Para o tipo de Pessoa PF, não é permitido enviar os detalhes da empresa Para o tipo de Pessoa PJ, os detalhes da empresa devem ser enviados Para o tipo de Dado Bancário selecionado, não é permitido o envio de Cartão Pré Pago Para o tipo de Dado Bancário selecionado, é necessário o envio dos Dados Bancários Para o tipo de titular selecionado, não é permitido o envio dos dados do mesmo Esse tipo de títular do dado bancário não é permitido para estabelecimento PF Para o tipo de titular selecionado, é necessário o envio dos dados do mesmo Para o tipo de Dado Bancário selecionado, não é permitido o envio dos Dados Bancários Para o tipo de Dado Bancário selecionado, é necessário o envio de Cartão Pré Pago Campo company.people_type_id é Inválido Para Matrizes, o campo company.company_details.cnpj_matriz não deverá ser enviado
402	Token não encontrado. Token expirado. Token é inválido.
406	Verifique os dados e tente novamente
500	Houve um erro interno

DELETE

DELETAR
/distributors/{id}

Detalhes

Ao chamar a API deleta o Distribuidor desejado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Estabelecimentos

GET

PAGINAÇÃO
/establishments

Detalhes

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

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAÇÃO
/establishments

Detalhes

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).

Produtos:
Se desejar cadastrar todos produtos automaticamente (all_products = 1).
Se desejar cadastrar produtos especificos enviar o campo "products" com ID dos produtos.

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.
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, 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”).

Se o dado bancário for "Conta Bancária" (bank_given_type_id = ”1”).

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

Podemos enviar o estado tanto com o ID quanto UF. Exemplo: "state_id": 25 / "state_description": "SP". Ambos estão referenciando o Estado de São Paulo. Ao enviar o "state_description", não é necessário enviar "state_id" e vice-versa. Podemos enviar o MCC tanto com o ID quanto código. Exemplo: "mcc_id": 25 / "mcc_code": "1731". Ao enviar o "mcc_code", não é necessário enviar "mcc_id" e vice-versa.

Podemos enviar o Banco tanto com o ID quanto código. Exemplo: "bank_id": 1 / "bank_code": "255". Ao enviar o "bank_code", não é necessário enviar "bank_id" e vice-versa.

Exportar Produtos Exportar Mccs

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	COMMERCIAL_NAME, MCC_ID, DISTRIBUTOR_ID, PREPOSTEROU_ID, ECONOMIC_GROUP_ID, NAME, LAST_NAME, RG, BIRTH, NATIONALITY, TELEPHONE, DOCUMENT, EMAIL, CITY_INSC, STATE_INSC, PEOPLE_TYPE_ID, BANK_GIVEN_TYPE_ID, HOLDER_TYPE_ID, SOCIAL_REASON, CNPJ_MATRIZ, BRANCH_TYPE_ID, CEP, ADDRESS, NUMBER, DISTRICT, CITY, COUNTRIE_ID, BANK_ACCOUNT_TYPE_ID, BANK_ID, AGENCY, ACCOUNT, OPERATOR_COMPANIE_ID, NUMBER_CARD, PRINTED_NAME, CPF, MAX_AMOUNT_DAY, MAX_AMOUNT, QUANTITY_OPERATOR_DAY
Body	{ "commercial_name" : "Nome comercial", "all_products" : "1", "mcc_id" : "1", "mcc_code" : "1731", "distributor_id" : "1", "preposterou_id" : "1", "preposterou_id" : "1", "pdv_code" : "552452255", "automatic_approve" : "1", "reason" : "Exemplo de razão", "company" : { "name": "Nome", "last_name":"22", "rg":"21312", "nationality":"brasileiro", "telephone":"46569995", "email":"rafa@rafa.com", "birth":"2000-02-05", "document":"08081794034", "city_insc":"23112", "state_insc":"1231312", "bank_given_type_id": "1", "people_type_id": "2", "company_details": { "social_reason": "Razao", "document": "56814311000149", "cnpj_matriz":"", "branch_type_id": "1" } }, "localization" : { "cep": "88902-378", "address": "Rua Alessandro de Souza", "number": "571", "district": "Polícia Rodoviária", "city": "Araranguá", "state_id": "1", "state_description": "SP", "countrie_id": "1", "complement": "Casa" }, "pix_autenticate" : { "access_key": "3232", "client_id": "dfdsffdsfsdfd", "secret_key": "123233", "provider": "1" }, "contacts" : [{ "contact_type_id": "2", "name": "José", "value": "Jose@hotmail.com" }, { "contact_type_id": "1", "name": "João", "value": "988544324" }], "prepaid_card" : { "operator_companie_id": "1", "number_card": "5516567850997747", "printed_name": "João", "cpf": "38575015028" }, "internal" : { "holder_type_id": "1", "bank_account_type_id": "1", "bank_id": "340", "agency": "0001", "account": "080817940", "digit_account": "34" }, "internal_parameter" : { "max_amount_day": "9999", "max_amount": "99999999", "quantity_operator_day": "1000", }, "bank_given" : { "bank_account_type_id": "2", "holder_type_id": "4", "bank_id": "1", "bank_code": "1", "agency": "0024", "digit_agency": "4", "account": "54282", "digit_account": "2" } , "products" : [{ "product_id": "1" }, { "product_id": "2" }], "base64" : { "pdv_file": "Imagem em formato base64"}, "files" : { "adesao_file": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "rg_file": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "cpf_file": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "social_contract_file": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "proof_address_file": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "proof_bank_details_file": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "pdv_file": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "other_file": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"} } }

Retornos

Código	Mensagem
201	CRIADO
401	Campo mcc_id é obrigatório Campo mcc_code é obrigatório Campo mcc_id deve conter apenas Números Campo mcc_id é Inválido Campo distributor_id é obrigatório Campo distributor_id deve conter apenas Números Campo distributor_id é Inválido Campo preposterou_id é obrigatório Campo preposterou_id deve conter apenas Números Campo preposterou_id é Inválido Campo economic_group_id é obrigatório Campo economic_group_id deve conter apenas Números Campo economic_group_id é Inválido Campo commercial_name é obrigatório O Tamanho Máximo para o campo commercial_name é de 255 caracteres Campo company.name é obrigatório O Tamanho Máximo para o campo company.name é de 255 caracteres Campo company.last_name é obrigatório O Tamanho Máximo para o campo company.last_name é de 255 caracteres Campo company.rg é obrigatório O Tamanho Máximo para o campo company.rg é de 255 caracteres Campo company.birth é obrigatório Campo company.birth é Inválido Campo company.nationality é obrigatório O Tamanho Máximo para o campo company.nationality é de 40 caracteres Campo company.telephone é obrigatório Campo company.document é obrigatório Campo company.document é Inválido Campo company.email é obrigatório Campo company.email é Inválido Campo company.city_insc deve conter apenas Números O Tamanho Máximo para o campo company.city_insc é de 255 caracteres Campo company.state_insc deve conter apenas Números O Tamanho Máximo para o campo company.state_insc é de 255 caracteres Campo company.people_type_id é obrigatório Campo company.people_type_id deve conter apenas Números Campo company.people_type_id é Inválido Campo company.bank_given_type_id é obrigatório Campo company.bank_given_type_id deve conter apenas Números O Campo company.bank_given_type_id é Inválido Campo localization.cep é obrigatório O Campo localization.cep é Inválido Campo localization.number é obrigatório Campo localization.number deve conter apenas Números Campo localization.address é obrigatório O Tamanho Máximo para o campo localization.address é de 255 caracteres Campo localization.district é obrigatório O Tamanho Máximo para o campo localization.district é de 255 caracteres Campo localization.city é obrigatório O Tamanho Máximo para o campo localization.city é de 255 caracteres Campo localization.state_id deve conter apenas Números Campo localization.state_id é Inválido Campo localization.countrie_id deve conter apenas Números Campo localization.countrie_id é Inválido O Tamanho Máximo para o campo localization.complement é de 255 caracteres Campo products é obrigatório Campo company.company_details.document é obrigatório Campo company.company_details.document é Inválido Campo company.company_details.social_reason é obrigatório O Tamanho Máximo para o campo company.company_details.social_reason é de 255 caracteres Campo company.company_details.cnpj_matriz é obrigatório Campo company.company_details.cnpj_matriz é Inválido Campo company.company_details.branch_type_id é Inválido Campo company.company_details.branch_type_id é obrigatório Campo bank_given.agency é obrigatório Campo bank_given.agency deve conter apenas Números Campo bank_given.digit_agency deve conter apenas Números Campo bank_given.account excedeu o número máximo de digitos suportado. Campo bank_given.account é obrigatório Campo bank_given.account deve conter apenas Números Campo bank_given.digit_account deve conter apenas Números Campo bank_given.bank_account_type_id é obrigatório Campo bank_given.bank_account_type_id deve conter apenas Números Campo bank_given.bank_account_type_id é Inválido Campo bank_given.bank_id é obrigatório Campo bank_given.bank_id deve conter apenas Números Campo bank_given.bank_id é Inválido Campo bank_given.holder_type_id é obrigatório Campo bank_given.holder_type_id deve conter apenas Números Campo bank_given.holder_type_id é Inválido Campo prepaid_card.operator_companie_id é obrigatório Campo prepaid_card.operator_companie_id deve conter apenas Números Campo prepaid_card.operator_companie_id é Inválido Campo prepaid_card.number_card é obrigatório Campo prepaid_card.number_card deve conter apenas Números O Tamanho Máximo para o campo prepaid_card.number_card é de 16 caracteres Campo prepaid_card.printed_name é obrigatório O Tamanho Máximo para o campo prepaid_card.printed_name é de 255 caracteres Campo prepaid_card.cpf é obrigatório Campo prepaid_card.cpf é Inválido Estabelecimento já cadastrado Para o tipo de Pessoa PF, não é permitido enviar os detalhes da empresa Para o tipo de Pessoa PJ, os detalhes da empresa devem ser enviados Para o tipo de Dado Bancário selecionado, não é permitido o envio de Cartão Pré Pago Para o tipo de Dado Bancário selecionado, é necessário o envio dos Dados Bancários Para o tipo de titular selecionado, não é permitido o envio dos dados do mesmo Esse tipo de títular do dado bancário não é permitido para estabelecimento PF Para o tipo de titular selecionado, é necessário o envio dos dados do mesmo Para o tipo de Dado Bancário selecionado, não é permitido o envio dos Dados Bancários Para o tipo de Dado Bancário selecionado, é necessário o envio de Cartão Pré Pago Produtos em formato incorreto Produto(s) Inválido(s) Dados malíciosos foram encontrados, cheque sua requisição
402	Token não encontrado. Token expirado. Token é inválido.
440	Houve um erro no Serviço do OFAC.
500	Houve um erro interno. Integração não realizada pela api estar inativa na tabela de parâmetros. Houve um erro ao Integrar com a API Gateway. Não foi possível encontrar o banco a partir do código informado.

GET

BUSCAR POR ID
/establishments/{id}

Detalhes

Ao chamar a API realiza listagem de uma única AFILIADO

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ATUALIZAÇÃO
/establishments/{id}

Detalhes

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).

Produtos:
Se desejar cadastrar todos produtos automaticamente (all_products = 1).
Se desejar cadastrar produtos especificos enviar o campo "products" com ID dos produtos.

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).

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, 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”).

Se o dado bancário for "Conta Bancária" (bank_given_type_id = ”1”).
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

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	COMMERCIAL_NAME, MCC_ID, DISTRIBUTOR_ID, PREPOSTEROU_ID, ECONOMIC_GROUP_ID, NAME, LAST_NAME, RG, BIRTH, NATIONALITY, TELEPHONE, DOCUMENT, EMAIL, CITY_INSC, STATE_INSC, PEOPLE_TYPE_ID, BANK_GIVEN_TYPE_ID, HOLDER_TYPE_ID, SOCIAL_REASON, CNPJ_MATRIZ, BRANCH_TYPE_ID, CEP, ADDRESS, NUMBER, DISTRICT, CITY, COUNTRIE_ID, BANK_ACCOUNT_TYPE_ID, BANK_ID, AGENCY, ACCOUNT, OPERATOR_COMPANIE_ID, NUMBER_CARD, PRINTED_NAME, CPF, MAX_AMOUNT_DAY, MAX_AMOUNT, QUANTITY_OPERATOR_DAY
Body	{ "commercial_name" : "Nome comercial Atualizado", "all_products" : "1", "mcc_id" : "1", "mcc_code" : "798", "distributor_id" : "1", "preposterou_id" : "1", "economic_group_id" : "1", "company" : { "name": "Nome Atualizado", "last_name":"22", "rg":"21312", "nationality":"brasileiro", "telephone":"46569995", "email":"atualizado@rafa.com", "birth":"2000-02-05", "document":"08081794034", "city_insc":"23112", "state_insc":"1231312", "bank_given_type_id": "1", "people_type_id": "2", "company_details": { "social_reason": "Razao Atualizado", "document": "56814311000149", "cnpj_matriz":"", "branch_type_id": "1" } }, "localization" : { "cep": "88902-378", "address": "Rua Alessandro de Souza Atualizado", "number": "571", "district": "Polícia Rodoviária", "city": "Araranguá", "state_id": "1", "state_description": "SP", "countrie_id": "1", "complement": "Casa" }, "pix_autenticate" : { "access_key": "3232", "client_id": "dfdsffdsfsdfd", "secret_key": "123233", "provider": "1" }, "contacts" : [{ "contact_type_id": "2", "name": "José", "value": "Atualizado@hotmail.com" }, { "contact_type_id": "1", "name": "João", "value": "988544324" }], "internal" : { "holder_type_id": "1", "bank_account_type_id": "1", "bank_id": "340", "agency": "0001", "account": "080817940", "digit_account": "34" }, "internal_parameter" : { "max_amount_day": "9999", "max_amount": "99999999", "quantity_operator_day": "1000", }, "prepaid_card" : { "operator_companie_id": "1", "number_card": "5516567850997747", "printed_name": "João Atualizado", "cpf": "38575015028" }, "bank_given" : { "bank_account_type_id": "2", "holder_type_id": "4", "bank_id": "1", "bank_code": "1", "agency": "0024", "digit_agency": "4", "account": "54282", "digit_account": "2" } , "products" : [{ "product_id": "1" }, { "product_id": "2" }], "base64" : { "pdv_file": "Imagem em formato base"}, "files" : { "adesao_file": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "rg_file": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "cpf_file": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "social_contract_file": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "proof_address_file": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "proof_bank_details_file": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "pdv_file": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "other_file": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"} } }

Retornos

Código	Mensagem
201	CRIADO
401	Campo mcc_id é obrigatório Campo mcc_code é obrigatório Campo mcc_id deve conter apenas Números Campo mcc_id é Inválido Campo distributor_id é obrigatório Campo distributor_id deve conter apenas Números Campo distributor_id é Inválido Campo preposterou_id é obrigatório Campo preposterou_id deve conter apenas Números Campo preposterou_id é Inválido Campo economic_group_id é obrigatório Campo economic_group_id deve conter apenas Números Campo economic_group_id é Inválido Campo commercial_name é obrigatório O Tamanho Máximo para o campo commercial_name é de 255 caracteres Campo company.name é obrigatório O Tamanho Máximo para o campo company.name é de 255 caracteres Campo company.last_name é obrigatório O Tamanho Máximo para o campo company.last_name é de 255 caracteres Campo company.rg é obrigatório O Tamanho Máximo para o campo company.rg é de 255 caracteres Campo company.birth é obrigatório Campo company.birth é Inválido Campo company.nationality é obrigatório O Tamanho Máximo para o campo company.nationality é de 40 caracteres Campo company.telephone é obrigatório Campo company.document é obrigatório Campo company.document é Inválido Campo company.email é obrigatório Campo company.email é Inválido Campo company.city_insc deve conter apenas Números O Tamanho Máximo para o campo company.city_insc é de 255 caracteres Campo company.state_insc deve conter apenas Números O Tamanho Máximo para o campo company.state_insc é de 255 caracteres Campo company.people_type_id é obrigatório Campo company.people_type_id deve conter apenas Números Campo company.people_type_id é Inválido Campo company.bank_given_type_id é obrigatório Campo company.bank_given_type_id deve conter apenas Números O Campo company.bank_given_type_id é Inválido Campo localization.cep é obrigatório O Campo localization.cep é Inválido Campo localization.number é obrigatório Campo localization.number deve conter apenas Números Campo localization.address é obrigatório O Tamanho Máximo para o campo localization.address é de 255 caracteres Campo localization.district é obrigatório O Tamanho Máximo para o campo localization.district é de 255 caracteres Campo localization.city é obrigatório O Tamanho Máximo para o campo localization.city é de 255 caracteres Campo localization.state_id deve conter apenas Números Campo localization.state_id é Inválido Campo localization.countrie_id deve conter apenas Números Campo localization.countrie_id é Inválido O Tamanho Máximo para o campo localization.complement é de 255 caracteres Campo products é obrigatório Campo company.company_details.document é obrigatório Campo company.company_details.document é Inválido Campo company.company_details.social_reason é obrigatório O Tamanho Máximo para o campo company.company_details.social_reason é de 255 caracteres Campo company.company_details.cnpj_matriz é obrigatório Campo company.company_details.cnpj_matriz é Inválido Campo company.company_details.branch_type_id é Inválido Campo company.company_details.branch_type_id é obrigatório Campo bank_given.agency é obrigatório Campo bank_given.agency deve conter apenas Números Campo bank_given.digit_agency deve conter apenas Números Campo bank_given.account excedeu o número máximo de digitos suportado. Campo bank_given.account é obrigatório Campo bank_given.account deve conter apenas Números Campo bank_given.digit_account deve conter apenas Números Campo bank_given.bank_account_type_id é obrigatório Campo bank_given.bank_account_type_id deve conter apenas Números Campo bank_given.bank_account_type_id é Inválido Campo bank_given.bank_id é obrigatório Campo bank_given.bank_id deve conter apenas Números Campo bank_given.bank_id é Inválido Campo bank_given.holder_type_id é obrigatório Campo bank_given.holder_type_id deve conter apenas Números Campo bank_given.holder_type_id é Inválido Campo prepaid_card.operator_companie_id é obrigatório Campo prepaid_card.operator_companie_id deve conter apenas Números Campo prepaid_card.operator_companie_id é Inválido Campo prepaid_card.number_card é obrigatório Campo prepaid_card.number_card deve conter apenas Números O Tamanho Máximo para o campo prepaid_card.number_card é de 16 caracteres Campo prepaid_card.printed_name é obrigatório O Tamanho Máximo para o campo prepaid_card.printed_name é de 255 caracteres Campo prepaid_card.cpf é obrigatório Campo prepaid_card.cpf é Inválido Estabelecimento não encontrado Estabelecimento não está aguardando uma aprovação Estabelecimento não encontrado Estabelecimento não existente Estabelecimento já cadastrado É impossível alterar o tipo de pessoa Não é possível alterar o documento Para o tipo de Pessoa PF, não é permitido enviar os detalhes da empresa Para o tipo de Pessoa PJ, os detalhes da empresa devem ser enviados Para o tipo de Dado Bancário selecionado, não é permitido o envio de Cartão Pré Pago Para o tipo de Dado Bancário selecionado, é necessário o envio dos Dados Bancários Para o tipo de titular selecionado, não é permitido o envio dos dados do mesmo Esse tipo de títular do dado bancário não é permitido para estabelecimento PF Para o tipo de titular selecionado, é necessário o envio dos dados do mesmo Para o tipo de Dado Bancário selecionado, não é permitido o envio dos Dados Bancários Para o tipo de Dado Bancário selecionado, é necessário o envio de Cartão Pré Pago Produtos em formato incorreto Produto(s) Inválido(s) Dados malíciosos foram encontrados, cheque sua requisição
402	Token não encontrado. Token expirado. Token é inválido.
440	Houve um erro no Serviço do OFAC. Dado bancário não encontrado.
500	Houve um erro interno. Integração não realizada pela api estar inativa na tabela de parâmetros. Houve um erro ao Integrar com a API Gateway. Não foi possível encontrar o banco a partir do código informado.

PUT

DELETAR
/establishments/delete/{id}

Detalhes

Ao chamar a API bloqueia e desbloqueia o estabelecimento

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "reason" : "Bloqueado" }

Retornos

Código	Mensagem
200	OK
401	É preciso informar a razão
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAR STATUS DE PAGAMENTOS
/establishments/payment

Detalhes

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

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LOG DE STATUS DE PAGAMENTO
/establishments/payment/{id}

Detalhes

Rota designada para listagem de logs de pagamento

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ALTERAR STATUS DE PAGAMENTO
/establishments/payment/{id}

Detalhes

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

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	PAYMENT_STATUS_ID, REASON
Body	{ "payment_status_id" : "1", "reason" : "Gente boa, mas não merece o pagamento" }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
401	Estabelecimento não existente É necessário informar um motivo para a mudança Status de Pagamento inválido Estabelecimento já está com o status selecionado
500	Houve um erro interno

Feriados

GET

LISTAGEM
/holidays

Detalhes

Ao chamar a API realiza listagem dos feriados

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAÇÃO
/holidays

Detalhes

Ao chamar a API realiza a criação do feriado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DESCRIPTION, DATE
Body	{ "description" : "Natal", "date" : "2035-12-25" }

Retornos

Código	Mensagem
201	CRIADO
401	Campo description é obrigatório O Tamanho Máximo para o campo description é de 255 caracteres O registro description já está cadastrado no banco Campo date é obrigatório O registro date já está cadastrado no banco Campo date é Inválido
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR POR ID
/holidays/{id}

Detalhes

Ao chamar a API realiza listagem de um único feriado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ATUALIZAÇÃO
/holidays/{id}

Detalhes

Ao chamar a API recebe os dados do feriado e realiza a atualização

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DESCRIPTION, DATE
Body	{ "description" : "Páscoa", "date" : "2019-12-25" }

Retornos

Código	Mensagem
200	OK
401	Campo description é obrigatório O Tamanho Máximo para o campo description é de 255 caracteres O registro description já está cadastrado no banco Campo date é obrigatório O registro date já está cadastrado no banco Campo date é Inválido
402	Token não encontrado. Token expirado. Token é inválido.
406	Verifique os dados e tente novamente
500	Houve um erro interno

DELETE

DELETAR
/holidays/{id}

Detalhes

Ao chamar a API deleta o feriado desejado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.

Fiduciario

GET

LISTAGEM
/fiduciaries

Detalhes

Ao chamar a API realiza a listagem dos Fiduciarios

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAÇÃO
/fiduciaries

Detalhes

Ao chamar a API realiza a criação do Fiduciario

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	COMMERCIAL_NAME, SOCIAL_REASON, DOCUMENT, CEP, ADDRESS, NUMBER, DISTRICT, CITY, STATE_ID, COUNTRIE_ID, CONTACT_TYPE_ID, NAME, VALUE
Body	{ "commercial_name" : "Nome Comercial", "company" : { "company_details": { "social_reason": "Razao Social", "document": "56814311000149", } }, "localization" : { "cep": "88902-378", "address": "Rua Alessandro de Souza Social", "number": "571", "district": "Polícia Rodoviária", "city": "Araranguá", "state_id": "1", "countrie_id": "1", "complement": "Casa" }, "contacts" : [{ "contact_type_id": "2", "name": "José", "value": "social@hotmail.com" }, { "contact_type_id": "1", "name": "João", "value": "988544324" }], "bank_given" : { "bank_account_type_id": "1", "holder_type_id": "4", "bank_id": "1", "agency": "0364", "digit_agency": "4", "account": "0615869", "digit_account": "2" } }

Retornos

Código	Mensagem
201	CRIADO
401	Campo commercial_name é obrigatório O Tamanho Máximo para o campo commercial_name é de 255 caracteres Campo company.company_details.document é obrigatório Campo company.company_details.document é Inválido Campo company.company_details.social_reason é obrigatório Campo localization.cep é obrigatório O Campo localization.cep é Inválido Campo localization.number é obrigatório Campo localization.number deve conter apenas Números Campo localization.address é obrigatório O Tamanho Máximo para o campo localization.address é de 255 caracteres Campo localization.district é obrigatório O Tamanho Máximo para o campo localization.district é de 255 caracteres Campo localization.city é obrigatório O Tamanho Máximo para o campo localization.city é de 255 caracteres Campo localization.state_id deve conter apenas Números Campo localization.state_id é Inválido Campo localization.countrie_id deve conter apenas Números Campo localization.countrie_id é Inválido O Tamanho Máximo para o campo localization.complement é de 255 caracteres Fiduciario já cadastrado
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR POR ID
/fiduciaries/{id}

Detalhes

Ao chamar a API realiza listagem de um único Fiduciario

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ATUALIZAÇÃO
/fiduciaries/{id}

Detalhes

Ao chamar a API recebe os dados do Fiduciario e realiza a atualização

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	COMMERCIAL_NAME, SOCIAL_REASON, DOCUMENT, CEP, ADDRESS, NUMBER, DISTRICT, CITY, STATE_ID, COUNTRIE_ID, CONTACT_TYPE_ID, NAME, VALUE
Body	{ "commercial_name" : "Nome Comercial Atualizado", "code_establishment" : "9090", "company" : { "company_details": { "social_reason": "Razao Atualizado", "document": "56814311000149", } }, "localization" : { "cep": "88902-378", "address": "Rua Alessandro de Souza Atualizado", "number": "571", "district": "Polícia Rodoviária", "city": "Araranguá", "state_id": "1", "countrie_id": "1", "complement": "Casa" }, "contacts" : [{ "contact_type_id": "2", "name": "José", "value": "Atualizado@hotmail.com" }, { "contact_type_id": "1", "name": "João", "value": "988544324" }], "bank_given" : { "bank_account_type_id": "2", "holder_type_id": "4", "bank_id": "20", "agency": "0224", "digit_agency": "11", "account": "28172", "digit_account": "55" } }

Retornos

Código	Mensagem
200	OK
401	Campo commercial_name é obrigatório O Tamanho Máximo para o campo commercial_name é de 255 caracteres Campo company.company_details.document é obrigatório Campo company.company_details.document é Inválido Campo company.company_details.social_reason é obrigatório Campo localization.cep é obrigatório O Campo localization.cep é Inválido Campo localization.number é obrigatório Campo localization.number deve conter apenas Números Campo localization.address é obrigatório O Tamanho Máximo para o campo localization.address é de 255 caracteres Campo localization.district é obrigatório O Tamanho Máximo para o campo localization.district é de 255 caracteres Campo localization.city é obrigatório O Tamanho Máximo para o campo localization.city é de 255 caracteres Campo localization.state_id deve conter apenas Números Campo localization.state_id é Inválido Campo localization.countrie_id deve conter apenas Números Campo localization.countrie_id é Inválido O Tamanho Máximo para o campo localization.complement é de 255 caracteres Adquirente já cadastrado Não é possível alterar o documento Adquirente não existente
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

DELETE

DELETAR
/fiduciaries/{id}

Detalhes

Ao chamar a API ativa ou inativa o Fiduciario desejado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Gestao de senhas

GET

LISTAGEM
/password_configuration

Detalhes

Ao chamar a API realiza a listagem das regras de senhas

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CONFIGURAR
/password_configuration/create

Detalhes

Ao chamar a API configura a gestão de senhas os campos: upper, lower, numbers, char são booleanos ( 0 ou 1 ).

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	MAX_REPEAT_PASSWORD, MIN_QTD_PASSWORD, MAX_TIME, LIMIT_LOGIN_ATTEMPTS, UPPER, LOWER, NUMBERS, CHAR
Body	{ "max_repeat_password" : "5", "min_qtd_password" : "10", "max_time" : "10", "limit_login_attempts" : "3", "time_blocked" : "1", "expiry_days" : "90", "char" : "1", "upper" : "1", "lower" : "1", "numbers" : "1" }

Retornos

Código	Mensagem
200	OK
401	Campo max_repeat_password é obrigatório Campo min_qtd_password é obrigatório Campo max_time é obrigatório Campo limit_login_attempts é obrigatório Campo upper é obrigatório Campo lower é obrigatório Campo numbers é obrigatório Campo char é obrigatório
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Grupo Econômico

GET

LISTAGEM
/economic_groups

Detalhes

Ao chamar a API realiza listagem do grupo econômico

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAÇÃO
/economic_groups

Detalhes

Ao chamar a API realiza a criação do grupo econômico

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	NAME, CODE_POS, CODE_MENU
Body	{ "name" : "Nome", "url_logo" : "Arquivo", "code_pos" : "2", "url_pos_1" : "Arquivo", "url_pos_2" : "Arquivo", "url_pos_3" : "Arquivo", "code_menu" : "1", "url_menu_1" : "Arquivo", "url_menu_2" : "Arquivo", "url_menu_3" : "Arquivo", "files" : { "url_logo": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "url_pos_1": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "url_pos_2": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "url_pos_3": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "url_menu_1": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "url_menu_2": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "url_menu_3": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"} } }

Retornos

Código	Mensagem
201	CRIADO
401	Campo name é obrigatório O registro name já está cadastrado no banco O Tamanho Máximo para o campo name é de 255 caracteres Campo code_pos é obrigatório Campo code_pos deve conter apenas Números O Tamanho Máximo para o campo code_pos é de 11 caracteres Campo code_menu é obrigatório Campo code_menu deve conter apenas Números O Tamanho Máximo para o campo code_menu é de 11 caracteres Erro ao mandar os arquivos, por favor verificar!
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR POR ID
/economic_groups/{id}

Detalhes

Ao chamar a API realiza listagem de um único grupo econômico

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
401	Campo name é obrigatório O registro name já está cadastrado no banco O Tamanho Máximo para o campo name é de 255 caracteres Campo code_pos é obrigatório Campo code_pos deve conter apenas Números O Tamanho Máximo para o campo code_pos é de 11 caracteres Campo code_menu é obrigatório Campo code_menu deve conter apenas Números O Tamanho Máximo para o campo code_menu é de 11 caracteres
402	Token não encontrado. Token expirado. Token é inválido.
406	Verifique os dados e tente novamente
500	Houve um erro interno

POST

ATUALIZAÇÃO
/economic_groups/{id}

Detalhes

Ao chamar a API recebe os dados do grupo econômico e realiza a atualização

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	NAME, CODE_POS, CODE_MENU
Body	{ "name" : "Novo Nome", "url_logo" : "Arquivo", "code_pos" : "1", "url_pos_1" : "Arquivo", "url_pos_2" : "Arquivo", "url_pos_3" : "Arquivo", "code_menu" : "1", "url_menu_1" : "Arquivo", "url_menu_2" : "Arquivo", "url_menu_3" : "Arquivo", "files" : { "url_logo": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "url_pos_1": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "url_pos_2": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "url_pos_3": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "url_menu_1": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "url_menu_2": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"}, "url_menu_3": {"name": "file_name.jpg", "extension": "jpg", "contents": "Imagem em formato base64"} } }

Retornos

Código	Mensagem
200	OK
401	Campo name é obrigatório O registro name já está cadastrado no banco O Tamanho Máximo para o campo name é de 255 caracteres Campo code_pos é obrigatório Campo code_pos deve conter apenas Números O Tamanho Máximo para o campo code_pos é de 11 caracteres Campo code_menu é obrigatório Campo code_menu deve conter apenas Números O Tamanho Máximo para o campo code_menu é de 11 caracteres Grupo Econômico não existente Erro ao mandar os arquivos, por favor verificar!
402	Token não encontrado. Token expirado. Token é inválido.
406	Verifique os dados e tente novamente
500	Houve um erro interno

DELETE

DELETAR
/economic_groups/{id}

Detalhes

Ao chamar a API deleta o grupo econômico desejado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno Registro contém relacionamento externo

Inclusão Manual

GET

LISTAR INCLUSÕES MANUAIS
/moneylender/approvations/{id}

Detalhes

Ao realizar a chamada, será apresentado uma lista com as Inclusões Manuais feitas no sistema.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

DETALHAR APROVAÇÃO MANUAL
/moneylender/approvations/{id}

Detalhes

Ao realizar a chamada, será apresentado os detalhes da Aprovação Manual.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Integrações

GET

LISTAR INTEGRAÇÕES
/integrations

Detalhes

Ao realizar a chamada, a API irá apresentar uma lista com as integrações.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Lançamento de Saldo

POST

LANÇAR SALDO
/launch/store

Detalhes

Ao realizar a chamada, a API irá realizar o lançamento de saldo para o estabelecimento informado.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "establishment_id" : "7", "type" : "+", "description" : "Lançamento de saldo para o Conta Interna", "amount" : "100.00" }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Lançamentos

GET

LISTAR LANÇAMENTOS
/additional_tariffs

Detalhes

Ao realizar a chamada, a API irá mostrar uma lista com os lançamentos feitos no sistema.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

EDITAR LANÇAMENTOS
/additional_tariffs/{id}

Detalhes

Ao realizar a chamada, a API irá fazer alterações no lançamento escolhido.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "tariff_id" : "6", "expiry_date" : "2021-09-14", "value" : "10.00", "description" : "aaaa" }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

DELETE

DELETAR LANÇAMENTO
/additional_tariffs/{id}

Detalhes

Ao realizar a chamada, a API irá realizar a deleção de um lançamento cadastrado no sistema.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Layout Padrão Email

GET

LISTAR
/layout_email

Detalhes

Ao realizar a chamada, a API irá apresentar uma lista com o Layout de Email.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

EDITAR LAYOUT EMAIL PADRÃO
/layout_email/{id}

Detalhes

Ao realizar a chamada, a APi irá realizar a edição do Layout de Email Padrão com os dados informados.

Parâmetros

Authorization

{

Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==)

}

Body

{

"font" : "sans-serif",

"font_size" : "12",

"font_size_title" : "7",

"header_height" : "100",

"header_width" : "100",

"header_background" : "#ffffff",

"header_title_text" : "AQUI O TITULO",

"header_title_color" : "#000000",

"footer_height" : "50",

"footer_width" : "100",

"footer_background" : "#ffffff",

"footer_line_1" : "Linha 1 rodap\u00e9",

"footer_line_2" : "Linha 2 rodap\u00e9",

"footer_line_color" : "#000000",

"email" : null,

"mail_type" : null

}

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Layout de Transferencia

GET

LISTAR LAYOUT DE TRANSFERÊNCIA
/layout_transfer/listTransferLayout

Detalhes

Ao realizar a chamada, a API irá apresentar uma lista com os Layouts de Transferência.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Link de Pagamento

GET

LISTAGEM
/payment_links/list

Detalhes

Ao chamar a API realiza a listagem dos links de pagamentos

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR POR ID
/payment_links/list/{id}

Detalhes

Ao chamar a API realiza listagem de um único Link de Pagamento

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

GERAR LINK DE PAGAMENTO
/payment_links/store

Detalhes

Ao chamar a API gera o link de pagamento

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DOCUMENT, ESTABLISHMENT_ID, AMOUNT, EXPIRY_DATE, DESCRIPTION, NOTIFICATION, NAME, NOTIFICATION_TYPE_ID, VALUE
Body	{ "document" : "83035612005", "establishment_id" : "1", "amount" : "1500", "expiry_date" : "2021-05-11", "description" : "Exemplo de Descrição", "notification" : { "name": "Exemplo da Silva", "notification_type_id": "1", "value": "email@exemplo.com" }, }

Retornos

Código	Mensagem
200	OK
401	Campo document é obrigatório Campo establishment_id é obrigatório Campo amount é obrigatório Campo expiry_date é obrigatório Campo description é obrigatório Campo notification é obrigatório Campo name é obrigatório Campo notification_type_id é obrigatório Campo value é obrigatório
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

CANCELAR LINK DE PAGAMENTO
/payment_links/list/cancel/{id}

Detalhes

Ao chamar a API realiza a cancelamento do link de pagamento

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

REENVIAR CONTATOS LINK DE PAGAMENTO
/payment_links/list/send/contacts/{id}

Detalhes

Ao chamar a API realiza o reenvio dos contatos do link de pagamento

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Log SES

GET

LISTAGEM
/log_ses

Detalhes

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/log_ses?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

Data - filters[created_at]
Enviado de - filters[from]
Para - filters[to]
Assunto - filters[subject]
Retorno - filters[return]

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR POR ID
/log_ses/{id}

Detalhes

Ao chamar a API busca o detalhe dos logs

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Login

POST

LOGIN
/login

Detalhes

Ao chamar a API realiza o login do usuário

Parâmetros

Required	EMAIL, PASSWORD
Body	{ "email" : "admin@admin.com", "password" : "admin" }

Retornos

Código	Mensagem
200	Token para utilizar nas requisições
401	Usuário não existente
403	Usuário bloqueado

POST

LOGIN PORTAL DO ESTABELECIMENTO
/login

Detalhes

Ao chamar a API realiza o login do portal do estabelecimento

Parâmetros

Required	ESTABLISHMENT_ID, LOGIN, PASSWORD
Body	{ "establishment_id" : "1", "login" : "nome", "password" : "nome123mudar" }

Retornos

Código	Mensagem
200	Token para utilizar nas requisições
401	Credenciais inválidas
403	Usuário bloqueado

POST

LOGIN PORTAL DO DISTRIBUIDOR
/login

Detalhes

Ao chamar a API realiza o login do portal do distribuidor

Parâmetros

Required	DISTRIBUIDOR_ID, LOGIN, PASSWORD
Body	{ "distributor_id" : "1", "login" : "nome", "password" : "nome123mudar" }

Retornos

Código	Mensagem
200	Token para utilizar nas requisições
401	Credenciais inválidas
403	Usuário bloqueado

POST

RESETAR PASSWORD
/resetPassword

Detalhes

Ao chamar a API realiza a troca de senha do usuário

Parâmetros

Required	name, email, not, old_password, password, password_confirmation
Body	{ "name" : "nome", "email" : "admin@admin.com", "not" : "true", "old_password" : "senha antiga", "password" : "nova senha", "password_confirmation" : "confirmar senha" }

Retornos

Código	Mensagem
200	Token para utilizar nas requisições
401	Credenciais inválidas
403	Usuário bloqueado

Logs

GET

BUSCAR POR ID
/logs/{id}

Detalhes

Ao chamar a API realiza busca de log por id

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

PAGINAÇÃO
/logs

Detalhes

Ao chamar a API realiza paginação de logs

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Logs APIs Externas

GET

LISTAGEM
/external_logs

Detalhes

Ao realizar a chamada, teremos uma resposta da API retornando os logs de APIs Externas

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR POR ID
/external_logs/{id}

Detalhes

Ao chamar a API busca o detalhe dos logs

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Mccs

GET

LISTAGEM
combo/mcc

Detalhes

Ao chamar a API realiza listagem dos Mccs

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Meio de Entrada

GET

LISTAGEM
/entry_modes

Detalhes

Ao chamar a API realiza a listagem dos meios de entradas

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Modelos de Comissão

GET

LISTAR MODELOS DE COMISSÃO
/commision_models

Detalhes

Ao realizar a chamada, a API irá apresentar uma lista com os Modelos de Comissão do sistema

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAR MODELO DE COMISSÃO
/commision_models

Detalhes

Ao realizar a chamada, a API irá realizar a criação de um novo Modelo de Comissão com os dados informados no formulário.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "description" : "TESTE DOC" }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

EDITAR MODELO DE COMISSÃO
/commision_models/update/{id}

Detalhes

Ao realizar a chamada, a API irá realizar a edição de um modelo de comissão, filtrado por ID, com os dados informados.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "description" : "AAAAAAA" }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Multi Estabelecimento

GET

EXIBIR ESTABELECIMENTOS
/multi_ec

Detalhes

Ao realizar a chamada, a API irá apresentar os detalhes do estabelecimento filtrado por ID.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

EXIBIR VINCULOS DO ESTABELECIMENTO
/multi_ec/{id}

Detalhes

Ao realizar a chamada, a API irá apresentar os vinculos do Estabelecimento escolhido.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ADICIONAR VINCULO
/multi_ec/{id}

Detalhes

Ao realizar a chamada, a API irá realizar um novo vinculo com o estabelecimento.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

DELETE

DELETAR UNICO VINCULO
/multi_ec/{id}

Detalhes

Ao realizar a chamada, a API irá realizar a deleção de um unico vinculo.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

DELETE

LIMPAR TODOS VINCULOS
/multi_ec/clean/{id}

Detalhes

Ao realizar a chamada, a API irá limpar todos os vinculos do estabelecimento.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

OFAC

GET

LISTAR OFAC
/reports/ofac/

Detalhes

Ao realizar a chamada, a API irá apresentar uma lista com os OFAC.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Padronização MCC

POST

ADICIONAR MCC
/mcc_standard/store

Detalhes

Ao realizar a chamada, a API irá adicionar

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "mcc_id" : "302", "capture_method_id" : "2", "default_type_id" : "1" }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

DELETE

DELETAR MCC
/mcc_standard/destroy/{id}

Detalhes

Ao realizar a chamada, a API irá deletar a Padronização de MCC escolhido.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Pagamento Manual

GET

LISTAR PAGAMENTO MANUAL
/manual_payments

Detalhes

Ao realizar a chamada, a API irá apresentar uma lista com os Pagamentos Manuais feitos no sistema

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

Efetivar / Prorrogar Repasse
/manual_payments/update/{action}/{id}

Detalhes

Ao chamar a API efetiva ou prorroga o repasse.

Só é possível Efetivar ou Prorrogar um repasse que tenha um dos seguintes status:
1 - Aguardando Pagamento
8 - Erro no processamento
9 - Erro no pagamento
10 - Suspenso

Para Efetivar o pagamento do repasse, é necessário enviar no parâmetro "action" o valor : 1.
Para prorrogar é necessário enviar o valor : 2

Retornos

Código	Mensagem
200	OK
400	Repasse não encontrado ou contém status de sucesso Ação inválida
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Pagamento de Boleto

POST

Agendamento de Pagamento
/internal_account/payment

Detalhes

Apenas usuários de tipo Estabelecimento podem realizar o pagamento de boleto. Ao realizar a chamada, a API irá verificar se o Estabelecimento contém Conta Interna e realizar o agendamento do pagamento do boleto.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	BANK_SLIP, DIGITABLE_LINE, DUE_DATE, NOMINAL_VALUE, AMOUNT, OBSERVATION, TRANSACTIONID, EXTERNALNSU, PAYMENT, TERMINAL_ID, COMPANY_ID
Body	{ "bank_slip" : "83630000001252201110000010102023395204097918", "digitable_line" : "836300000012252201110001001010202339952040979181", "due_date" : "2024-07-14", "discount_amount" : "0", "nominal_value" : "2", "amount" : "2", "observation" : "Documentação", "transactionID" : "2147790351", "externalNSU" : "212120", "payment" : "1", "terminal_id" : "7200031909200285", "company_id" : "1" }

Retornos

Código	Mensagem
200	CRIADO
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Pagamentos Futuros

GET

LISTAR PAGAMENTOS FUTUROS
/reports/future_payments

Detalhes

Ao realizar a chamada, a API irá apresentar uma lista com os Pagamentos Futuros.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Parametros

GET

LISTAR PARAMETROS
/parameters

Detalhes

Ao realizar a chamada, a API irá apresentar uma lista com Parametros do sistema.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

EDITAR PARAMETROS
/parameters

Detalhes

Ao realizar a chamada, a API irá editar os parametros do sistema conforme dados enviados.

Parâmetros

Authorization

{

Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==)

}

Body

{

"days_to_block_affiliate" : 0,

"range_anticipation" : 5.50,

"max_establishment_split" : 5,

"max_percent_split" : 100,

"value_min_transfer" : 50,

"initial_transfer_file" : 44,

"transactions_limit" : 10,

"ted_hour" : "18:00:00",

"tef_hour" : "20:00:00",

"minimum_day" : 1,

"PCC" : "default",

"contract_link" : null,

"contract_label" : null,

"automatic_approve" : 2,

"cerc_line_broker" : "LF",

"whitelabel_distributor" : "Distribuidor",

"max_installments" : 12,

"commission_report_terminal_label" : "Terminal",

"commission_report_local_label" : "Local",

"cerc_sequential" : 44,

"ignore_installment_days" : 0,

"cerc_identificator" : "BYTA",

"anticipation_ecommerce_status" : 1,

"payment_deletion_from_months" : 3,

"cerc_layout" : "1.5.0",

"sub_full" : 1,

"sgs_api_sub_doc" : 24557435000108,

"months_to_maintain" : 3,

"internal_account_sequential" : "000001",

"send_email_ec" : 1,

"status_dimp" : 2,

"whitelabel_provider" : "Fornecedor",

"date_to_use_cancel" : "23/05/2023"

}

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Perfis

GET

LISTAGEM
/profiles

Detalhes

Ao realizar a chamada, teremos uma resposta da API retornando os perfis cadastrados

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAR
/profiles

Detalhes

Ao chamar a API cria o perfil.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	NAME, USER_TYPE_ID, PERMISSIONS
Body	{ "name" : "Exemplo", "user_type_id" : "4", "permissions" : { "1", "2", "3", "4", "5", "6" }, }

Retornos

Código	Mensagem
200	OK
401	Campo name é obrigatório Campo user_type_id é obrigatório Campo permissions é obrigatório
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR POR ID
/profiles/{id}

Detalhes

Ao chamar a API busca o detalhe do perfil

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

EDITAR
/profiles/{id}

Detalhes

Ao chamar a API edita o perfil.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	NAME, USER_TYPE_ID, PERMISSIONS
Body	{ "name" : "Exemplo", "user_type_id" : "4", "permissions" : { "1", "2", "3", "4", "5", "6" }, }

Retornos

Código	Mensagem
200	OK
401	Campo name é obrigatório Campo user_type_id é obrigatório Campo permissions é obrigatório
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Personalização

PUT

ATUALIZAÇÃO
/layouts/{id}

Detalhes

Ao chamar a API realiza a atualização das cores do sistema, para isso devemos colocar o ID como 1

Parâmetros

Authorization

{

Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==)

}

Body

{

"font_login" : "arial",

"background_login" : "#01007c",

"background_panel_login" : "#191952",

"background_buttom_login" : "#191952",

"color_buttom_login" : "#ffffff",

"background_menu" : "#01007c",

"background_lateral_menu" : "#01007c",

"color_lateral_menu" : "#ffffff",

"background_lateral_hover_menu" : "#7877ff",

"buttom_color_primary" : "#5553ff",

"buttom_color_danger" : "#f23636",

"buttom_color_warning" : "#ffd145"

}

Retornos

Código	Mensagem
402	Token não encontrado. Token expirado. Token é inválido.
405	Verifique os dados e tente novamente
500	Houve um erro interno

Período Estabelecimento

GET

LISTAGEM
/establishment_periods

Detalhes

Ao chamar a API realiza a listagem dos estabelecimentos ativos

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAÇÃO
/establishment_periods/{id}

Detalhes

Ao chamar a API realiza a criação do período para estabelecimento

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	PERIOD_ID, PERIOD
Body	{ "period_id" : "1", "period" : "20" }

Retornos

Código	Mensagem
201	CRIADO
401	Campo period_id é obrigatório O Tamanho Máximo para o campo period_id é de 10 caracteres O registro period_id já está cadastrado no banco Campo code é inválido O Estabelecimento não existe O Prazo não existe Já contém este Prazo para o Estabelecimento Prazo tem que estar na faixa de 1 a 30
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR POR ID
/establishment_periods/{id}

Detalhes

Ao chamar a API realiza listagem de um único estabelecimento e tras informações dos periodos registrado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

DELETE

DELETAR
/establishment_periods/{id}

Detalhes

Ao chamar a API deleta o período do estabelecimento desejado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Período Grupo Econômico

GET

LISTAGEM
/economic_group_periods

Detalhes

Ao chamar a API realiza a listagem dos grupos econômicos

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAÇÃO
/economic_group_periods/{id}

Detalhes

Ao chamar a API realiza a criação do período para grupo econômico

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	PERIOD_ID, PERIOD
Body	{ "period_id" : "1", "period" : "20" }

Retornos

Código	Mensagem
201	CRIADO
401	Campo period_id é obrigatório O Tamanho Máximo para o campo period_id é de 10 caracteres O registro period_id já está cadastrado no banco Campo code é inválido O Grupo Econômico não existe O Prazo não existe Já contém este Prazo para o Grupo Econômico Prazo tem que estar na faixa de 1 a 30
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR POR ID
/economic_group_periods/{id}

Detalhes

Ao chamar a API realiza listagem de um único grupo econômico e tras informações dos periodos registrado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

DELETE

DELETAR
/economic_group_periods/{id}

Detalhes

Ao chamar a API deleta o período do grupo econômico desejado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Período Padrão

GET

LISTAGEM
/periods

Detalhes

Ao chamar a API realiza a listagem das bandeiras e o método de pagamento

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
500	Houve um erro interno

GET

LISTAGEM METODO DE PAGAMENTO
/periods/payment_method

Detalhes

Ao chamar a API realiza listagem de todos os metodos de pagamento registrados no sistema

Retornos

Código	Mensagem
200	OK
500	Houve um erro interno

POST

ATUALIZAÇÃO
/periods

Detalhes

Ao chamar a API realiza a alteração dos perídos em padrão

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	PERIOD
Body	{ "period" : { "1": "5"} }

Retornos

Código	Mensagem
200	OK
401	Período tem que estar na faixa de 1 a 30 Produto não existe na base de dados
500	Houve um erro interno

POST

ATUALIZAÇÃO
/periods/payment_method

Detalhes

Ao chamar a API realiza a alteração em massa por método de pagamento em padrão

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	payment_method_id, period
Body	{ "payment_method_id" : "2", "period" : "12" }

Retornos

Código	Mensagem
200	OK
401	Método de Pagamento inválido Período é obrigatório Período deve conter apenas números Período deve ser maior ou igual a 1
500	Houve um erro interno

Prazo Grupo Economico

GET

LISTAR PRAZO
/economic_group_periods

Detalhes

Ao realizar a chamada, a API irá apresentar uma lista com os Prazos de Grupo Econômico

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

EXIBIR GRUPO ECONOMICO
/economic_group_periods/{id}

Detalhes

Ao realizar a chamada, a API irá apresentar os detalhes do Prazo de Grupo Economico, filtrado por ID.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAR PRAZO
/economic_group_periods/{id}

Detalhes

Ao realizar a chamada, a API irá a criação de um novo Prazo para o Grupo Economico com dados informados.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "period_id" : "7", "period" : "15" }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Prazo Padrão

GET

LISTAR PRAZO PADRÃO
/periods

Detalhes

Ao realizar a chamada, a API irá apresentar uma lista com os Prazos.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

ATUALIZAR PRAZO PADRÃO
/periods/

Detalhes

Ao realizar a chamada, a API irá realizar a edição do Prazo.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "period" : {"1": "5"} }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Prepostos

GET

LISTAGEM
combo/preposterous

Detalhes

Ao chamar a API realiza listagem de Preposto

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAÇÃO
/preposterous

Detalhes

Ao chamar a API realiza a criação do Preposto.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DISTRIBUTOR_ID, NAME, LAST_NAME, CPF, RG, CEP, ADDRESS, NUMBER, DISTRICT, CITY, STATE_ID, COUNTRIE_ID, COMPLEMENT, BANK_ACCOUNT_TYPE_ID, HOLDER_TYPE_ID, BANK_ID, AGENCY, ACCOUNT
Body	{ "distributor_id" : "1", "name" : "Nome", "company" : { "last_name": "SobreNome", "rg": "384858107", "document": "24133784057", }, "localization" : { "cep": "29127-043", "address": "Rua Agamalie de Moraes", "number": "125", "district": "João Goulart", "city": "Vila Velha", "state_id": "1", "countrie_id": "1", "complement": "Casa" }, "contacts" : [{ "contact_type_id": "2", "name": "João", "value": "joao@gmail.com" }, { "contact_type_id": "2", "name": "Maria", "value": "942115432" }, {"contact_type_id": "1", "name": "Contato celular", "value": "942115432" } ], "bank_given" : { "bank_account_type_id": "1", "bank_id": "1", "agency": "00000", "digit_agency": "00", "account": "00000", "digit_account": "00", "countrie_id": "1", "complement": "Casa" }, "commission" : { "commission_activation": "1", "commission_payment": "0", "commission_model_id": "1", "validity": "2021-05-10" } , "max_date" : "2021-05-10" }

Retornos

Código	Mensagem
201	CRIADO
401	Campo distributor_id é obrigatório Campo distributor_id deve conter apenas Números O Tamanho Máximo para o campo distributor_id é de 11 caracteres Campo name é obrigatório O Tamanho Máximo para o campo distributor_id é de 255 caracteres Campo company.last_name é obrigatório O Tamanho Máximo para o campo company.last_name é de 255 caracteres Campo company.rg é obrigatório O Tamanho Máximo para o campo company.rg é de 255 caracteres Campo company.document é obrigatório Campo company.document é Inválido Campo localization.cep é obrigatório O Campo localization.cep é Inválido Campo localization.number é obrigatório Campo localization.number deve conter apenas Números Campo localization.address é obrigatório O Tamanho Máximo para o campo localization.address é de 255 caracteres Campo localization.district é obrigatório O Tamanho Máximo para o campo localization.district é de 255 caracteres Campo localization.city é obrigatório O Tamanho Máximo para o campo localization.city é de 255 caracteres Campo localization.state_id é obrigatório Campo localization.state_id deve conter apenas Números O Tamanho Máximo para o campo localization.state_id é de 11 caracteres Campo localization.state_id é Inválido Campo localization.countrie_id é obrigatório O Tamanho Máximo para o campo localization.countrie_id é de 11 caracteres Campo localization.countrie_id deve conter apenas Números Campo localization.countrie_id é Inválido O Tamanho Máximo para o campo localization.complement é de 255 caracteres Preposto não existente É impossível alterar o tipo de pessoa Para o tipo de Dado Bancário selecionado, não é permitido o envio de Cartão Pré Pago Para o tipo de Dado Bancário selecionado, é necessário o envio dos Dados Bancários Para o tipo de titular selecionado, não é permitido o envio dos dados do mesmo Esse tipo de títular do dado bancário não é permitido para estabelecimento PF Para o tipo de titular selecionado, é necessário o envio dos dados do mesmo Para o tipo de Dado Bancário selecionado, não é permitido o envio dos Dados Bancários Para o tipo de Dado Bancário selecionado, é necessário o envio de Cartão Pré Pago Preposto já cadastrado
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR POR ID
/preposterous/{id}

Detalhes

Ao chamar a API realiza listagem de um único Preposto

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ATUALIZAÇÃO
/preposterous/{id}

Detalhes

Ao chamar a API recebe os dados do Preposto e realiza a atualização.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DISTRIBUTOR_ID, NAME, LAST_NAME, CPF, RG, CEP, ADDRESS, NUMBER, DISTRICT, CITY, STATE_ID, COUNTRIE_ID, COMPLEMENT, BANK_ACCOUNT_TYPE_ID, HOLDER_TYPE_ID, BANK_ID, AGENCY, ACCOUNT
Body	{ "distributor_id" : "1", "name" : "Nome Atualizado", "company" : { "last_name": "SobreNome Atualizado", "rg": "384858107", "document": "88216378084", }, "localization" : { "cep": "29127-043", "address": "Rua Agamalie de Moraes Atualizado", "number": "125", "district": "João Goulart Atualizado", "city": "Vila Velha Atualizado", "state_id": "1", "countrie_id": "1", "complement": "Casa" }, "contacts" : [{ "contact_type_id": "2", "name": "João Atualizado", "value": "atualizado@gmail.com" }, { "contact_type_id": "1", "name": "Maria", "value": "942115431" }], "bank_given" : { "bank_account_type_id": "1", "bank_id": "1", "agency": "00000", "digit_agency": "00", "account": "00000", "digit_account": "00", "countrie_id": "1", "complement": "Casa" }, "commission" : { "commission_activation": "1", "commission_payment": "0", "commission_model_id": "1", "validity": "2021-05-10" } , "max_date" : "2021-05-10" }

Retornos

Código	Mensagem
200	OK
401	Campo distributor_id é obrigatório Campo distributor_id deve conter apenas Números O Tamanho Máximo para o campo distributor_id é de 11 caracteres Campo name é obrigatório O Tamanho Máximo para o campo distributor_id é de 255 caracteres Campo company.last_name é obrigatório O Tamanho Máximo para o campo company.last_name é de 255 caracteres Campo company.rg é obrigatório O Tamanho Máximo para o campo company.rg é de 255 caracteres Campo company.document é obrigatório Campo company.document é Inválido Campo localization.cep é obrigatório O Campo localization.cep é Inválido Campo localization.number é obrigatório Campo localization.number deve conter apenas Números Campo localization.address é obrigatório O Tamanho Máximo para o campo localization.address é de 255 caracteres Campo localization.district é obrigatório O Tamanho Máximo para o campo localization.district é de 255 caracteres Campo localization.city é obrigatório O Tamanho Máximo para o campo localization.city é de 255 caracteres Campo localization.state_id é obrigatório Campo localization.state_id deve conter apenas Números O Tamanho Máximo para o campo localization.state_id é de 11 caracteres Campo localization.state_id é Inválido Campo localization.countrie_id é obrigatório O Tamanho Máximo para o campo localization.countrie_id é de 11 caracteres Campo localization.countrie_id deve conter apenas Números Campo localization.countrie_id é Inválido O Tamanho Máximo para o campo localization.complement é de 255 caracteres Preposto não existente É impossível alterar o tipo de pessoa Não é possível alterar o documento Para o tipo de Dado Bancário selecionado, não é permitido o envio de Cartão Pré Pago Para o tipo de Dado Bancário selecionado, é necessário o envio dos Dados Bancários Para o tipo de titular selecionado, não é permitido o envio dos dados do mesmo Esse tipo de títular do dado bancário não é permitido para estabelecimento PF Para o tipo de titular selecionado, é necessário o envio dos dados do mesmo Para o tipo de Dado Bancário selecionado, não é permitido o envio dos Dados Bancários Para o tipo de Dado Bancário selecionado, é necessário o envio de Cartão Pré Pago Preposto já cadastrado
402	Token não encontrado. Token expirado. Token é inválido.
406	Verifique os dados e tente novamente
500	Houve um erro interno

DELETE

DELETAR
/preposterous/{id}

Detalhes

Ao chamar a API deleta o Preposto desejado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Produtos

GET

LISTAR PRODUTOS
/products

Detalhes

Ao realizar a chamada, a API irá apresentar uma lista com os Produtos cadastrados no sistema.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

EDITAR PRODUTO
/products/{id}

Detalhes

Ao realizar a chamada, a API irá realizar a edição informada nos campos do produto selecionado.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "brand_id" : "2", "payment_method_id" : "8" }

Retornos

Código	Mensagem
200	OK
401	O produto já está cadastrado
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

DELETE

DELETAR PRODUTO
/products/{id}

Detalhes

Ao realizar a chamada, API irá deletar o produto escolhido.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Relatorios

GET

LISTAGEM DE REPASSES
/transfer_resume

Detalhes

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/transfer_resume?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

Repasses com valores zerados ? (0 - Não, 1 - Sim) - filters[total.all]
ID do Repasse - filters[nsu]
Data do Repasse - filters[date]
Status do Repasse - filters[status_id]
Valor Repasse - filters[total]
Documento Estabelecimento [ CNPJ ] - filters[companies.company_details.document]
Documento Estabelecimento [ CPF ] - filters[companies.document]
Nome Comercial do Estabelecimento - filters[establishment.commercial_name]
ID Estabelecimento - filters[establishment_id]

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR REPASSE POR ID
/transfer_resume/{id}

Detalhes

Ao chamar a API realiza listagem de um único Repasse

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM PREPOSTOS
/reports/preposterous

Detalhes

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/reports/preposterous?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

CPF do Preposto - filters[companies.document]
Status do Preposto - filters[companies.status_id]
ID de preposto - filters[nsu]
Nome do Preposto - filters[name]
Nome comercial do distribuidor - filters[distributor.commercial_name]

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR PREPOSTO POR ID
/reports/preposterous/{id}

Detalhes

Ao chamar a API realiza listagem dos dados completos do preposto

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM DE PAGAMENTOS FUTUROS
/reports/future_payments

Detalhes

Ao realizar a chamada, teremos uma resposta da API retornando 10 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/reports/future_payments?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

Documento do Estabelecimento - filters[document]
Tipo de documento (1 - CPF, 2 - CNPJ, 3 - ID) - filters[people_type_id]
Período (data Inicial) - filters[start_period]
Período (data Final) - filters[end_period]

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM TRANSAÇÕES
/transactions

Detalhes

Ao realizar a chamada, teremos uma resposta da API retornando 10 últimos registros devido a paginação. (a Paginação é parametrizada no sistema, então ela irá variar de acordo com o parametrizado pelo administrador)
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/transactions?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.

Para carregar as parcelas, basta usar a rota /ajax/transaction/{id_transacao} - Próxima rota da documentação.

Filtros

Id de Estabelecimento - filters[establishment_id]
Nome Comercial - filters[establishment.commercial_name]
Documento Estabelecimento - filters[document]
Id de Transação - filters[id]
Produto - filters[product_id]
Tipo da Transação - filters[transaction_type_id]
Originador - filters[originator]
Autorização - filters[authorization]
Número de Cartão - filters[card_number]
Método Captura - filters[capture_method_id]
NSU Captura - filters[nsu_captura]
Número de série equipamento - filters[serial_number]
Método Captura - filters[capture_method_id]
Data da Integração - filters[created_at]
Data de Transação (Período Inicial) - filters[transaction_initial_date]
Data de Transação (Período Final) - filters[transaction_final_date]
ID Parcela - filters[installment_id]
Situação da Parcela - filters[installment_situation_id]
Status da Parcela - filters[installment_status_id]
Data de vencimento da parcela (Período Inicial) - filters[installment_inital_expiry_date]
Data de vencimento da parcela (Período Final) - filters[installment_final_expiry_date]

O Número total de registros + a soma de todos os valores das transações são retornados nessa mesma consulta no seguintes parâmetros : total_items + amount

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCA DE PARCELAS POR ID DE TRANSAÇÃO
/ajax/transaction/{id}

Detalhes

A rotina trará as parcelas de uma determinada transação com as colunas de tarifas da mesma maneira que trás em tela

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

CONTROLE DE ACESSOS
/system_tries

Detalhes

Ao realizar a chamada, teremos uma resposta da API retornando 10 últimos registros devido a paginação. (a Paginação é parametrizada no sistema, então ela irá variar de acordo com o parametrizado pelo administrador)
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/system_tries?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

Sistema - filters[system_id]
IP - filters[ip]
ID Estabelecimento - filters[establishment_id]
Id Distribuidor - filters[distributor_id]
Login - filters[login]
Data Inicial - filters[initial_date]
Data Final - filters[final_date]

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

SALDOS
/establishment_balances/

Detalhes

Ao realizar a chamada, teremos uma resposta da API retornando 10 últimos registros devido a paginação. (a Paginação é parametrizada no sistema, então ela irá variar de acordo com o parametrizado pelo administrador)
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/establishment_balances?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

ID - filters[establishment_id]
Nome Comercial - filters[commercial_name]
Documento - filters[document]
Data Prevista - filters[date]

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

SPLITS
/reports/splits/

Detalhes

Ao realizar a chamada, teremos uma resposta da API retornando 10 últimos registros devido a paginação. (a Paginação é parametrizada no sistema, então ela irá variar de acordo com o parametrizado pelo administrador)
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/establishment_balances?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

ID Estabelecimento - filters[establishment_id]
Nome Comercial - filters[commercial_name]
Documento - filters[document]
Status - filters[installment_status_id]
Situação - filters[installment_situation_id]
Data Inicial - filters[initial_date]
Data Final - filters[final_date]

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

DISTRIBUIDORES
/reports/distributors/

Detalhes

Ao realizar a chamada, teremos uma resposta da API retornando 10 últimos registros devido a paginação. (a Paginação é parametrizada no sistema, então ela irá variar de acordo com o parametrizado pelo administrador)
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/reports/distributors?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

ID - filters[nsu]
Nome Distribuidor - filters[commercial_name]
Documento (CPF)- filters[companies.document]
Documento (CNPJ)- filters[companies.company_details.document]
Tipo de Pessoa - filters[companies.people_type_id]
Status - filters[companies.status_id]

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR DISTRIBUIDOR POR ID
/reports/distributors/{id}

Detalhes

Ao realizar a chamada, teremos uma resposta da API com os dados do distrubuidor específicado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

ARQUIVO DE TRANSAÇÃO FIRSTDATA
/transaction_files/first_data/

Detalhes

Ao realizar a chamada, teremos uma resposta da API retornando 10 últimos registros devido a paginação. (a Paginação é parametrizada no sistema, então ela irá variar de acordo com o parametrizado pelo administrador)
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/transaction_files/first_data?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

ID - filters[id]
Data - filters[date]
Status - filters[transaction_file_status_id]
Nome do Arquivo- filters[fileName]

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR ARQUIVO FIRSTDATA POR ID
/transaction_files/first_data/{id}

Detalhes

Ao realizar a chamada, teremos uma resposta da API com os dados do arquivo específicado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

ARQUIVO DE TRANSAÇÃO PAGSEGURO
/transaction_files/pag_seguro/

Detalhes

Ao realizar a chamada, teremos uma resposta da API retornando 10 últimos registros devido a paginação. (a Paginação é parametrizada no sistema, então ela irá variar de acordo com o parametrizado pelo administrador)
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/transaction_files/pag_seguro?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

ID - filters[id]
Data - filters[date]
Status - filters[transaction_file_status_id]
Nome do Arquivo- filters[fileName]

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR ARQUIVO PAGSEGURO POR ID
/transaction_files/pag_seguro/{id}

Detalhes

Ao realizar a chamada, teremos uma resposta da API com os dados do arquivo específicado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

ARQUIVO DE CONCILIAÇÂO FIRSTDATA
/conciliation/firstdata_conciliation

Detalhes

Ao realizar a chamada, teremos uma resposta da API retornando 10 últimos registros devido a paginação. (a Paginação é parametrizada no sistema, então ela irá variar de acordo com o parametrizado pelo administrador)
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/conciliation/firstdata_conciliation?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

ID - filters[id]
Data - filters[date]
Status - filters[transaction_file_status_id]
Nome do Arquivo- filters[fileName]

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR ARQUIVO DE CONCILIAÇÂO FIRSTDATA POR ID
/conciliation/firstdata_conciliation/{id}

Detalhes

Ao realizar a chamada, teremos uma resposta da API com os dados do arquivo específicado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

ARQUIVO DE CONCILIAÇÂO PAGSEGURO
/conciliation/pag_seguro_conciliation

Detalhes

Ao realizar a chamada, teremos uma resposta da API retornando 10 últimos registros devido a paginação. (a Paginação é parametrizada no sistema, então ela irá variar de acordo com o parametrizado pelo administrador)
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/conciliation/pag_seguro_conciliation?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

ID - filters[id]
Data - filters[date]
Status - filters[transaction_file_status_id]
Nome do Arquivo- filters[fileName]

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR ARQUIVO DE CONCILIAÇÂO PAGSEGURO POR ID
/conciliation/pag_seguro_conciliation/{id}

Detalhes

Ao realizar a chamada, teremos uma resposta da API com os dados do arquivo específicado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

ARQUIVO DE MAN. ESTAB. CERC
/report_cerc/ap001

Detalhes

Ao realizar a chamada, teremos uma resposta da API retornando 10 últimos registros devido a paginação. (a Paginação é parametrizada no sistema, então ela irá variar de acordo com o parametrizado pelo administrador)
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//report_cerc/ap001?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

Data - filters[date]
Nome do Arquivo- filters[fileName]

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR ARQUIVO DE MAN. ESTAB. CERC POR ID
/report_cerc/ap001/{id}

Detalhes

Ao realizar a chamada, teremos uma resposta da API com os dados do arquivo específicado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

ARQUIVO DE RECEBIVEIS CERC
/report_cerc/ap002

Detalhes

Ao realizar a chamada, teremos uma resposta da API retornando 10 últimos registros devido a paginação. (a Paginação é parametrizada no sistema, então ela irá variar de acordo com o parametrizado pelo administrador)
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//report_cerc/ap002?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

Data - filters[date]
Nome do Arquivo- filters[fileName]

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR ARQUIVO DE RECEBIVEIS CERC POR ID
/report_cerc/ap002/{id}

Detalhes

Ao realizar a chamada, teremos uma resposta da API com os dados do arquivo específicado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

REGISTRO DE RECEBIVEIS CERC
/received_file

Detalhes

Ao realizar a chamada, teremos uma resposta da API retornando 10 últimos registros devido a paginação. (a Paginação é parametrizada no sistema, então ela irá variar de acordo com o parametrizado pelo administrador)
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/received_file?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

ID - filters[id]
Documento - filters[document]
ID Estabelecimento - filters[establishment_id]
Nome Comercial - filters[establishment.commercial_name]
Produto - filters[product_id]
Status - filters[status_id]

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR REGISTRO DE RECEBIVEIS CERC POR ID
/received_file/installments/{id}

Detalhes

Ao realizar a chamada, teremos uma resposta da API com os dados do arquivo específicado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

ARQUIVO DE DADOS MANUTENÇÃO DE ESTABELECIMENTOS
/report_cerc/file_data_estab

Detalhes

Ao realizar a chamada, teremos uma resposta da API retornando 10 últimos registros devido a paginação. (a Paginação é parametrizada no sistema, então ela irá variar de acordo com o parametrizado pelo administrador)
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/report_cerc/file_data_estab?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

Data - filters[date]
Nome do Arquivo - filters[filename]

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR ARQUIVO DE DADOS MANUTENÇÃO DE ESTABELECIMENTOS POR ID
/report_cerc/file_data_estab/{id}

Detalhes

Ao realizar a chamada, teremos uma resposta da API com os dados do arquivo específicado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

ARQUIVO DE DADOS RECEBIVEIS
/report_cerc/file_data_received

Detalhes

Ao realizar a chamada, teremos uma resposta da API retornando 10 últimos registros devido a paginação. (a Paginação é parametrizada no sistema, então ela irá variar de acordo com o parametrizado pelo administrador)
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/report_cerc/report_cerc/file_data_received?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

Data - filters[date]
Nome do Arquivo - filters[filename]

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR ARQUIVO DE DADOS RECEBIVEIS POR ID
/report_cerc/file_data_received/{id}

Detalhes

Ao realizar a chamada, teremos uma resposta da API com os dados do arquivo específicado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

RELATÓRIO EDI
/edi_adiq

Detalhes

Ao realizar a chamada, teremos uma resposta da API retornando 10 últimos registros devido a paginação. (a Paginação é parametrizada no sistema, então ela irá variar de acordo com o parametrizado pelo administrador)
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/report_cerc/edi_adiq?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

ID Transação - filters[transaction_id]
NSU Transação - filters[nsu]
Autorização - filters[authorization]
Originador - filters[originator_id]
Data da Transação - filters[transaction_date]
Data de Liquidação - filters[liquid_date]

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR RELATÓRIO EDI POR ID
/edi_adiq/{id}

Detalhes

Ao realizar a chamada, teremos uma resposta da API com os dados da transação

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM ESTABELECIMENTO
/reports/establishments

Detalhes

Filtros

Id de Estabelecimento - filters[nsu]
Nome Comercial - filters[commercial_name]
Documento CNPJ - filters[companies.company_details.document]
Documento CPF - filters[companies.document]
Tipo de pessoa - filters[companies.people_type_id]
Status - filters[companies.status_id]
Situação - filters[establishment_situation_id]
Distribuidor - filters[distributor.id]
Preposto - filters[preposterou.id]
Grupo econômico - filters[economic_group.id]
Data de cadastro - filters[date]

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR ESTABELECIMENTO POR ID
/reports/establishments/{id}

Detalhes

Ao chamar a API realiza listagem dos dados completos do estabelecimento

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Repasses

GET

LISTAR REPASSES
/transfer_resume

Detalhes

Ao realizar a chamada, a API irá apresentar uma lista com os Repasses cadastrados no sistema.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAR REPASSES POR ID
/transfer_resume/{id}

Detalhes

Ao realizar a chamada, a API irá apresentar um determinado Repasse, filtrado pelo ID.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Repasses Invalidos

GET

LISTAGEM
/transfer_diff

Detalhes

Ao chamar a API realiza a listagem dos Repasses Inválidos

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

Processar Repasses Inválidos
/transfer_diff/proccess/{id}

Detalhes

Ao chamar a API realiza o processamento dos Repasses Inválidos

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Repasse inválido não encontrado. Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

Finalizar Repasses Inválidos
/transfer_diff/finish/{id}

Detalhes

Ao chamar a API realiza a finalização dos Repasses Inválidos

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Repasse inválido não encontrado. Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Serviços

GET

LISTAR SERVIÇOS
/commision_services

Detalhes

Ao realizar a chamada, a API irá apresentar uma lista com os Serviços.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

EDITAR SERVIÇO
/commision_services/update/{id}

Detalhes

Ao realizar a chamada, a API irá realizar a edição de um serviço filtrado por ID, com os dados informados.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "description" : "TESTE2" }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAR SERVIÇO
/commision_services

Detalhes

Ao realizar a chamada, a API irá realizar a criação de um novo serviço com os dados informados no formulário.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Split

GET

LISTAGEM DE ESTABELECIMENTOS
split

Detalhes

Aqui, poderemos basicamente visualizar todos os estabelecimentos que são, ou podem ser PAIS, ou seja, que não estão definidos como filho!

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM DE ESPECÍFICO
split/{id}

Detalhes

Aqui, poderemos basicamente visualizar o estabelecimento selecionado e relacionar outros estabelecimentos ao mesmo.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
401	Estabelecimento não encontrado Estabelecimento está inativo Estabelecimento está definido como Filho
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ALTERAR TIPO DE SPLIT
split/type/{id}

Detalhes

Função utilizada para alternar tipo de split entre Destino ou Origem.

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

DELETE

LIMPAR TODOS SPLITS
split/clean/{id}

Detalhes

Função utilizada para Limpar todos os splits configurados.

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

DELETE

REMOVER VINCULO DE ESTABELECIMENTO
split/{id}

Detalhes

Função utilizada para remover um estabelecimento do vínculo com outro. O ID utilizado, não é o ID nem do estabelecimento pai, nem do filho, e sim da relação entre os dois.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

MANUTENÇÃO DE SPLIT
split/{id}

Detalhes

Com essa função, poderemos atrelar um ou mais estabelecimentos a um estabelecimento PAI, definindo a porcentagem de cada um ( que será o que ganhará encima das transações do PAI )

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	VALUE, PEOPLE_TYPE_ID, DOCUMENT
Body	{ "document" : "45246008177", "people_type_id" : "1", "value" : "1" }

Retornos

Código	Mensagem
200	OK
401	Estabelecimento não encontrado Estabelecimento está inativo Estabelecimento está definido como Filho Dados para busca são inconsistentes Nenhum Estabelecimento válido foi encontrado Não é possível vincular um estabelecimento a ele mesmo Um estabelecimento definido como filho, não pode ser pai O estabelecimento já está como filho do estabelecimento selecionado O estabelecimento está definido como pai, e não pode ser vinculado como Filho O valor do split está excedendo o limite estipulado O número de estabelecimentos como filho está excedendo o limite estipulado Dados são inconsistentes
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Sub Adquirente

GET

PAGINAÇÃO
/sub_acquirers

Detalhes

Ao chamar a API realiza paginação de Sub Adquirente

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAÇÃO
/sub_acquirers

Detalhes

Regras de negócio:
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 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.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	COMMERCIAL_NAME, LINK_EC, NAME, LAST_NAME, RG, DOCUMENT, CEP, ADDRESS, NUMBER, DISTRICT, CITY, STATE_ID, COUNTRIE_ID, SOCIAL_REASON, BANK_ACCOUNT_TYPE_ID, BANK_ID, AGENCY, ACCOUNT, HOLDER_TYPE_ID, BANK_ACCOUNT_TYPE_ID
Body	{ "code_facilitator_elo" : "33", "link_ec" : "http://www.portalec.com.br", "link_pd" : "http://www.portalpd.com.br", "commercial_name" : "Nome comercial", "company" : { "name": "Nome", "last_name": "Sobrenome", "rg": "21312", "document": "57722600069", "company_details":{ "social_reason":"Nome", "document":"45011462000142" } }, "localization" : { "cep": "77006-660", "address": "Quadra 508 Norte Alameda 3", "number": "321", "district": "Plano Diretor Norte", "city": "Palmas", "state_id": "1", "countrie_id": "1", "complement": "Casa" }, "contacts" : [{ "contact_type_id": "2", "name": "João", "value": "joao@hotmail.com" }, { "contact_type_id": "2", "name": "Maria", "value": "933445566" }, { "contact_type_id": "1", "name": "Pedro", "value": "9944443322" } ], "bank_given" : { "bank_account_type_id": "1", "holder_type_id": "4", "bank_id": "1", "agency": "0364", "digit_agency": "4", "account": "0615869", "digit_account": "2" } }

Retornos

Código	Mensagem
201	CRIADO
401	Campo commercial_name é obrigatório O Tamanho Máximo para o campo commercial_name é de 255 caracteres Campo link_ec é obrigatório O Tamanho Máximo para o campo link_ec é de 255 caracteres Campo company.name é obrigatório O Tamanho Máximo para o campo company.name é de 255 caracteres Campo company.last_name é obrigatório O Tamanho Máximo para o campo company.last_name é de 255 caracteres Campo company.rg é obrigatório O Tamanho Máximo para o campo company.rg é de 255 caracteres Campo company.document é obrigatório Campo company.document é Inválido Campo company.city_insc deve conter apenas Números O Tamanho Máximo para o campo company.city_insc é de 255 caracteres Campo company.state_insc deve conter apenas Números O Tamanho Máximo para o campo company.state_insc é de 255 caracteres Campo localization.cep é obrigatório Campo localization.cep é Inválido Campo localization.address é obrigatório O Tamanho Máximo para o campo localization.address é de 255 caracteres Campo localization.number é obrigatório Campo localization.number deve conter apenas Números Campo localization.district é obrigatório O Tamanho Máximo para o campo localization.district é de 255 caracteres Campo localization.city é obrigatório O Tamanho Máximo para o campo localization.city é de 255 caracteres Campo localization.state_id deve conter apenas Números Campo localization.state_id é Inválido Campo localization.countrie_id deve conter apenas Números Campo localization.countrie_id é Inválido localization.complement O Tamanho Máximo para o campo localization.complement é de 255 caracteres Campo company.company_details.branch_type_id é Inválido Campo company.company_details.branch_type_id é obrigatório Campo company.company_details.document é obrigatório Campo company.company_details.document é Inválido Campo company.company_details.social_reason é obrigatório O Tamanho Máximo para o campo company.company_details.social_reason é de 255 caracteres Campo bank_given.agency é obrigatório Campo bank_given.agency deve conter apenas Números Campo bank_given.digit_agency deve conter apenas Números Campo bank_given.account excedeu o número máximo de digitos suportado. Campo bank_given.account é obrigatório Campo bank_given.account deve conter apenas Números Campo bank_given.digit_account deve conter apenas Números Campo bank_given.bank_account_type_id é obrigatório Campo bank_given.bank_account_type_id deve conter apenas Números Campo bank_given.bank_account_type_id é Inválido Campo bank_given.bank_id é obrigatório Campo bank_given.bank_id deve conter apenas Números Campo bank_given.bank_id é Inválido Campo bank_given.holder_type_id é obrigatório Campo bank_given.holder_type_id deve conter apenas Números Campo bank_given.holder_type_id é Inválido Sub Adquirente já cadastrado Para o tipo de titular selecionado, não é permitido o envio dos dados do mesmo Para o tipo de titular selecionado, é necessário o envio dos dados do mesmo
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR POR ID
/sub_acquirers/{id}

Detalhes

Ao chamar a API realiza listagem de um único Sub Adquirente

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ATUALIZAÇÃO
/sub_acquirers/{id}

Detalhes

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	CNPJ, COMMERCIAL_NAME, LINK_EC, SOCIAL_REASON, BANK_GIVEN_TYPE_ID, CODE_FACILITATOR_ELO, CPF, NAME, LAST_NAME, RG, CEP, ADDRESS, NUMBER, DISTRICT, CITY, STATE_ID, COUNTRIE_ID, COMPLEMENT, CONTACT_TYPE_ID, CONTACT_NAME, VALUE, BANK_ACCOUNT_TYPE_ID, BANK_ID, AGENCY, DIGIT_AGENCY, ACCOUNT, DIGIT_ACCOUNT, OPERATOR_COMPANIE_ID, NUMBER_CARD, PRINTED_NAME, CPF, BANK_HOLDER_TYPE_ID
Body	{ "code_facilitator_elo" : "33", "link_ec" : "http://www.portalec.com.br", "commercial_name" : "Nome comercial Atualizado", "company" : { "name": "Nome Atualizado", "last_name": "Sobrenome Atualizado", "rg": "21312", "document": "57722600069", "company_details":{ "social_reason":"Nome Atualizado", "document":"45011462000142", } }, "localization" : { "cep": "77006-660", "address": "Quadra 508 Norte Alameda 3 Atualizado", "number": "321", "district": "Plano Diretor Norte", "city": "Palmas", "state_id": "1", "countrie_id": "1", "complement": "Casa" }, "contacts" : [{ "contact_type_id": "2", "name": "João", "value": "atualizado@hotmail.com" }, { "contact_type_id": "2", "name": "Maria", "value": "933445566" }], "bank_given" : { "bank_account_type_id": "1", "holder_type_id": "4", "bank_id": "1", "agency": "0364", "digit_agency": "4", "account": "0615869", "digit_account": "2" } }

Retornos

Código	Mensagem
200	OK
401	Campo commercial_name é obrigatório O Tamanho Máximo para o campo commercial_name é de 255 caracteres Campo link_ec é obrigatório O Tamanho Máximo para o campo link_ec é de 255 caracteres Campo company.name é obrigatório O Tamanho Máximo para o campo company.name é de 255 caracteres Campo company.last_name é obrigatório O Tamanho Máximo para o campo company.last_name é de 255 caracteres Campo company.rg é obrigatório O Tamanho Máximo para o campo company.rg é de 255 caracteres Campo company.document é obrigatório Campo company.document é Inválido Campo company.city_insc deve conter apenas Números O Tamanho Máximo para o campo company.city_insc é de 255 caracteres Campo company.state_insc deve conter apenas Números O Tamanho Máximo para o campo company.state_insc é de 255 caracteres Campo localization.cep é obrigatório Campo localization.cep é Inválido Campo localization.address é obrigatório O Tamanho Máximo para o campo localization.address é de 255 caracteres Campo localization.number é obrigatório Campo localization.number deve conter apenas Números Campo localization.district é obrigatório O Tamanho Máximo para o campo localization.district é de 255 caracteres Campo localization.city é obrigatório O Tamanho Máximo para o campo localization.city é de 255 caracteres Campo localization.state_id deve conter apenas Números Campo localization.state_id é Inválido Campo localization.countrie_id deve conter apenas Números Campo localization.countrie_id é Inválido localization.complement O Tamanho Máximo para o campo localization.complement é de 255 caracteres Campo company.company_details.branch_type_id é Inválido Campo company.company_details.branch_type_id é obrigatório Campo company.company_details.document é obrigatório Campo company.company_details.document é Inválido Campo company.company_details.social_reason é obrigatório O Tamanho Máximo para o campo company.company_details.social_reason é de 255 caracteres Campo bank_given.agency é obrigatório Campo bank_given.agency deve conter apenas Números Campo bank_given.digit_agency deve conter apenas Números Campo bank_given.account excedeu o número máximo de digitos suportado. Campo bank_given.account é obrigatório Campo bank_given.account deve conter apenas Números Campo bank_given.digit_account deve conter apenas Números Campo bank_given.bank_account_type_id é obrigatório Campo bank_given.bank_account_type_id deve conter apenas Números Campo bank_given.bank_account_type_id é Inválido Campo bank_given.bank_id é obrigatório Campo bank_given.bank_id deve conter apenas Números Campo bank_given.bank_id é Inválido Campo bank_given.holder_type_id é obrigatório Campo bank_given.holder_type_id deve conter apenas Números Campo bank_given.holder_type_id é Inválido Sub Adquirente não existente Não é possível alterar o documento Sub Adquirente já cadastrado Para o tipo de titular selecionado, não é permitido o envio dos dados do mesmo Para o tipo de titular selecionado, é necessário o envio dos dados do mesmo
402	Token não encontrado. Token expirado. Token é inválido.
406	Verifique os dados e tente novamente
500	Houve um erro interno

DELETE

DELETAR
/sub_acquirers/{id}

Detalhes

Ao chamar a API deleta o Sub Adquirente desejado

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Tarifa Adicional

GET

LISTAGEM DE ESTABELECIMENTOS
additional_tariffs

Detalhes

Aqui, poderemos basicamente visualizar todos os estabelecimentos para realizar manutenção de tarifas adicionais para o mesmo

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM DE ESTABELECIMENTO ESPECÍFICO
additional_tariffs/{id}

Detalhes

Aqui, poderemos basicamente visualizar o estabelecimento selecionado e atrelar novas tarifas ao mesmo

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
401	Estabelecimento não encontrado
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

DELETE

REMOVER TARIFA DE ESTABELECIMENTO
additional_tariffs/{id}

Detalhes

Função utilizada para remover tarifas personalizadas adicionadas ao estabelecimento (ela não pode ter sido paga, caso contrário, retornará que não será possível exclui-la;)

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
401	Tarifa já foi excluída. Não é possível remover uma tarifa já paga.
500	Houve um erro interno

PUT

ADIÇÃO DE TARIFAS PERSONALIZADAS
additional_tariffs/{id}

Detalhes

Com essa função, atrelaremos tarifas a um estabelecimento.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	VALUE, DESCRIPTION, EXPIRY_DATE, TARIFF_ID
Body	{ "value" : "1200.00", "description" : "Tarifa Adicional por manutenção", "tariff_id" : "6", "expiry_date" : "2019-12-12" }

Retornos

Código	Mensagem
200	OK
401	O campo [:field] é obrigatório O campo [:field] é inválido O campo [:field] deve conter apenas números O Tamanho Máximo para o campo [:field] é de [:quantity] caracteres Estabelecimento não existente Tarifa não encontrada Somente tarifas eventuais podem ser adicionais
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Tarifa Estabelecimento

GET

LISTAR ESTABELECIMENTOS COM TARIFAS
/establishment_tariffs

Detalhes

Ao realizar a chamada, teremos uma resposta da API com uma lista com os Estabelecimentos cadastrados com tarifas para eles.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAR TARIFAS DO ESTABELECIMENTO
/establishment_tariffs/{id}

Detalhes

Ao realizar a chamada, teremos uma resposta da API com uma lista com as tarifas cadastradas para o Estabelecimento escolhido.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ADICIONAR / ATUALIZAR TARIFA ESTABELECIMENTO
/establishment_tariffs/{id}

Detalhes

Ao chamar a API realiza a adição ou atualização da tarifa para o Estabelecimento.

Parâmetros

Required	REASON
Body	{ "type_change_id" : "2", "tariff_id" : "2", "value_change" : "8765.45", "ecommerce_change" : "0.00" }

Retornos

Código	Mensagem
200	OK
401	Estabelecimento não encontrado Estabelecimento não está aguardando uma aprovação Houve um erro ao integrar ao serviço OFAC
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

DELETE

DELETAR
/establishment_tariffs/{id}

Detalhes

Ao chamar a API deleta a tarifa do Estabelecimento.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Tarifa Grupo Economico

GET

LISTAR GRUPO ECONOMICO COM TARIFAS
/economic_group_tariff

Detalhes

Ao realizar a chamada, teremos uma resposta da API com uma lista com os Grupos Economicos cadastrados com tarifas para eles.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAR TARIFAS DE GRUPO ECONOMICO
/economic_group_tariff/{id}

Detalhes

Ao realizar a chamada, teremos uma resposta da API com uma lista com as tarifas cadastradas para o Grupo Economico escolhido.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ADICIONAR / ATUALIZAR TARIFA GRUPO ECONOMICO
/economic_group_tariff/{id}

Detalhes

Ao chamar a API realiza a adição ou atualização da tarifa para o Grupo Economico.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	REASON
Body	{ "type_change_id" : "2", "tariff_id" : "2", "value_change" : "8765.45", "ecommerce_change" : "0.00" }

Retornos

Código	Mensagem
200	OK
401	Estabelecimento não encontrado Estabelecimento não está aguardando uma aprovação Houve um erro ao integrar ao serviço OFAC
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

DELETE

DELETAR
/economic_group_tariffs/{id}

Detalhes

Ao chamar a API deleta o a tarifa.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Tarifas

GET

PAGINAÇÃO
/tariffs

Detalhes

Ao chamar a API realiza paginação da tarifa

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAÇÃO
/tariffs

Detalhes

Ao chamar a API realiza a criação da tarifa.
É preciso criar tarifa frequencia.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DESCRIPTION, TYPE, VALUE, FREQUENCY_ID
Body	{ "description" : "4 Parcelas", "complement" : "Brief remark", "tariff_type_id" : "1", "value" : "250.00", "frequency_id" : "1", "franchise_qtd" : "2", "franchise_type_id" : "1", "franchise_rule_id" : "1", "product_id" : "1" }

Retornos

Código	Mensagem
201	CRIADO
401	O Campo description é obrigatório O Tamanho Máximo para o campo description é de 255 caracteres Campo value é obrigatório Campo value deve conter apenas Números Campo frequency_id é obrigatório Campo frequency_id deve conter apenas Números O Tamanho Máximo para o campo frequency_id é de 11 caracteres Campo tariff_type_id é obrigatório Campo tariff_type_id deve conter apenas Números O Tamanho Máximo para o campo tariff_type_id é de 11 caracteres O Tipo tarifa não existe A frequência não existe Para a frequência selecionada, o campo franchise_rule_id não deverá ser enviado. Para a frequência selecionada, o campo franchise_type_id não deverá ser enviado. O tipo de franquia não existe. A regra de franquia não existe.
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR POR ID
/tariffs/{id}

Detalhes

Ao chamar a API realiza listagem de uma única tarifa

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ATUALIZAÇÃO
/tariffs/{id}

Detalhes

Ao chamar a API recebe os dados da tarifa e realiza a atualização

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DESCRIPTION, TYPE, VALUE, FREQUENCY_ID
Body	{ "description" : "Administração", "complement" : "8 Parcelas", "tariff_type_id" : "1", "value" : "50.00", "frequency_id" : "1", "franchise_qtd" : "2", "franchise_type_id" : "1", "franchise_rule_id" : "1", "product_id" : "1" }

Retornos

Código	Mensagem
200	OK
401	O Campo description é obrigatório O Tamanho Máximo para o campo description é de 255 caracteres Campo value é obrigatório Campo value deve conter apenas Números Campo frequency_id é obrigatório Campo frequency_id deve conter apenas Números O Tamanho Máximo para o campo frequency_id é de 11 caracteres Campo tariff_type_id é obrigatório Campo tariff_type_id deve conter apenas Números O Tamanho Máximo para o campo tariff_type_id é de 11 caracteres O Tipo tarifa não existe A frequência não existe
402	Token não encontrado. Token expirado. Token é inválido.
406	Verifique os dados e tente novamente
500	Houve um erro interno

DELETE

DELETAR
/tariffs/{id}

Detalhes

Ao chamar a API deleta a tarifa desejada

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Termos de Uso

GET

LISTAR TERMOS DE USO
/terms

Detalhes

Ao realizar a chamada, a API irá apresentar os Termos de Uso do sistema.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

EDITAR TERMOS DE USO
/terms

Detalhes

Ao realizar a chamada, a API irá realizar a edição dos Termos de Uso do sistema, com os dados informados.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "description" : "Terms of use DOCUMENTAÇÃO" }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Transacoes

POST

GERAÇÃO DE TRANSAÇÃO
/transactions

Detalhes

A geração de transações consiste numa combinação de dados enviados a mesma rota.

Para gerar uma transação COMUM, é necessário enviar o campo transaction_type_id = 2, e existem regras de validação de acordo com o meio de pagamento. ( Caso seja débito, por exemplo, o campo installments não pode ser MAIOR que 1, porque o meio de pagamento não permite parcelamento ) - O meio de pagamento é carregado de acordo com o PRODUTO

Para uma transação de CANCELAMENTO, ou DESFAZIMENTO, é necessário enviar o campo transaction_type_id 6 ou 7 respectivamente, e também enviar o ID de integração da transação no campo transaction_canceled_id.

Existem Regras de validação, do tipo : A transação financeira, não aceita o campo transaction_canceled_id, devido a ser uma transação financeira, e não uma de cancelamento, ou desfazimento.

Na geração das parcelas, é importante ressaltar que é levado em consideração finais de semana e feriados para geração da data de vencimento das mesmas.

A Data, enviada no campo DATE é levada em consideração como base para calculo de todas as datas relacionadas a transação gerada, no caso de enviar uma data no exemplo do dia 2019-01-01 22:00:00, a mesma será utilizada para base na geração das parcelas, ou seja, as parcelas serão geradas a partir do dia 1º de Janeiro de 2019, de acordo com as regras específicadas. O mesmo também se aplica no desfazimento e cancelamento que utilizará a data enviada para preencher as datas de cancelamento da transação e suas parcelas.

As transações de CANCELAMENTO ou DESFAZIMENTO, também geram uma parcela, mas a mesma já será gerada como CANCELADA, apenas para controle.

Para as Transações dos estabelecimento que possuem o split configurado do tipo ORIGEM, o campo "estab_split" deverá ser preenchido com o documento para qual o estabelecimento deseja splitar.

Exportar Produtos

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DOCUMENT, ORIGINATOR, ACQUIRER_ID, PRODUCT_ID, ENTRY_MODE_ID, TRANSACTION_TYPE_ID, CAPTURE_METHOD_ID, TERMINAL_IDENTIFICATION, CARD_NUMBER, AMOUNT, INSTALLMENTS, NSU, AUTHORIZATION, INTEGRATION_TRANSACTION_ID, DATE
Body	{ "document" : "45246008177", "estab_split" : "29820019699", "originator" : "ADIQ", "capture_method_id" : "2", "entry_mode_id" : "2", "terminal_identification" : "10283102381", "acquirer_id" : "1", "card_number" : "000589916XXXXXX0487", "product_id" : "1", "amount" : "1200.00", "installments" : "9", "authorization" : "1203", "integration_transaction_id" : "7", "transaction_type_id" : "7", "transaction_canceled_id" : "6", "nsu" : "00010856445", "date" : "2019-09-24 23:00:00", "additional_info" : "Campo informação adicional" }

Retornos

Código	Mensagem
200	OK
401	*Valdações Básicas* Campo [:field] é obrigatório O Tamanho Mínimo para o campo [:field] é de [:number] caracteres O Tamanho Máximo para o campo [:field] é de [:number] caracteres O campo [:field] deve conter apenas números *Validação de Integridade* Estabelecimento não existente Estabelecimento não está liberado para gerar Transações Produto inválido Não é permitido manipular a identificação de uma transação Meio de Pagamento inválido Numero de parcelas é menor do que o permitido para esse meio de pagamento Numero de parcelas é maior do que o permitido para esse meio de pagamento Tipo de transação inválida Meio de captura inválido Meio de Entrada inválido Campo date é Inválido Para esse tipo de transação, não é permitido envio do campo transaction_canceled_id O campo transaction_canceled_id é obrigatório para realizar o cancelamento Não é permitido cancelar uma transação que está sendo enviada Transação Original não encontrada Não é possível realizar um cancelamento de um cancelamento Não é possível realizar um chargeback de um chargeback Não é possível realizar um desfazimento de um desfazimento
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

PAGINAÇÃO TRANSAÇÕES
transactions

Detalhes

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/transactions?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

A API requer a inclusão de pelo menos um filtro para realizar consultas. Os parâmetros de filtro devem ser passados na URL por meio do método GET. Utilize o formato de array filters[chave] = VALOR_BUSCADO. Para adicionar filtros adicionais, empregue o operador "&".

Id de Estabelecimento - filters[establishment_id]
CNPJ Estabelecimento - filters[cnpj]
CPF Estabelecimento - filters[cpf]
Id de Transação - filters[id]
Nº de Parcelas - filters[installments]
Produto - filters[product_id]
Tipo da Transação - filters[transaction_type_id]
Originador - filters[originator]
Autorização - filters[authorization]
Número de Cartão - filters[card_number]
Método Captura - filters[capture_method_id]
Meio de Entrada - filters[entry_mode_id]
Data da Integração - filters[created_at]
Data de Transação (Período Inicial) - filters[transaction_initial_date]
Data de Transação (Período Final) - filters[transaction_final_date]
ID Parcela - filters[installment_id]
Situação da Parcela - filters[installment_situation_id]
Status da Parcela - filters[installment_status_id]
Data de vencimento da parcela (Período Inicial) - filters[installment_inital_expiry_date]
Data de vencimento da parcela (Período Final) - filters[installment_final_expiry_date]

O Número total de registros + a soma de todos os valores das transações são retornados nessa mesma consulta no seguintes parâmetros : total_items + amount

Exemplo de requisição

Requisicao	/transactions?page=1&filters[establishment_id]=1&filters[transaction_initial_date]=2024-02-12&filters[transaction_final_date]=2024-03-12

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Transacoes nao integradas

GET

LISTAGEM
/integration_transactions_errors

Detalhes

Ao realizar a chamada, teremos uma resposta da API retornando 10 últimos registros devido a paginação. (a Paginação é parametrizada no sistema, então ela irá variar de acordo com o parametrizado pelo administrador)
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/integration_transactions_errors ?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.

Para carregar as parcelas, basta usar a rota /ajax/transaction/{id_transacao} - Próxima rota da documentação.

Filtros

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

BUSCAR POR ID
/integration_transactions_errors/file_row/{id}

Detalhes

Ao chamar a API busca o detalhe das Transações

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Usuarios

GET

PAGINAÇÃO
/users

Detalhes

Ao chamar a API realiza a paginação do usuário

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAÇÃO
/users

Detalhes

Ao chamar a API realiza a criação do usuário

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	NAME, CPF, EMAIL, PASSWORD
Body	{ "name" : "Nome", "cpf" : "99818032004", "telephone" : "999999999", "email" : "email@email.com", "password" : "senha" }

Retornos

Código	Mensagem
201	CRIADO
401	O campo name é obrigatório O tamanho mínimo para o campo name é de 3 caracteres O Tamanho Máximo para o campo name é de 255 caracteres O campo cpf é obrigatório O registro cpf já está cadastrado no banco Campo cpf é Inválido O campo email é obrigatório O registro email já está cadastrado no banco Campo email é Inválido
402	Token não encontrado. Token expirado. Token é inválido.
406	Verifique os dados e tente novamente
500	Houve um erro interno

GET

BUSCAR POR ID
/users/{id}

Detalhes

Ao chamar a API realiza listagem de um único usuário em API

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ATUALIZAÇÃO
/users/{id}

Detalhes

Ao chamar a API recebe os dados do usuário e realiza a atualização

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	NAME, CPF, EMAIL, PASSWORD
Body	{ "name" : "Nome", "cpf" : "99818032004", "telephone" : "888888888", "status_id" : "1", "email" : "novoemail@email.com" }

Retornos

Código	Mensagem
200	OK
401	O campo name é obrigatório. O tamanho mínimo para o campo name é de 3 caracteres. É impossível alterar o cpf O campo email é obrigatório. O registro email já está cadastrado no banco. Email inválido.
402	Token não encontrado. Token expirado. Token é inválido.
406	Verifique os dados e tente novamente
500	Houve um erro interno

DELETE

DELETAR
/users/{id}

Detalhes

Ao chamar a API deleta o usuário

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM USUARIOS PEC
/users_pec

Detalhes

Ao chamar a API realiza a paginação do usuário

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAÇÃO DE USUÁRIO PEC
/users_pec

Detalhes

Ao chamar a API realiza a criação do usuário

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	NAME, CPF, EMAIL, PASSWORD, LINK, TYPE_ID, LOGIN, DOCUMENT, PROFILE_ID
Body	{ "link" : "http://teste.com.br", "name" : "Nome", "cpf" : "99818032004", "telephone" : "999999999", "email" : "email@email.com", "password" : "senha", "type_id" : "2", "login" : "exemplo", "document" : "000.000.000-00", "profile_id" : "1" }

Retornos

Código	Mensagem
201	CRIADO
401	O campo name é obrigatório O tamanho mínimo para o campo name é de 3 caracteres O Tamanho Máximo para o campo name é de 255 caracteres O campo cpf é obrigatório O registro cpf já está cadastrado no banco Campo cpf é Inválido O campo email é obrigatório O registro email já está cadastrado no banco Campo email é Inválido
402	Token não encontrado. Token expirado. Token é inválido.
406	Verifique os dados e tente novamente
500	Houve um erro interno

GET

BUSCAR USUÁRIO PEC POR ID
/users_pec/{id}

Detalhes

Ao chamar a API realiza listagem de um único usuário em API

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ATUALIZAÇÃO DE USUÁRIO PEC
/users_pec/{id}

Detalhes

Ao chamar a API recebe os dados do usuário e realiza a atualização

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	NAME, CPF, EMAIL, PASSWORD, LINK, TYPE_ID, LOGIN, DISTRIBUTOR_ID, PROFILE_ID
Body	{ "link" : "http://teste.com.br", "name" : "Nome", "cpf" : "99818032004", "telephone" : "999999999", "email" : "email@email.com", "password" : "senha", "type_id" : "4", "login" : "exemplo", "distributor_id" : "1", "profile_id" : "2" }

Retornos

Código	Mensagem
200	OK
401	O campo name é obrigatório. O tamanho mínimo para o campo name é de 3 caracteres. É impossível alterar o cpf O campo email é obrigatório. O registro email já está cadastrado no banco. Email inválido.
402	Token não encontrado. Token expirado. Token é inválido.
406	Verifique os dados e tente novamente
500	Houve um erro interno

DELETE

DELETAR USUÁRIO PEC
/users_pec/{id}

Detalhes

Ao chamar a API deleta o usuário

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM USUARIOS PD
/users_pd

Detalhes

Ao chamar a API realiza a paginação do usuário

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAÇÃO DE USUÁRIO PD
/users_pd

Detalhes

Ao chamar a API realiza a criação do usuário

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	NAME, CPF, EMAIL, PASSWORD, LINK, TYPE_ID, LOGIN, DISTRIBUTOR_ID, PROFILE_ID
Body	{ "link" : "http://teste.com.br", "name" : "Nome", "cpf" : "99818032004", "telephone" : "999999999", "email" : "email@email.com", "password" : "senha", "type_id" : "4", "login" : "exemplo", "distributor_id" : "1", "profile_id" : "2" }

Retornos

Código	Mensagem
201	CRIADO
401	O campo name é obrigatório O tamanho mínimo para o campo name é de 3 caracteres O Tamanho Máximo para o campo name é de 255 caracteres O campo cpf é obrigatório O registro cpf já está cadastrado no banco Campo cpf é Inválido O campo email é obrigatório O registro email já está cadastrado no banco Campo email é Inválido
402	Token não encontrado. Token expirado. Token é inválido.
406	Verifique os dados e tente novamente
500	Houve um erro interno

GET

BUSCAR USUÁRIO PD POR ID
/users_pd/{id}

Detalhes

Ao chamar a API realiza listagem de um único usuário em API

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
206	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ATUALIZAÇÃO DE USUÁRIO PD
/users_pd/{id}

Detalhes

Ao chamar a API recebe os dados do usuário e realiza a atualização

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	NAME, CPF, EMAIL, PASSWORD, LINK, TYPE_ID, LOGIN, DOCUMENT, PROFILE_ID
Body	{ "link" : "http://teste.com.br", "name" : "Nome", "cpf" : "99818032004", "telephone" : "999999999", "email" : "email@email.com", "password" : "senha", "type_id" : "2", "login" : "exemplo", "document" : "000.000.000-00", "profile_id" : "1" }

Retornos

Código	Mensagem
200	OK
401	O campo name é obrigatório. O tamanho mínimo para o campo name é de 3 caracteres. É impossível alterar o cpf O campo email é obrigatório. O registro email já está cadastrado no banco. Email inválido.
402	Token não encontrado. Token expirado. Token é inválido.
406	Verifique os dados e tente novamente
500	Houve um erro interno

DELETE

DELETAR USUÁRIO PD
/users_pd/{id}

Detalhes

Ao chamar a API deleta o usuário

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno