Documentação

Versão: homolog_1.5.0

Adquirente

GET

LISTAGEM
/acquirers

Detalhes

Ao realizar a chamada, teremos uma resposta da API retornando 10 últimos registros de Adquirentes 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/acquirers?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

Caso não queira filtrar por algum dos campos abaixo, apenas apague a linha do campo dentro do objeto filters.

Id de Adquirente - filters[nsu] / Tipo de dado: Integer
Nome Comercial - filters[commercial_name] / Tipo de dado: String
Documento CNPJ - filters[companies.company_details.document] / Tipo de dado: String
Status - filters[companies.status_id] / Tipo de dado: Integer

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "nsu": "null", "commercial_name": "null", "companies.company_details.document": "null", "companies.status_id": "null", } }

Retornos

Código	Mensagem
200	EXEMPLO: "data":{ "data":[ { "id": 1, Tipo Integer "commercial_name": "Carla e Daniel Assessoria Jurídica ME", Tipo String / Nome comercial "company_id": 12, Tipo Integer / Id do company adquirente "created_at": "2021-09-29 12:30:03", Tipo Date "updated_at": "2021-12-07 08:36:27", Tipo Date "code_establishment": "1", Tipo Integer / Codigo de estabelecimento "path_edi": null, Tipo String / Caminho do edi "financial_status_id": 1, Tipo Integer / Id do status de financeiro "anticipation_type_id": 1, Tipo Integer / Id do tipo de antecipação "required_document": 1, Tipo Integer / Id do status de documento "company": { "id": 12, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { "id": 9, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do adquirente "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date }, "status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "localization": { "id": 12, Tipo Integer "company_id": 45, Tipo Integer / Id do company do adquirente "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "contact": [ { "id": 5, Tipo Integer "company_id": 5, Tipo Integer / Id do company do adquirente "contact_type_id": 1, Tipo Integer / Id do tipo de contato "name": "jacqueline", Tipo String / Nome "value": "11988808096", Tipo String / Telefone ou Email "created_at": "2022-06-13 09:16:38", Tipo Date "updated_at": "2022-06-13 09:16:38", Tipo Date "contact_type": { "id": 1, Tipo Integer "description": "Celular", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ] }, "company_anticipation": [ { "id": 3, Tipo Integer "company_id": 12, Tipo Integer / Id do company do adquirente "period": 30, Tipo Integer / Periodo de dias "amount": "10.50", Tipo Decimal / Valor "date_initial": "2021-11-30", Tipo Date / Data inicial "tariff_type_id": 2, Tipo Integer / Id do tipo de tarifa "created_at": "2021-11-29 07:41:09", Tipo Date "updated_at": "2021-11-29 07:41:09", Tipo Date "method_id": 1, Tipo Integer / Id do metodo } ], "company_anticipation_ecommerce": [ { "id": 4, Tipo Integer "company_id": 12, Tipo Integer / Id do company adquirente "period": 30, Tipo Integer / Periodo de dias "amount": "10.50", Tipo Decimal / Valor "date_initial": "2021-11-30", Tipo Date / Data inicial "tariff_type_id": 2, Tipo Integer / Id do tipo de tarifa "created_at": "2021-11-29 07:41:09", Tipo Date "updated_at": "2021-11-29 07:41:09", Tipo Date "method_id": 1, Tipo Integer / Id do metodo } ], "vigencies": [ { "id": 1, Tipo Integer "vigency": "2019-01-01", Tipo Date / Data de vigencia "acquirer_id": 1, Tipo Integer / Id do adquirente "created_at": "2022-06-02 14:49:54", Tipo Date "updated_at": "2022-06-02 14:49:54" Tipo Date } ] } ] }
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.

Tipo de Dado
ID: Integer
commercial_name: String
code_establishment:Integer
social_reason: String
document: String
cep: String
address: String
number: String
district: String
city: String
state_id: Integer
countrie_id: Integer
complement: String
contact_type_id: Integer
name: String
value: String

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" : "Código do estabelecimento", "company" : { "name": "Nome", "last_name":"Ultimo nome", "rg":"RG", "nationality":"Nacionalidade", "telephone":"Telefone", "email":"E-mail", "birth":"Data de nascimento", "document":"Documento", "bank_given_type_id": "Tipo de conta bancaria", "people_type_id": "Tipo pessoa, fisica ou jiridica", "company_details": { "social_reason": "Razão social", "document": "documento", "cnpj_matriz":"CNPJ da matriz", "branch_type_id": "Id do tipo da empresa (1 - Matriz, 2 - Filial)" } }, "localization" : { "cep": "CEP", "address": "Rua", "number": "Numero", "district": "Distrito", "city": "Cidade", "state_id": "Id do Estado", "countrie_id": "Id do Pais", "complement": "Complemento" }, "contacts" : [{ "contact_type_id": "Id do tipo de contato", "name": "nome", "value": "O contato em si (Numero de telefone ou e-mail de acordo com o tipo selecionado)" }] }

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.

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
206	{ "id": 1, Tipo Integer "commercial_name": "Carla e Daniel Assessoria Jurídica ME", Tipo String / Nome comercial "company_id": 12, Tipo Integer / Id do company do adquirente "created_at": "2021-09-29 12:30:03", Tipo Date "updated_at": "2021-12-07 08:36:27", Tipo Date "code_establishment": "1", Tipo Integer / Codigo de estabelecimento "path_edi": null, Tipo String / Caminho do edi "financial_status_id": 1, Tipo Integer / Id do status de financeiro "anticipation_type_id": 1, Tipo Integer / Id do tipo de antecipação "required_document": 1, Tipo Integer / Id do status de documento "company": { "id": 12, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { "id": 9, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do adquirente "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date }, "status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "localization": { "id": 12, Tipo Integer "company_id": 45, Tipo Integer / Id do company do adquirente "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "contact": [ { "id": 5, Tipo Integer "company_id": 5, Tipo Integer / Id do company do adquirente "contact_type_id": 1, Tipo Integer / Id do tipo de contato "name": "jacqueline", Tipo String / Nome "value": "11988808096", Tipo String / Telefone ou Email "created_at": "2022-06-13 09:16:38", Tipo Date "updated_at": "2022-06-13 09:16:38", Tipo Date "contact_type": { "id": 1, Tipo Integer "description": "Celular", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ] }, "company_anticipation": [ { "id": 3, Tipo Integer "company_id": 12, Tipo Integer / Id do company do adquirente "period": 30, Tipo Integer / Periodo de dias "amount": "10.50", Tipo Decimal / Valor "date_initial": "2021-11-30", Tipo Date / Data inicial "tariff_type_id": 2, Tipo Integer / Id do tipo de tarifa "created_at": "2021-11-29 07:41:09", Tipo Date "updated_at": "2021-11-29 07:41:09", Tipo Date "method_id": 1, Tipo Integer / Id do metodo } ], "company_anticipation_ecommerce": [ { "id": 4, Tipo Integer "company_id": 12, Tipo Integer / Id do company do adquirente "period": 30, Tipo Integer / Periodo de dias "amount": "10.50", Tipo Decimal / Valor "date_initial": "2021-11-30", Tipo Date / Data inicial "tariff_type_id": 2, Tipo Integer / Id do tipo de tarifa "created_at": "2021-11-29 07:41:09", Tipo Date "updated_at": "2021-11-29 07:41:09", Tipo Date "method_id": 1, Tipo Integer / Id do metodo } ], "period": [], "vigencies": [ { "id": 1, Tipo Integer "vigency": "2019-01-01", Tipo Date / Data de vigencia "acquirer_id": 1, Tipo Integer / Id do adquirente "created_at": "2022-06-02 14:49:54", Tipo Date "updated_at": "2022-06-02 14:49:54" Tipo Date } ] }
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.

Tipo de Dado
ID: Integer
commercial_name: String
code_establishment: Integer
social_reason: String
document: String
cep: String
address: String
number: String
district: String
city: String
state_id: Integer
countrie_id: Integer
complement: String
contact_type_id: Integer
name: String
value: String

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" : "Codigo do estabelecimento", "company" : { "name": "Nome", "last_name":"Ultimo nome", "rg":"RG", "nationality":"Nacionalidade", "telephone":"Telefone", "email":"E-mail", "birth":"Data de nascimento", "document":"Documento", "bank_given_type_id": "Tipo de conta bancaria", "people_type_id": "Tipo pessoa, fisica ou jiridica", "company_details": { "social_reason": "Razão social", "document": "documento", "cnpj_matriz":"CNPJ da matriz", "branch_type_id": "Id do tipo da empresa (1 - Matriz, 2 - Filial)" } }, "localization" : { "cep": "CEP", "address": "Rua", "number": "Numero", "district": "Distrito", "city": "Cidade", "state_id": "Id do Estado", "countrie_id": "Id do Pais", "complement": "Complemento" }, "contacts" : [{ "contact_type_id": "Id do tipo de contato", "name": "nome", "value": "O contato em si (Numero de telefone ou e-mail de acordo com o tipo selecionado)" }] }

Retornos

Código	Mensagem
200	{ "id": 1, Tipo Integer "commercial_name": "Carla e Daniel Assessoria Jurídica ME", Tipo String "company_id": 12, Tipo Integer / Id do company do adquirente "created_at": "2021-09-29 12:30:03", Tipo Date "updated_at": "2021-12-07 08:36:27", Tipo Date "code_establishment": "1", Tipo Integer / Codigo de estabelecimento "path_edi": null, Tipo String / Caminho do edi "financial_status_id": 1, Tipo Integer / Id do status de financeiro "anticipation_type_id": 1, Tipo Integer / Id do tipo de antecipação "required_document": 1, Tipo Integer / Id do status de documento "company": { "id": 12, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { "id": 9, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do adquirente "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date }, } }
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

Tipo de Dado
ID: Integer

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

Antecipação

get

ALTERAÇÃO DE ESTABELECIMENTO
establishment_automatic_anticipations

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" : "Id do estabelecimento", "anticipation_status_id" : "Id do status de antecipação" }

Retornos

Código	Mensagem
200	{ "data": null, "msg": [ "OK" ], "statusCode": 200 }
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

GET

BUSCA DE PARCELAS
establishment_automatic_anticipations/{id}

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

Tipo de Dado
document: String
date: Date

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DOCUMENT, DATE
Body	{ "document" : "Documento do estabelecimento", "date" : "Data de antecipação" }

Retornos

Código	Mensagem
200	{ "received_val": 0, Tipo Decimal / Valor a receber "admin_tariff": { "tarif_estab": "0", Tipo Decimal / Valor da tarifa do estabelecimento "tariff_type": 2, Tipo Integer / Tipo de tarifa "nameEC": "Xampson", Tipo String / Nome "documentEC": "22228816507", Tipo String / Documento "document": "22228816507", Tipo String / Documento "people_type_id": 1, Tipo Integer / Id do tipo de pessoa "tariff_calculate": 0 Tipo Decimal / Tarifa calculada }, "data": { "data": [ { "id": 314, "transaction_id": 134, Tipo Integer / Id da transação "amount": "1000.00", Tipo Decimal / Valor "number": 1, Tipo Integer / Numero da parcela "situation_id": 2, Tipo Integer / Situação de pagamento da parcela "installment_status_id": 2, Tipo Integer / Id de status da parcela "expiry_date": "2022-02-09", Tipo Date / Data de vencimento da parcela "closing_date": "2022-03-30", Tipo Date / Data de fechamento da parcela "pay_date": "2022-03-30", Tipo Date / Data de pagamento da parcela "cancel_date": null, Tipo Date / Data de cancelamento da parcela "created_at": "2022-01-26 12:26:03", Tipo Date "updated_at": "2022-03-30 08:31:34", Tipo Date "net_amount": "980.54", Tipo Decimal / Valor liquido da parcela "split_amount": "0.00", Tipo Decimal / Valor de split "split_amount_percent": "0.00", Tipo Decimal / Porcentagem de split "conciliation_status_id": null, Tipo Integer / Id do Status de conciliação "expected_payment_date": null, Tipo Date / Data estimada de pagamento "commission": "0.00", Tipo Decimal / Valor da comissão "original_expected_payment_date": null, Tipo Date / Data original de pagamento "adq_anticipation_tax": "0.00", Tipo Decimal / Taxa de antecipação Adquirente "adq_mdr_tax": "0.00", Tipo Decimal / MDR do Adquirente "cerc_status_id": 1, Tipo Integer / Id do status na CERC "job_amount": null, Tipo Decimal "external_code": null, Tipo String / Código externo "proccess_date": null, Tipo String / Data de processamento "liquid_status_id": 1, Tipo Integer / Id do status de liquidação "pgs_code": null, Tipo String / Código pgs "transaction": { "id": 203, "card_number": "000589916XXXXXX0487", Tipo String / Numero do cartão "originator": "ADIQ", Tipo String / Originador "authorization": "007078", Tipo String / Autorização "nsu": "75", Tipo String / Nsu transação "company_id": 9, Tipo Integer / Id do company do estabelecimento "acquirer_id": 1, Tipo Integer / Id do Adquirente "installments": 1, Tipo Integer / Quantidade de Parcelas "amount": "1000.00", Tipo Decimal / Valor "terminal_identification": "6N281051", Tipo String / Identificação do terminal "capture_method_id": 1, Tipo Integer / Metodo de captura "product_id": 1, Tipo Integer / Id do Produto "transaction_type_id": 2, Tipo Integer / Id do tipo de transação "integration_transaction_id": "75", Tipo Integer / Id da transação integrada "transaction_canceled_id": null, Tipo Integer / Id do cancelamento da transação "date": "2022-01-26 13:45:43", Tipo Date "created_at": "2022-01-26 12:26:03", Tipo Date "updated_at": "2022-01-26 12:26:03", Tipo Date "entry_mode_id": 2, Tipo Integer / Id do meio de entrada "integration_transaction_id_2": "75", Tipo Integer / Id da transação integrada "distributor_id": 1, Tipo Integer / Id do Distribuidor "preposterou_id": 1, Tipo Integer / Id do Preposto "last_import": null, / Ultima data que foi importado "attempt": 0, Tipo Integer / Tentativas "integration_status_id": 2, Tipo Integer // Id do status de integração "cerc_status_id": 2, Tipo Integer / Id do status na CERC "external_identificator": null, Tipo String / Indentificação externa "liquid_amount": null, Tipo Decimal / Valor liquido "return_tax": null, Tipo Decimal / Taxa de retorno "service_type_id": 2, Tipo Integer / Id do tipo de serviço "alias": null, Tipo String "additional_info": null, Tipo String / Informação adicional "proccess_date": null, Tipo Date / Data de processamento "identificator": null, Tipo String / identificador "pgs_code": null, Tipo String / Código pgs "received_edi": "N", Tipo String "capture_method": { "id": 1, "description": "POS", / Descrição "tariff_column": "value", "created_at": null, "updated_at": "2021-09-29 11:47:43" }, "company": { "id": 9, "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "establishment": { "id": 1, Tipo Integer "commercial_name": "Xampson", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão } }, "product": { "id": 7, "brand_id": 2, Tipo Integer / Id da bandeira "payment_method_id": 1, Tipo Integer / Id do metodo de pagamento "created_at": null, Tipo Date "updated_at": "2021-09-29 11:47:33", Tipo Date "cip_product_id": 1, Tipo Integer / Id do produto cip "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) } } } ], "paginator": { "current_page": 1, "prev_page": 1, "next_page": 1, "first_page": 1, "is_first_page": true, "last_page": 1, "is_last_page": true, "page_keys": [ 1 ], "from_item": null, "to_item": null, "total_items": 0, "amount": null, / Valor "value": null, "efective": 0, "balance": 0, "low": 0, "manual": 0, "per_page": 10, "display_items": 0 } }, "date": "2022-06-03", "tarif_estab": [], "msg": [ "OK" ], "statusCode": 200 }
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

GET

REALIZAR ANTECIPAÇÃO
establishment_automatic_anticipations/{id}

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.

Tipo de Dado
document: String
date: Date
anticipation_tariff: Integer
installments: Array

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DATE, ANTICIPATION_TARIFF, INSTALLMENTS, DOCUMENT
Body	{ "document" : "Documento do estabelecimento", "people_type_id" : "Id do tipo de pessoa", "page" : "Pagina", "anticipation_tariff" : "Tarifa de antecipação", "date" : "Data", "installments" : ["Id das parcelas a serem antecipadas"], "current_page" : "Pagina atual" }

Retornos

Código	Mensagem
200	{ "document":"22228816507", Tipo String / Documento "people_type_id":"1", Tipo Integer / Id do tipo de pessoa "page":null, Tipo Integer / Pagina "anticipation_tariff":"1", Tipo Integer / Id de status de tarifa de antecipação "date":"2022-06-06", Tipo Date / Data "installments": [ "314" ], "current_page":"1" }
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.

.

Tipo de Dado
document: String
date: Date
anticipation_tariff: Integer

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DATE, ANTICIPATION_TARIFF, DOCUMENT
Body	{ "document" : "Documento do estabelecimento", "date" : "Data", "anticipation_tariff" : "Tarifa de antecipação" }

Retornos

Código	Mensagem
200	{ "data": null, "msg": "Antecipação realizada com sucesso.", "statusCode": 200 }
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

Antecipação Automatica

GET

LISTAGEM DE ESTABELECIMENTOS
/establishment_automatic_anticipations

Detalhes

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

Filtros

Caso não queira filtrar por algum dos campos abaixo, apenas apague a linha do campo dentro do objeto filters.

Documento - filters[document] \ Tipo de Dado: String
Nome Fantasia - filters[commercial_name] \ Tipo de Dado: String
Tipo de Pessoa - filters[companies.people_type_id] \ Tipo de Dado: Integer

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "document": "null", "companies.people_type_id": "null", "commercial_name": / Nome Comercial"null", } }

Retornos

Código	Mensagem
200	Exemplo: { "data": { "data": [ { "id": 17, "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 9, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { "id": 45, "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { "id": 31, "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date } } } ] } }
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.

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
200	EXEMPLO: { "data": { "id": 2, "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 9, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "automatic_anticipations": [ { "id": 2, "establishment_id": 2, Tipo integer / Id do Estabelecimento "economic_group_id": null, Tipo Integer / Id do Grupo econômico "anticipation_application_mode_id": 1, Tipo integer / Tipo de aplicação "anticipation_mode_id": 1, Tipo Integer / Id do modo de aplicação "value": 5, Tipo Integer "created_at": "2022-04-08 09:49:25", "updated_at": "2022-04-08 09:49:25", "mode": { Objeto do tipo "id": 1, "description": "Diário", Tipo String/ Descrição "created_at": null, "updated_at": null }, "application_mode": { Objeto da Forma de aplicação "id": 1, "description": "Mensal", Tipo String/ Descrição "created_at": null, "updated_at": null, }, "establishment": { Objeto do dados do estabelecimento "id": 2, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão } } ] }, "msg": [ "OK" ], "statusCode": 200 }
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_anticipation/{id}

Detalhes

Ao chamar a API Configura a Antecipação Automática.
anticipation_application_mode_id é d Forma de aplicação se é mensal ou parcela, e o anticipation_mode_id é do tipo diario ou mensal e o value é do Prazo (D+)

Tipo de Dado
ID: Integer
anticipation_application_mode_id: Integer
anticipation_mode_id: Integer
value: Integer

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	ANTICIPATION_APPLICATION_MODE_ID, ANTICIPATION_MODE_ID, VALUE
Body	{ "anticipation_application_mode_id" : "Id da forma de aplicação de antecipação automatica", "anticipation_mode_id" : "Id do modelo de antecipação automatica", "value" : "Valor" }

Retornos

Código	Mensagem
200	EXEMPLO: { "data": null, "msg": [ "Regra de antecipação configurada com sucesso" ], "statusCode": 200 }
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

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
200	EXEMPLO: { "data": null, "msg": [ "OK" ], "statusCode": 200 }
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==) }
Body	{ "" : "" }

Retornos

Código	Mensagem
200	EXEMPLO: "data": { "data": [ { "id": 1, "name": "Teste SLG", Tipo String / Nome do Grupo Econômico "code_pos": 1, Tipo Integer / Código POS "code_menu": 2, Tipo Integer / Código menu "created_at": "2021-09-29 12:15:07", "updated_at": "2021-09-29 12:15:07" } ], "paginator": { "current_page": 1, "prev_page": 1, "next_page": 1, "first_page": 1, "is_first_page": true, "last_page": 1, "is_last_page": true, "page_keys": [ 1 ], "from_item": 1, "to_item": 1, "total_items": 1, "amount": null, / Valor "value": null, "efective": 0, "balance": 0, "low": 0, "manual": 0, "per_page": 10, "display_items": 1 } }, "msg": [ "OK" ], "statusCode": 200 }
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 do grupo econômico correspondente ao ID.

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
206	EXEMPLO: { "data": { "id": 1, "name": "Teste SLG", Tipo String / Nome do Grupo Econômico "code_pos": 1, Tipo Integer / Código POS "code_menu": 2, Tipo Integer / Código menu "created_at": "2021-09-29 12:15:07", "updated_at": "2021-09-29 12:15:07" } "msg": [ "OK" ], "statusCode": 200 }
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.

Tipo de Dado
ID: Integer
anticipation_application_mode_id: Integer
anticipation_mode_id: Integer
value: Integer

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	ANTICIPATION_APPLICATION_MODE_ID, ANTICIPATION_MODE_ID, VALUE
Body	{ "anticipation_application_mode_id" : "Id da forma de aplicação de antecipação automatica", "anticipation_mode_id" : "Id do modelo de antecipação automatica", "value" : "Valor" }

Retornos

Código	Mensagem
200	Exemplo: { "data": null, "msg": [ "Regra de antecipação configurada com sucesso" ], "statusCode": 200 }
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.

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
200	EXEMPLO: { "data": null, "msg": [ "OK" ], "statusCode": 200 }
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	EXEMPLO: { "data": { "id": 17, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 9, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "distributor": { "id": 1, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "company_id": 3, Tipo Integer / Id do company do distribuidor "created_at": "2021-09-29 12:03:59", Tipo Date "updated_at": "2021-09-29 12:03:59", Tipo Date "commission_activation": 0, Tipo Integer / Ativação de comissão para o distribuidor "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos }, "mccs": { "id": 76, Tipo Integer "code": "5511", Tipo String / Código do MCC "description": "Carros e Caminhões (Novos e Usados)", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date "type_id": null, Tipo Integer "minimal_balance": null, Tipo Decimal / Saldo minimo "max_post": null, Tipo Decimal / Valor minimo "min_post": null, Tipo Decimal / Valor maximo "period": null Tipo Date / Periodo }, "verification_ofac": { "id": 2, Tipo Integer "description": "Não Checado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "integration": { "id": 1, Tipo Integer "description": "Integrado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "antecipation": { "id": 3, Tipo Integer "description": "Liberado Geral", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "preposterou": { "id": 1, Tipo Integer "distributor_id": 1, Tipo Integer / Id do Distribuidor "company_id": 5, Tipo Integer / Id do company do preposto "created_at": "2021-09-29 12:06:09", Tipo Date "updated_at": "2021-09-29 12:06:09", Tipo Date "name": "Marcos", Tipo String / Nome do Preposto "commission_activation": 0, Tipo Integer / Status de comissão "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos "preposterous_credential_type_id": null Tipo Integer / Tipo de credencial do preposto }, "economic_group": { "id": 1, Tipo Integer "name": "Teste SLG", Tipo String / Nome do Grupo Econômico "code_pos": 1, Tipo String / Código POS "code_menu": 2, Tipo String / Código menu "created_at": "2021-09-29 12:15:07", Tipo Decimal "updated_at": "2021-09-29 12:15:07", Tipo Decimal "automatic_anticipations": [ { "id": 2, Tipo Integer "establishment_id": null, Tipo Integer / Id do Estabelecimento "economic_group_id": 1, Tipo Integer / Id do Grupo Econômico "anticipation_application_mode_id": 1, Tipo Integer / Id do Tipo de aplicação "anticipation_mode_id": 1, Tipo Integer / Id do Modo de aplicação "value": 1, Tipo Integer / Valor "created_at": "2022-06-02 12:52:06", Tipo Date "updated_at": "2022-06-02 12:52:06", Tipo Date "application_mode": { "id": 1, Tipo Integer "description": "Mensal", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "mode": { "id": 1, Tipo Integer "description": "Diário", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ] }, "situation": { "id": 6, Tipo Integer "description": "Aprovado Manualmente", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "product": [ { "id": 1446, Tipo Integer "establishment_id": 3, Tipo Integer / Id do Estabelecimento "product_id": 1, Tipo Integer "created_at": "2022-02-17 15:25:32", Tipo Date "updated_at": "2022-02-17 15:25:32", Tipo Date "product": { "id": 1, Tipo Integer "brand_id": 2, Tipo Integer / Id da bandeira "payment_method_id": 1, Tipo Integer / Id do metodo de pagamento "created_at": null, Tipo Date "updated_at": "2021-09-29 11:47:33", Tipo Date "cip_product_id": 1, Tipo Integer / Id do numero do produto na CIP "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "payment_method": { Objeto "id": 1, Tipo Integer "description": "Crédito rotativo", Tipo String / Descrição "max_installments": 1, Tipo Integer / Maximo de parcelas "min_installments": 1, Tipo Integer / Minimo de parcelas "created_at": null, Tipo Date "updated_at": null, Tipo Date "rules": "default" Tipo String / Regras }, "brand": { Objeto "id": 2, Tipo Integer "name": "Mastercard", Tipo String / Nome "icons": "data:image/png;", Tipo String / Icone "created_at": null, Tipo Date "updated_at": null, Tipo Date "payment": 2 Tipo Integer } } } ], "document": null, Tipo String / Documento "company": { "id": 45, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "localization": { "id": 45, Tipo Integer "company_id": 45, Tipo Integer / Id do company distribuidor "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "contact": [ { "id": 240, Tipo Integer "company_id": 3, Tipo Integer / Id do company do distribuidor "contact_type_id": 1, Tipo Integer / Id do tipo de contato "name": "jacqueline", Tipo String / Nome "value": "11988808096", Tipo String / Telefone ou Email "created_at": "2022-06-13 09:16:38", Tipo Date "updated_at": "2022-06-13 09:16:38", Tipo Date "contact_type": { "id": 1, Tipo Integer "description": "Celular", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ], "detail": { "id": 31, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date "branch_type": { "id": 1, Tipo Integer "description": "Matriz", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "bank_given": { "id": 46, Tipo Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do distribuidor "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer "account_type": { Objeto "id": 1, Tipo Integer "value": "Conta Corrente", Tipo String / Descrição do tipo da conta "created_at": null, Tipo Date "updated_at": null, Tipo Date "code": "CC" Tipo String / Código }, "holder_type": { Objeto "id": 2, Tipo Integer "value": "Pessoa Jurídica - Empresa", Tipo String / Descrição do tipo de documento representante "abbreviation": "PJE", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank": { Objeto "id": 340, Tipo Integer "code": "X1X", Tipo String / Código do banco "name": "CONTA INTERNA", Tipo String / Nome do banco "ispb": "00000000", Tipo String / Ispb do banco "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:07", Tipo Date "ispb_code": null Tipo String / Código ispb }, }, "bank_given_type": { "id": 1, Tipo Integer "value": "Conta Bancária", Tipo String / Descrição do tipo da conta "abbreviation": "CB", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null, Tipo Date "status_id": 1 / Id do Status (1 - Ativo, 2 - Inativo) }, "people_type": { "id": 2, Tipo Integer "name": "Pessoa Jurídica", Tipo String / Nome "abbreviation": "PJ", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "internal_parameter": { "id": 4, Tipo Integer "max_amount_day": "9999.00", Tipo Decimal / Valor maximo diario "max_amount": "99999999.00", Tipo Decimal / Valor maximo "quantity_operator_day": 1000, Tipo Decimal / Quantidade maxima de operações diarias "created_at": "2022-03-20 17:43:09", Tipo Date "updated_at": "2022-03-20 17:43:09", Tipo Date "establishment_id": 17 Tipo Integer / Id do Estabelecimento }, "father": [ { "id": 1, Tipo Integer "father_id": 17, Tipo Integer "establishment_id": 18, Tipo Integer / Id do Estabelecimento "value": "1.00", Tipo Decimal / Valor "created_at": "2022-06-02 13:00:04", Tipo Date "updated_at": "2022-06-02 13:00:04", Tipo Date "establishment": { "id": 18, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { "id": 46, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { "id": 32, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date } } } } ], "tariffs": [ { "id": 26, Tipo Integer "establishment_id": 1, Tipo Integer / Id do Estabelecimento "tariff_id": 236, Tipo Integer / Id da tarifa "value": "1.38", Tipo Decimal / Valor "ecommerce_change": "0.00", Tipo Decimal / Valor ecommerce calculos tarifa "ecommerce_value": "0.00", Tipo Decimal / Valor ecommerce antes do comissionamento tarifa "created_at": "2021-10-04 11:41:07", Tipo Date "updated_at": "2021-10-07 09:22:54", Tipo Date "value_change": "10.00", Tipo Decimal / Valor padrão após calculos "type_change_id": 2, Tipo Integer / Id do tipo de aplicação da tarifa "type_change_ecommerce": null, Tipo Integer / Id do tipo de aplicação da tarifa ecommerce "tariff": { "id": 236, Tipo Integer "description": "Transferência entre bancos", Tipo String / Descrição "value": "0", Tipo Decimal / Valor "complement": null, Tipo String / Complemento "tariff_type_id": 1, Tipo Integer / Id do tipo da tarifa "frequency_id": 7, Tipo Integer / Id da frequencia em que a tarifa é aplicada "created_at": null, Tipo Date "updated_at": "2021-10-04 08:26:02", Tipo Date "franchise_qtd": 0, Tipo Decimal / Qtd Franquia "franchise_type_id": null, Tipo Integer / Id do Tipo de Franquia "franchise_rule_id": null, Tipo Integer / Id da Regra Frequência "installments": 1, Tipo Integer / Numero de parcelas que a tarifa se aplica "product_id": null, Tipo Integer / Id do Produto "discount_status": 2, Tipo Integer / Status do Desconto "ecommerce_value": "0.00", Tipo Decimal / Valor ecommerce "franchise_type": null, Tipo Integer "franchise_rule": null, Tipo Integer "tariff_type": { "id": 2, Tipo Integer "description": "%", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "frequency": { "id": 5, Tipo Integer "description": "Transação Financeira", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } }, ], "payment_status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "cerc_status": { "id": 2, Tipo Integer "description": "Recusado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "payment_logs": { "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 1, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo Boolean "last_page": 1, Tipo Integer "is_last_page": true, Tipo Boolean "page_keys": [ 1 ], "from_item": null, Tipo Integer "to_item": null, Tipo Integer "total_items": 0, Tipo Integer "amount": null, Tipo Decimal / Valor "value": null, Tipo Decimal "efective": 0, Tipo Decimal "balance": 0, Tipo Decimal "low": 0, Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 0 Tipo Integer } }, "msg": [ "OK" ], "statusCode": 206 }
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM AFILIADO PARA SER 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	EXEMPLO: { "data": { "id": 17, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 9, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "distributor": { "id": 1, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "company_id": 3, Tipo Integer / Id do company do distribuidor "created_at": "2021-09-29 12:03:59", Tipo Date "updated_at": "2021-09-29 12:03:59", Tipo Date "commission_activation": 0, Tipo Integer / Ativação de comissão para o distribuidor "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos }, "mccs": { "id": 76, Tipo Integer "code": "5511", Tipo String / Código do MCC "description": "Carros e Caminhões (Novos e Usados)", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date "type_id": null, Tipo Integer "minimal_balance": null, Tipo Decimal / Saldo minimo "max_post": null, Tipo Decimal / Valor minimo "min_post": null, Tipo Decimal / Valor maximo "period": null Tipo Date / Periodo }, "verification_ofac": { "id": 2, Tipo Integer "description": "Não Checado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "integration": { "id": 1, Tipo Integer "description": "Integrado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "antecipation": { "id": 3, Tipo Integer "description": "Liberado Geral", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "preposterou": { "id": 1, Tipo Integer "distributor_id": 1, Tipo Integer / Id do Distribuidor "company_id": 5, Tipo Integer / Id do company do preposto "created_at": "2021-09-29 12:06:09", Tipo Date "updated_at": "2021-09-29 12:06:09", Tipo Date "name": "Marcos", Tipo String / Nome do Preposto "commission_activation": 0, Tipo Decimal / Status de comissão "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos "preposterous_credential_type_id": null Tipo Integer / Tipo de credencial do preposto }, "economic_group": { "id": 1, Tipo Integer "name": "Teste SLG", Tipo String / Nome do Grupo Econômico "code_pos": 1, Tipo String / Código POS "code_menu": 2, Tipo String / Código menu "created_at": "2021-09-29 12:15:07", Tipo Decimal "updated_at": "2021-09-29 12:15:07", Tipo Decimal "automatic_anticipations": [ { "id": 2, Tipo Integer "establishment_id": null, Tipo Integer / Id do Estabelecimento "economic_group_id": 1, Tipo Integer / Id do Grupo Econômico "anticipation_application_mode_id": 1, Tipo Integer / Id do Tipo de aplicação "anticipation_mode_id": 1, Tipo Integer / Id do Modo de aplicação "value": 1, Tipo Integer / Valor "created_at": "2022-06-02 12:52:06", Tipo Date "updated_at": "2022-06-02 12:52:06", Tipo Date "application_mode": { "id": 1, Tipo Integer "description": "Mensal", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "mode": { "id": 1, Tipo Integer "description": "Diário", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ] }, "situation": { "id": 6, Tipo Integer "description": "Aprovado Manualmente", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "product": [ { "id": 1446, Tipo Integer "establishment_id": 3, Tipo Integer / Id do Estabelecimento "product_id": 1, Tipo Integer / Id do Produto "created_at": "2022-02-17 15:25:32", Tipo Date "updated_at": "2022-02-17 15:25:32", Tipo Date "product": { "id": 1, Tipo Integer "brand_id": 2, Tipo Integer / Id da bandeira "payment_method_id": 1, Tipo Integer / Id do metodo de pagamento "created_at": null, Tipo Date "updated_at": "2021-09-29 11:47:33", Tipo Date "cip_product_id": 1, Tipo Integer / Id do produto cip "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "brand": { "id": 2, Tipo Integer "name": "Mastercard", Tipo String / Nome da bandeira "icons": "data:image/png;base64", Tipo String / Icone em base 64 "created_at": null, Tipo Date "updated_at": null Tipo Date }, "payment_method": { "id": 1, Tipo Integer "description": "Crédito rotativo", Tipo String / Descrição "max_installments": 1, Tipo Integer / Quantidade maxima de parcelas "min_installments": 1, Tipo Integer / Quantidade minima de parcelas "created_at": null, Tipo Date "updated_at": null, Tipo Date "rules": "default" Tipo String / Regra } } } ], "company": { "id": 45, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "localization": { "id": 45, Tipo Integer "company_id": 45, Tipo Integer / Id do company preposto "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "localization_delivery": { "id": 1, Tipo Integer "company_id": 45, Tipo Integer / Id do company do estabelecimento "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "contact": [ { "id": 240, Tipo Integer "company_id": 3, Tipo Integer / Id do company do estabelecimento "contact_type_id": 1, Tipo Integer / Id do tipo de contato "name": "jacqueline", Tipo String / Nome "value": "11988808096", Tipo String / Telefone ou Email "created_at": "2022-06-13 09:16:38", Tipo Date "updated_at": "2022-06-13 09:16:38", Tipo Date "contact_type": { "id": 1, Tipo Integer "description": "Celular", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ], "detail": { "id": 31, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date "branch_type": { "id": 1, Tipo Integer "description": "Matriz", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "bank_given": { "id": 46, Tipo Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do estabelecimento "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer "account_type": { Objeto "id": 1, Tipo Integer "value": "Conta Corrente", Tipo String / Descrição do tipo da conta "created_at": null, Tipo Date "updated_at": null, Tipo Date "code": "CC" Tipo String / Código }, "holder_type": { Objeto "id": 2, Tipo Integer "value": "Pessoa Jurídica - Empresa", Tipo String / Descrição do tipo de documento representante "abbreviation": "PJE", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank": { Objeto "id": 340, Tipo Integer "code": "X1X", Tipo String / Código do banco "name": "CONTA INTERNA", Tipo String / Nome do banco "ispb": "00000000", Tipo String / Ispb do banco "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:07", Tipo Date "ispb_code": null Tipo String / Código ispb }, "holder": null }, "prepaid_card": null, "bank_given_type": { "id": 1, Tipo Integer "value": "Conta Bancária", Tipo String / Descrição do tipo da conta "abbreviation": "CB", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null, Tipo Date "status_id": 1 / Id do Status (1 - Ativo, 2 - Inativo) }, "people_type": { "id": 2, Tipo Integer "name": "Pessoa Jurídica", Tipo String / Nome "abbreviation": "PJ", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "internal_parameter": { "id": 4, Tipo Integer "max_amount_day": "9999.00", Tipo Decimal / Valor maximo diario "max_amount": "99999999.00", Tipo Decimal / Valor maximo "quantity_operator_day": 1000, Tipo Decimal / Quantidade maxima de operações diarias "created_at": "2022-03-20 17:43:09", Tipo Date "updated_at": "2022-03-20 17:43:09", Tipo Date "establishment_id": 17 Tipo Integer / Id do Estabelecimento }, "father": [ { "id": 1, Tipo Integer "father_id": 17, Tipo Integer "establishment_id": 18, Tipo Integer / Id do Estabelecimento "value": "1.00", Tipo Decimal "created_at": "2022-06-02 13:00:04", Tipo Date "updated_at": "2022-06-02 13:00:04", Tipo Date "establishment": { "id": 18, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { "id": 46, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { "id": 32, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date } } } } ], "tariffs": [ { "id": 26, Tipo Integer "establishment_id": 1, Tipo Integer / Id do Estabelecimento "tariff_id": 236, Tipo Integer / Id da tarifa "value": "1.38", Tipo Decimal / Valor "ecommerce_change": "0.00", Tipo Decimal / Valor ecommerce calculos tarifa "ecommerce_value": "0.00", Tipo Decimal / Valor ecommerce antes do comissionamento tarifa "created_at": "2021-10-04 11:41:07", Tipo Date "updated_at": "2021-10-07 09:22:54", Tipo Date "value_change": "10.00", Tipo Decimal / Valor padrão após calculos "type_change_id": 2, Tipo Integer / Id do tipo de aplicação da tarifa "type_change_ecommerce": null, Tipo Integer / Id do tipo de aplicação da tarifa ecommerce "tariff": { "id": 236, Tipo Integer "description": "Transferência entre bancos", Tipo String / Descrição "value": "0", Tipo Decimal / Valor "complement": null, Tipo String / Complemento "tariff_type_id": 1, Tipo Integer / Id do tipo da tarifa "frequency_id": 7, Tipo Integer / Id da frequencia em que a tarifa é aplicada "created_at": null, Tipo Date "updated_at": "2021-10-04 08:26:02", Tipo Date "franchise_qtd": 0, Tipo Decimal / Qtd Franquia "franchise_type_id": null, Tipo Integer / Id do Tipo de Franquia "franchise_rule_id": null, Tipo Integer / Id da Regra Frequência "installments": 1, Tipo Integer / Numero de parcelas que a tarifa se aplica "product_id": null, Tipo Integer / Id do Produto "discount_status": 2, Tipo Integer / Status do Desconto "ecommerce_value": "0.00", Tipo Decimal / Valor ecommerce "franchise_type": null, Tipo Integer "franchise_rule": null, Tipo Integer "tariff_type": { "id": 2, Tipo Integer "description": "%", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "frequency": { "id": 5, Tipo Integer "description": "Transação Financeira", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } }, ], "payment_status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "cerc_status": { "id": 2, Tipo Integer "description": "Recusado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "payment_logs": { "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 1, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo Boolean "last_page": 1, Tipo Integer "is_last_page": true, Tipo Boolean "page_keys": [ 1 ], "from_item": null, Tipo Integer "to_item": null, Tipo Integer "total_items": 0, Tipo Integer "amount": null, Tipo Decimal / Valor "value": null, Tipo Decimal "efective": 0, Tipo Decimal "balance": 0, Tipo Decimal "low": 0, Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 0 Tipo Integer } }, "msg": [ "OK" ], "statusCode": 206 }
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.

Tipo de Dado
reason: String

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	REASON
Body	{ "reason" : "Razão" }

Retornos

Código	Mensagem
200	{ "data": { Object "id": 19, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 9, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { Object "id": 49, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade }, "distributor": { Object "id": 1, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "company_id": 3, Tipo Integer / Id do company do distribuidor "created_at": "2021-09-29 12:03:59", Tipo Date "updated_at": "2021-09-29 12:03:59", Tipo Date "commission_activation": 0, Tipo Integer / Ativação de comissão para o distribuidor "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos } }, "msg": [ "OK" ], "statusCode": 200 }
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.

Tipo de Dado
reason: String

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	REASON
Body	{ "reason" : "Razão" }

Retornos

Código	Mensagem
200	{ "data": { "id": 22, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 9, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão }, "msg": [ "OK" ], "statusCode": 200 }
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

Arquivos

GET

Dados do Arquivos
/base_transacional_elo

Detalhes

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

Retornos

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

GET

Base cadastral ELO
downloadFile/{file_id}

Detalhes

Todos os dados utilizados no Base cadastral ELO, são carregados através dessa rota

Retornos

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

get

Base transacional ELO
downloadFile/{file_id}

Detalhes

Todos os dados utilizados no Base cadastral elo transação, são carregados através dessa rota

Retornos

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

GET

Arquivo de pagamento
payment_file

Detalhes

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

Retornos

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

Autenticação-MFA

GET

MFA
/authentication

Detalhes

Todos os dados utilizados na Autenticação MFA, são carregados através dessa rota

Retornos

Código	Mensagem
200	OK
402	Token não encontrado. Token expirado. Token é inválido.
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	Deletado com sucesso
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

Comissões

GET

LISTAGEM
/commissions

Detalhes

Ao realizar a chamada, teremos uma resposta da API retornando 10 últimos registros de comissões 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/commissions?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

Caso não queira filtrar por algum dos campos abaixo, apenas apague a linha do campo dentro do objeto filters.

Nome do Modelo - filters[name] \ Tipo de Dado: String
Data de Vigência - filters[validity] \ Tipo de Dado: Date
Tipo de Comissionamento - filters[commission_type_id] \ Tipo de Dado: Integer

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "name": "null", "validity": "null", "commission_type_id": "null", "value": "null", } }

Retornos

Código	Mensagem
200	"data":{ "data":[ Array { "id": 7, Tipo String "company_type_id": 2, Tipo String / Id do tipo do company "commission_type_id": 1, Tipo String / Id do tipo de comissão "name": "exemplo", Tipo String / Nome "validity": "2022-06-13", Tipo Date / Validade "subsequent": 1, Tipo String / Dia de fechamento "amount_tariff": "0.00", Tipo Decimal / Taxa de serviço R$ "service_tariff": "0.00", Tipo Decimal / Taxa de serviço % "mkt": null, Tipo Decimal / Taxa de MKT (%) "royalty": null, Tipo Decimal / Taxa de Royalties (%) "commission_model_id": null, Tipo String / Id do modelo de comissão "created_at": "2022-06-08 08:12:04", Tipo Date "updated_at": "2022-06-08 08:12:04", Tipo Date "company_type": { "id": 2, Tipo String "description": "Distribuidor", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "commission_type": { "id": 1, Tipo String "description": "Fixo", Tipo String / Descrição "activate": 1, Tipo String / Ativação "created_at": null, Tipo Date "updated_at": null Tipo Date } } ] }
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.

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
206	{ "commission": { "id": 1, Tipo Integer "company_type_id": 2, Tipo String / Id do tipo do company "commission_type_id": 1, Tipo String / Id do tipo de comissão "name": "exemplo", Tipo String / Nome "validity": "2022-06-13", Tipo Date / Validade "subsequent": 1, Tipo String / Dia de fechamento "amount_tariff": "0.00", Tipo Decimal / Taxa de serviço R$ "service_tariff": "0.00", Tipo Decimal / Taxa de serviço % "mkt": null, Tipo Decimal / Taxa de MKT (%) "royalty": null, Tipo Decimal / Taxa de Royalties (%) "commission_model_id": null, Tipo String / Id do modelo de comissão "created_at": "2022-06-08 08:12:04", Tipo Date "updated_at": "2022-06-08 08:12:04", Tipo Date "company_type": { "id": 2, Tipo Integer "description": "Distribuidor", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "commission_type": { "id": 1, Tipo Integer "description": "Fixo", Tipo String / Descrição "activate": 1, Tipo Integer / Id do status de ativação "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "credentials": { "id": 1, Tipo Integer "commission_value": "3.33", Tipo Decimal / Valor da comissão "commission_minimum_value": "0.33", Tipo Decimal / Valor Mínimo de Faturamento para considerar Ativo "commission_model_id": 1, Tipo Integer / Id do modelo de comissão "created_at": "2022-01-19 08:23:20", Tipo Date "updated_at": "2022-01-19 08:23:20" Tipo Date }, "data": false, "msg": [ "OK" ], "statusCode": 200 }
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".

Tipo de Dado
name: String
validity: Date
company_type_id: Integer
subsequent: Integer
commission_type_id: Integer
distributor: Integer

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	NAME, VALIDITY, COMPANY_TYPE_ID, SUBSEQUENT, COMMISSION_TYPE_ID, DISTRIBUTOR
Body	{ "commission_basic" : { "name": "Nome da comissão", "validity": "Validade", "company_type_id": "Id do tipo de documento", "subsequent": "Dia de fechamento", "commission_type_id": "Id do tipo de comissionamento" }, }

Retornos

Código	Mensagem
200	{ "data": { "company_type_id": 2, Tipo String / Id do tipo do company "commission_type_id": 1, Tipo String / Id do tipo de comissão "name": "exemplo", Tipo String / Nome "validity": "2022-06-13", Tipo Date / Validade "subsequent": 1, Tipo String / Dia de fechamento "updated_at": "2022-06-13 08:26:51", Tipo Date "created_at": "2022-06-13 08:26:51", Tipo Date "id": 8 }, "msg": [ "OK" ], "statusCode": 200 }
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".

Tipo de Dado
name: String
validity: Date
company_type_id: Integer
subsequent: Integer
commission_type_id: Integer
distributor: Integer
commission_service_id: Integer
tariff_id: Integer
amount: Decimal
initial_installment: Date
final_installment: Date
mkt: Decimal
royalty: Decimal
commission_value: Decimal
commission_minimum_value: Decimal

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":"Nome", "validity":"Validade", "company_type_id":"Id do tipo de company", "subsequent":"Dia de fechamento", "commission_type_id":"Id do tipo de comissionamento" }, "distributor":"Distribuidor" , "commission_detail" : { "commission_service_id":"Id do serviço da comissão", "tariff_id":"Id da tarifa", "amount":"Valor", "initial_installment":"Parcela inicial", "final_installment":"Parcela Final" } , "commission_model_tax" : { "mkt":"MKT", "royalty":"Royalties" } , "commission_credentials" : { "commission_value":"Valor da comissão", "commission_minimum_value":"Valor Mínimo de Faturamento para considerar Ativo" } }

Retornos

Código	Mensagem
200	{ "data": { "id": 8, Tipo Integer "company_type_id": 2, Tipo String / Id do tipo do company "commission_type_id": 1, Tipo String / Id do tipo de comissão "name": "exemplo", Tipo String / Nome "validity": "2022-06-13", Tipo Date / Validade "subsequent": 1, Tipo String / Dia de fechamento "amount_tariff": "0.00", Tipo Decimal / Taxa de serviço R$ "service_tariff": "0.00", Tipo Decimal / Taxa de serviço % "mkt": null, Tipo Decimal / Taxa de MKT (%) "royalty": null, Tipo Decimal / Taxa de Royalties (%) "commission_model_id": null, Tipo String / Id do modelo de comissão "created_at": "2022-06-08 08:12:04", Tipo Date "updated_at": "2022-06-08 08:12:04", Tipo Date }, "msg": [ "OK" ], "statusCode": 200 }
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.

Filtros

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Preposto - filters[preposterou] / Tipo de dado Integer
Mês/Ano - filters[month_year] / Tipo de dado Date
Documento Estabelecimento - filters[document] / Tipo de dado String
Apelido - filters[totem_alias] / Tipo de dado String
Distribuidor - filters[distributor] / Tipo de dado Integer
Produto - filters[product_id] / Tipo de dado Integer
Tipo de Serviço - filters[commission_services] / Tipo de dado Integer

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "preposterou": "null", "month_year": "null", "document": "null", "totem_alias": "null", "distributor": "null", "product_id": "null", "commission_services": "null" }, }

Retornos

Código	Mensagem
206	{ "data": { "data": [ { "id": 1, Tipo Integer "commission_id": 1, Tipo Integer / Id da comissão "value": "0.00", Tipo Decimal / Valor da comissão "net_value": "0.00", Tipo Decimal / Valor liquido "transaction_id": 196, Tipo Integer / Id da transação "commission_model_id": 8, Tipo Integer / Id do modelo de comissão "commission_type_id": 1, Tipo Integer / Id do tipo de comissão "commission_service_id": 2, Tipo Integer / Id do serviço da comissão "tariff_id": 28, Tipo Integer / Id tarifa "tariff_value": "0.000", Tipo Decimal / Valor tarifa "created_at": "2022-06-24 12:37:15", Tipo Date "updated_at": "2022-06-24 12:37:15", Tipo Date "tax": "0.00", Tipo Decimal / Taxa "commission": { "id": 1, Tipo Integer "commission_id": null, Tipo Integer / Id da comissão "company_id": 3, Tipo Integer / Id do company do distribuidor "commission_status_id": 1, Tipo Integer / Id do status de comissão "period": "2022-06-14", Tipo Date / Periodo "value": "1.00", Tipo Decimal / Valor "adjustment_status": "1", Tipo Integer / Status de ajuste "credit": "1.00", Tipo Decimal / Valor de credito "mkt": "1.000", Tipo Decimal / Taxa de MKT "royalty": "1.000", Tipo Decimal / Taxa de Royalties (%) "amount_royalty": "1.00", Tipo Decimal / Valor royalty (R$) "amount_mkt": "1.00", Tipo Decimal / Valor MKT (R$) "discount": "1.000", Tipo Decimal / Desconto "observation": "a", Tipo String / Observação "created_at": null, Tipo Date "updated_at": null, Tipo Date "subsequent": 1, Tipo Integer / Dia de fechamento "user_id": 1, Tipo Integer / Id de usuário "net_value": "1.00", Tipo Decimal / Valor liquido "approvation_date": "2022-06-13", Tipo Date / Data de aprovação "liberation_date": "2022-06-13", Tipo Date / Data de liberação "liquid_date": "2022-06-13", Tipo Date / Data liquidação "payment_status_id": 1, Tipo Integer / Id status de pagamento "payday": "2022-06-13", Tipo Date / Data pagamento "external_code": "a", Tipo String / Código externo "company": { "id": 3, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": null, "distributor": { "id": 1, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "company_id": 3, Tipo Integer / Id do company do distribuidor "created_at": "2021-09-29 12:03:59", Tipo Date "updated_at": "2021-09-29 12:03:59", Tipo Date "commission_activation": 0, Tipo Integer / Ativação de comissão para o distribuidor "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos }, "preposterou": { "id": 1, Tipo Integer "distributor_id": 1, Tipo Integer / Id do Distribuidor "company_id": 5, Tipo Integer / Id do company do preposto "created_at": "2021-09-29 12:06:09", Tipo Date "updated_at": "2021-09-29 12:06:09", Tipo Date "name": "Marcos", Tipo String / Nome do Preposto "commission_activation": 0, Tipo Integer / Status de comissão "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos "preposterous_credential_type_id": null Tipo Integer / Tipo de credencial do preposto }, } }, "transaction": { "id": 196, Tipo Integer "card_number": "000589916XXXXXX0487", Tipo String / Numero do cartão "originator": "ADIQ", Tipo String / Originador "authorization": "007078", Tipo String / Autorização "nsu": "75", Tipo String / Nsu transação "company_id": 9, Tipo Integer / Id do company do estabelecimento "acquirer_id": 1, Tipo Integer / Id do Adquirente "installments": 1, Tipo Integer / Quantidade de Parcelas "amount": "1000.00", Tipo Decimal / Valor "terminal_identification": "6N281051", Tipo String / Identificação do terminal "capture_method_id": 1, Tipo Integer / Metodo de captura "product_id": 1, Tipo Integer / Id do Produto "transaction_type_id": 2, Tipo Integer / Id do tipo de transação "integration_transaction_id": "75", Tipo Integer / Id da transação integrada "transaction_canceled_id": null, Tipo Integer / Id do cancelamento da transação "date": "2022-01-26 13:45:43", Tipo Date "created_at": "2022-01-26 12:26:03", Tipo Date "updated_at": "2022-01-26 12:26:03", Tipo Date "entry_mode_id": 2, Tipo Integer / Id do meio de entrada "integration_transaction_id_2": "75", Tipo Integer / Id da transação integrada "distributor_id": 1, Tipo Integer / Id do Distribuidor "preposterou_id": 1, Tipo Integer / Id do Preposto "last_import": null, / Ultima data que foi importado "attempt": 0, Tipo Integer / Tentativas "integration_status_id": 2, Tipo Integer // Id do status de integração "cerc_status_id": 2, Tipo Integer / Id do status na CERC "external_identificator": null, Tipo String / Indentificação externa "liquid_amount": null, Tipo Decimal / Valor liquido "return_tax": null, Tipo Decimal / Taxa de retorno "service_type_id": 2, Tipo Integer / Id do tipo de serviço "alias": null, Tipo String "additional_info": null, Tipo String / Informação adicional "proccess_date": null, Tipo Date / Data de processamento "identificator": null, Tipo String / identificador "pgs_code": null, Tipo String / Código pgs "received_edi": "N", Tipo String "company": { "id": 9, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade }, "product": { "id": 7, Tipo Integer "brand_id": 2, Tipo Integer / Id da bandeira "payment_method_id": 1, Tipo Integer / Id do metodo de pagamento "created_at": null, Tipo Date "updated_at": "2021-09-29 11:47:33", Tipo Date "cip_product_id": 1, Tipo Integer / Id do produto cip "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "brand": { "id": 2, Tipo Integer "name": "Mastercard", Tipo String / Nome da bandeira "icons": "data:image/png;base64", Tipo String / Icone em base 64 "created_at": null, Tipo Date "updated_at": null Tipo Date }, "payment_method": { "id": 1, Tipo Integer "description": "Crédito rotativo", Tipo String / Descrição "max_installments": 1, Tipo Integer / Quantidade maxima de parcelas "min_installments": 1, Tipo Integer / Quantidade minima de parcelas "created_at": null, Tipo Date "updated_at": null, Tipo Date "rules": "default" Tipo String / Regra } }, "service_type": { "id": 2, Tipo Integer "description": "Pgto Boleto", Tipo String / Descrição "activate": 1, Tipo Integer / Ativação "created_at": null, Tipo Date "updated_at": "2021-12-15 09:07:34" Tipo Date } }, "commission_model": { "id": 8, Tipo Integer "company_type_id": 2, Tipo String / Id do tipo do company "commission_type_id": 1, Tipo String / Id do tipo de comissão "name": "exemplo", Tipo String / Nome "validity": "2022-06-13", Tipo Date / Validade "subsequent": 1, Tipo String / Dia de fechamento "amount_tariff": "0.00", Tipo Decimal / Taxa de serviço R$ "service_tariff": "0.00", Tipo Decimal / Taxa de serviço % "mkt": null, Tipo Decimal / Taxa de MKT (%) "royalty": null, Tipo Decimal / Taxa de Royalties (%) "commission_model_id": null, Tipo String / Id do modelo de comissão "created_at": "2022-06-13 08:26:51", Tipo Date "updated_at": "2022-06-13 08:38:03" Tipo Date }, "commission_type": { "id": 1, Tipo Integer "description": "Fixo", Tipo String / Descrição "activate": 1, Tipo Integer / Ativação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "commission_service": { "id": 2, Tipo Integer "description": "Pgto Boleto", Tipo String / Descrição "activate": 1, Tipo Integer / Ativação "created_at": null, Tipo Date "updated_at": "2021-12-15 09:07:34" Tipo Date }, } ], "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 1, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo Boolean "last_page": 1, Tipo Integer "is_last_page": true, Tipo Boolean "page_keys": [ 1 ], "from_item": 1, Tipo Integer "to_item": 1, Tipo Integer "total_items": 1, Tipo Integer "amount": null, Tipo Decimal "value": null, Tipo Decimal "efective": 0, Tipo Decimal "balance": 0, Tipo Decimal "low": 0, Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 1 Tipo Integer } }, "array": { "totalMDR": [ { "totalMDR": "0.00", "commission": null, "transaction": null, "commission_model": null, "commission_type": null, "commission_service": null, "commission_tariff": null } ], "totalCD": "0.00", Tipo Decimal "totalDiscount": 1, Tipo Decimal "totalLCD": "0.00", Tipo Decimal "totalRoyalt": "1.00", Tipo Decimal "totalMKT": "1.00" Tipo Decimal }, "msg": [ "OK" ], "statusCode": 200 }
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 Comissões.

Filtros

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Mês - filters[month] / Tipo de dado Integer
Ano - filters[year] / Tipo de dado String

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "month": "null", "year": "null", }, }

Retornos

Código	Mensagem
206	{ "data": { "data": [ { "id": 1, Tipo Integer "commission_id": null, Tipo Integer / Id da comissão "company_id": 3, Tipo Integer / Id do company do distribuidor "commission_status_id": 1, Tipo Integer / Id do status de comissão "period": "2022-06-14", Tipo Date / Periodo "value": "1.00", Tipo Decimal / Valor "adjustment_status": "1", Tipo Integer / Status de ajuste "credit": "1.00", Tipo Decimal / Valor de credito "mkt": "1.000", Tipo Decimal / Taxa de MKT "royalty": "1.000", Tipo Decimal / Taxa de Royalties (%) "amount_royalty": "1.00", Tipo Decimal / Valor royalty (R$) "amount_mkt": "1.00", Tipo Decimal / Valor MKT (R$) "discount": "1.000", Tipo Decimal / Desconto "observation": "a", Tipo String / Observação "created_at": null, Tipo Date "updated_at": null, Tipo Date "subsequent": 1, Tipo Integer / Dia de fechamento "user_id": 1, Tipo Integer / Id de usuário "net_value": "1.00", Tipo Decimal / Valor liquido "approvation_date": "2022-06-13", Tipo Date / Data de aprovação "liberation_date": "2022-06-13", Tipo Date / Data de liberação "liquid_date": "2022-06-13", Tipo Date / Data liquidação "payment_status_id": 1, Tipo Integer / Id status de pagamento "payday": "2022-06-13", Tipo Date / Data pagamento "external_code": "a", Tipo String / Código externo "company": { "id": 3, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "distributor": { "id": 1, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "company_id": 3, Tipo Integer / Id do company do distribuidor "created_at": "2021-09-29 12:03:59", Tipo Date "updated_at": "2021-09-29 12:03:59", Tipo Date "commission_activation": 0, Tipo Integer / Ativação de comissão para o distribuidor "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos }, "preposterou": { "id": 1, Tipo Integer "distributor_id": 1, Tipo Integer / Id do Distribuidor "company_id": 5, Tipo Integer / Id do company do preposto "created_at": "2021-09-29 12:06:09", Tipo Date "updated_at": "2021-09-29 12:06:09", Tipo Date "name": "Marcos", Tipo String / Nome do Preposto "commission_activation": 0, Tipo Integer / Status de comissão "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos "preposterous_credential_type_id": null Tipo Integer / Tipo de credencial do preposto }, }, "status": { "id": 1, Tipo Integer "description": "Aberto", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "user":{ "id": 1, Tipo Integer "name": "Admin", Tipo String / Nome "cpf": "99999999999", Tipo String / CPF "telephone": "46569090", Tipo String / Telefone "email": "slg@logics4u.com.br", Tipo String / E-mail "password": "$2y$10$uf9pAQ4H7XYFaaHZxr//ru1qChgUDBb0y0JVCFd/UwtsYWTydPwwW", Tipo String / Senha "reset_token": null, Tipo String / Token de reset "api_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwibmFtZSI6IkFkbWluIiwiY3BmIjoiOTk5OTk5OTk5OTkiLCJlbWFpbCI6InNsZ0Bsb2dpY3M0dS5jb20uYnIiLCJsb2dpbiI6bnVsbCwic3RhdHVzIjoxLCJlc3RhYmxpc2htZW50c19pZCI6W10sImRpc3RyaWJ1dG9yc19pZCI6W10sInR5cGVfaWQiOjMsImlhdCI6MTY1N TEzODkyMywiZXhwIjo5LjIyMzM3MjAzODUwOTkxNGUrMTh9.kutRpEEmeClDcMjSByRRinWzn4ClBTSUPr19QJ18gsc", Tipo String / Token da API "date_access_token": "2022-06-13 12:16:27", Tipo Date / Data de acesso do token "status_id": 1, Tipo Integer / Id de status "created_at": null, Tipo Date "updated_at": "2022-06-13 12:16:27", Tipo Date "type_id": 3, Tipo Integer / Id do tipo de usuario "login": null, Tipo String / Login do usuario "first_access": null, Tipo Date / Data do primeiro acesso "profile_id": null, Tipo Integer / Id do perfil "request_reset_token": null, Tipo Date / Data de requisição do token de reset de senha "attempt": 0, Tipo Integer / Tentativas "mfa_code": null, Tipo String / Código MFA "mfa_created_at": null, Tipo Date / Data do código mfa "permission_alert": 0, Tipo Integer / Alerta de permissão "expiry_date": "2022-02-08" Tipo Date / Data de vencimento }, "transfer_status": { "id": 1, Tipo Integer "description": "Aguardando pagamento", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ], "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 1, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo Boolean "last_page": 1, Tipo Integer "is_last_page": true, Tipo Boolean "page_keys": [ 1 ], "from_item": 1, Tipo Integer "to_item": 1, Tipo Integer "total_items": 1, Tipo Integer "amount": null, Tipo Decimal / Valor "value": null, Tipo Decimal "efective": 0, Tipo Decimal "balance": 0, Tipo Decimal "low": 0, Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 1 Tipo Integer } }, "msg": [ "OK" ], "statusCode": 200 }
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==) }
Body	{ "" : "" }

Retornos

Código	Mensagem
206	{ "data": [ { "id": 11, Tipo Integer "date": "2022-06-13", Tipo Date / Data "bank_given_id": 3, Tipo Integer / Id da Conta Bancária "file_transfer_id": 1, Tipo Integer / Id do arquivo de transferencia "transfer_resume_id": null, Tipo Integer / Id do repasse "status_id": 1, Tipo Integer / Id do status de processamento "created_at": null, Tipo Date "updated_at": null, Tipo Date "commission_id": 1, Tipo Integer / Id da comissão "external_transfer_id": null, Tipo Integer / Id do extrato "financial_transfer_id": null, Tipo Integer / Id financeiro "commission": { "id": 1, Tipo Integer "commission_id": null, Tipo Integer / Id da comissão "company_id": 3, Tipo Integer / Id do company do distribuidor "commission_status_id": 1, Tipo Integer / Id do status de comissão "period": "2022-06-14", Tipo Date / Periodo "value": "1.00", Tipo Decimal / Valor "adjustment_status": "1", Tipo Integer / Id do tipo de ajuste "credit": "1.00", Tipo Decimal / Valor de credito "mkt": "1.000", Tipo Decimal / Taxa de MKT "royalty": "1.000", Tipo Decimal / Taxa de Royalties (%) "amount_royalty": "1.00", Tipo Decimal / Valor royalty (R$) "amount_mkt": "1.00", Tipo Decimal / Valor MKT (R$) "discount": "1.000", Tipo Decimal / Desconto "observation": "a", Tipo String / Observação "created_at": null, Tipo Date "updated_at": null, Tipo Date "subsequent": 1, Tipo Integer / Dia de fechamento "user_id": 1, Tipo Integer / Id do usuário "net_value": "1.00", Tipo Decimal / Valor liquido "approvation_date": "2022-06-13", Tipo Date / Data de aprovação "liberation_date": "2022-06-13", Tipo Date / Data de liberação "liquid_date": "2022-06-13", Tipo Date / Data de liquidação "payment_status_id": 1, Tipo Integer / Id do status de pagamento "payday": "2022-06-13", Tipo Date / Data de pagamento "external_code": "a", Tipo String / Código externo "company": { "id": 3, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { "id": 31, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 3, Tipo Integer / Id do company do distribuidor "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date } "distributor": { "id": 1, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "company_id": 3, Tipo Integer / Id do company do distribuidor "created_at": "2021-09-29 12:03:59", Tipo Date "updated_at": "2021-09-29 12:03:59", Tipo Date "commission_activation": 0, Tipo Integer / Ativação de comissão para o distribuidor "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos }, "preposterou": { "id": 1, Tipo Integer "distributor_id": 1, Tipo Integer / Id do Distribuidor "company_id": 5, Tipo Integer / Id do company do preposto "created_at": "2021-09-29 12:06:09", Tipo Date "updated_at": "2021-09-29 12:06:09", Tipo Date "name": "Marcos", Tipo String / Nome do Preposto "commission_activation": 0, Tipo Integer / Status de comissão "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos "preposterous_credential_type_id": null Tipo Integer / Tipo de credencial do preposto }, } }, "file_transfer_log": { "id": 1, Tipo Integer "name": "CVCB0613F1.REM", Tipo String "action": "sendRemFileBradesco", Tipo String "layout_id": 2, Tipo Integer / Id do layout "proccess_status_id": 1, Tipo Integer / Id de status de processamento "created_at": "2022-06-13 06:30:34", Tipo Date "updated_at": "2022-06-13 06:30:34", Tipo Date "type_id": 3, Tipo Integer / Id do tipo do arquivo de transferencia "proccess_status": { "id": 1, Tipo Integer "description": "Sucesso", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "transfer_layouts": { "id": 2, Tipo Integer "status_id": 1, Tipo Integer / Id do status de ativação do layout "description": "Bradesco", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": "2021-09-29 11:47:57" Tipo Date } }, "bank_given": { "id": 3, Tipo Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do distribuidor "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer "account_type": { Objeto "id": 1, Tipo Integer "value": "Conta Corrente", Tipo String / Descrição do tipo da conta "created_at": null, Tipo Date "updated_at": null, Tipo Date "code": "CC" Tipo String / Código }, "holder_type": { Objeto "id": 2, Tipo Integer "value": "Pessoa Jurídica - Empresa", Tipo String / Descrição do tipo de documento representante "abbreviation": "PJE", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank": { Objeto "id": 340, Tipo Integer "code": "X1X", Tipo String / Código do banco "name": "CONTA INTERNA", Tipo String / Nome do banco "ispb": "00000000", Tipo String / Ispb do banco "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:07", Tipo Date "ispb_code": null Tipo String / Código ispb }, "company": { "id": 3, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": null, "bank_given_type": { "id": 1, Tipo Integer "value": "Conta Bancária", Tipo String / Descrição do tipo da conta "abbreviation": "CB", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null, Tipo Date "status_id": 1 / Id do Status (1 - Ativo, 2 - Inativo) }, "people_type": { "id": 1, Tipo Integer "name": "Pessoa Fisica", Tipo String / Nome "abbreviation": "PJ", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "holder_type": { "id": 1, Tipo Integer "value": "Pessoa Física - Representante", Tipo String "abbreviation": "PFR", Tipo String "created_at": null, Tipo Date "updated_at": null Tipo Date }, }, "transfer_status": { "id": 1, Tipo Integer "description": "Sucesso", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, } ], "msg": [ "Ok" ], "statusCode": 200 }
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": "{ "name": "Nome do arquivo", "extension": "Extensão do arquivo", "contents": "Imagem em formato base64" }" }, }

Retornos

Código	Mensagem
200	{ "data":null, "msg":[ "CRIADO" ], "statusCode":201 }
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

Filtros

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Valor - filters[value] / Tipo de dado Decimal
Desconto - filters[discount] / Tipo de dado Decimal
Status - filters[commission_status_id] / Tipo de dado Integer
Periodo à partir - filters[period_from] / Tipo de dado Date
Periodo até - filters[period_until] / Tipo de dado Date
Observação - filters[observation] / Tipo de dado String

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "value": "null", "discount": "null", "commission_status_id": "null", "period_from": "null", "period_until": "null", "observation": "null" } }

Retornos

Código	Mensagem
206	{ "data":{ "data":[ { "validity": "2022-06-13", Tipo Date "miscellaneous_discounts": null, Tipo Decimal / Desconto "observation": "exemplo", Tipo String / Observação "commission_model_id": "1", Tipo Integer / Id do modelo de comissão "company_id": "1", Tipo Integer / Id do company do distribuidor } ] } }
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.

Tipo de Dado
payday: Date
idComission: Integer

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	PAYDAY, IDCOMISSION
Body	{ "payday" : "Data de pagamento", "idComission" : "Id da comissão" }

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==) }
Body	{ "" : "" }

Retornos

Código	Mensagem
200	{ "data": { "data": [ { "id": 1, Tipo Integer "description": "Variável VT", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date "activate": 1 Tipo Integer Tipo Integer / Id do status de ativação } ], "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 1, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo Boolean "last_page": 1, Tipo Integer "is_last_page": true, Tipo Boolean "page_keys": [ 1 ], "from_item": 1, Tipo Integer "to_item": 1, Tipo Integer "total_items": 1, Tipo Integer "amount": null, Tipo Decimal / Valor "value": null, Tipo Decimal "efective": 0, Tipo Decimal "balance": 0, Tipo Decimal "low": 0, Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 1 Tipo Integer } }, "msg": [ "OK" ], "statusCode": 200 }
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	{ "data": { "id": 1, Tipo Integer "description": "Variável VT", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date "activate": 1 Tipo Integer / Id do status de ativação }, "msg": [ "OK" ], "statusCode": 206 }
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.

Tipo de Dado
description: String

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DESCRIPTION
Body	{ "description" : "Descrição" }

Retornos

Código	Mensagem
200	{ "data": { "id": 1, Tipo Integer "description": "Variável VT", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date "activate": 1 Tipo Integer / Id do status de ativação }, "msg": [ "OK" ], "statusCode": 206 }
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.

Tipo de Dado
description: String

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DESCRIPTION
Body	{ "description" : "Descrição" }

Retornos

Código	Mensagem
200	{ "data": { "id": 2, Tipo Integer "description": "EXEMPL0", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date "activate": 1 Tipo Integer / Id do status de ativação }, "msg": [ "OK" ], "statusCode": 206 }
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==) }
Body	{ "" : "" }

Retornos

Código	Mensagem
200	{ "data":{ "data":[ { "id": 5, Tipo Integer "description": "Recarga de Celular", Tipo String / Descrição "activate": 2, Tipo Integer / Id do status de ativação "created_at": null, Tipo Date "updated_at": "2021-12-14 08:27:55" Tipo Date } ] "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 1, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo Boolean "last_page": 1, Tipo Integer "is_last_page": true, Tipo Boolean "page_keys": [ 1 ], "from_item": 1, Tipo Integer "to_item": 5, Tipo Integer "total_items": 5, Tipo Integer "amount": null, Tipo Decimal / Valor "value": null, Tipo Decimal "efective": 0, Tipo Decimal "balance": 0, Tipo Decimal "low": 0, Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 5 Tipo Integer } }, "msg": [ "OK" ], "statusCode": 200 }
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.

Tipo de Dado
id: Integer

Parâmetros

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

Retornos

Código	Mensagem
206	{ "data": { "id": 1, Tipo Integer "description": "Transação", Tipo String / Descrição "activate": 1, Tipo Integer / Id do status de ativação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "msg": [ "OK" ], "statusCode": 206 }
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.

Tipo de Dado
description: String

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DESCRIPTION
Body	{ "description" : "Descrição" }

Retornos

Código	Mensagem
200	{ "data": { "id": 1, Tipo Integer "description": "Transação", Tipo String / Descrição "activate": 1, Tipo Integer / Id do status de ativação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "msg": [ "OK" ], "statusCode": 206 }
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_services/update/{id}

Detalhes

Ao chamar a API edita o serviço de comissão através do id informado.

Tipo de Dado
description: String

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DESCRIPTION
Body	{ "description" : "Descrição" }

Retornos

Código	Mensagem
200	{ "data": { "id": 1, Tipo Integer "description": "Transação", Tipo String / Descrição "activate": 1, Tipo Integer / Id do status de ativação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "msg": [ "OK" ], "statusCode": 206 }
401	Campo description é obrigatório
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

ComissõesPD

GET

Aprovação De Comissão
commission_companies

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

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Valor - filters[value] / Valor
Desconto - filters[discount] / Desconto
Status - filters[commission_status_id] / Status
Periodo à partir- filters[period_from] / Periodo à partir
Periodo até- filters[period_until] / Periodo até
Observação- filters[observation] / Observaçã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

Configurações
distributors

Detalhes

Filtros

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Nome do Modelo - filters[name] / Nome do Modelo
Data de Vigência - filters[validity] / Data de Vigência
Tipo de Comissionamento - filters[commission_type_id] / Tipo de Comissionamento
Valor da Comissão- filters[value] / Valor da Comissã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

Conciliação

GET

Arquivo de Conciliação
edi_registers

Detalhes

Filtros

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

ID do Estabelecimento - filters[establishment_id] /ID do estabelecimento
Documento - filters[document] / Documento
Estabelecimento - filters[establishment.commercial_name] / Nome Comercial
Situação- filters[conciliation_status_id] / Situação
NSU- filters[nsu_captura] / NSU
Data Inicial- filters[initial_date] / Data inicial
Data Final- filters[final_date] / Data final

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

Análise Transacional
acquirer_transaction

Detalhes

Filtros

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

MCC - filters[mcc_id] / MCC
Adquirente - filters[acquirer_id] / Adquirente
NSU - filters[nsu] / NSU
Inicial - Final- filters[datefilter_date] / Inicial - Final
Pagamento Adq (Período)- filters[datefilter_expected_payment_date] / Pagamento Adq (Período)
Pagamento original Adq (Período)- filters[datefilter_original_expected_payment_date] / Pagamento original Adq (Período)
Previsão de Liquidação- filters[datefilter_prev_liquid] / Previsão de Liquidação
Periodo- filters[datefilter_datefinal] / Periodo
Produto- filters[product_id][] / Produto

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

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.

Filtros

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Documento - filters[document] / Tipo de dado String
Nome Fantasia - filters[establishment.commercial_name] / Tipo de dado String

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "document": "null", "establishment.commercial_name": "null", } }

Retornos

Código	Mensagem
200	{ "data":{ "data":[ { "id": 21, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "internal_balance": { "id": 17, Tipo Integer "establishment_id": 21, Tipo Integer / Id do Estabelecimento "amount": "-2.23", / Valor "created_at": "2022-03-30 08:31:35", Tipo Date "updated_at": "2022-06-13 08:51:28", Tipo Date "description": null / Descrição }, "company": { "id": 51, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { "id": 35, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date } } }, ] } }
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.

Filtros

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Período Inicial - filters[initial_date] / Tipo de dado Date
Período Final - filters[final_date] / Tipo de dado Date

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "initial_date": "null", "final_date":"null" } }

Retornos

Código	Mensagem
206	{ "data": { "data": [ { "id": 54, Tipo Integer "balance_id": 17, Tipo Integer / Id do saldo do estabelecimento "amount": "2.23", Tipo Decimal / Valor "signal": "-", Tipo String / Sinal "description": "Saldo de repasse", Tipo String / Descrição "created_at": "2022-06-13 08:51:28", Tipo Date "updated_at": "2022-06-13 08:51:28", Tipo Date "external_transfer_id": null, Tipo Integer / Id que referencia os dados da transação "payment_ticket_id": null, Tipo Integer / Id que referencia o boleto "balance_day": "-2.23", Tipo Decimal / Saldo do dia "additional_tariff_id": null, Tipo Integer / Id da tarifa adicional "establishment_credit_id": null Tipo Integer / Id do credito do estabelecimento } ], "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 1, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo Boolean "last_page": 1, Tipo Integer "is_last_page": true, Tipo Boolean "page_keys": [ 1 ], "from_item": 1, Tipo Integer "to_item": 1, Tipo Integer "total_items": 1, Tipo Integer "amount": null, Tipo Decimal / Valor "value": null, Tipo Decimal "efective": 0, Tipo Decimal "balance": 0, Tipo Decimal "low": 0, Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 1 Tipo Integer } }, "extract": 0, Tipo Decimal "operations": 0, Tipo Decimal "balance": { "id": 17, Tipo Integer "establishment_id": 21, Tipo Integer / Id do Estabelecimento "amount": "-2.23", Tipo Decimal / Valor "created_at": "2022-03-30 08:31:35", Tipo Date "updated_at": "2022-06-13 08:51:28", Tipo Date "description": null Tipo String / Descrição }, "rules": { "id": 6, Tipo Integer "max_amount_day": "9999.00", Tipo Decimal / Valor maximo do total transação diaria "max_amount": "99999999.00", Tipo Decimal / Valor maximo do total de transação "quantity_operator_day": 1000, Tipo Decimal / Quantidade maxima de operações diarias "created_at": "2022-03-21 13:41:03", Tipo Date "updated_at": "2022-03-21 13:41:03", Tipo Date "establishment_id": 21 Tipo Integer / Id do Estabelecimento }, "establishment_id": 21, Tipo Integer / Id do Estabelecimento "msg": [ "OK" ], "statusCode": 200 }
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.

Filtros

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Documento - filters[document] / Tipo de dado String
Nome Fantasia - filters[commercial_name] / Tipo de dado String
Tipo de Operação - filters[operation_type] / Tipo de dado Integer
Período Inicial - filters[initial_date] / Tipo de dado Date
Período Final - filters[final_date] / Tipo de dado Date

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "document": "null", "commercial_name": / Nome Comercial"null", "operation_type": "null", "document": "null", "initial_date": "null", "final_date": "null" } }

Retornos

Código	Mensagem
200	"data":{ "data":[ { "id": 34, Tipo Integer "establishment_id": null, Tipo Integer / Id do Estabelecimento "amount": "2.22", Tipo String / Valor "tax": null, Tipo String "status_id": 1, Tipo Integer "expected_payment_date": "2022-04-13", Tipo Date "payment_date": null, Tipo Date / Data de Pagamento "external_code": null, Tipo String / Código externo "bank_id": 1, Tipo Integer "account": "111111111111", Tipo String "digit_account": "11", Tipo String "agency": "111111111", Tipo String "digit_agency": "11", Tipo String "holder_document": "39373389000156", Tipo String "holder": "Carla e Daniel Assessoria Jurídica ME", Tipo String "people_type_id": 2, Tipo Integer "created_at": "2022-04-12 07:20:52", Tipo Date "updated_at": "2022-04-12 07:20:52", Tipo Date "observation": "aaaaaaa", Tipo String "type_transfer_id": 1, Tipo Integer "favorite_id": null, Tipo Integer "balance_day": null, "account_type_id": null, Tipo Integer "bank": { "id": 1, Tipo Integer "code": "341", Tipo String / Codigo do banco "name": "BANCO ITAU S.A.", Tipo String / Nome do banco "ispb": "60701190", Tipo String / isbp "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:06" Tipo Date }, "type": { "id": 1, Tipo Integer "description": "Transferência para conta própria", / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "establishment": null }, ] "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 2, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo Boolean "last_page": 4, Tipo Integer "is_last_page": false, Tipo Boolean "page_keys": [ 1, 2, 3 ], "from_item": 1, Tipo Integer "to_item": 10, Tipo Integer "total_items": 34, Tipo Integer "amount": null, Tipo Decimal / Valor "value": null, Tipo Decimal "efective": 0, Tipo Decimal "balance": 0, Tipo Decimal "low": 0, Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 10 Tipo Integer } }, "msg": [ "OK" ], "statusCode": 200 }
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

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
206	{ "data": { "id": 34, Tipo Integer "establishment_id": null, Tipo Integer / Id do Estabelecimento "amount": "2.22", Tipo Decimal / Valor "tax": null, Tipo Decimal "status_id": 1, Tipo Integer "expected_payment_date": "2022-04-13", Tipo Date "payment_date": null, Tipo Date / Data de Pagamento "external_code": null, Tipo String / Código externo "bank_id": 1, Tipo Integer "account": "111111111111", Tipo String "digit_account": "11", Tipo String "agency": "111111111", Tipo String "digit_agency": "11", Tipo String "holder_document": "39373389000156", Tipo String "holder": "Carla e Daniel Assessoria Jurídica ME", Tipo String "people_type_id": 2, Tipo Integer "created_at": "2022-04-12 07:20:52", Tipo Date "updated_at": "2022-04-12 07:20:52", Tipo Date "observation": "aaaaaaa", Tipo String "type_transfer_id": 1, Tipo Integer "favorite_id": null, Tipo Integer "balance_day": null, "account_type_id": null, Tipo Integer "establishment": null, "bank": { "id": 1, Tipo Integer "code": "341", Tipo String / Codigo do banco "name": "BANCO ITAU S.A.", Tipo String / Nome do banco "ispb": "60701190", Tipo String / isbp "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:06" Tipo Date }, "status": { "id": 1, Tipo Integer "description": "Aguardando pagamento", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "people_type": { "id": 2, Tipo Integer "name": "Pessoa Jurídica", Tipo String / Nome "abbreviation": "PJ", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "external_transfer_tariff": { "id": 33, Tipo Integer "external_transfer_id": 34, Tipo Integer "tariff_id": 792, Tipo Integer "amount_charged": "0.25", Tipo Decimal / Valor cobrado após tarifas "amount": "0.25", Tipo Decimal / Valor "created_at": "2022-04-12 07:20:52", Tipo Date "updated_at": "2022-04-12 07:20:52" Tipo Date }, "type": { "id": 1, Tipo Integer "description": "Transferência para conta própria", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "account_type": null Tipo Integer }, "msg": [ "OK" ], "statusCode": 200 }
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.

Filtros

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

ID - filters[nsu] / Tipo de dado String
ID Estabelecimento - filters[establishment_id] / Tipo de dado Interger
Nome Fantasia - filters[establishment.commercial_name] / Tipo de dado String
Documento - filters[document] / Tipo de dado String
Agendamento - filters[expected_payment_date] / Tipo de dado Date
Pagamento - filters[payment_date] / Tipo de dado Date
Status - filters[status_id] / Tipo de dado Interger
Tipo - filters[type] / Tipo de dado Interger

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "nsu": "null", "establishment_id": "null", "status_id": "null", "type": "null", "document": "null", "establishment.commercial_name": "null", "payment_date": / Data de Pagamento"null", "expected_payment_date": "null" } }

Retornos

Código	Mensagem
200	"data":{ "data":[ { "id": 34, Tipo Integer "establishment_id": null, Tipo Integer / Id do Estabelecimento "amount": "2.22", Tipo Decimal / Valor "tax": null, Tipo Decimal "status_id": 1, Tipo Integer "expected_payment_date": "2022-04-13", Tipo Date "payment_date": null, Tipo Date / Data de Pagamento "external_code": null, Tipo String / Código externo "bank_id": 1, Tipo Integer "account": "111111111111", Tipo String "digit_account": "11", Tipo String "agency": "111111111", Tipo String "digit_agency": "11", Tipo String "holder_document": "39373389000156", Tipo String "holder": "Carla e Daniel Assessoria Jurídica ME", Tipo String "people_type_id": 2, Tipo Integer "created_at": "2022-04-12 07:20:52", Tipo Date "updated_at": "2022-04-12 07:20:52", Tipo Date "observation": "aaaaaaa", Tipo String "type_transfer_id": 1, Tipo Integer "favorite_id": null, Tipo Integer "balance_day": null, Tipo Decimal "account_type_id": null, Tipo Integer "establishment": null, "bank": { "id": 1, Tipo Integer "code": "341", Tipo String / Codigo do banco "name": "BANCO ITAU S.A.", Tipo String / Nome do banco "ispb": "60701190", Tipo String / isbp "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:06" Tipo Date }, "status": { "id": 1, Tipo Integer "description": "Aguardando pagamento", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "people_type": { "id": 2, Tipo Integer "name": "Pessoa Jurídica", Tipo String / Nome "abbreviation": "PJ", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "external_transfer_tariff": { "id": 33, Tipo Integer "external_transfer_id": 34, Tipo Integer "tariff_id": 792, Tipo Integer "amount_charged": "0.25", Tipo Decimal / Valor cobrado após tarifas "amount": "0.25", Tipo Decimal / Valor "created_at": "2022-04-12 07:20:52", Tipo Date "updated_at": "2022-04-12 07:20:52", Tipo Date "tariff": { "id": 792, Tipo Integer "description": "Transferência entre bancos", Tipo String / Descrição "value": "0", Tipo Decimal / Valor "complement": null, Tipo String / Complemento "tariff_type_id": 1, Tipo Integer / Id do tipo da tarifa "frequency_id": 7, Tipo Integer / Id da frequencia em que a tarifa é aplicada "created_at": null, Tipo Date "updated_at": "2021-10-04 08:26:02", Tipo Date "franchise_qtd": 0, Tipo Decimal / Qtd Franquia "franchise_type_id": null, Tipo Integer / Id do Tipo de Franquia "franchise_rule_id": null, Tipo Integer / Id da Regra Frequência "installments": 1, Tipo Integer / Numero de parcelas que a tarifa se aplica "product_id": null, Tipo Integer / Id do Produto "discount_status": 2, Tipo Integer / Status do Desconto "ecommerce_value": "0.00", Tipo Decimal / Valor ecommerce "franchise_type": null, Tipo Integer "franchise_rule": null, Tipo Integer } }, "type": { "id": 1, Tipo Integer "description": "Transferência para conta própria", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "paylog": [], "account_type": null }, ] }
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.

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
206	{ "data": { "id": 34, Tipo Integer "establishment_id": null, Tipo Integer / Id do Estabelecimento "amount": "2.22", Tipo Decimal / Valor "tax": null, Tipo Decimal "status_id": 1, Tipo Integer "expected_payment_date": "2022-04-13", Tipo Date "payment_date": null, Tipo Date / Data de Pagamento "external_code": null, Tipo String / Código externo "bank_id": 1, Tipo Integer "account": "111111111111", Tipo String "digit_account": "11", Tipo String "agency": "111111111", Tipo String "digit_agency": "11", Tipo String "holder_document": "39373389000156", Tipo String "holder": "Carla e Daniel Assessoria Jurídica ME", Tipo String "people_type_id": 2, Tipo Integer "created_at": "2022-04-12 07:20:52", Tipo Date "updated_at": "2022-04-12 07:20:52", Tipo Date "observation": "aaaaaaa", Tipo String "type_transfer_id": 1, Tipo Integer "favorite_id": null, Tipo Integer "balance_day": null, Tipo Decimal "account_type_id": null, Tipo Integer "establishment": null, "bank": { "id": 1, Tipo Integer "code": "341", Tipo String / Codigo do banco "name": "BANCO ITAU S.A.", Tipo String / Nome do banco "ispb": "60701190", Tipo String / isbp "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:06" Tipo Date }, "status": { "id": 1, Tipo Integer "description": "Aguardando pagamento", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "people_type": { "id": 2, Tipo Integer "name": "Pessoa Jurídica", Tipo String / Nome "abbreviation": "PJ", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "external_transfer_tariff": { "id": 33, Tipo Integer "external_transfer_id": 34, Tipo Integer "tariff_id": 792, Tipo Integer "amount_charged": "0.25", Tipo Decimal / Valor cobrado após tarifas "amount": "0.25", Tipo Decimal / Valor "created_at": "2022-04-12 07:20:52", Tipo Date "updated_at": "2022-04-12 07:20:52", Tipo Date "tariff": { "id": 792, Tipo Integer "description": "Transferência entre bancos", Tipo String / Descrição "value": "0", Tipo Decimal / Valor "complement": null, Tipo String / Complemento "tariff_type_id": 1, Tipo Integer / Id do tipo da tarifa "frequency_id": 7, Tipo Integer / Id da frequencia em que a tarifa é aplicada "created_at": null, Tipo Date "updated_at": "2021-10-04 08:26:02", Tipo Date "franchise_qtd": 0, Tipo Decimal / Qtd Franquia "franchise_type_id": null, Tipo Integer / Id do Tipo de Franquia "franchise_rule_id": null, Tipo Integer / Id da Regra Frequência "installments": 1, Tipo Integer / Numero de parcelas que a tarifa se aplica "product_id": null, Tipo Integer / Id do Produto "discount_status": 2, Tipo Integer / Status do Desconto "ecommerce_value": "0.00", Tipo Decimal / Valor ecommerce "franchise_type": null, Tipo Integer "franchise_rule": null, Tipo Integer } }, "type": { "id": 1, Tipo Integer "description": "Transferência para conta própria", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "paylog": [], "account_type": null }, "msg": [ "OK" ], "statusCode": 206 }
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.

Tipo de Dado
people_type_id: Integer
bank_id: Integer
agency: String
digit_agency: String
account: String
digit_account: String
amount: Decimal
observation: String
holder_document: String
holder: String
favorite_id: Integer

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "people_type_id" : "Id do tipo de pessoa", "bank_id" : "Id do banco", "agency" : "Agencia", "digit_agency" : "Digito da agencia", "account" : "Conta", "digit_account" : "Digito da conta", "amount" : "Valor", "observation" : "Observação", "holder_document" : "Documento", "holder" : "Nome", "favorite_id" : "Id do favorito" }

Retornos

Código	Mensagem
206	{ "data": { "people_type_id": "1", Tipo Integer / Id do tipo de pessoa "bank_id": "1", Tipo Integer / Id do banco "agency": "1", Tipo String / numero da agencia "digit_agency": "1", Tipo String / Digito da agencia "account": "1", Tipo String / Numero da conta "digit_account": "1", Tipo String / Digito da conta "amount": "1", Tipo Decimal / Valor "observation": "a", Tipo String / Observação "holder_document": "22228816507", Tipo String / Documento "holder": "exemplo", Tipo String / Nome "establishment_id": 1, Tipo Integer / Id do Estabelecimento "status_id": 1, Tipo Integer / Id do status de ativação "expected_payment_date": "2022-06-14", Tipo Date / Data esperada de pagamento "type_transfer_id": 2, Tipo Integer / Id do tipo de transferencia "updated_at": "2022-06-13 15:44:13", Tipo Date "created_at": "2022-06-13 15:44:13", Tipo Date "id": 35 Tipo Integer }, "msg": [ "CRIADO" ], "statusCode": 201 }
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. Como regra de funcionamento, O "holder_document" e o "establishment_id" informados deverão ser do mesmo estabelecimento e o mesmo devera ter uma Conta bancaria conta interna com status ativo e liquidação ativa

Tipo de Dado
amount: Decimal
document: String
establishment_id: Integer
name_estab: String
observation: String
favorite_id: Integer

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "amount" : "Valor", "document" : "Documento", "establishment_id" : "Id do estabelecimento", "favorite_id" : "Id do favorito", "name_estab" : "Nome do estabelecimento", "observation" : "Observação" }

Retornos

Código	Mensagem
206	{ "data": { "establishment_id": 1, Tipo Integer / Id do Estabelecimento "amount": "1", Tipo Decimal / Valor "tax": 0, Tipo Decimal / Tarifa "status_id": 4, Tipo Integer / Id de status "expected_payment_date": "2022-06-13", Tipo Date / Data esperada de pagamento "payment_date": "2022-06-13", Tipo Date / Data de Pagamento "type_transfer_id": 3, Tipo Integer / Id do tipo de transferencia "external_code": null, Tipo String / Código externo "bank_id": 340, Tipo Integer / Id do banco "account": "333333333333", Tipo String / Numero da conta "digit_account": "44", Tipo String / Digito da conta "agency": "111111111", Tipo String / Numero da agencia "digit_agency": "22", Tipo String / Digito da agencia "holder_document": "81865755000150", Tipo String / Documento "holder": "Rebeca Alves", Tipo String / Nome "people_type_id": 2, Tipo Integer / Id do tipo de pessoa "observation": "aaaa", Tipo String / Observação "updated_at": "2022-06-13 15:47:31", Tipo Date "created_at": "2022-06-13 15:47:31", Tipo Date "id": 36 Tipo Integer }, "msg": [ "CRIADO" ], "statusCode": 201 }
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

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "people_type_id" : "Id do tipo de pessoa", "bank_id" : "Id do banco", "agency" : "Agencia", "digit_agency" : "Digito da agencia", "account" : "Conta", "digit_account" : "Digito da conta", "amount" : "Valor", "observation" : "Observação", "holder_document" : "Documento", "holder" : "Nome" }

Retornos

Código	Mensagem
206	{ "data": { "people_type_id": "1", Tipo Integer / Id do tipo de pessoa "bank_id": "1", Tipo Integer / Id do banco "agency": "1", Tipo String / numero da agencia "digit_agency": "1", Tipo String / Digito da agencia "account": "1", Tipo String / Numero da conta "digit_account": "1", Tipo String / Digito da conta "amount": "1", Tipo Decimal / Valor "observation": "a", Tipo String / Observação "holder_document": "22228816507", Tipo String / Documento "holder": "exemplo", Tipo String / Nome "establishment_id": 1, Tipo Integer / Id do Estabelecimento "status_id": 1, Tipo Integer / Id do status de ativação "expected_payment_date": "2022-06-14", Tipo Date / Data esperada de pagamento "type_transfer_id": 2, Tipo Integer / Id do tipo de transferencia "updated_at": "2022-06-13 15:44:13", Tipo Date "created_at": "2022-06-13 15:44:13", Tipo Date "id": 35 Tipo Integer }, "msg": [ "CRIADO" ], "statusCode": 201 }
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.

Filtros

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Nome - filters[name] / Tipo de dado String
Documento - filters[document] / Tipo de dado String

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "name": "null", "document": "null" } }

Retornos

Código	Mensagem
200	{ "data":{ "data":[ { "id": 1, Tipo Integer "establishment_id": 1, Tipo Integer / Id do Estabelecimento "document": "22228816507", Tipo String / Documento "name": "xampson", Tipo String / Nome "agency": null, Tipo String / Agencia "digit_agency": null, Tipo String / Digito da agencia "account": null, Tipo String / Conta "digit_account": null, Tipo String / Digito da conta "bank_id": null, Tipo Integer / Id do banco "created_at": "2022-06-13 15:53:14", Tipo Date "updated_at": "2022-06-13 15:53:14", Tipo Date "status": 1, Tipo Integer / Id do status de ativação "status_edit": 2, Tipo Integer / Id do status de ativação "account_type_id": null, Tipo Integer / Id do tipo da conta "establishment": { "id": 1, Tipo Integer "commercial_name": "Xampson", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 9, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão }, "bank": null, "status_d": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "account_type": null } ] } }
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.

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
200	{ "data": { "id": 1, Tipo Integer "establishment_id": 1, Tipo Integer / Id do Estabelecimento "document": "22228816507", Tipo String / Documento "name": "xampson", Tipo String / Nome "agency": null, Tipo String / Agencia "digit_agency": null, Tipo String / Digito da agencia "account": null, Tipo String / Conta "digit_account": null, Tipo String / Digito da conta "bank_id": null, Tipo Integer / Id do banco "created_at": "2022-06-13 15:53:14", Tipo Date "updated_at": "2022-06-13 15:53:14", Tipo Date "status": 1, Tipo Integer / Id do status de ativação "status_edit": 2, Tipo Integer / Id do status de ativação "account_type_id": null, Tipo Integer / Id do tipo da conta "establishment": { "id": 1, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 9, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão }, "bank": null, "status_d": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "account_type": null }
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

Tipo de Dado
ID: Integer

Parâmetros

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

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.

Tipo de Dado
document: String
name: String

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "document" : "Documento", "name" : "Nome" }

Retornos

Código	Mensagem
201	{ "data": { "document": "22228816507", Tipo String / Documento "name": "xampson", Tipo String / Nome "establishment_id": 1, Tipo Integer / Id do Estabelecimento "status_edit": 2, Tipo Integer / Id de status de ativação "updated_at": "2022-06-13 15:53:14", Tipo Date "created_at": "2022-06-13 15:53:14", Tipo Date "id": 1 Tipo Integer }, "msg": [ "CRIADO" ], "statusCode": 201 }
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.

Tipo de Dado
bank_id: Integer
agency: String
digit_agency: String
account: String
digit_account: String
document: String
name: String

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "bank_id" : "Id do banco", "agency" : "Agencia", "digit_agency" : "Digito da agencia", "account" : "Conta", "digit_account" : "Digito da conta", "document" : "Documento", "name" : "Nome" }

Retornos

Código	Mensagem
201	{ "data": { "establishment_id": 1, Tipo Integer / Id do Estabelecimento "document": "22228816507", Tipo String / Documento "name": "xampson", Tipo String / Nome "agency": null, Tipo String / Agencia "digit_agency": null, Tipo String / Digito da agencia "account": null, Tipo String / Conta "digit_account": null, Tipo String / Digito da conta "bank_id": null, Tipo Integer / Id do banco "created_at": "2022-06-13 15:53:14", Tipo Date "updated_at": "2022-06-13 15:53:14", Tipo Date "status_edit": 2, Tipo Integer / Id do status de ativação "id": 2 Tipo Integer }, "msg": [ "CRIADO" ], "statusCode": 201 }
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

Tipo de Dado
id: Integer
bank_id: Integer
agency: String
digit_agency: String
account: String
digit_account: String

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "bank_id" : "Id do banco", "agency" : "Agencia", "digit_agency" : "Digito da agencia", "account" : "Conta", "digit_account" : "Digito da conta" }

Retornos

Código	Mensagem
201	{ "data": null, "msg": [ "OK" ], "statusCode": 200 }
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	EXEMPLO: { "data":[ Array { "id": 1, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 9, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { Object "id": 9, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade } }, ] }
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.

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
206	EXEMPLO: { "data": { Object "id": 2, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 9, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "credit": [ / Valor de credito { "id": 4, Tipo Integer "establishment_id": 2, Tipo Integer / Id do Estabelecimento "expiry_date": "2022-06-07", Tipo Date "value": 1, Tipo Decimal / Valor "description": "Crédito gerado em recálculo", Tipo String / Descrição "created_at": "2022-06-06 12:50:27", Tipo Date "updated_at": "2022-06-06 12:50:27", Tipo Date "credit_status_id": 2, Tipo Integer / Id do credito de status "moneylender_solicitation_id": null, Tipo Integer / Id de solicitação de GIRO "user_id": null, Tipo Integer / Id do usuario "establishment": { "id": 2, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { "id": 13, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { "id": 10, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date } } }, "status_credit": { "id": 2, Tipo Integer "description": "Não Pago", Tipo String / Descrição "created_at": null, Tipo Date Tipo Date "updated_at": null Tipo Date Tipo Date } } ], "company": { "id": 13, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { "id": 10, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date } } }, "credit": { / Valor de credito "data": [ { "id": 4, Tipo Integer "establishment_id": 2, Tipo Integer / Id do Estabelecimento "expiry_date": "2022-06-07", Tipo Date "value": 1, Tipo Decimal "description": "Crédito gerado em recálculo", Tipo String / Descrição "created_at": "2022-06-06 12:50:27", Tipo Date "updated_at": "2022-06-06 12:50:27", Tipo Date "credit_status_id": 2, Tipo Integer "moneylender_solicitation_id": null, Tipo Integer "user_id": null, Tipo Integer "establishment": { "id": 2, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { "id": 13, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { "id": 10, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date } } }, "status_credit": { "id": 2, "description": "Não Pago", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ], "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 1, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo Boolean "last_page": 1, Tipo Integer "is_last_page": true, Tipo Boolean "page_keys": [ 1 ], "from_item": 1, Tipo Integer "to_item": 1, Tipo Integer "total_items": 1, Tipo Integer "amount": null, Tipo Decimal / Valor "value": null, Tipo Decimal "efective": 0, Tipo Decimal "balance": 0, Tipo Decimal "low": 0, Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 1 Tipo Integer } }, "msg": [ "OK" ], "statusCode": 200 }
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.

Tipo de Dado
ID: Integer
expiry_date: Date
description: String
value: Double

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	VALUE, EXPIRY_DATE, DESCRIPTION
Body	{ "value" : "Valor", "expiry_date" : "Data de vencimento", "description" : "Descrição" }

Retornos

Código	Mensagem
200	EXEMPLO: { "data": { "establishment_id": "2", Tipo Integer / Id do Estabelecimento "expiry_date": "2022-06-10", Tipo Date / Data de vencimento "value": "10.50", Tipo Decimal / Valor "description": "Exemplo de Descrição", Tipo String / Descrição "credit_status_id": 2, Tipo Integer / Id de status de credito "updated_at": "2022-06-07 11:03:17", Tipo Date "created_at": "2022-06-07 11:03:17", Tipo Date "id": 5 Tipo Integer }, "msg": [ "CRIADO" ], "statusCode": 201 }
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.

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
200	EXEMPLO: { "data": null, "msg": [ "OK" ], "statusCode": 200 }
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

GET

Financeiro
/dashboard_financial

Detalhes

Todos os dados utilizados no financeiro, 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

GET

Integrações
/dashboard_integration

Detalhes

Todos os dados utilizados no integração, 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

GET

Comissões
/dashboard_commission

Detalhes

Todos os dados utilizados no comissão, 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

GET

Conta interna
internal_account.ted

Detalhes

Todos os dados utilizados no conta interna, 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==) }
Body	{ "filters" : { "commercial_name": "null", "document": "null", "companies.status_id": "null" } }

Retornos

Código	Mensagem
200	{ "data":{ "data":[ { "id": 1, Tipo Integer "commercial_name": "Rita e Beatriz Contábil ME", Tipo String / Nome Comercial "company_id": 3, Tipo Integer / Id do company do distribuidor "created_at": "2021-09-29 12:03:59", Tipo Date "updated_at": "2021-09-29 12:03:59", Tipo Date "commission_activation": 0, Tipo Integer / Status de ativação de comissão "commission_payment": 0, Tipo Integer / Status de ativação de Suspensão de pagamentos "company": { "id": 3, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "localization": { "id": 45, Tipo Integer "company_id": 45, Tipo Integer / Id do company do distribuidor "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "contact": [ { "id": 140, Tipo Integer "company_id": 3, Tipo Integer / Id do company do distribuidor "contact_type_id": 1, Tipo Integer / Id do tipo de contato "name": "jacqueline", Tipo String / Nome "value": "11988808096", Tipo String / Telefone ou Email "created_at": "2022-06-13 09:16:38", Tipo Date "updated_at": "2022-06-13 09:16:38", Tipo Date "contact_type": { "id": 1, Tipo Integer "description": "Celular", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ], "detail": null, "bank_given": { "id": 3, Tipo Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do distribuidor "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer "account_type": { Objeto "id": 1, Tipo Integer "value": "Conta Corrente", Tipo String / Descrição do tipo da conta "created_at": null, Tipo Date "updated_at": null, Tipo Date "code": "CC" Tipo String / Código }, "holder_type": { Objeto "id": 2, Tipo Integer "value": "Pessoa Jurídica - Empresa", Tipo String / Descrição do tipo de documento representante "abbreviation": "PJE", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank": { Objeto "id": 340, Tipo Integer "code": "X1X", Tipo String / Código do banco "name": "CONTA INTERNA", Tipo String / Nome do banco "ispb": "00000000", Tipo String / Ispb do banco "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:07", Tipo Date "ispb_code": null Tipo String / Código ispb }, "holder": null }, "prepaid_card": null, "bank_given_type": { "id": 1, Tipo Integer "value": "Conta Bancária", Tipo String / Descrição do tipo da conta "abbreviation": "CB", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null, Tipo Date "status_id": 1 / Id do Status (1 - Ativo, 2 - Inativo) }, "people_type": { "id": 1, Tipo Integer "name": "Pessoa Jurídica", Tipo String / Nome "abbreviation": "PJ", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, }, "layout": { "id": 10, Tipo Integer "host": "Distribuidor", Tipo String "company_id": 3, Tipo Integer / Id do company do distribuidor "layout_id": 12, Tipo Integer / Id do layout "layout_email_id": null, Tipo Integer "created_at": "2022-01-17 08:21:51", Tipo Date "updated_at": "2022-01-17 08:21:51", Tipo Date "email": null, Tipo String / E-mail "term_of_use": null, Tipo String / Termos de uso "system": null / Tipo do siste } } ] } }
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":"Ultimo nome", "rg":"RG", "nationality":"Nacionalidade", "telephone":"Telefone", "email":"E-mail", "birth":"Data de nascimento", "document":"Documento", "bank_given_type_id": "Tipo de conta bancaria", "people_type_id": "Tipo pessoa, fisica ou jiridica", "company_details": { "social_reason": "Razão social", "document": "documento", "cnpj_matriz":"CNPJ da matriz", "branch_type_id": "Id do tipo da empresa (1 - Matriz, 2 - Filial)" } }, "localization" : { "cep": "CEP", "address": "Rua", "number": "Numero", "district": "Distrito", "city": "Cidade", "state_id": "Id do Estado", "countrie_id": "Id do Pais", "complement": "Complemento" }, "contacts" : [{ "contact_type_id": "Id do tipo de contato", "name": "nome", "value": "O contato em si (Numero de telefone ou e-mail de acordo com o tipo selecionado)" }], "prepaid_card" : { "operator_companie_id": "Id do operador", "number_card": "Numero do cartão", "printed_name": "Nome no cartão", "cpf": "CPF" }, "bank_given" : { "holder_type_id": "Id do tipo de documento", "bank_account_type_id": "Id do tipo de conta bancaria", "bank_id": "Id do banco", "agency": "Agencia", "account": "Conta", "digit_agency": "digito da agencia", "digit_account": "digito da conta" } , "bank_given_holder" : { "name": "Nome", "document": "Documento" }, "commission" : { "commission_activation": "Id de status de comissão", "commission_payment": "Id de status de suspender pagamentos", "commission_model_id": "Id do modelo de comissão", "validity": "Data de validade" } , "max_date" : "Data maxima" }

Retornos

Código	Mensagem
201	{ "data": { "commercial_name": "Kestwega", Tipo String / Nome Comercial "company_id": 81, Tipo Integer / Id do company do distribuidor "commission_activation": 0, Tipo Integer / Status de comissão "updated_at": "2022-06-07 12:46:05", Tipo Date "created_at": "2022-06-07 12:46:05", Tipo Date "id": 5, Tipo Integer "company": { "id": 81, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade } }, "msg": [ "CRIADO" ], "statusCode": 201 }
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 bank_given_holder.document é obrigatório Campo bank_given_holder.document é Inválido Campo bank_given_holder.name é obrigatório O Tamanho Máximo para o campo bank_given_holder.name é de 255 caracteres 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.

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
206	EXEMPLO : { "data": { "id": 5, Tipo Integer "commercial_name": "Kestwega", Tipo String / Nome Comercial "commercial_name": "Rita e Beatriz Contábil ME", Tipo String / Nome Comercial "company_id": 3, Tipo Integer / Id do company do distribuidor "created_at": "2021-09-29 12:03:59", Tipo Date "updated_at": "2021-09-29 12:03:59", Tipo Date "commission_activation": 0, Tipo Integer / Status de ativação de comissão "commission_payment": 0, Tipo Integer / Status de ativação de Suspensão de pagamentos "company": { "id": 81, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "localization": { "id": 45, Tipo Integer "company_id": 45, Tipo Integer / Id do company do distribuidor "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "contact": [ { "id": 216, Tipo Integer "company_id": 3, Tipo Integer / Id do company do distribuidor "contact_type_id": 1, Tipo Integer / Id do tipo de contato "name": "jacqueline", Tipo String / Nome "value": "11988808096", Tipo String / Telefone ou Email "created_at": "2022-06-13 09:16:38", Tipo Date "updated_at": "2022-06-13 09:16:38", Tipo Date "contact_type": { "id": 1, Tipo Integer "description": "Celular", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ], "detail": null, "bank_given": { "id": 76, Tipo Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do distribuidor "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer "account_type": { Objeto "id": 1, Tipo Integer "value": "Conta Corrente", Tipo String / Descrição do tipo da conta "created_at": null, Tipo Date "updated_at": null, Tipo Date "code": "CC" Tipo String / Código }, "holder_type": { Objeto "id": 2, Tipo Integer "value": "Pessoa Jurídica - Empresa", Tipo String / Descrição do tipo de documento representante "abbreviation": "PJE", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank": { Objeto "id": 340, Tipo Integer "code": "X1X", Tipo String / Código do banco "name": "CONTA INTERNA", Tipo String / Nome do banco "ispb": "00000000", Tipo String / Ispb do banco "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:07", Tipo Date "ispb_code": null Tipo String / Código ispb }, "holder": null }, "prepaid_card": null, "bank_given_type": { "id": 1, Tipo Integer "value": "Conta Bancária", Tipo String / Descrição do tipo da conta "abbreviation": "CB", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null, Tipo Date "status_id": 1 / Id do Status (1 - Ativo, 2 - Inativo) }, "people_type": { "id": 1, Tipo Integer "name": "Pessoa Jurídica", Tipo String / Nome "abbreviation": "PJ", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "commission_company": null }, "layout": null }, "msg": [ "OK" ], "statusCode": 206 }
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ATUALIZAÇÃO
/distributors/{id}

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 Atualizado", "company" : { "name": "Nome", "last_name":"Ultimo nome", "rg":"RG", "nationality":"Nacionalidade", "telephone":"Telefone", "email":"E-mail", "birth":"Data de nascimento", "document":"Documento", "bank_given_type_id": "Tipo de conta bancaria", "people_type_id": "Tipo pessoa, fisica ou jiridica", "company_details": { "social_reason": "Razão social", "document": "documento", "cnpj_matriz":"CNPJ da matriz", "branch_type_id": "Id do tipo da empresa (1 - Matriz, 2 - Filial)" } }, "localization" : { "cep": "CEP", "address": "Rua", "number": "Numero", "district": "Distrito", "city": "Cidade", "state_id": "Id do Estado", "countrie_id": "Id do Pais", "complement": "Complemento" }, "contacts" : [{ "contact_type_id": "Id do tipo de contato", "name": "nome", "value": "O contato em si (Numero de telefone ou e-mail de acordo com o tipo selecionado)" }], "prepaid_card" : { "operator_companie_id": "Id do operador", "number_card": "Numero do cartão", "printed_name": "Nome no cartão", "cpf": "CPF" }, "bank_given" : { "holder_type_id": "Id do tipo de documento", "bank_account_type_id": "Id do tipo de conta bancaria", "bank_id": "Id do banco", "agency": "Agencia", "account": "Conta", "digit_agency": "digito da agencia", "digit_account": "digito da conta" } , "bank_given_holder" : { "name": "Nome", "document": "Documento" }, "commission" : { "commission_activation": "Id de status de comissão", "commission_payment": "Id de status de suspender pagamentos", "commission_model_id": "Id do modelo de comissão", "validity": "Data de validade" } , "max_date" : "Data maxima" }

Retornos

Código	Mensagem
200	{ "data": { "id": 5, Tipo Integer "commercial_name": "Rita e Beatriz Contábil ME", Tipo String / Nome Comercial "company_id": 3, Tipo Integer / Id do company do distribuidor "created_at": "2021-09-29 12:03:59", Tipo Date "updated_at": "2021-09-29 12:03:59", Tipo Date "commission_activation": 0, Tipo Integer / Status de ativação de comissão "commission_payment": 0, Tipo Integer / Status de ativação de Suspensão de pagamentos "company": { "id": 81, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade } }, "msg": [ "OK" ], "statusCode": 200 }
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 bank_given_holder.document é obrigatório Campo bank_given_holder.document é Inválido Campo bank_given_holder.name é obrigatório O Tamanho Máximo para o campo bank_given_holder.name é de 255 caracteres 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

INATIVAR E ATIVAR DISTRIBUIDOR
/distributors/{id}

Detalhes

Ao chamar a API deleta o Distribuidor desejado.

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
200	{ "data": { "id": 5, Tipo Integer "commercial_name": "Rita e Beatriz Contábil ME", Tipo String / Nome Comercial "company_id": 3, Tipo Integer / Id do company do distribuidor "created_at": "2021-09-29 12:03:59", Tipo Date "updated_at": "2021-09-29 12:03:59", Tipo Date "commission_activation": 0, Tipo Integer / Status de ativação de comissão "commission_payment": 0, Tipo Integer / Status de ativação de Suspensão de pagamentos "company": { "id": 81, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade } }, "msg": [ "OK" ], "statusCode": 200 }
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

E-Commerce

get

E-Commerce Padrão
/rules_ecommerce/default

Detalhes

Ao chamar a API realiza E-Commerce padrã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

E-Commerce Estabelecimentos
/rules_ecommerce/establishment

Detalhes

Ao chamar a API realiza E-Commerce 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

Estabelecimentos

GET

LISTAGEM
/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

Caso não queira filtrar por algum dos campos abaixo, apenas apague a linha do campo dentro do objeto filters.

Id de Estabelecimento - filters[nsu] / Tipo de Dado: Integer
Nome Comercial - filters[commercial_name] / Tipo de Dado: String
Documento - filters[document] / Tipo de Dado: String
Tipo de pessoa - filters[companies.people_type_id] / Tipo de Dado: Integer
Status - filters[companies.status_id]/ Tipo de Dado: Integer
Situação - filters[establishment_situation_id]

Tipo de Dado
commercial_name: String
mcc_id: Integer
distributor_id: Integer
pdv_code: Integer
automatic_approve: Integer
reason: String

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "nsu": "null", "commercial_name": "null", "document": "null", "companies.people_type_id": "null", "companies.status_id": "null", "establishment_situation_id": "null" } }

Retornos

Código	Mensagem
200	EXEMPLO: { "data": { "id": 17, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "distributor": { "id": 1, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "company_id": 3, Tipo Integer / Id do company do distribuidor "created_at": "2021-09-29 12:03:59", Tipo Date "updated_at": "2021-09-29 12:03:59", Tipo Date "commission_activation": 0, Tipo Integer / Ativação de comissão para o distribuidor "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos }, "mccs": { "id": 76, Tipo Integer "code": "5511", Tipo String / Código do MCC "description": "Carros e Caminhões (Novos e Usados)", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date "type_id": null, Tipo Integer "minimal_balance": null, Tipo Decimal / Saldo minimo "max_post": null, Tipo Decimal / Valor minimo "min_post": null, Tipo Decimal / Valor maximo "period": null Tipo Date / Periodo }, "verification_ofac": { "id": 2, Tipo Integer "description": "Não Checado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "integration": { "id": 1, Tipo Integer "description": "Integrado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "antecipation": { "id": 3, Tipo Integer "description": "Liberado Geral", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "preposterou": { "id": 1, Tipo Integer "distributor_id": 1, Tipo Integer / Id do Distribuidor "company_id": 5, Tipo Integer / Id do company do preposto "created_at": "2021-09-29 12:06:09", Tipo Date "updated_at": "2021-09-29 12:06:09", Tipo Date "name": "Marcos", Tipo String / Nome do Preposto "commission_activation": 0, Tipo Integer / Status de comissão "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos "preposterous_credential_type_id": null Tipo Integer / Tipo de credencial do preposto }, "economic_group": { "id": 1, Tipo Integer "name": "Teste SLG", Tipo String / Nome do Grupo Econômico "code_pos": 1, Tipo String / Código POS "code_menu": 2, Tipo String / Código menu "created_at": "2021-09-29 12:15:07", Tipo Decimal "updated_at": "2021-09-29 12:15:07", Tipo Decimal "automatic_anticipations": [ { "id": 2, Tipo Integer "establishment_id": null, Tipo Integer / Id do Estabelecimento "economic_group_id": 1, Tipo Integer / Id do Grupo Econômico "anticipation_application_mode_id": 1, Tipo Integer / Id do Tipo de aplicação "anticipation_mode_id": 1, Tipo Integer / Id do Modo de aplicação "value": 1, Tipo Integer / Valor "created_at": "2022-06-02 12:52:06", Tipo Date "updated_at": "2022-06-02 12:52:06", Tipo Date "application_mode": { "id": 1, Tipo Integer "description": "Mensal", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "mode": { "id": 1, Tipo Integer "description": "Diário", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ] }, "situation": { "id": 6, Tipo Integer "description": "Aprovado Manualmente", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "product": [ { "id": 1446, Tipo Integer "establishment_id": 3, Tipo Integer / Id do Estabelecimento "product_id": 1, Tipo Integer "created_at": "2022-02-17 15:25:32", Tipo Date "updated_at": "2022-02-17 15:25:32", Tipo Date "product": { "id": 1, Tipo Integer "brand_id": 2, Tipo Integer / Id da bandeira "payment_method_id": 1, Tipo Integer / Id do metodo de pagamento "created_at": null, Tipo Date "updated_at": "2021-09-29 11:47:33", Tipo Date "cip_product_id": 1, Tipo Integer / Id do produto cip "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "brand": { "id": 2, Tipo Integer "name": "Mastercard", Tipo String / Nome da bandeira "icons": "data:image/png;base64", Tipo String / Icone em base 64 "created_at": null, Tipo Date "updated_at": null Tipo Date }, "payment_method": { "id": 1, Tipo Integer "description": "Crédito rotativo", Tipo String / Descrição "max_installments": 1, Tipo Integer / Quantidade maxima de parcelas "min_installments": 1, Tipo Integer / Quantidade minima de parcelas "created_at": null, Tipo Date "updated_at": null, Tipo Date "rules": "default" Tipo String / Regra } } } ], "document": null, Tipo String "company": { "id": 45, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "localization": { "id": 45, Tipo Integer "company_id": 45, Tipo Integer / Id do company do estabelecimento "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "localization_delivery": { "id": 1, Tipo Integer "company_id": 9, Tipo Integer / Id do company do estabelecimento "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "contact": [ { "id": 240, Tipo Integer "company_id": 3, Tipo Integer / Id do company do estabelecimento "contact_type_id": 1, Tipo Integer / Id do tipo de contato "name": "jacqueline", Tipo String / Nome "value": "11988808096", Tipo String / Telefone ou Email "created_at": "2022-06-13 09:16:38", Tipo Date "updated_at": "2022-06-13 09:16:38", Tipo Date "contact_type": { "id": 1, Tipo Integer "description": "Celular", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ], "detail": { "id": 31, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date "branch_type": { "id": 1, Tipo Integer "description": "Matriz", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "bank_given": { "id": 46, Tipo Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do estabelecimento "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer "account_type": { Objeto "id": 1, Tipo Integer "value": "Conta Corrente", Tipo String / Descrição do tipo da conta "created_at": null, Tipo Date "updated_at": null, Tipo Date "code": "CC" Tipo String / Código }, "holder_type": { Objeto "id": 2, Tipo Integer "value": "Pessoa Jurídica - Empresa", Tipo String / Descrição do tipo de documento representante "abbreviation": "PJE", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank": { Objeto "id": 340, Tipo Integer "code": "X1X", Tipo String / Código do banco "name": "CONTA INTERNA", Tipo String / Nome do banco "ispb": "00000000", Tipo String / Ispb do banco "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:07", Tipo Date "ispb_code": null Tipo String / Código ispb }, "holder": null }, "prepaid_card": null, "bank_given_type": { "id": 1, Tipo Integer "value": "Conta Bancária", Tipo String / Descrição do tipo da conta "abbreviation": "CB", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null, Tipo Date "status_id": 1 / Id do Status (1 - Ativo, 2 - Inativo) }, "people_type": { "id": 2, Tipo Integer "name": "Pessoa Jurídica", Tipo String / Nome "abbreviation": "PJ", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "internal_parameter": { "id": 4, Tipo Integer "max_amount_day": "9999.00", Tipo Decimal / Valor maximo diario "max_amount": "99999999.00", Tipo Decimal / Valor maximo "quantity_operator_day": 1000, Tipo Decimal / Quantidade maxima de operações diarias "created_at": "2022-03-20 17:43:09", Tipo Date "updated_at": "2022-03-20 17:43:09", Tipo Date "establishment_id": 17 Tipo Integer / Id do Estabelecimento }, "father": [ { "id": 1, Tipo Integer "father_id": 17, Tipo Integer "establishment_id": 18, Tipo Integer / Id do Estabelecimento "value": "1.00", Tipo Decimal "created_at": "2022-06-02 13:00:04", Tipo Date "updated_at": "2022-06-02 13:00:04", Tipo Date "establishment": { "id": 18, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { "id": 46, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { "id": 32, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date } } } } ], "tariffs": [ { "id": 26, Tipo Integer "establishment_id": 1, Tipo Integer / Id do Estabelecimento "tariff_id": 236, Tipo Integer / Id da tarifa "value": "1.38", Tipo Decimal / Valor "ecommerce_change": "0.00", Tipo Decimal / Valor ecommerce calculos tarifa "ecommerce_value": "0.00", Tipo Decimal / Valor ecommerce antes do comissionamento tarifa "created_at": "2021-10-04 11:41:07", Tipo Date "updated_at": "2021-10-07 09:22:54", Tipo Date "value_change": "10.00", Tipo Decimal / Valor padrão após calculos "type_change_id": 2, Tipo Integer / Id do tipo de aplicação da tarifa "type_change_ecommerce": null, Tipo Integer / Id do tipo de aplicação da tarifa ecommerce "tariff": { "id": 236, Tipo Integer "description": "Transferência entre bancos", Tipo String / Descrição "value": "0", Tipo Decimal / Valor "complement": null, Tipo String / Complemento "tariff_type_id": 1, Tipo Integer / Id do tipo da tarifa "frequency_id": 7, Tipo Integer / Id da frequencia em que a tarifa é aplicada "created_at": null, Tipo Date "updated_at": "2021-10-04 08:26:02", Tipo Date "franchise_qtd": 0, Tipo Decimal / Qtd Franquia "franchise_type_id": null, Tipo Integer / Id do Tipo de Franquia "franchise_rule_id": null, Tipo Integer / Id da Regra Frequência "installments": 1, Tipo Integer / Numero de parcelas que a tarifa se aplica "product_id": null, Tipo Integer / Id do Produto "discount_status": 2, Tipo Integer / Status do Desconto "ecommerce_value": "0.00", Tipo Decimal / Valor ecommerce "franchise_type": null, Tipo Integer "franchise_rule": null, Tipo Integer "tariff_type": { "id": 2, Tipo Integer "description": "%", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "frequency": { "id": 5, Tipo Integer "description": "Transação Financeira", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } }, ], "payment_status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "cerc_status": { "id": 2, Tipo Integer "description": "Recusado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "payment_logs": { "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 1, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo Boolean "last_page": 1, Tipo Integer "is_last_page": true, Tipo Boolean "page_keys": [ 1 ], "from_item": null, Tipo Integer "to_item": null, Tipo Integer "total_items": 0, Tipo Integer "amount": null, Tipo Decimal / Valor "value": null, Tipo Decimal "efective": 0, Tipo Decimal "balance": 0, Tipo Decimal "low": 0, Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 0 Tipo Integer } }, "msg": [ "OK" ], "statusCode": 206 }
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).

O objeto base64 com o campo pdv_file sempre sera enviado como null.

O array products é do cadastro de produtos para o estabelecimento, caso não houver cadastro de produtos não enviar na requisição.

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

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

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

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

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

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

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

Exportar Produtos Exportar Mccs

Tipo de Dado
commercial_name: String
mcc_id: Integer
distributor_id: Integer
pdv_code: Integer
automatic_approve: Integer
reason: String
company: Object
   company.name: String
   company.last_name: String
   company.rg: String
   company.nationality: String
   company.telephone: String
   company.email: String
   company.birth: Date
   company.document: String
   company.city_insc: String
   company.state_insc: String
   company.bank_given_type_id: Integer
   company.people_type_id: Integer
   company.company_details.social_reason: String
   company.company_details.document: String
   company.company_details.cnpj_matriz: String
   company.company_details.branch_type_id: Integer
localization: Object
   localization.cep: String
   localization.address: String
   localization.number: String
   localization.district: String
   localization.city: String
   localization.state_id: Integer
   localization.countrie_id: Integer
   localization.complement: String
contacts: Array of Objects
   contacts.contact_type_id: Integer
   contacts.name: String
   contacts.value: String
prepaid_card: Object
   prepaid_card.operator_companie_id: Integer
   prepaid_card.number_card: String
   prepaid_card.printed_name: String
   prepaid_card.cpf: String
internal: Object
   internal.holder_type_id: Integer
   internal.bank_account_type_id: Integer
   internal.bank_id: Integer
   internal.agency: String
   internal.digit_agency: Integer
   internal.account: String
   internal.digit_account: Integer
internal_parameter: Object
   internal_parameter.max_amount_day: Decimal
   internal_parameter.max_amount: Decimal
   internal_parameter.quantity_operator_day: Integer
bank_given: Object
   bank_given.bank_account_type_id: Integer
   bank_given.holder_type_id: Integer
   bank_given.bank_id: Integer
   bank_given.agency: Integer
   bank_given.digit_agency: Integer
   bank_given.account: Integer
   bank_given.digit_account: Integer
bank_given_holder: Object
   bank_given_holder.name: String
   bank_given_holder.document: String
products: Array\ of Objects
   products.product_id: Integer
base64: Object
   base64.pdv_file: String (Base64)
files: Object
   files.name: String
   files.extension: String
   files.contents: String (Base64)

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, STATE_ID, 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", "mcc_id" : "Id do mcc", "distributor_id" : "Id do distribuidor", "preposterou_id" : "Id do preposto", "economic_group_id" : "Id do grupo econômico", "pdv_code" : "Codigo pdv", "company" : { "name": "Nome", "last_name":"Ultimo nome", "rg":"RG", "nationality":"Nacionalidade", "telephone":"Telefone", "email":"E-mail", "birth":"Data de nascimento", "document":"Documento", "bank_given_type_id": "Tipo de conta bancaria", "people_type_id": "Tipo pessoa, fisica ou jiridica", "company_details": { "social_reason": "Razão social", "document": "documento", "cnpj_matriz":"CNPJ da matriz", "branch_type_id": "Id do tipo da empresa (1 - Matriz, 2 - Filial)" } }, "localization" : { "cep": "CEP", "address": "Rua", "number": "Numero", "district": "Distrito", "city": "Cidade", "state_id": "Id do Estado", "countrie_id": "Id do Pais", "complement": "Complemento" }, "contacts" : [{ "contact_type_id": "Id do tipo de contato", "name": "nome", "value": "O contato em si (Numero de telefone ou e-mail de acordo com o tipo selecionado)" }, { "contact_type_id":"Id do tipo de contato", "name":"nome", "value":"O contato em si (Numero de telefone ou e-mail de acordo com o tipo selecionado)" } ], "prepaid_card" : { "operator_companie_id": "Id do operador", "number_card": "Numero do cartão", "printed_name": "Nome no cartão", "cpf": "CPF" }, "internal" : { "holder_type_id": "Id do tipo de documento", "bank_account_type_id": "Id do tipo de conta bancaria", "bank_id": "Id do banco", "agency": "Agencia", "account": "Conta", "digit_agency": "digito da agencia", "digit_account": "digito da conta" }, "internal_parameter" : { "max_amount_day": "Valor maximo diario", "max_amount": "Valor maximo da transação", "quantity_operator_day": "Quantidade maxima de transações por dia", }, "bank_given" : { "holder_type_id": "Id do tipo de documento", "bank_account_type_id": "Id do tipo de conta bancaria", "bank_id": "Id do banco", "agency": "Agencia", "account": "Conta", "digit_agency": "digito da agencia", "digit_account": "digito da conta" } , "bank_given_holder" : { "name": "Nome", "document": "Documento" }, "products" : [{ "product_id": "Id do produto"}], "base64" : { "pdv_file": "null"}, "files" : { "adesao_file": {"name": "Nome do arquivo com a extensão", "extension": "extensão", "contents": "Codificado em base64"}, "rg_file": {"name": "Nome do arquivo", "extension": "Extensão do arquivo", "contents": "Codificado em base64"}, "cpf_file": {"name": "Nome do arquivo", "extension": "extensão", "contents": "Codificado em base64"}, "social_contract_file": {"name": "Nome do arquivo", "extension": "extensão", "contents": "Codificado em base64"}, "proof_address_file": {"name": "Nome do arquivo", "extension": "extensão", "contents": "Codificado em base64"}, "proof_bank_details_file": {"name": "Nome do arquivo", "extension": "extensão", "contents": "Codificado em base64"}, "pdv_file": {"name": "Nome do arquivo", "extension": "extensão", "contents": "Codificado em base64"}, "other_file": {"name": "Nome do arquivo", "extension": "extensão", "contents": "Codificado em base64"} } }

Retornos

Código	Mensagem
201	EXEMPLO : { "data": { "commercial_name": "Valmir", Tipo String / Nome Comercial "mcc_id": "2", Tipo Integer / Id do mcc "establishment_situation_id": 1, Tipo Integer / Id da situação do estabelecimento "preposterou_id": "1", Tipo Integer / Id do preposto "distributor_id": "1", Tipo Integer / Id do distribuidor "ofac_status_id": 2, Tipo Integer / Id do status de OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": "1", Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "pdv_code": "11111111111111", Tipo String / Codigo pdv "has_delivery_address": 2, Tipo Integer / Ativação do endereço de entrega "company_id": 94, Tipo Integer / Id do company do estabelecimento "updated_at": "2022-05-30 08:07:15", Tipo Date "created_at": "2022-05-30 08:07:15", Tipo Date "id": 28, Tipo Integer "company": { "id": 97, "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade } }, "msg": [ "CRIADO" ], "statusCode": 201 }
401	Campo mcc_id é 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 bank_given_holder.document é obrigatório Campo bank_given_holder.document é Inválido Campo bank_given_holder.name é obrigatório O Tamanho Máximo para o campo bank_given_holder.name é de 255 caracteres 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.

GET

BUSCAR POR ID
/establishments/{id}

Detalhes

Ao chamar a API realiza listagem de uma única AFILIADO, para isso a rota recebe o ID do estabelecimento. É necessário lembrar que o ID precisa corresponder a um estabelecimento cadastrado.

Tipo de Dado
id: Integer

Parâmetros

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

Retornos

Código	Mensagem
206	EXEMPLO: { "id": 1, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "distributor": { "id": 1, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "company_id": 3, Tipo Integer / Id do company do distribuidor "created_at": "2021-09-29 12:03:59", Tipo Date "updated_at": "2021-09-29 12:03:59", Tipo Date "commission_activation": 0, Tipo Integer / Ativação de comissão para o distribuidor "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos }, "mccs": { "id": 70, Tipo Integer "code": "5511", Tipo String / Código do MCC "description": "Carros e Caminhões (Novos e Usados)", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date "type_id": null, Tipo Integer "minimal_balance": null, Tipo Decimal / Saldo minimo "max_post": null, Tipo Decimal / Valor minimo "min_post": null, Tipo Decimal / Valor maximo "period": null Tipo Date / Periodo }, "verification_ofac": { "id": 1, Tipo Integer "description": "Checado", Tipo String / Descrição "created_at": null, Tipo Decimal "updated_at": null Tipo Decimal }, "integration": { "id": 1, Tipo Integer "description": "Integrado", Tipo String / Descrição "created_at": null, Tipo Decimal "updated_at": null Tipo Decimal }, "antecipation": { "id": 3, Tipo Integer "description": "Liberado Geral", Tipo String / Descrição "created_at": null, Tipo Decimal "updated_at": null Tipo Decimal }, "preposterou": { "id": 1, Tipo Integer "distributor_id": 1, Tipo Integer / Id do Distribuidor "company_id": 5, Tipo Integer / Id do company do preposto "created_at": "2021-09-29 12:06:09", Tipo Date "updated_at": "2021-09-29 12:06:09", Tipo Date "name": "Marcos", Tipo String / Nome do Preposto "commission_activation": 0, Tipo Integer / Status de comissão "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos "preposterous_credential_type_id": null Tipo Integer / Tipo de credencial do preposto }, "economic_group": { "id": 1, Tipo Integer "name": "Teste SLG", Tipo String / Nome do Grupo Econômico "code_pos": 1, Tipo String / Código POS "code_menu": 2, Tipo String / Código menu "created_at": "2021-09-29 12:15:07", Tipo Decimal "updated_at": "2021-09-29 12:15:07", Tipo Decimal "automatic_anticipations": [] }, "situation": { "id": 6, Tipo Integer "description": "Aprovado Manualmente", Tipo String / Descrição "created_at": null, Tipo Decimal "updated_at": null Tipo Decimal }, "company": { "id": 9, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "localization": { "id": 45, Tipo Integer "company_id": 45, Tipo Integer / Id do company do estabelecimento "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "localization_delivery": { "id": 1, Tipo Integer "company_id": 9, Tipo Integer / Id do company do estabelecimento "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "contact": [ { "id": 202, Tipo Integer "company_id": 3, Tipo Integer / Id do company do estabelecimento "contact_type_id": 1, Tipo Integer / Id do tipo de contato "name": "jacqueline", Tipo String / Nome "value": "11988808096", Tipo String / Telefone ou Email "created_at": "2022-06-13 09:16:38", Tipo Date "updated_at": "2022-06-13 09:16:38", Tipo Date "contact_type": { "id": 1, Tipo Integer "description": "Celular", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ] "bank_given": { "id": 9, Tipo Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do estabelecimento "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer "account_type": { Objeto "id": 1, Tipo Integer "value": "Conta Corrente", Tipo String / Descrição do tipo da conta "created_at": null, Tipo Date "updated_at": null, Tipo Date "code": "CC" Tipo String / Código }, "holder_type": { Objeto "id": 2, Tipo Integer "value": "Pessoa Jurídica - Empresa", Tipo String / Descrição do tipo de documento representante "abbreviation": "PJE", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank": { Objeto "id": 340, Tipo Integer "code": "X1X", Tipo String / Código do banco "name": "CONTA INTERNA", Tipo String / Nome do banco "ispb": "00000000", Tipo String / Ispb do banco "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:07", Tipo Date "ispb_code": null Tipo String / Código ispb }, }, "bank_given_type": { "id": 1, Tipo Integer "value": "Conta Bancária", Tipo String / Descrição do tipo da conta "abbreviation": "CB", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null, Tipo Date "status_id": 1 / Id do Status (1 - Ativo, 2 - Inativo) }, "people_type": { "id": 1, Tipo Integer "name": "Pessoa Fisica", Tipo String / Nome "abbreviation": "PJ", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Decimal "updated_at": null Tipo Decimal } }, "internal_parameter": { "id": 1, Tipo Integer "max_amount_day": "9999.00", Tipo Decimal / Valor maximo diario "max_amount": "99999999.00", Tipo Decimal / Valor maximo "quantity_operator_day": 1000, Tipo Decimal / Quantidade maxima de operações diarias "created_at": "2022-03-20 17:43:09", Tipo Date "updated_at": "2022-03-20 17:43:09", Tipo Date "establishment_id": 17 Tipo Integer / Id do Estabelecimento }, "automatic_anticipations": [ { "id": 1, Tipo Integer "establishment_id": 1, Tipo Integer / Id do estabelecimento "economic_group_id": null, Tipo Integer / Id do grupo econômico "anticipation_application_mode_id": 2, Tipo Integer / Id forma de aplicação da antecipação automatica "anticipation_mode_id": 1, Tipo Integer / Id do tipo de aplicação da antecipação automatica "value": 1, Tipo Integer / Prazo D+ "created_at": "2022-06-13 08:49:27", Tipo Date "updated_at": "2022-06-13 08:49:27", Tipo Date "application_mode": { "id": 2, Tipo Integer "description": "Parcela", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "mode": { "id": 1, Tipo Integer "description": "Diário", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ], "payment_status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "cerc_status": { "id": 2, Tipo Integer "description": "Recusado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }
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).

O objeto base64 com o campo pdv_file sempre sera enviado como null.

O array products é do cadastro de produtos para o estabelecimento, caso não houver cadastro de produtos não enviar na requisição.

Dados Bancários:
O campo dado bancário (_validNewBank), é necessário para cadastrar uma nova conta bancaria

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

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

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

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

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

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

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

Tipo de Dado
commercial_name: String
mcc_id: Integer
distributor_id: Integer
pdv_code: Integer
automatic_approve: Integer
reason: String
company: Object
   name: String
   last_name: String
   rg: String
   nationality: String
   telephone: String
   email: String
   birth: Date
   document: String
   city_insc: String
   state_insc: String
   bank_given_type_id: Integer
   people_type_id: Integer
   company_details.social_reason: String
   company_details.document: String
   company_details.cnpj_matriz: String
   company_details.branch_type_id: Integer
localization: Object
   cep: String
   address: String
   number: String
   district: String
   city: String
   state_id: Integer
   countrie_id: Integer
   complement: String
contacts: Array of Objects
   contact_type_id: Integer
   name: String
   value: String
prepaid_card: Object
   operator_companie_id: Integer
   number_card: String
   printed_name: String
   cpf: String
internal: Object
   holder_type_id: Integer
   bank_account_type_id: Integer
   bank_id: Integer
   agency: String
   digit_agency: Integer
   account: String
   digit_account: Integer
internal_parameter: Object
   max_amount_day: Decimal
   max_amount: Decimal
   quantity_operator_day: Integer
bank_given: Object
   bank_account_type_id: Integer
   holder_type_id: Integer
   bank_id: Integer
   agency: Integer
   digit_agency: Integer
   account: Integer
   digit_account: Integer
bank_given_holder: Object
   name: String
   document: String
products: Array\ of Objects
   product_id: Integer
base64: Object
   pdv_file: String (Base64)
files: Object
   name: String
   extension: String
   contents: String

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, STATE_ID, 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", "mcc_id" : "Id do mcc", "distributor_id" : "Id do distribuidor", "preposterou_id" : "Id do preposto", "integration_status_id" : "Id do status de integração", "economic_group_id" : "Id do grupo econômico", "anticipation_status_id" : "Id do status de antecipação", "ofac_status_id" : "Id do status de OFAC", "pdv_code" : "Codigo pdv", "has_delivery_address" : "Ativação do endereço de entrega", "company_id" : "Id do company do estabelecimento", "company" : { "name": "Nome", "last_name":"Ultimo nome", "rg":"RG", "nationality":"Nacionalidade", "telephone":"Telefone", "email":"E-mail", "birth":"Data de nascimento", "document":"Documento", "bank_given_type_id": "Tipo de conta bancaria", "people_type_id": "Tipo pessoa, fisica ou jiridica", "company_details": { "social_reason": "Razão social", "document": "documento", "cnpj_matriz":"CNPJ da matriz", "branch_type_id": "Id do tipo da empresa (1 - Matriz, 2 - Filial)" } }, "localization" : { "cep": "CEP", "address": "Rua", "number": "Numero", "district": "Distrito", "city": "Cidade", "state_id": "Id do Estado", "countrie_id": "Id do Pais", "complement": "Complemento" }, "contacts" : [{ "contact_type_id": "Id do tipo de contato", "name": "nome", "value": "O contato em si (Numero de telefone ou e-mail de acordo com o tipo selecionado)" }], "prepaid_card" : { "operator_companie_id": "Id do operador", "number_card": "Numero do cartão", "printed_name": "Nome no cartão", "cpf": "CPF" }, "internal" : { "holder_type_id": "Id do tipo de documento", "bank_account_type_id": "Id do tipo de conta bancaria", "bank_id": "Id do banco", "agency": "Agencia", "account": "Conta", "digit_agency": "digito da agencia", "digit_account": "digito da conta" }, "internal_parameter" : { "max_amount_day": "Valor maximo diario", "max_amount": "Valor maximo da transação", "quantity_operator_day": "Quantidade maxima de transações por dia", }, "bank_given" : { "holder_type_id": "Id do tipo de documento", "bank_account_type_id": "Id do tipo de conta bancaria", "bank_id": "Id do banco", "agency": "Agencia", "account": "Conta", "digit_agency": "digito da agencia", "digit_account": "digito da conta" } , "bank_given_holder" : { "name": "Nome", "document": "Documento" }, "products" : [{ "product_id": "Id do produto"}], "base64" : { "pdv_file": "null"}, "files" : { "adesao_file": {"name": "Nome do arquivo", "extension": "extensão", "contents": "Codificado em base64"}, "rg_file": {"name": "Nome do arquivo", "extension": "Extensão do arquivo", "contents": "Codificado em base64"}, "cpf_file": {"name": "Nome do arquivo", "extension": "extensão", "contents": "Codificado em base64"}, "social_contract_file": {"name": "Nome do arquivo", "extension": "extensão", "contents": "Codificado em base64"}, "proof_address_file": {"name": "Nome do arquivo", "extension": "extensão", "contents": "Codificado em base64"}, "proof_bank_details_file": {"name": "Nome do arquivo", "extension": "extensão", "contents": "Codificado em base64"}, "pdv_file": {"name": "Nome do arquivo", "extension": "extensão", "contents": "Codificado em base64"}, "other_file": {"name": "Nome do arquivo", "extension": "extensão", "contents": "Codificado em base64"} } }

Retornos

Código	Mensagem
201	EXEMPLO: { "data": { "id": 1, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { "id": 9, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade } }, "msg": [ "OK" ], "statusCode": 200 }
401	Campo mcc_id é 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 bank_given_holder.document é obrigatório Campo bank_given_holder.document é Inválido Campo bank_given_holder.name é obrigatório O Tamanho Máximo para o campo bank_given_holder.name é de 255 caracteres 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.
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.

PUT

DELETAR
/establishments/delete/{id}

Detalhes

Ao chamar a API bloqueia e desbloqueia o estabelecimento

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "reason" : "Razão" }

Retornos

Código	Mensagem
200	EXEMPLO : { "data": { "id": 3, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { "id": 16, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { "id": 13, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date } } }, "msg": [ "OK" ], "statusCode": 200 }
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==) }
Body	{ "" : "" }

Retornos

Código	Mensagem
200	EXEMPLO: { "data": { "id": 17, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "distributor": { "id": 1, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "company_id": 3, Tipo Integer / Id do company do distribuidor "created_at": "2021-09-29 12:03:59", Tipo Date "updated_at": "2021-09-29 12:03:59", Tipo Date "commission_activation": 0, Tipo Integer / Ativação de comissão para o distribuidor "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos }, "mccs": { "id": 76, Tipo Integer "code": "5511", Tipo String / Código do MCC "description": "Carros e Caminhões (Novos e Usados)", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date "type_id": null, Tipo Integer "minimal_balance": null, Tipo Decimal / Saldo minimo "max_post": null, Tipo Decimal / Valor minimo "min_post": null, Tipo Decimal / Valor maximo "period": null Tipo Date / Periodo }, "verification_ofac": { "id": 2, Tipo Integer "description": "Não Checado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "integration": { "id": 1, Tipo Integer "description": "Integrado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "antecipation": { "id": 3, Tipo Integer "description": "Liberado Geral", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "preposterou": { "id": 1, Tipo Integer "distributor_id": 1, Tipo Integer / Id do Distribuidor "company_id": 5, Tipo Integer / Id do company do preposto "created_at": "2021-09-29 12:06:09", Tipo Date "updated_at": "2021-09-29 12:06:09", Tipo Date "name": "Marcos", Tipo String / Nome do Preposto "commission_activation": 0, Tipo Integer / Status de comissão "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos "preposterous_credential_type_id": null Tipo Integer / Tipo de credencial do preposto }, "economic_group": { "id": 1, Tipo Integer "name": "Teste SLG", Tipo String / Nome do Grupo Econômico "code_pos": 1, Tipo String / Código POS "code_menu": 2, Tipo String / Código menu "created_at": "2021-09-29 12:15:07", Tipo Decimal "updated_at": "2021-09-29 12:15:07", Tipo Decimal "automatic_anticipations": [ { "id": 2, Tipo Integer "establishment_id": null, Tipo Integer / Id do Estabelecimento "economic_group_id": 1, Tipo Integer / Id do Grupo Econômico "anticipation_application_mode_id": 1, Tipo Integer / Id do Tipo de aplicação "anticipation_mode_id": 1, Tipo Integer / Id do Modo de aplicação "value": 1, Tipo Integer / Valor "created_at": "2022-06-02 12:52:06", Tipo Date "updated_at": "2022-06-02 12:52:06", Tipo Date "application_mode": { "id": 1, Tipo Integer "description": "Mensal", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "mode": { "id": 1, Tipo Integer "description": "Diário", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ] }, "situation": { "id": 6, Tipo Integer "description": "Aprovado Manualmente", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "product": [ { "id": 1446, Tipo Integer "establishment_id": 3, Tipo Integer / Id do Estabelecimento "product_id": 1, Tipo Integer "created_at": "2022-02-17 15:25:32", Tipo Date "updated_at": "2022-02-17 15:25:32", Tipo Date "product": { "id": 1, Tipo Integer "brand_id": 2, Tipo Integer / Id da bandeira "payment_method_id": 1, Tipo Integer / Id do metodo de pagamento "created_at": null, Tipo Date "updated_at": "2021-09-29 11:47:33", Tipo Date "cip_product_id": 1, Tipo Integer / Id do produto cip "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "brand": { "id": 2, Tipo Integer "name": "Mastercard", Tipo String / Nome da bandeira "icons": "data:image/png;base64", Tipo String / Icone em base 64 "created_at": null, Tipo Date "updated_at": null Tipo Date }, "payment_method": { "id": 1, Tipo Integer "description": "Crédito rotativo", Tipo String / Descrição "max_installments": 1, Tipo Integer / Quantidade maxima de parcelas "min_installments": 1, Tipo Integer / Quantidade minima de parcelas "created_at": null, Tipo Date "updated_at": null, Tipo Date "rules": "default" Tipo String / Regra } } } ], "document": null, Tipo String "company": { "id": 45, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "localization": { "id": 45, Tipo Integer "company_id": 45, Tipo Integer / Id do company do estabelecimento "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "localization_delivery": { "id": 1, Tipo Integer "company_id": 9, Tipo Integer / Id do company do estabelecimento "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "contact": [ { "id": 240, Tipo Integer "company_id": 3, Tipo Integer / Id do company do estabelecimento "contact_type_id": 1, Tipo Integer / Id do tipo de contato "name": "jacqueline", Tipo String / Nome "value": "11988808096", Tipo String / Telefone ou Email "created_at": "2022-06-13 09:16:38", Tipo Date "updated_at": "2022-06-13 09:16:38", Tipo Date "contact_type": { "id": 1, Tipo Integer "description": "Celular", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ], "detail": { "id": 31, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date "branch_type": { "id": 1, Tipo Integer "description": "Matriz", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "bank_given": { "id": 46, Tipo Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do estabelecimento "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer "account_type": { Objeto "id": 1, Tipo Integer "value": "Conta Corrente", Tipo String / Descrição do tipo da conta "created_at": null, Tipo Date "updated_at": null, Tipo Date "code": "CC" Tipo String / Código }, "holder_type": { Objeto "id": 2, Tipo Integer "value": "Pessoa Jurídica - Empresa", Tipo String / Descrição do tipo de documento representante "abbreviation": "PJE", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank": { Objeto "id": 340, Tipo Integer "code": "X1X", Tipo String / Código do banco "name": "CONTA INTERNA", Tipo String / Nome do banco "ispb": "00000000", Tipo String / Ispb do banco "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:07", Tipo Date "ispb_code": null Tipo String / Código ispb }, "holder": null }, "bank_given_type": { "id": 1, Tipo Integer "value": "Conta Bancária", Tipo String / Descrição do tipo da conta "abbreviation": "CB", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null, Tipo Date "status_id": 1 / Id do Status (1 - Ativo, 2 - Inativo) }, "people_type": { "id": 2, Tipo Integer "name": "Pessoa Jurídica", Tipo String / Nome "abbreviation": "PJ", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "internal_parameter": { "id": 4, Tipo Integer "max_amount_day": "9999.00", Tipo Decimal / Valor maximo diario "max_amount": "99999999.00", Tipo Decimal / Valor maximo "quantity_operator_day": 1000, Tipo Decimal / Quantidade maxima de operações diarias "created_at": "2022-03-20 17:43:09", Tipo Date "updated_at": "2022-03-20 17:43:09", Tipo Date "establishment_id": 17 Tipo Integer / Id do Estabelecimento }, "father": [ { "id": 1, Tipo Integer "father_id": 17, Tipo Integer "establishment_id": 18, Tipo Integer / Id do Estabelecimento "value": "1.00", Tipo Decimal "created_at": "2022-06-02 13:00:04", Tipo Date "updated_at": "2022-06-02 13:00:04", Tipo Date "establishment": { "id": 18, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { "id": 46, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { "id": 32, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date } } } } ], "tariffs": [ { "id": 26, Tipo Integer "establishment_id": 1, Tipo Integer / Id do Estabelecimento "tariff_id": 236, Tipo Integer / Id da tarifa "value": "1.38", Tipo Decimal / Valor "ecommerce_change": "0.00", Tipo Decimal / Valor ecommerce calculos tarifa "ecommerce_value": "0.00", Tipo Decimal / Valor ecommerce antes do comissionamento tarifa "created_at": "2021-10-04 11:41:07", Tipo Date "updated_at": "2021-10-07 09:22:54", Tipo Date "value_change": "10.00", Tipo Decimal / Valor padrão após calculos "type_change_id": 2, Tipo Integer / Id do tipo de aplicação da tarifa "type_change_ecommerce": null, Tipo Integer / Id do tipo de aplicação da tarifa ecommerce "tariff": { "id": 236, Tipo Integer "description": "Transferência entre bancos", Tipo String / Descrição "value": "0", Tipo Decimal / Valor "complement": null, Tipo String / Complemento "tariff_type_id": 1, Tipo Integer / Id do tipo da tarifa "frequency_id": 7, Tipo Integer / Id da frequencia em que a tarifa é aplicada "created_at": null, Tipo Date "updated_at": "2021-10-04 08:26:02", Tipo Date "franchise_qtd": 0, Tipo Decimal / Qtd Franquia "franchise_type_id": null, Tipo Integer / Id do Tipo de Franquia "franchise_rule_id": null, Tipo Integer / Id da Regra Frequência "installments": 1, Tipo Integer / Numero de parcelas que a tarifa se aplica "product_id": null, Tipo Integer / Id do Produto "discount_status": 2, Tipo Integer / Status do Desconto "ecommerce_value": "0.00", Tipo Decimal / Valor ecommerce "franchise_type": null, Tipo Integer "franchise_rule": null, Tipo Integer "tariff_type": { "id": 2, Tipo Integer "description": "%", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "frequency": { "id": 5, Tipo Integer "description": "Transação Financeira", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } }, ], "payment_status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "cerc_status": { "id": 2, Tipo Integer "description": "Recusado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "payment_logs": { "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 1, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo Boolean "last_page": 1, Tipo Integer "is_last_page": true, Tipo Boolean "page_keys": [ 1 ], "from_item": null, Tipo Integer "to_item": null, Tipo Integer "total_items": 0, Tipo Integer "amount": null, Tipo Decimal / Valor "value": null, Tipo Decimal "efective": 0, Tipo Decimal "balance": 0, Tipo Decimal "low": 0, Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 0 Tipo Integer } }, "msg": [ "OK" ], "statusCode": 206 }
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==) }
Body	{ "" : "" }

Retornos

Código	Mensagem
206	EXEMPLO: { "id": 1, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "distributor": { "id": 1, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "company_id": 3, Tipo Integer / Id do company do distribuidor "created_at": "2021-09-29 12:03:59", Tipo Date "updated_at": "2021-09-29 12:03:59", Tipo Date "commission_activation": 0, Tipo Integer / Ativação de comissão para o distribuidor "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos }, "mccs": { "id": 70, Tipo Integer "code": "5511", Tipo String / Código do MCC "description": "Carros e Caminhões (Novos e Usados)", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date "type_id": null, Tipo Integer "minimal_balance": null, Tipo Decimal / Saldo minimo "max_post": null, Tipo Decimal / Valor minimo "min_post": null, Tipo Decimal / Valor maximo "period": null Tipo Date / Periodo }, "verification_ofac": { "id": 1, Tipo Integer "description": "Checado", Tipo String / Descrição "created_at": null, Tipo Decimal "updated_at": null Tipo Decimal }, "integration": { "id": 1, Tipo Integer "description": "Integrado", Tipo String / Descrição "created_at": null, Tipo Decimal "updated_at": null Tipo Decimal }, "antecipation": { "id": 3, Tipo Integer "description": "Liberado Geral", Tipo String / Descrição "created_at": null, Tipo Decimal "updated_at": null Tipo Decimal }, "preposterou": { "id": 1, Tipo Integer "distributor_id": 1, Tipo Integer / Id do Distribuidor "company_id": 5, Tipo Integer / Id do company do preposto "created_at": "2021-09-29 12:06:09", Tipo Date "updated_at": "2021-09-29 12:06:09", Tipo Date "name": "Marcos", Tipo String / Nome do Preposto "commission_activation": 0, Tipo Integer / Status de comissão "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos "preposterous_credential_type_id": null Tipo Integer / Tipo de credencial do preposto }, "economic_group": { "id": 1, Tipo Integer "name": "Teste SLG", Tipo String / Nome do Grupo Econômico "code_pos": 1, Tipo String / Código POS "code_menu": 2, Tipo String / Código menu "created_at": "2021-09-29 12:15:07", Tipo Decimal "updated_at": "2021-09-29 12:15:07", Tipo Decimal "automatic_anticipations": [] }, "situation": { "id": 6, Tipo Integer "description": "Aprovado Manualmente", Tipo String / Descrição "created_at": null, Tipo Decimal "updated_at": null Tipo Decimal }, "company": { "id": 9, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "localization": { "id": 45, Tipo Integer "company_id": 45, Tipo Integer / Id do company do estabelecimento "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "localization_delivery": { "id": 1, Tipo Integer "company_id": 9, Tipo Integer / Id do company do estabelecimento "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "contact": [ { "id": 202, Tipo Integer "company_id": 3, Tipo Integer / Id do company do estabelecimento "contact_type_id": 1, Tipo Integer / Id do tipo de contato "name": "jacqueline", Tipo String / Nome "value": "11988808096", Tipo String / Telefone ou Email "created_at": "2022-06-13 09:16:38", Tipo Date "updated_at": "2022-06-13 09:16:38", Tipo Date "contact_type": { "id": 1, Tipo Integer "description": "Celular", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ] "bank_given": { "id": 9, Tipo Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do estabelecimento "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer "account_type": { Objeto "id": 1, Tipo Integer "value": "Conta Corrente", Tipo String / Descrição do tipo da conta "created_at": null, Tipo Date "updated_at": null, Tipo Date "code": "CC" Tipo String / Código }, "holder_type": { Objeto "id": 2, Tipo Integer "value": "Pessoa Jurídica - Empresa", Tipo String / Descrição do tipo de documento representante "abbreviation": "PJE", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank": { Objeto "id": 340, Tipo Integer "code": "X1X", Tipo String / Código do banco "name": "CONTA INTERNA", Tipo String / Nome do banco "ispb": "00000000", Tipo String / Ispb do banco "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:07", Tipo Date "ispb_code": null Tipo String / Código ispb }, }, "bank_given_type": { "id": 1, Tipo Integer "value": "Conta Bancária", Tipo String / Descrição do tipo da conta "abbreviation": "CB", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null, Tipo Date "status_id": 1 / Id do Status (1 - Ativo, 2 - Inativo) }, "people_type": { "id": 1, Tipo Integer "name": "Pessoa Fisica", Tipo String / Nome "abbreviation": "PJ", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Decimal "updated_at": null Tipo Decimal } }, "internal_parameter": { "id": 1, Tipo Integer "max_amount_day": "9999.00", Tipo Decimal / Valor maximo diario "max_amount": "99999999.00", Tipo Decimal / Valor maximo "quantity_operator_day": 1000, Tipo Decimal / Quantidade maxima de operações diarias "created_at": "2022-03-20 17:43:09", Tipo Date "updated_at": "2022-03-20 17:43:09", Tipo Date "establishment_id": 17 Tipo Integer / Id do Estabelecimento }, "automatic_anticipations": [ { "id": 1, Tipo Integer "establishment_id": 1, Tipo Integer / Id do estabelecimento "economic_group_id": null, Tipo Integer / Id do grupo econômico "anticipation_application_mode_id": 2, Tipo Integer / Id forma de aplicação da antecipação automatica "anticipation_mode_id": 1, Tipo Integer / Id do tipo de aplicação da antecipação automatica "value": 1, Tipo Integer / Prazo D+ "created_at": "2022-06-13 08:49:27", Tipo Date "updated_at": "2022-06-13 08:49:27", Tipo Date "application_mode": { "id": 2, Tipo Integer "description": "Parcela", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "mode": { "id": 1, Tipo Integer "description": "Diário", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ], "payment_status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "cerc_status": { "id": 2, Tipo Integer "description": "Recusado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }
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

Tipo de Dado
ID: Integer
payment_status_id: Integer
reason: String

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	PAYMENT_STATUS_ID, REASON
Body	{ "payment_status_id" : "Id do status de pagamento", "reason" : "razão" }

Retornos

Código	Mensagem
200	{ "data": true, "msg": [ "OK" ], "statusCode": 200 }
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

GET

LISTAGEM DE CONTAS BANCÁRIAS
/bank_given

Detalhes

Ao chamar a API realiza a listagem das Contas Báncarias

Tipo de Dado
data: Array,    id: Integer
   agency: String
   digit_agency: String
   account: String
   digit_account: String
   company_id: Integer
   bank_account_type_id: Integer
   bank_id: Integer
   holder_type_id: Integer
   created_at: Date
   updated_at: Date
   status_id: Integer
   liquid: Integer
   bank: Array
      id: Integer
      code: String
      name: String
      ispb: String
   holder: Array
      id: Integer
      name: String
      document: String
      bank_given_id: Integer
   account_type: Array
      id: Integer
      value: Decimal
      code: String
   holder_type: Array
      id: Integer
      value: String
      abbreviation: String
   status: Array
      id: Integer
      description: String

Parâmetros

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

Retornos

Código	Mensagem
200	EXEMPLO: "data":[ { "id": 91, Tipo Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do estabelecimento "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer / Status de liquidação "bank": { "id": 2, Tipo Integer "code": "341", Tipo String / Codigo do banco "name": "BANCO ITAU S.A.", Tipo String / Nome do banco "ispb": "60701190", Tipo String / isbp "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:06" Tipo Date }, "holder": null, "account_type": { "id": 1, Tipo Integer "value": "Conta Corrente", Tipo String "created_at": null, Tipo Date "updated_at": null, Tipo Date "code": "CC" Tipo String }, "holder_type": { "id": 1, Tipo Integer "value": "Pessoa Física - Representante", Tipo String "abbreviation": "PFR", Tipo String "created_at": null, Tipo Date "updated_at": null Tipo Date }, "status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "company": { "id": 97, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "establishment": { "id": 31, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão } } } ]
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ATUALIZAÇÃO DO STATUS DA CONTA BANCARIA
/bank_given/{id}/company_id/{company_id}/status/{status}

Detalhes

Ao chamar a API altera o status da conta bancaria do estabelecimento. O id é do id da conta bancaria, o company_id tem que ser do company_id do estabelecimento da conta bancaria informado e o "status" o id do status para ser alterado (1 - Ativo; 2 - Inativo)

Tipo de Dado
ID: Integer
company_id: Integer
status: Integer

Parâmetros

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

Retornos

Código	Mensagem
200	{ "data": { "id": 74, Tipo Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do estabelecimento "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer / Status de liquidação }, "msg": [ "OK" ], "statusCode": 200 }
401	É preciso informar a razão. Campo company_id inválido! Não é possível inativar uma conta que está selecionada como principal para liquidação. A conta interna não pode ser ativada. Verifique os dados e tente novamente.
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ATUALIZAÇÃO DO STATUS DE LIQUIDAÇÃO DA CONTA BANCARIA
/bank_given/{id}/company_id/{company_id}/liquid/{liquid}

Detalhes

Ao chamar a API altera o status de liquidação da conta bancaria do estabelecimento. O id é do id da conta bancaria, o company_id tem que ser do company_id do estabelecimento da conta bancaria informado e o liquid o id do status de liquidação para ser alterado

Tipo de Dado
ID: Integer
company_id: Integer
liquid: Integer

Parâmetros

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

Retornos

Código	Mensagem
200	{ "data": true, "msg": [ "OK" ], "statusCode": 200 }
401	É preciso informar a razão. Campo company_id inválido! Houve um erro interno. Verifique os dados e tente novamente.
402	Token não encontrado. Token expirado. Token é inválido.
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" : { "name": "Nome", "last_name":"Ultimo nome", "rg":"RG", "nationality":"Nacionalidade", "telephone":"Telefone", "email":"E-mail", "birth":"Data de nascimento", "document":"Documento", "bank_given_type_id": "Tipo de conta bancaria", "people_type_id": "Tipo pessoa, fisica ou jiridica", "company_details": { "social_reason": "Razão social", "document": "documento", "cnpj_matriz":"CNPJ da matriz", "branch_type_id": "Id do tipo da empresa (1 - Matriz, 2 - Filial)" } }, "localization" : { "cep": "CEP", "address": "Rua", "number": "Numero", "district": "Distrito", "city": "Cidade", "state_id": "Id do Estado", "countrie_id": "Id do Pais", "complement": "Complemento" }, "contacts" : [{ "contact_type_id": "Id do tipo de contato", "name": "nome", "value": "O contato em si (Numero de telefone ou e-mail de acordo com o tipo selecionado)" }], "bank_given" : { "holder_type_id": "Id do tipo de documento", "bank_account_type_id": "Id do tipo de conta bancaria", "bank_id": "Id do banco", "agency": "Agencia", "account": "Conta", "digit_agency": "digito da agencia", "digit_account": "digito da conta" } , "bank_given_holder" : { "name": "Nome", "document": "Documento" } }

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" : { "name": "Nome", "last_name":"Ultimo nome", "rg":"RG", "nationality":"Nacionalidade", "telephone":"Telefone", "email":"E-mail", "birth":"Data de nascimento", "document":"Documento", "bank_given_type_id": "Tipo de conta bancaria", "people_type_id": "Tipo pessoa, fisica ou jiridica", "company_details": { "social_reason": "Razão social", "document": "documento", "cnpj_matriz":"CNPJ da matriz", "branch_type_id": "Id do tipo da empresa (1 - Matriz, 2 - Filial)" } }, "localization" : { "cep": "CEP", "address": "Rua", "number": "Numero", "district": "Distrito", "city": "Cidade", "state_id": "Id do Estado", "countrie_id": "Id do Pais", "complement": "Complemento" }, "contacts" : [{ "contact_type_id": "Id do tipo de contato", "name": "nome", "value": "O contato em si (Numero de telefone ou e-mail de acordo com o tipo selecionado)" }], "bank_given" : { "holder_type_id": "Id do tipo de documento", "bank_account_type_id": "Id do tipo de conta bancaria", "bank_id": "Id do banco", "agency": "Agencia", "account": "Conta", "digit_agency": "digito da agencia", "digit_account": "digito da conta" } , "bank_given_holder" : { "name": "Nome", "document": "Documento" } }

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

Gestão 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.

Filtros

Caso não queira filtrar por algum dos campos abaixo, apenas apague a linha do campo dentro do objeto filters.

ID - filters[nsu] / Tipo de Dado: Integer
Nome - filters[name] / Tipo de Dado: String

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "nsu": "null", "name": "null", } }

Retornos

Código	Mensagem
200	{ "data": { Object "data": [ Array { "id": 1, Tipo Integer "name": "Teste SLG", Tipo String / Nome do Grupo Econômico "code_pos": 1, Tipo String / Código POS "code_menu": 2, Tipo String / Código menu "created_at": "2021-09-29 12:15:07", Tipo Date "updated_at": "2021-09-29 12:15:07", Tipo Date } ], "paginator": { Object "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 1, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo Boolean "last_page": 1, Tipo Integer "is_last_page": true, Tipo Boolean "page_keys": [ Array 1 ], "from_item": 1, Tipo Integer "to_item": 1, Tipo Integer "total_items": 1, Tipo Integer "amount": null, Tipo Decimal / Valor "value": null, Tipo Decimal "efective": 0, Tipo Decimal "balance": 0, Tipo Decimal "low": 0, Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 1 Tipo Integer } }, "msg": [ "OK" ], "statusCode": 200 }
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. Os objetos, url_logo, url_pos, url_menu, não é necessário o envio

Tipo de Dado
name: String
code_pos: String
code_menu: String
extension: String
contents: String
files: Object
url_pos_1: Object
url_pos_2: Object
url_pos_3: Object
url_menu_1: Object
url_menu_2: Object
url_menu_3: Object

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	NAME, CODE_POS, CODE_MENU
Body	{ "name" : "Nome do grupo econômico", "code_pos" : "Código POS", "code_menu" : "Código de menu", "files" : { "url_logo": {"name": "Nome do arquivo", "extension": "Extensão do arquivo", "contents": "Imagem em formato base64"}, "url_pos_1": {"name": "Nome do arquivo", "extension": "Extensão do arquivo", "contents": "Imagem em formato base64"}, "url_pos_2": {"name": "Nome do arquivo", "extension": "Extensão do arquivo", "contents": "Imagem em formato base64"}, "url_pos_3": {"name": "Nome do arquivo", "extension": "Extensão do arquivo", "contents": "Imagem em formato base64"}, "url_menu_1": {"name": "Nome do arquivo", "extension": "Extensão do arquivo", "contents": "Imagem em formato base64"}, "url_menu_2": {"name": "Nome do arquivo", "extension": "Extensão do arquivo", "contents": "Imagem em formato base64"}, "url_menu_3": {"name": "Nome do arquivo", "extension": "Extensão do arquivo", "contents": "Imagem em formato base64"} } }

Retornos

Código	Mensagem
201	{ "data": { Object "name": "Teste SLG", Tipo String / Nome do Grupo Econômico "code_pos": 1, Tipo String / Código POS "code_menu": 2, Tipo String / Código menu "created_at": "2021-09-29 12:15:07", Tipo Date "updated_at": "2021-09-29 12:15:07", Tipo Date "id": 2 Tipo Integer }, "msg": [ "CRIADO" ], "statusCode": 201 }
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.

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
206	{ "data": { Object "id": 1, Tipo Integer "name": "Teste SLG", Tipo String / Nome do Grupo Econômico "code_pos": 1, Tipo String / Código POS "code_menu": 2, Tipo String / Código menu "created_at": "2021-09-29 12:15:07", Tipo Date "updated_at": "2021-09-29 12:15:07", Tipo Date }, "msg": [ "OK" ], "statusCode": 206 }
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. Os objetos, url_logo, url_pos, url_menu, não é necessário o envio

Tipo de Dado
name: String
code_pos: String
code_menu: String
extension: String
contents: String
files: Object
url_logo: Object
url_pos_1: Object
url_pos_2: Object
url_pos_3: Object
url_menu_1: Object
url_menu_2: Object
url_menu_3: Object

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	NAME, CODE_POS, CODE_MENU
Body	{ "name" : "Nome do grupo econômico", "code_pos" : "Código POS", "code_menu" : "Código de menu", "files" : { "url_logo": {"name": "Nome do arquivo", "extension": "Extensão do arquivo", "contents": "Imagem em formato base64"}, "url_pos_1": {"name": "Nome do arquivo", "extension": "Extensão do arquivo", "contents": "Imagem em formato base64"}, "url_pos_2": {"name": "Nome do arquivo", "extension": "Extensão do arquivo", "contents": "Imagem em formato base64"}, "url_pos_3": {"name": "Nome do arquivo", "extension": "Extensão do arquivo", "contents": "Imagem em formato base64"}, "url_menu_1": {"name": "Nome do arquivo", "extension": "Extensão do arquivo", "contents": "Imagem em formato base64"}, "url_menu_2": {"name": "Nome do arquivo", "extension": "Extensão do arquivo", "contents": "Imagem em formato base64"}, "url_menu_3": {"name": "Nome do arquivo", "extension": "Extensão do arquivo", "contents": "Imagem em formato base64"} } }

Retornos

Código	Mensagem
200	{ "data": { Object "id": 1, Tipo Integer "name": "Teste SLG", Tipo String / Nome do Grupo Econômico "code_pos": 1, Tipo String / Código POS "code_menu": 2, Tipo String / Código menu "created_at": "2021-09-29 12:15:07", Tipo Date "updated_at": "2021-09-29 12:15:07", Tipo Date }, "msg": [ "OK" ], "statusCode": 200 }
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.

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
200	{ "data": { Object "id": 3, Tipo Integer "name": "Teste SLG", Tipo String / Nome do Grupo Econômico "code_pos": 1, Tipo String / Código POS "code_menu": 2, Tipo String / Código menu "created_at": "2021-09-29 12:15:07", Tipo Date "updated_at": "2021-09-29 12:15:07", Tipo Date }, "msg": [ "OK" ], "statusCode": 200 }
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

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" : "Id do estabelecimento", "type" : "Tipo credito (+) ou Debito (-)", "description" : "Descrição", "amount" : "Valor" }

Retornos

Código	Mensagem
200	{ "data": { "id": 3, Tipo Integer "establishment_id": 3, Tipo Integer / Id do Estabelecimento "amount": 1000248.92, Tipo Decimal / Valor "created_at": null, Tipo Date "updated_at": "2022-06-14 08:48:38", Tipo Date "description": null Tipo String / Descrição }, "msg": [ "Lançamento efetuado com sucesso" ], "statusCode": 200 }
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	EXEMPLO: "data":{ Objeto "data": [ Array { "id": 17, "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { "id": 51, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { "id": 31, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date } } }, ], "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 1, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo Boolean "last_page": 1, Tipo Integer "is_last_page": true, Tipo Boolean "page_keys": [ 1 ], "from_item": 1, Tipo Integer "to_item": 9, Tipo Integer "total_items": 9, Tipo Integer "amount": null, Tipo Decimal / Valor "value": null, Tipo Decimal "efective": 0, Tipo Decimal "balance": 0, Tipo Decimal "low": 0, Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 9, Tipo Integer } }
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.

Tipo de Dado
ID: Integer, do id da tarifa a ser editada

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "tariff_id" : "Id da tarifa", "expiry_date" : "Data de vencimento", "value" : "Valor", "description" : "Descrição" }

Retornos

Código	Mensagem
200	{ "data": null, "msg": [ "OK" ], "statusCode": 200 }
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	{ "data": null, "msg": [ "OK" ], "statusCode": 200 }
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.

Filtros

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Documento - filters[document] / Tipo de dado String
Estabelecimento - filters[establishment] / Tipo de dado String
Data de Vencimento - filters[expiry_date] / Tipo de dado Integer
Data de Pagamento - filters[pay_date] / Tipo de dado Integer
Status - filters[status_id] / Tipo de dado Integer

Parâmetros

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

Retornos

Código	Mensagem
200	{ "data":{ Object "data":[ Array { "id": 19, Tipo de dado Integer "establishment_id": 1, Tipo de dado Integer / Id do Estabelecimento "status_id": 1, Tipo de dado Integer / Id do Status do link de pagamento "amount": "2.00", Tipo de dado Decimal / Valor "description": "aaa", Tipo de dado String / Descrição "expiry_date": "2022-05-06", Tipo de dado Date "token": "$2y$10$3r6nt3EY7hBNqjW4B.5lHez6ZUqvl8CA8y4roOM2YnInZ7cNL9OxS", Tipo de dado String / Token do link de pagamento "created_at": "2022-05-03 09:08:04", Tipo ded dado Date "updated_at": "2022-05-03 09:08:04", Tipo ded dado Date "external_id": null, Tipo de dado Integer "pay_link": "http://dev.slg-web-ec/pagamentos/$2y$10$3r6nt3EY7hBNqjW4B.5lHez6ZUqvl8CA8y4roOM2YnInZ7cNL9OxS", Tipo de dado String / Url do link de pagamento "pay_date": null, Tipo Date / Data de pagamento "nsu": null, Tipo de dado String / NSU "authorization": null, Tipo de dado String / Autorização "installments": 1, Tipo de dado Integer / Numero da parcela "parcel_costumer": 2, Tipo de dado Integer "required_document": 2, Tipo de dado Integer / Status de necessidade de documento "establishment": { Object "id": 1, Tipo Integer "commercial_name": "Xampson", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 9, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { Object "id": 9, Tipo de dado Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade } } }, ] "paginator": { Object "current_page": 1, Tipo de dado Integer "prev_page": 1, Tipo de dado Integer "next_page": 2, Tipo de dado Integer "first_page": 1, Tipo de dado Integer "is_first_page": true, Tipo de Boolean "last_page": 2, Tipo de dado Integer "is_last_page": false, Tipo de Boolean "page_keys": [ Array 1, 2 ], "from_item": 1, Tipo de dado Integer "to_item": 10, Tipo de dado Integer "total_items": 19, Tipo de dado Integer "amount": null, Tipo de dado Decimal / Valor "value": null, Tipo de dado Decimal "efective": 0, Tipo de dado Decimal "balance": 0, Tipo de dado Decimal "low": 0, Tipo de dado Decimal "manual": 0, Tipo de dado Decimal "per_page": 10, Tipo de dado Integer "display_items": 10 Tipo de dado Integer } }, "msg": [ "OK" ], "statusCode": 200 }
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.

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
206	{ "data": { Object "data": [ Array { "id": 1, Tipo de dado Integer "establishment_id": 1, Tipo de dado Integer / Id do Estabelecimento "status_id": 1, Tipo de dado Integer / Id do Status do link de pagamento "amount": "2.00", Tipo de dado Decimal / Valor "description": "aaa", Tipo de dado String / Descrição "expiry_date": "2022-05-06", Tipo de dado Date "token": "$2y$10$3r6nt3EY7hBNqjW4B.5lHez6ZUqvl8CA8y4roOM2YnInZ7cNL9OxS", Tipo de dado String / Token do link de pagamento "created_at": "2022-05-03 09:08:04", Tipo ded dado Date "updated_at": "2022-05-03 09:08:04", Tipo ded dado Date "external_id": null, Tipo de dado Integer "pay_link": "http://dev.slg-web-ec/pagamentos/$2y$10$3r6nt3EY7hBNqjW4B.5lHez6ZUqvl8CA8y4roOM2YnInZ7cNL9OxS", Tipo de dado String / Url do link de pagamento "pay_date": null, Tipo Date / Data de pagamento "nsu": null, Tipo de dado String / NSU "authorization": null, Tipo de dado String / Autorização "installments": 1, Tipo de dado Integer / Numero da parcela "parcel_costumer": 2, Tipo de dado Integer "required_document": 2, Tipo de dado Integer / Status de necessidade de documento "establishment": { Object "id": 2, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { Object "id": 13, Tipo de dado Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { Object "id": 10, Tipo de dado Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date } } }, "notifications": [ Array { "id": 1, Tipo de dado Integer "payment_link_id": 1, Tipo de dado Integer "notification_type_id": 1, Tipo de dado Integer "name": "slg", Tipo de dado String "value": "jackielabate160988@gmail.com", Tipo de dado String "created_at": "2021-09-29 15:48:32", Tipo de dado Date "updated_at": "2021-09-29 15:48:32", Tipo de dado Date "notification": { Object "id": 1, Tipo de dado Integer "description": "Email", Tipo de dado String / Descrição "created_at": null, Tipo de dado Date "updated_at": null Tipo de dado Date } } ], "status": { Object "id": 1, Tipo de dado Integer "description": "Pendente", Tipo de dado String / Descrição "created_at": null, Tipo de dado Date "updated_at": null Tipo de dado Date } } ], "paginator": { Object "current_page": 1, Tipo de dado Integer "prev_page": 1, Tipo de dado Integer "next_page": 1, Tipo de dado Integer "first_page": 1, Tipo de dado Integer "is_first_page": true, "last_page": 1, Tipo de dado Integer "is_last_page": true, "page_keys": [ Array 1 ], "from_item": 1, Tipo de dado Integer "to_item": 1, Tipo de dado Integer "total_items": 1, Tipo de dado Integer "amount": null, Tipo de dado Decimal / Valor "value": null, Tipo de dado Decimal "efective": 0, Tipo de dado Decimal "balance": 0, Tipo de dado Decimal "low": 0, Tipo de dado Decimal "manual": 0, Tipo de dado Decimal "per_page": 10, Tipo de dado Integer "display_items": 1 Tipo de dado Integer } }, "log": [], "msg": [ "OK" ], "statusCode": 200 }
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.

Tipo de Dado
document: String
establishment_id: Integer
amount: Double
expiry_date: Date
description: String
notification: String
name: String
notification_type_id: Integer
value: String

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DOCUMENT, ESTABLISHMENT_ID, AMOUNT, EXPIRY_DATE, DESCRIPTION, NOTIFICATION, NAME, NOTIFICATION_TYPE_ID, VALUE
Body	{ "document" : "Documento", "establishment_id" : "Id do estabelecimento", "amount" : "Valor", "expiry_date" : "Data de vencimento", "description" : "Exemplo de Descrição", "required_document" : "Necessidade de documento", "installments" : "Numero de parcelas", "parcel_costumer" : "Permite parcelado cliente (1- Sim , 2 - Não)", "notification" : { "1":{ "name": "Nome", "notification_type_id": "Id do tipo de contato", "value": "Contato", }, } , "anti_rule" : "regra de antecipação", "max_value_link" : Valor maximo do link de pagamento, "active_ecommerce_rule" : "Id do status de ativação de regras ecommerce" }

Retornos

Código	Mensagem
200	EXEMPLO: { "data": { "establishment_id": "1", Tipo Integer / Id do Estabelecimento "amount": "200.00", Tipo Decimal / Valor "expiry_date": "2022-06-06", Tipo Date "description": "aaa", Tipo String / Descrição "required_document": "2", Tipo Integer / Necessidade de informar documento "installments": "2", Tipo Integer / Parcelas "parcel_costumer": "2", Tipo Integer / Status de parcelado cliente "status_id": 1, Tipo Integer / Id do status do link de pagamento "token": "$2y$10$yFvJWhJ29YwR6sNq7lGsJ.AxvEq27oPnzgqRErcWWAbSykNpBZa", Tipo String / Token do link de pagamento "updated_at": "2022-06-02 07:56:11", Tipo Date "created_at": "2022-06-02 07:56:11", Tipo Date "id": 20 Tipo Integer }, "msg": [ "CRIADO" ], "statusCode": 201 }
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.

Tipo de Dado
ID: Integer

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "reason" : "Razão" }

Retornos

Código	Mensagem
200	EXEMPLO: { "data": null, "msg": "Link de pagamento cancelado com sucesso", "statusCode": 200 }
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.

Tipo de Dado
ID: Integer

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.

Tipo de Dado
login: String
password: String

Parâmetros

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

Retornos

Código	Mensagem
200	{ "data":{ "user": { "id": 1, "name": "Admin", Tipo String / Nome "cpf": "99999999999", Tipo String / CPF "telephone": "46569090", Tipo String / Telefone "email": "slg@logics4u.com.br", Tipo String / E-mail "password": "$2y$10$uf9pAQ4H7XYFaaHZxr//ru1qChgUDBb0y0JVCFd/UwtsYWTydPwwW", Tipo String / Senha "reset_token": null, Tipo String / Token de reset "api_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwibmFtZSI6IkFkbWluIiwiY3BmIjoiOTk5OTk5OTk5OTkiLCJlbWFpbCI6InNsZ0Bsb2dpY3M0dS5jb20uYnIiLCJsb2dpbiI6bnVsbCwic3RhdHVzIjoxLCJlc3RhYmxpc2htZW50c19pZCI6W10sImRpc3RyaWJ1dG9yc19pZCI6W10sInR5cGVfaWQiOjMsImlhdCI6MTY1N TEzODkyMywiZXhwIjo5LjIyMzM3MjAzODUwOTkxNGUrMTh9.kutRpEEmeClDcMjSByRRinWzn4ClBTSUPr19QJ18gsc", Tipo String / Token da API "date_access_token": "2022-06-13 12:16:27", Tipo Date / Data de acesso do token "status_id": 1, Tipo Integer / Id de status "created_at": null, Tipo Date "updated_at": "2022-06-13 12:16:27", Tipo Date "type_id": 3, Tipo Integer / Id do tipo de usuario "login": null, Tipo String / Login do usuario "first_access": null, Tipo Date / Data do primeiro acesso "profile_id": null, Tipo Integer / Id do perfil "request_reset_token": null, Tipo Date / Data de requisição do token de reset de senha "attempt": 0, Tipo Integer / Tentativas "mfa_code": null, Tipo String / Código MFA "mfa_created_at": null, Tipo Date / Data do código mfa "permission_alert": 0, Tipo Integer / Alerta de permissão "expiry_date": "2022-02-08" Tipo Date / Data de vencimento "establishment": [] "type": { "id": 1, Tipo Integer "description": "Admin", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date "mfa_status": 2, Id do status de ativação do mfa }, "distributor": [], "status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "layouts": [ { "id": 1, Tipo Integer "font_login": null, Tipo String / Fonte do login "background_login": "#f5f7fa", Tipo String / Cor de fundo do login "background_panel_login": "#3a3f51", Tipo String / Cor do painel de login "background_buttom_login": "#4b91ea", Tipo String / Cor de fundo do botão do login "color_buttom_login": "#ffffff", Tipo String / Cor da letra do botão de login "background_menu": "#1c3f5f", Tipo String / Cor de fundo do menu "background_lateral_menu": "#ffffff", Tipo String / Cor de fundo do menu lateral "color_lateral_menu": "#000000", Tipo String / Cor das letras do menu lateral "background_lateral_hover_menu": "#463eac", Tipo String / Cor de fundo do menu lateral quando passa o mouse em cima "buttom_color_primary": "#79b1ec", Tipo String / Cor primaria do botão "buttom_color_danger": "#fd7777", Tipo String / Cor do botão de retorno "buttom_color_warning": "#ff902b", Tipo String / Cor do botão de aviso "created_at": null, Tipo Date "updated_at": "2022-01-20 12:47:59", Tipo Date "title": null, Tipo String / Titulo "background_logo": "#1c3f5f", Tipo String / Logo de fundo "file_name": "https://unioit-test.s3.amazonaws.com/unioit-test/layouts/gatinho.Extensão do arquivo?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAVYSAFS4ZQIWRSATW%2F20220630%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20220630T121337Z&X-Amz-SignedHeaders=host&X-Amz-Expires=28800&X-Amz-Signature=ab67b2f179ca476e27f89f5e82fe2d652c013e3a9e514330a0130970454093bd", Tipo String / Nome da logo "distributor": "Distribuidor", Tipo String / Distribuidor } ], "menu":[ "id": 1, "name": "Dashboard", Tipo String / Nome do menu "description": null, Tipo String / Descrição do menu "route": null, Tipo String / Rota do menu "icon": "fa fa-home", Tipo String / Icone do menu "parent_id": null, Tipo Integer / Id de um menu ao qual este está vinculado "order": 1, Tipo Integer / Ordem "friendly_name": "dashboard", Tipo String / Nome do menu "actions": [ { "id": 4, "name": "exemplo", "route": "exemplo.exemplo", "menu_id": 5, }, ], "children":[Menus dependentes { "id": 2, "name": "Dashboard", Tipo String / Nome do menu "description": null, Tipo String / Descrição do menu "route": null, Tipo String / Rota do menu "icon": "fa fa-home", Tipo String / Icone do menu "parent_id": null, Tipo Integer / Id de um menu ao qual este está vinculado "order": 1, Tipo Integer / Ordem "friendly_name": "dashboard", Tipo String / Nome do menu "actions": [Ação do menu { "id": 1, "name": "Visualização", Tipo String / Nome "route": "dashboard", Tipo String / Rota "menu_id": 2, Tipo Integer / Id do menu } ], } ], ], "actions":[Rotas permitidas { "route": "dashboard", Tipo String / Rota } ] }, }
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.

Tipo de Dado
establishment_id: Integer
login: String
password: String

Parâmetros

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

Retornos

Código	Mensagem
200	{ "data":{ "user": { "id": 1, "name": "Admin", Tipo String / Nome "cpf": "99999999999", Tipo String / CPF "telephone": "46569090", Tipo String / Telefone "email": "slg@logics4u.com.br", Tipo String / E-mail "password": "$2y$10$uf9pAQ4H7XYFaaHZxr//ru1qChgUDBb0y0JVCFd/UwtsYWTydPwwW", Tipo String / Senha "reset_token": null, Tipo String / Token de reset "api_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwibmFtZSI6IkFkbWluIiwiY3BmIjoiOTk5OTk5OTk5OTkiLCJlbWFpbCI6InNsZ0Bsb2dpY3M0dS5jb20uYnIiLCJsb2dpbiI6bnVsbCwic3RhdHVzIjoxLCJlc3RhYmxpc2htZW50c19pZCI6W10sImRpc3RyaWJ1dG9yc19pZCI6W10sInR5cGVfaWQiOjMsImlhdCI6MTY1N TEzODkyMywiZXhwIjo5LjIyMzM3MjAzODUwOTkxNGUrMTh9.kutRpEEmeClDcMjSByRRinWzn4ClBTSUPr19QJ18gsc", Tipo String / Token da API "date_access_token": "2022-06-13 12:16:27", Tipo Date / Data de acesso do token "status_id": 1, Tipo Integer / Id de status "created_at": null, Tipo Date "updated_at": "2022-06-13 12:16:27", Tipo Date "type_id": 3, Tipo Integer / Id do tipo de usuario "login": null, Tipo String / Login do usuario "first_access": null, Tipo Date / Data do primeiro acesso "profile_id": null, Tipo Integer / Id do perfil "request_reset_token": null, Tipo Date / Data de requisição do token de reset de senha "attempt": 0, Tipo Integer / Tentativas "mfa_code": null, Tipo String / Código MFA "mfa_created_at": null, Tipo Date / Data do código mfa "permission_alert": 0, Tipo Integer / Alerta de permissão "expiry_date": "2022-02-08" Tipo Date / Data de vencimento "establishment": [ { "id": 1, "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { "id": 9, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { "id": 31, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date } } } ], "type": { "id": 1, Tipo Integer "description": "Admin", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date "mfa_status": 2, Id do status de ativação do mfa }, "distributor": [], "status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "layouts": [ { "id": 1, Tipo Integer "font_login": null, Tipo String / Fonte do login "background_login": "#f5f7fa", Tipo String / Cor de fundo do login "background_panel_login": "#3a3f51", Tipo String / Cor do painel de login "background_buttom_login": "#4b91ea", Tipo String / Cor de fundo do botão do login "color_buttom_login": "#ffffff", Tipo String / Cor da letra do botão de login "background_menu": "#1c3f5f", Tipo String / Cor de fundo do menu "background_lateral_menu": "#ffffff", Tipo String / Cor de fundo do menu lateral "color_lateral_menu": "#000000", Tipo String / Cor das letras do menu lateral "background_lateral_hover_menu": "#463eac", Tipo String / Cor de fundo do menu lateral quando passa o mouse em cima "buttom_color_primary": "#79b1ec", Tipo String / Cor primaria do botão "buttom_color_danger": "#fd7777", Tipo String / Cor do botão de retorno "buttom_color_warning": "#ff902b", Tipo String / Cor do botão de aviso "created_at": null, Tipo Date "updated_at": "2022-01-20 12:47:59", Tipo Date "title": null, Tipo String / Titulo "background_logo": "#1c3f5f", Tipo String / Logo de fundo "file_name": "https://unioit-test.s3.amazonaws.com/unioit-test/layouts/gatinho.Extensão do arquivo?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAVYSAFS4ZQIWRSATW%2F20220630%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20220630T121337Z&X-Amz-SignedHeaders=host&X-Amz-Expires=28800&X-Amz-Signature=ab67b2f179ca476e27f89f5e82fe2d652c013e3a9e514330a0130970454093bd", Tipo String / Nome da logo "distributor": "Distribuidor", Tipo String / Distribuidor } ], "menu":[ "id": 1, "name": "Dashboard", Tipo String / Nome do menu "description": null, Tipo String / Descrição do menu "route": null, Tipo String / Rota do menu "icon": "fa fa-home", Tipo String / Icone do menu "parent_id": null, Tipo Integer / Id de um menu ao qual este está vinculado "order": 1, Tipo Integer / Ordem "friendly_name": "dashboard", Tipo String / Nome do menu "actions": [ { "id": 4, "name": "exemplo", "route": "exemplo.exemplo", "menu_id": 5, }, ], "children":[Menus dependentes { "id": 2, "name": "Dashboard", Tipo String / Nome do menu "description": null, Tipo String / Descrição do menu "route": null, Tipo String / Rota do menu "icon": "fa fa-home", Tipo String / Icone do menu "parent_id": null, Tipo Integer / Id de um menu ao qual este está vinculado "order": 1, Tipo Integer / Ordem "friendly_name": "dashboard", Tipo String / Nome do menu "actions": [Ação do menu { "id": 1, "name": "Visualização", Tipo String / Nome "route": "dashboard", Tipo String / Rota "menu_id": 2, Tipo Integer / Id do menu } ], } ], ], "actions":[Rotas permitidas { "route": "dashboard", Tipo String / Rota } ] }, } dashboard
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

Tipo de Dado
distributor_id: Integer
login: String
password: String

Parâmetros

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

Retornos

Código	Mensagem
200	{ "data":{ "user": { "id": 1, "name": "Admin", Tipo String / Nome "cpf": "99999999999", Tipo String / CPF "telephone": "46569090", Tipo String / Telefone "email": "slg@logics4u.com.br", Tipo String / E-mail "password": "$2y$10$uf9pAQ4H7XYFaaHZxr//ru1qChgUDBb0y0JVCFd/UwtsYWTydPwwW", Tipo String / Senha "reset_token": null, Tipo String / Token de reset "api_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwibmFtZSI6IkFkbWluIiwiY3BmIjoiOTk5OTk5OTk5OTkiLCJlbWFpbCI6InNsZ0Bsb2dpY3M0dS5jb20uYnIiLCJsb2dpbiI6bnVsbCwic3RhdHVzIjoxLCJlc3RhYmxpc2htZW50c19pZCI6W10sImRpc3RyaWJ1dG9yc19pZCI6W10sInR5cGVfaWQiOjMsImlhdCI6MTY1N TEzODkyMywiZXhwIjo5LjIyMzM3MjAzODUwOTkxNGUrMTh9.kutRpEEmeClDcMjSByRRinWzn4ClBTSUPr19QJ18gsc", Tipo String / Token da API "date_access_token": "2022-06-13 12:16:27", Tipo Date / Data de acesso do token "status_id": 1, Tipo Integer / Id de status "created_at": null, Tipo Date "updated_at": "2022-06-13 12:16:27", Tipo Date "type_id": 3, Tipo Integer / Id do tipo de usuario "login": null, Tipo String / Login do usuario "first_access": null, Tipo Date / Data do primeiro acesso "profile_id": null, Tipo Integer / Id do perfil "request_reset_token": null, Tipo Date / Data de requisição do token de reset de senha "attempt": 0, Tipo Integer / Tentativas "mfa_code": null, Tipo String / Código MFA "mfa_created_at": null, Tipo Date / Data do código mfa "permission_alert": 0, Tipo Integer / Alerta de permissão "expiry_date": "2022-02-08" Tipo Date / Data de vencimento "establishment": [], "type": { "id": 1, Tipo Integer "description": "Admin", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date "mfa_status": 2, Id do status de ativação do mfa }, "distributor": [ { "id": 1, "commercial_name": "Rita e Beatriz Contábil ME", Tipo String / Nome comercial "company_id": 3, Tipo Integer / Id do company do distribuidor "created_at": "2021-09-29 12:03:59", Tipo Date "updated_at": "2022-06-13 09:16:38", Tipo Date "commission_activation": 1, Tipo Integer / Id do status de ativação do comissionamento "commission_payment": 0, Tipo Integer / Id do status de ativação de suspensão de pagamentos } ], "status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "layouts": [ { "id": 1, Tipo Integer "font_login": null, Tipo String / Fonte do login "background_login": "#f5f7fa", Tipo String / Cor de fundo do login "background_panel_login": "#3a3f51", Tipo String / Cor do painel de login "background_buttom_login": "#4b91ea", Tipo String / Cor de fundo do botão do login "color_buttom_login": "#ffffff", Tipo String / Cor da letra do botão de login "background_menu": "#1c3f5f", Tipo String / Cor de fundo do menu "background_lateral_menu": "#ffffff", Tipo String / Cor de fundo do menu lateral "color_lateral_menu": "#000000", Tipo String / Cor das letras do menu lateral "background_lateral_hover_menu": "#463eac", Tipo String / Cor de fundo do menu lateral quando passa o mouse em cima "buttom_color_primary": "#79b1ec", Tipo String / Cor primaria do botão "buttom_color_danger": "#fd7777", Tipo String / Cor do botão de retorno "buttom_color_warning": "#ff902b", Tipo String / Cor do botão de aviso "created_at": null, Tipo Date "updated_at": "2022-01-20 12:47:59", Tipo Date "title": null, Tipo String / Titulo "background_logo": "#1c3f5f", Tipo String / Logo de fundo "file_name": "https://unioit-test.s3.amazonaws.com/unioit-test/layouts/gatinho.Extensão do arquivo?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAVYSAFS4ZQIWRSATW%2F20220630%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20220630T121337Z&X-Amz-SignedHeaders=host&X-Amz-Expires=28800&X-Amz-Signature=ab67b2f179ca476e27f89f5e82fe2d652c013e3a9e514330a0130970454093bd", Tipo String / Nome da logo "distributor": "Distribuidor", Tipo String / Distribuidor } ], "menu":[ "id": 1, "name": "Dashboard", Tipo String / Nome do menu "description": null, Tipo String / Descrição do menu "route": null, Tipo String / Rota do menu "icon": "fa fa-home", Tipo String / Icone do menu "parent_id": null, Tipo Integer / Id de um menu ao qual este está vinculado "order": 1, Tipo Integer / Ordem "friendly_name": "dashboard", Tipo String / Nome do menu "actions": [ { "id": 4, "name": "exemplo", "route": "exemplo.exemplo", "menu_id": 5, }, ], "children":[Menus dependentes { "id": 2, "name": "Dashboard", Tipo String / Nome do menu "description": null, Tipo String / Descrição do menu "route": null, Tipo String / Rota do menu "icon": "fa fa-home", Tipo String / Icone do menu "parent_id": null, Tipo Integer / Id de um menu ao qual este está vinculado "order": 1, Tipo Integer / Ordem "friendly_name": "dashboard", Tipo String / Nome do menu "actions": [Ação do menu { "id": 1, "name": "Visualização", Tipo String / Nome "route": "dashboard", Tipo String / Rota "menu_id": 2, Tipo Integer / Id do menu } ], } ], ], "actions":[Rotas permitidas { "route": "dashboard", Tipo String / Rota } ] }, }
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.

Tipo de Dado
ID: Integer

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

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	{ "data": { "data": [ { "id": 1, Tipo Integer "description": "Variável VT", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date "activate": 1 Tipo Integer Tipo Integer / Id do status de ativação } ], "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 1, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo Boolean "last_page": 1, Tipo Integer "is_last_page": true, Tipo Boolean "page_keys": [ 1 ], "from_item": 1, Tipo Integer "to_item": 1, Tipo Integer "total_items": 1, Tipo Integer "amount": null, Tipo Decimal / Valor "value": null, Tipo Decimal "efective": 0, Tipo Decimal "balance": 0, Tipo Decimal "low": 0, Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 1 Tipo Integer } }, "msg": [ "OK" ], "statusCode": 200 }
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" : "Descrição" }

Retornos

Código	Mensagem
200	{ "data": { "id": 1, Tipo Integer "description": "Variável VT", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date "activate": 1 Tipo Integer / Id do status de ativação }, "msg": [ "OK" ], "statusCode": 206 }
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" : "Descrição" }

Retornos

Código	Mensagem
200	{ "data": { "id": 2, Tipo Integer "description": "EXEMPL0", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date "activate": 1 Tipo Integer / Id do status de ativação }, "msg": [ "OK" ], "statusCode": 206 }
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.

Tipo de Dado
ID: Integer

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

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	"data":{ "data":[ { "id": 51, Tipo Integer "expiry_date": "2022-06-15", Tipo Date "installment": "0.00", Tipo Decimal "liquid_installment": "0.00", Tipo Decimal "split_credit": "0.00", Tipo Decimal "split_debit": "0.00", Tipo Decimal / Valor de debito de split "credit": "0.00", Tipo Decimal / Valor de credito "tariffs": "0.00", Tipo Decimal / Valor das tarifas "mdr": "0.00", Tipo Decimal / Valor MDR "approvation": "0.00", Tipo Decimal / Taxa de aprovação "chargeback": "0.00", Tipo Decimal / Taxa de chargeback "cancellation": "0.00", Tipo Decimal / Taxa de cancelamento "anticipation": "0.00", Tipo Decimal / Taxa de antecipação "total": "0.00", Tipo Decimal / Valor total "liquid": "0.00", Tipo Decimal / Valor liquido "created_at": "2022-06-14 08:52:58", Tipo Date "updated_at": "2022-06-14 08:53:58" Tipo Date }, ] }
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

DELETE

DELETAR PRAZO
economic_group_periods/{id}

Detalhes

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

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.

Filtros

Nome fantasia - filters[name_preposterou]
Nome Distribuidor - filters[distributor.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]

Parâmetros

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

Retornos

Código	Mensagem
200	{ "data":[ { "id": 1, Tipo Integer "distributor_id": 1, Tipo Integer / Id do Distribuidor "company_id": 5, Tipo Integer / Id do company do preposto "created_at": "2021-09-29 12:06:09", Tipo Date "updated_at": "2021-09-29 12:06:09", Tipo Date "name": "Marcos", Tipo String / Nome do Preposto "commission_activation": 0, Tipo Integer / Status de comissão "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos "preposterous_credential_type_id": null Tipo Integer / Tipo de credencial do preposto } ], "msg": [ "OK" ], "statusCode": 200 }
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" : "Id do distribuidor", "name" : "Nome", "company" : { "last_name": "Ultimo nome", "rg": "RG", "document": "Documento", }, "localization" : { "cep": "CEP", "address": "Rua", "number": "Numero", "district": "Distrito", "city": "Cidade", "state_id": "Id do Estado", "countrie_id": "Id do Pais", "complement": "Complemento" }, "contacts" : [{ "contact_type_id": "Id do tipo de contato", "name": "nome", "value": "O contato em si (Numero de telefone ou e-mail de acordo com o tipo selecionado)" }], "bank_given" : { "holder_type_id": "Id do tipo de documento", "bank_account_type_id": "Id do tipo de conta bancaria", "bank_id": "Id do banco", "agency": "Agencia", "account": "Conta", "digit_agency": "digito da agencia", "digit_account": "digito da conta", "countrie_id": "Id do Pais", "complement": "Complemento" } , "commission" : { "commission_activation": "Id de status de comissão", "commission_payment": "Id de status de suspender pagamentos", "commission_model_id": "Id do modelo de comissão", "validity": "Data de validade" } , "max_date" : "Data maxima" }

Retornos

Código	Mensagem
201	"data": { "distributor_id": 1, Tipo Integer / Id do Distribuidor "company_id": 5, Tipo Integer / Id do company do preposto "created_at": "2021-09-29 12:06:09", Tipo Date "updated_at": "2021-09-29 12:06:09", Tipo Date "name": "Marcos", Tipo String / Nome do Preposto "commission_activation": 0, Tipo Decimal / Status de comissão "id": 3 }, "msg": [ "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.

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
206	"data": { "id": 1, Tipo Integer "distributor_id": 1, Tipo Integer / Id do Distribuidor "company_id": 5, Tipo Integer / Id do company do preposto "created_at": "2021-09-29 12:06:09", Tipo Date "updated_at": "2021-09-29 12:06:09", Tipo Date "name": "Marcos", Tipo String / Nome do Preposto "commission_activation": 0, Tipo Integer / Status de comissão "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos "distributor": { "id": 1, "commercial_name": "Exemplo", Tipo String / Nome Comercial "company_id": 3, Tipo Integer / Id do company do distribuidor "created_at": "2021-09-29 12:03:59", Tipo Date "updated_at": "2021-09-29 12:03:59", Tipo Date "commission_activation": 0, Tipo Integer / Ativação de comissão para o distribuidor "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos }, "company": { "id": 5, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "localization": { "id": 45, Tipo Integer "company_id": 5, Tipo Integer / Id do company do preposto "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "contact": [ { "id": 5, Tipo Integer "company_id": 3, Tipo Integer / Id do company do preposto "contact_type_id": 1, Tipo Integer / Id do tipo de contato "name": "jacqueline", Tipo String / Nome "value": "11988808096", Tipo String / Telefone ou Email "created_at": "2022-06-13 09:16:38", Tipo Date "updated_at": "2022-06-13 09:16:38", Tipo Date "contact_type": { "id": 1, Tipo Integer "description": "Celular", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ], "status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank_given": { "id": 5, Tipo Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do preposto "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer "account_type": { Objeto "id": 1, Tipo Integer "value": "Conta Corrente", Tipo String / Descrição do tipo da conta "created_at": null, Tipo Date "updated_at": null, Tipo Date "code": "CC" Tipo String / Código }, "holder_type": { Objeto "id": 2, Tipo Integer "value": "Pessoa Jurídica - Empresa", Tipo String / Descrição do tipo de documento representante "abbreviation": "PJE", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank": { Objeto "id": 340, Tipo Integer "code": "X1X", Tipo String / Código do banco "name": "CONTA INTERNA", Tipo String / Nome do banco "ispb": "00000000", Tipo String / Ispb do banco "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:07", Tipo Date "ispb_code": null Tipo String / Código ispb }, "holder": null }, "commission_company": null } }, "msg": [ "OK" ], "statusCode": 206
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.

Tipo de Dado
ID: Integer

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" : "Id do distribuidor", "name" : "Nome Atualizado", "company" : { "last_name": "Ultimo nome", "rg": "RG", "document": "Documento", }, "localization" : { "cep": "CEP", "address": "Rua", "number": "Numero", "district": "Distrito", "city": "Cidade", "state_id": "Id do Estado", "countrie_id": "Id do Pais", "complement": "Complemento" }, "contacts" : [{ "contact_type_id": "Id do tipo de contato", "name": "nome", "value": "O contato em si (Numero de telefone ou e-mail de acordo com o tipo selecionado)" }], "bank_given" : { "holder_type_id": "Id do tipo de documento", "bank_account_type_id": "Id do tipo de conta bancaria", "bank_id": "Id do banco", "agency": "Agencia", "account": "Conta", "digit_agency": "digito da agencia", "digit_account": "digito da conta", "countrie_id": "Id do Pais", "complement": "Complemento" } , "commission" : { "commission_activation": "Id de status de comissão", "commission_payment": "Id de status de suspender pagamentos", "commission_model_id": "Id do modelo de comissão", "validity": "Data de validade" } , "max_date" : "Data maxima" }

Retornos

Código	Mensagem
200	"data": { "id": 3, Tipo Integer "distributor_id": 1, Tipo Integer / Id do Distribuidor "company_id": 5, Tipo Integer / Id do company do preposto "created_at": "2021-09-29 12:06:09", Tipo Date "updated_at": "2021-09-29 12:06:09", Tipo Date "name": "Marcos", Tipo String / Nome do Preposto "commission_activation": 0, Tipo Integer / Status de comissão "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos "company": { "id": 88, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade } }, "msg": [ "OK" ], "statusCode": 200
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.

Tipo de Dado
ID: Integer

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

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Repasses com valores zerados ? (0 - Não, 1 - Sim) - filters[total.all] / Tipo de dado Decimal
ID do Repasse - filters[nsu] / Tipo de dado String
Data do Repasse - filters[date] / Tipo de dado Date
Status do Repasse - filters[status_id] / Tipo de dado Integer
Valor Repasse - filters[total] / Tipo de dado Decimal
Documento - filters[document] / Tipo de dado String
Nome Comercial do Estabelecimento - filters[establishment.commercial_name] / Tipo de dado String
ID Estabelecimento - filters[establishment_id] / Tipo de dado Integer

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "nsu":"null", "date":"null", "document":"null", "status_id":"null", "establishment.commercial_name":"null", "establishment_id":"null", "total":"null" } }

Retornos

Código	Mensagem
200	{ "data":{ "data":[ { "id": 42, Tipo Integer "establishment_id": 21, Tipo Integer / Id do Estabelecimento "bank_given_id": 68, Tipo Integer / Id da Conta Bancaria "status_id": 4, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "tariff_tax": "2.23", Tipo Decimal / do valor da Tarifa "cancelation_tax": "0.00", Tipo Decimal / Taxa de cancelamento "chargeback_tax": "0.00", Tipo Decimal / Taxa de chargeback "transaction_tax": "0.00", Tipo Decimal / Taxa de transação "additional_tax": "0.00", Tipo Decimal / Taxa Adicional "payment_tax": "0.00", Tipo Decimal / Taxa de Pagamento "anticipation_tax": "0.00", Tipo Decimal / Taxa de Antecipação "installments": "0.00", Tipo Decimal / Quantidade de Parcelas "credit_granted": "0.00", Tipo Decimal / Subtotal "balance": "0.00", Tipo Decimal / Saldo "debit": "2.23", Tipo Decimal / Valor de debito "credit": "0.00", Tipo Decimal / Valor de credito "total": "-2.23", Tipo Decimal / Valor total "date": "2022-06-13", Tipo Date / Data "created_at": "2022-06-13 08:51:28", Tipo Date "updated_at": "2022-06-13 08:51:28", Tipo Date "split_credit": "0.00", Tipo Decimal / Valor de Credito do split "split_debit": "0.00", Tipo Decimal / Valor de debito de split "external_code": null, Tipo String / Código externo "partial_credit": "0.00", Tipo Decimal / Credito Parcial "partial_debit": "2.23", Tipo Decimal / Debito Parcial "refunds": "0.00", Tipo Decimal / Reembolso "payment_date": "2022-06-13", Tipo Date / Data de Pagamento "antecipated_credit": "0.00", Tipo Decimal / Credito Antecipado "raw_credit": "0.00", Tipo Decimal "mdr_credit": "0.00", Tipo Decimal / Credito MDR "commission_ec": null, "transfer_status": { "id": 4, Tipo Integer "description": "Pagamento efetuado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "establishment": { "id": 21, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { "id": 51, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { "id": 35, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date }, "people_type": { "id": 2, Tipo Integer "name": "Pessoa Jurídica", Tipo String / Nome "abbreviation": "PJ", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date } } }, }, ] "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 2, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo Boolean "last_page": 3, Tipo Integer "is_last_page": false, Tipo Boolean "page_keys": [ 1, 2, 3 ], "from_item": 1, Tipo Integer "to_item": 10, Tipo Integer "total_items": 28, Tipo Integer "amount": 106044.19, Tipo Decimal / Valor "value": null, Tipo Decimal "efective": "99832.98", Tipo Decimal "balance": "-1.75", Tipo Decimal "low": "56.02", Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 10 Tipo Integer } }, "msg": [ "OK" ], "statusCode": 200 }
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.

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
206	{ "data": { Objeto "id": 31, Tipo Integer "establishment_id": 21, Tipo Integer / Id do Estabelecimento "bank_given_id": 28, Tipo Integer / Id da Conta Bancária "status_id": 4, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "tariff_tax": "1.00", Tipo Decimal / do valor da Tarifa "cancelation_tax": "0.00", Tipo Decimal / Taxa de cancelamento "chargeback_tax": "0.00", Tipo Decimal / Taxa de chargeback "transaction_tax": "0.00", Tipo Decimal / Taxa de transação "additional_tax": "0.00", Tipo Decimal / Taxa Adicional "payment_tax": "0.00", Tipo Decimal / Taxa de Pagamento "anticipation_tax": "0.00", Tipo Decimal / Taxa de Antecipação "installments": "0.00", Tipo Decimal / Quantidade de Parcelas "credit_granted": "0.00", Tipo Decimal / Subtotal "balance": "0.00", Tipo Decimal / Saldo "debit": "1.00", Tipo Decimal / Valor de debito "credit": "3144.64", Tipo Decimal / Valor de credito "total": "3143.64", Tipo Decimal / Valor total "date": "2022-03-31", Tipo Date / Data "created_at": "2022-03-31 14:37:00", Tipo Date "updated_at": "2022-03-31 14:37:00", Tipo Date "split_credit": "3144.64", Tipo Decimal / Valor de credito do split "split_debit": "0.00", Tipo Decimal / Valor de debito de split "external_code": null, Tipo String / Código externo "partial_credit": "3144.64", Tipo Decimal / Credito Parcial "partial_debit": "1.00", Tipo Decimal / Debito Parcial "refunds": "0.00", Tipo Decimal / Reembolso "payment_date": "2022-03-31", Tipo Date / Data de Pagamento "antecipated_credit": "0.00", Tipo Decimal / Credito Antecipado "raw_credit": "0.00", Tipo Decimal "mdr_credit": "0.00", Tipo Decimal / Credito MDR "commission_ec": null, Tipo Status "transfer_status": { Objeto "id": 4, Tipo Integer "description": "Pagamento efetuado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank_given": { Objeto "id": 28, Tipo Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do estabelecimento "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer / Status de liquidação "account_type": { Objeto "id": 1, Tipo Integer "value": "Conta Corrente", Tipo String / Descrição do tipo da conta "created_at": null, Tipo Date "updated_at": null, Tipo Date "code": "CC" Tipo String / Código }, "holder_type": { Objeto "id": 2, Tipo Integer "value": "Pessoa Jurídica - Empresa", Tipo String / Descrição do tipo de documento representante "abbreviation": "PJE", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank": { Objeto "id": 340, Tipo Integer "code": "X1X", Tipo String / Código do banco "name": "CONTA INTERNA", Tipo String / Nome do banco "ispb": "00000000", Tipo String / Ispb do banco "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:07", Tipo Date "ispb_code": null Tipo String / Código ispb }, "holder": null }, "establishment": { "id": 21, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { Objeto "id": 13, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { Objeto "id": 10, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date "branch_type": { Objeto "id": 1, Tipo Integer "description": "Matriz", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "people_type": { Objeto "id": 2, Tipo Integer "name": "Pessoa Jurídica", Tipo String / Nome "abbreviation": "PJ", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank_given": { Objeto "id": 28, Tipo Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do estabelecimento "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer "account_type": { Objeto "id": 1, Tipo Integer "value": "Conta Corrente", Tipo String / Descrição do tipo da conta "created_at": null, Tipo Date "updated_at": null, Tipo Date "code": "CC" Tipo String / Código }, "holder_type": { Objeto "id": 2, Tipo Integer "value": "Pessoa Jurídica - Empresa", Tipo String / Descrição do tipo de documento representante "abbreviation": "PJE", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank": { Objeto "id": 340, Tipo Integer "code": "X1X", Tipo String / Código do banco "name": "CONTA INTERNA", Tipo String / Nome do banco "ispb": "00000000", Tipo String / Ispb do banco "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:07", Tipo Date "ispb_code": null Tipo String / Código ispb }, }, "prepaid_card": null, "bank_given_type": { Objeto "id": 1, Tipo Integer "value": "Conta Bancária", Tipo String / Descrição do tipo da conta "abbreviation": "CB", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null, Tipo Date "status_id": 1 / Id do Status (1 - Ativo, 2 - Inativo) } } }, "transfer_credit": [ Array { "transfer_resume_id":"31", Tipo Integer / Id do repasse "credit_id":"1", Tipo Integer / Id do credito do estabelecimento "establishment_credits":{ Objeto "establishment_id": 2, Tipo Integer / Id do Estabelecimento "expiry_date":"2021-10-01", Tipo Date / Data de vencimento "value":"250.00", Tipo Decimal / Valor "description":"teste", Tipo String / Descrição "credit_status_id":"1", Tipo Integer / Status de pagamento do credito "moneylender_solicitation_id": null Tipo Integer / Id da solicitação de GIRO "establishment": { Objeto "id": 2, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2021-09-29 13:10:33", Tipo Date / Data de ativação "company_id": 13, Tipo Integer / Id do company do estabelecimento "mcc_id": 3, Tipo Integer / Id do MCC "establishment_situation_id": 6, Tipo Integer / Situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 1, Tipo Integer / Status de OFAC "integration_status_id": 1, Tipo Integer / Status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2021-09-29 12:34:36", Tipo Date "updated_at": "2022-04-07 07:27:16", Tipo Date "payment_status_id": 1, Tipo Integer / Status de pagamento "external_unique_identification": "-2", Tipo String / Indentificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "1", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Id refente ao tipo de split "status_anticipation": 1, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data de criação da CERC "payment_link_status_id": 1, Tipo Integer / Status do link de pagamento "has_delivery_address": 2, Tipo Integer / Status do endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de antecipação automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data de contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { Objeto "id": 13, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { Objeto "id": 10, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date "branch_type": { Objeto "id": 1, Tipo Integer "description": "Matriz", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, }, }, } ], "transfer_balances": [ Array { "transfer_resume_id":"31", Tipo Integer "balance_id":"1", Tipo Integer "establishment_balances":{ Objeto "establishment_id": 2, Tipo Integer / Id do Estabelecimento "expiry_date":"2021-10-01", Tipo Date / Data de vencimento "amount":"250.00", Tipo Decimal / Valor "status_id":"1" Tipo Integer / Status de pagamento "establishment_credits":{ "establishment_id": 2, Tipo Integer / Id do Estabelecimento "expiry_date":"2021-10-01", Tipo Date / Data de vencimento "value":"250.00", Tipo Decimal / Valor "description":"teste", Tipo String / Descrição "credit_status_id":"1", Tipo Integer / Status de pagamento do credito "moneylender_solicitation_id": null, Tipo Integer / Id da solicitação de GIRO "status":{ Objeto "id": 1, Tipo Integer "description": "Não Pago", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } "establishment":{ Objeto "id": 2, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2021-09-29 13:10:33", Tipo Date / Data de ativação "company_id": 13, Tipo Integer / Id do company do estabelecimento "mcc_id": 3, Tipo Integer / Id do MCC "establishment_situation_id": 6, Tipo Integer / Situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 1, Tipo Integer / Status de OFAC "integration_status_id": 1, Tipo Integer / Status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2021-09-29 12:34:36", Tipo Date "updated_at": "2022-04-07 07:27:16", Tipo Date "payment_status_id": 1, Tipo Integer / Status de pagamento "external_unique_identification": "-2", Tipo String / Indentificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "1", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Id refente ao tipo de split "status_anticipation": 1, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data de criação da CERC "payment_link_status_id": 1, Tipo Integer / Status do link de pagamento "has_delivery_address": 2, Tipo Integer / Status do endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de antecipação automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data de contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { Objeto "id": 13, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { Objeto "id": 10, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date "branch_type": { Objeto "id": 1, Tipo Integer "description": "Matriz", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, }, }, } } ], "transfer_anticipations": [ Array { ""id": 29, Tipo Integer "transfer_resume_id": 24, Tipo Integer / Id do Repasse "anticipation_installment_id": 165, Tipo Integer / Id da parcela antecipada "installment_anticipations":{ "id": 165, Tipo Integer "transaction_id": 134, Tipo Integer / Id da transação "amount": "1000.00", Tipo Decimal / Valor "number": 1, Tipo Integer / Numero da parcela "situation_id": 2, Tipo Integer / Situação de pagamento da parcela "installment_status_id": 2, Tipo Integer / Id de status da parcela "expiry_date": "2022-02-09", Tipo Date / Data de vencimento da parcela "closing_date": "2022-03-30", Tipo Date / Data de fechamento da parcela "pay_date": "2022-03-30", Tipo Date / Data de pagamento da parcela "cancel_date": null, Tipo Date / Data de cancelamento da parcela "created_at": "2022-01-26 12:26:03", Tipo Date "updated_at": "2022-03-30 08:31:34", Tipo Date "net_amount": "980.54", Tipo Decimal / Valor liquido da parcela "split_amount": "0.00", Tipo Decimal / Valor de split "split_amount_percent": "0.00", Tipo Decimal / Porcentagem de split "conciliation_status_id": null, Tipo Integer / Id do Status de conciliação "expected_payment_date": null, Tipo Date / Data estimada de pagamento "commission": "0.00", Tipo Decimal / Valor da comissão "original_expected_payment_date": null, Tipo Date / Data original de pagamento "adq_anticipation_tax": "0.00", Tipo Decimal / Taxa de antecipação Adquirente "adq_mdr_tax": "0.00", Tipo Decimal / MDR do Adquirente "cerc_status_id": 1, Tipo Integer / Id do status na CERC "job_amount": null, Tipo Decimal "external_code": null, Tipo String / Código externo "proccess_date": null, Tipo String / Data de processamento "liquid_status_id": 1, Tipo Integer / Id do status de liquidação "pgs_code": null, Tipo String / Código pgs "tariff":[ Array { "id": 304, Tipo Integer "installment_id": 165, Tipo Integer / Id da parcela "tariff_id": 175, Tipo Integer / Id da tarifa "amount_charged": "14.20", Tipo Decimal / Valor cobrado após tarifas "tariff_amount": "1.42", Tipo Decimal / Valor da tarifa "tariff_type_id": 2, Tipo Integer / Tipo de aplicação da tarifa "created_at": "2022-01-26 12:26:03", Tipo Date "updated_at": "2022-01-26 12:26:03", Tipo Date "tariff": { Objeto "id": 175, Tipo Integer "description": "1 Parcela", Tipo String / Descrição "value": "1.55", Tipo Decimal / Valor "complement": null, Tipo String / Complemento "tariff_type_id": 2, Tipo Integer / Id do tipo de tarifa "frequency_id": 5, Tipo Integer / Id da frequencia da tarifa "created_at": null, Tipo Date "updated_at": "2021-12-06 12:55:43", Tipo Date "franchise_qtd": 0, Tipo Decimal / Qtd Franquia "franchise_type_id": null, Tipo Integer / Id do Tipo de Franquia "franchise_rule_id": null, Tipo Integer / Id da Regra Frequência "installments": 1, Tipo Integer / Quantidade de Parcelas "product_id": 1, Tipo Integer / Id do Produto "discount_status": 2, Tipo Integer / Status de Desconto "ecommerce_value": "1.55" Tipo Decimal / Valor Ecommerce } }, ], "anticipation": { Objeto "id": 33, Tipo Integer "installment_id": 165, Tipo Integer / Id da Parcela "original_expiry_date": "2022-02-25", Tipo Date / Data original de vencimento "created_at": "2022-02-08 08:36:54", Tipo Date "updated_at": "2022-02-08 08:36:54" Tipo Date }, "installment_situation": { Objeto "id": 2, Tipo Integer "description": "Paga", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "status": { Objeto "id": 2, Tipo Integer "description": "Fechada", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "transaction": { Objeto "id": 134, Tipo Integer "card_number": "000589916XXXXXX0487", Tipo String / Numero do cartão "originator": "ADIQ", Tipo String / Originador "authorization": "007078", Tipo String / Autorização "nsu": "75", Tipo String / Nsu transação "company_id": 9, Tipo Integer / Id do company do estabelecimento "acquirer_id": 1, Tipo Integer / Id do Adquirente "installments": 1, Tipo Integer / Quantidade de Parcelas "amount": "1000.00", Tipo Decimal / Valor "terminal_identification": "6N281051", Tipo String / Identificação do terminal "capture_method_id": 1, Tipo Integer / Metodo de captura "product_id": 1, Tipo Integer / Id do Produto "transaction_type_id": 2, Tipo Integer / Id do tipo de transação "integration_transaction_id": "75", Tipo Integer / Id da transação integrada "transaction_canceled_id": null, Tipo Integer / Id do cancelamento da transação "date": "2022-01-26 13:45:43", Tipo Date "created_at": "2022-01-26 12:26:03", Tipo Date "updated_at": "2022-01-26 12:26:03", Tipo Date "entry_mode_id": 2, Tipo Integer / Id do meio de entrada "integration_transaction_id_2": "75", Tipo Integer / Id da transação integrada "distributor_id": 1, Tipo Integer / Id do Distribuidor "preposterou_id": 1, Tipo Integer / Id do Preposto "last_import": null, / Ultima data que foi importado "attempt": 0, Tipo Integer / Tentativas "integration_status_id": 2, Tipo Integer // Id do status de integração "cerc_status_id": 2, Tipo Integer / Id do status na CERC "external_identificator": null, Tipo String / Indentificação externa "liquid_amount": null, Tipo Decimal / Valor liquido "return_tax": null, Tipo Decimal / Taxa de retorno "service_type_id": 2, Tipo Integer / Id do tipo de serviço "alias": null, Tipo String "additional_info": null, Tipo String / Informação adicional "proccess_date": null, Tipo Date / Data de processamento "identificator": null, Tipo String / identificador "pgs_code": null, Tipo String / Código pgs "received_edi": "N", Tipo String "product": { Objeto "id": 1, Tipo Integer "brand_id": 2, Tipo Integer / Id da bandeira "payment_method_id": 1, Tipo Integer / Id do metodo de pagamento "created_at": null, Tipo Date "updated_at": "2021-09-29 11:47:33", Tipo Date "cip_product_id": 1, Tipo Integer / Id do numero do produto na CIP "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "payment_method": { Objeto "id": 1, Tipo Integer "description": "Crédito rotativo", Tipo String / Descrição "max_installments": 1, Tipo Integer / Maximo de parcelas "min_installments": 1, Tipo Integer / Minimo de parcelas "created_at": null, Tipo Date "updated_at": null, Tipo Date "rules": "default" Tipo String / Regras }, "brand": { Objeto "id": 2, Tipo Integer "name": "Mastercard", Tipo String / Nome "icons": "data:image/png;", Tipo String / Icone "created_at": null, Tipo Date "updated_at": null, Tipo Date "payment": 2 Tipo Integer } } } } ], "transfer_cancelations": [ Array Retorna o a mesma estrutura de transfer_anticipations, com os dados das transações de canceladas ], "transfer_chargebacks": [ Array Retorna o a mesma estrutura de transfer_anticipations, com os dados das transações de chargeback ], "transfer_installments": [ Array Retorna o a mesma estrutura de transfer_anticipations, com os dados das parcelas ], "transfer_splits": [ Array { "id": 26, Tipo Integer "transfer_resume_id": 31, Tipo Integer / Id do Repasse "split_id": 39, Tipo Integer / Id do split "installment_splits": { Objeto "id": 39, Tipo Integer "installment_id": 216, Tipo Integer / Id da Parcela "company_id": 13, Tipo Integer / Id do company do estabelecimento "situation_id": 2, Tipo Integer / Id da situação da parcela "installment_status_id": 2, Tipo Integer / Id do Status da parcela "amount": "242.92", Tipo Decimal / Valor "amount_charged": "50.00", Tipo Decimal / Valor cobrado após tarifas "expiry_date": "2022-03-31", Tipo Date "created_at": "2022-02-17 20:38:22", Tipo Date "updated_at": "2022-03-31 14:37:00", Tipo Date "additional_information": "G01-01", Tipo String / Informação adicional "installment": { Objeto "id": 216, Tipo Integer "transaction_id": 134, Tipo Integer / Id da transação "amount": "1000.00", Tipo Decimal / Valor "number": 1, Tipo Integer / Numero da parcela "situation_id": 2, Tipo Integer / Situação de pagamento da parcela "installment_status_id": 2, Tipo Integer / Id de status da parcela "expiry_date": "2022-02-09", Tipo Date / Data de vencimento da parcela "closing_date": "2022-03-30", Tipo Date / Data de fechamento da parcela "pay_date": "2022-03-30", Tipo Date / Data de pagamento da parcela "cancel_date": null, Tipo Date / Data de cancelamento da parcela "created_at": "2022-01-26 12:26:03", Tipo Date "updated_at": "2022-03-30 08:31:34", Tipo Date "net_amount": "980.54", Tipo Decimal / Valor liquido da parcela "split_amount": "0.00", Tipo Decimal / Valor de split "split_amount_percent": "0.00", Tipo Decimal / Porcentagem de split "conciliation_status_id": null, Tipo Integer / Id do Status de conciliação "expected_payment_date": null, Tipo Date / Data estimada de pagamento "commission": "0.00", Tipo Decimal / Valor da comissão "original_expected_payment_date": null, Tipo Date / Data original de pagamento "adq_anticipation_tax": "0.00", Tipo Decimal / Taxa de antecipação Adquirente "adq_mdr_tax": "0.00", Tipo Decimal / MDR do Adquirente "cerc_status_id": 1, Tipo Integer / Id do status na CERC "job_amount": null, Tipo Decimal "external_code": null, Tipo String / Código externo "proccess_date": null, Tipo String / Data de processamento "liquid_status_id": 1, Tipo Integer / Id do status de liquidação "pgs_code": null, Tipo String / Código pgs "transaction": { Objeto "id": 164, Tipo Integer "card_number": "000589916XXXXXX0487", Tipo String / Numero do cartão "originator": "ADIQ", Tipo String / Originador "authorization": "007078", Tipo String / Autorização "nsu": "75", Tipo String / Nsu transação "company_id": 9, Tipo Integer / Id do company do estabelecimento "acquirer_id": 1, Tipo Integer / Id do Adquirente "installments": 1, Tipo Integer / Quantidade de Parcelas "amount": "1000.00", Tipo Decimal / Valor "terminal_identification": "6N281051", Tipo String / Identificação do terminal "capture_method_id": 1, Tipo Integer / Metodo de captura "product_id": 1, Tipo Integer / Id do Produto "transaction_type_id": 2, Tipo Integer / Id do tipo de transação "integration_transaction_id": "75", Tipo Integer / Id da transação integrada "transaction_canceled_id": null, Tipo Integer / Id do cancelamento da transação "date": "2022-01-26 13:45:43", Tipo Date "created_at": "2022-01-26 12:26:03", Tipo Date "updated_at": "2022-01-26 12:26:03", Tipo Date "entry_mode_id": 2, Tipo Integer / Id do meio de entrada "integration_transaction_id_2": "75", Tipo Integer / Id da transação integrada "distributor_id": 1, Tipo Integer / Id do Distribuidor "preposterou_id": 1, Tipo Integer / Id do Preposto "last_import": null, / Ultima data que foi importado "attempt": 0, Tipo Integer / Tentativas "integration_status_id": 2, Tipo Integer // Id do status de integração "cerc_status_id": 2, Tipo Integer / Id do status na CERC "external_identificator": null, Tipo String / Indentificação externa "liquid_amount": null, Tipo Decimal / Valor liquido "return_tax": null, Tipo Decimal / Taxa de retorno "service_type_id": 2, Tipo Integer / Id do tipo de serviço "alias": null, Tipo String "additional_info": null, Tipo String / Informação adicional "proccess_date": null, Tipo Date / Data de processamento "identificator": null, Tipo String / identificador "pgs_code": null, Tipo String / Código pgs "received_edi": "N", Tipo String "company": { Objeto "id": 9, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "establishment": { Objeto "id": 1, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão }, } } }, "split_situations": { Objeto "id": 2, Tipo Integer "description": "Paga", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "split_status": { Objeto "id": 2, Tipo Integer "description": "Fechada", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } }, ], "transfer_tariffs": [ { "id": 49, Tipo Integer "transfer_resume_id": 31, Tipo Integer "tariff_type_id": 1, Tipo Integer "tariff_id": 3, Tipo Integer "amount_charged": "1.00", Tipo Decimal / Valor cobrado após tarifas "tariff_amount": "1.00", Tipo Decimal / Valor da Tarifa "created_at": "2022-03-31 14:37:00", Tipo Date "updated_at": "2022-03-31 14:37:00", Tipo Date "description": "Transferência entre bancos", Tipo String / Descrição "tariff": { Objeto "id": 3, Tipo Integer "description": "Transferência entre bancos", Tipo String / Descrição "value": "0", Tipo Decimal / Valor "complement": null, Tipo String / Complemento "tariff_type_id": 1, Tipo Integer / Id do tipo da tarifa "frequency_id": 7, Tipo Integer / Id da frequencia em que a tarifa é aplicada "created_at": null, Tipo Date "updated_at": "2021-10-04 08:26:02", Tipo Date "franchise_qtd": 0, Tipo Decimal / Qtd Franquia "franchise_type_id": null, Tipo Integer / Id do Tipo de Franquia "franchise_rule_id": null, Tipo Integer / Id da Regra Frequência "installments": 1, Tipo Integer / Numero de parcelas que a tarifa se aplica "product_id": null, Tipo Integer / Id do Produto "discount_status": 2, Tipo Integer / Status do Desconto "ecommerce_value": "0.00", Tipo Decimal / Valor ecommerce "franchise_type": null, Tipo Integer "franchise_rule": null, Tipo Integer "frequency": {Objeto "id": 7, Tipo Integer "description": "Repasse", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, }, "tariff_types": { Objeto "id": 1, Tipo Integer "description": "R$", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ], }, "msg": [ "OK" ], "statusCode": 206 }
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

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

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

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "companies.document":"null", "companies.status_id":"null", "nsu":"null", "name":"null", "status_id":"null", "distributor.commercial_name":"null" } }

Retornos

Código	Mensagem
200	{ "data":[ { "id": 1, Tipo Integer "distributor_id": 1, Tipo Integer "company_id": 5, Tipo Integer / Id do company do preposto "created_at": "2021-09-29 12:06:09", Tipo Date "updated_at": "2021-09-29 12:06:09", Tipo Date "name": "Marcos", Tipo String / Nome do Preposto "commission_activation": 0, Tipo Integer / Status de ativação de comissão "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos } ], "msg": [ "OK" ], "statusCode": 200 }
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

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
206	"data": { "id": 1, Tipo Integer "distributor_id": 1, Tipo Integer "company_id": 5, Tipo Integer / Id do company do preposto "created_at": "2021-09-29 12:06:09", Tipo Date "updated_at": "2021-09-29 12:06:09", Tipo Date "name": "Exemplo", Tipo String "commission_activation": 0, Tipo Integer / Status de ativação de comissão "commission_payment": 0, Tipo Integer / Status de ativação de Suspensão de pagamentos "distributor": { "id": 1, "commercial_name": "Exemplo", Tipo String / Nome Comercial "company_id": 3, Tipo Integer / Id do company do distribuidor "created_at": "2021-09-29 12:03:59", Tipo Date "updated_at": "2021-09-29 12:03:59", Tipo Date "commission_activation": 0, Tipo Integer / Ativação de comissão para o distribuidor "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos }, "company": { "id": 5, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "localization": { "id": 45, Tipo Integer "company_id": 45, Tipo Integer / Id do company do preposto "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "contact": [ { "id": 5, Tipo Integer "company_id": 5, Tipo Integer / Id do company do preposto "contact_type_id": 1, Tipo Integer / Id do tipo de contato "name": "jacqueline", Tipo String / Nome "value": "11988808096", Tipo String / Telefone ou Email "created_at": "2022-06-13 09:16:38", Tipo Date "updated_at": "2022-06-13 09:16:38", Tipo Date "contact_type": { "id": 1, Tipo Integer "description": "Celular", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ], "status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank_given": { "id": 5, Tipo Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do preposto "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer "account_type": { Objeto "id": 1, Tipo Integer "value": "Conta Corrente", Tipo String / Descrição do tipo da conta "created_at": null, Tipo Date "updated_at": null, Tipo Date "code": "CC" Tipo String / Código }, "holder_type": { Objeto "id": 2, Tipo Integer "value": "Pessoa Jurídica - Empresa", Tipo String / Descrição do tipo de documento representante "abbreviation": "PJE", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank": { Objeto "id": 340, Tipo Integer "code": "X1X", Tipo String / Código do banco "name": "CONTA INTERNA", Tipo String / Nome do banco "ispb": "00000000", Tipo String / Ispb do banco "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:07", Tipo Date "ispb_code": null Tipo String / Código ispb }, }, } }, "msg": [ "OK" ], "statusCode": 206
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

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

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==) }
Body	{ "filters" : { "document": "null", "people_type_id": "null", "start_period": "null", "end_period": "null" } }

Retornos

Código	Mensagem
200	{ "data": { "data": [ { "id": 40, Tipo Integer "expiry_date": "2022-07-20", Tipo Date / Data de vencimento "installment": "0.00", Tipo Decimal / Valor da parcela "liquid_installment": "0.00", Tipo Decimal / Valor liquido da parcela "split_credit": "0.00", Tipo Decimal / Valor de credito de split "split_debit": "0.00", Tipo Decimal / Valor de debito de split "credit": "0.00", Tipo Decimal / Valor de credito "tariffs": "0.00", Tipo Decimal / Valor de tarifa "mdr": "0.00", Tipo Decimal / Valor de MDR "approvation": "0.00", Tipo Decimal / Valor de aprovação "chargeback": "0.00", Tipo Decimal / Valor de chargeback "cancellation": "0.00", Tipo Decimal / Valor de cancelamento "anticipation": "0.00", Tipo Decimal / Valor de antecipação "total": "0.00", Tipo Decimal / Valor total "liquid": "0.00", Tipo Decimal / Valor liquido "created_at": "2022-03-30 08:19:47", Tipo Date "updated_at": "2022-04-06 08:34:04", Tipo Date "details": [ { "id": 176, Tipo Integer "future_payment_id": 40, Tipo Integer / Id do pagamento futuro "establishment_id": 1, Tipo Integer / Id do estabelecimento "expiry_date": "2022-07-20", Tipo Date / Data de vencimento "installment": "0.00", Tipo Decimal / Valor da parcela "liquid_installment": "0.00", Tipo Decimal / Valor liquido da parcela "split_credit": "0.00", Tipo Decimal / Valor de credito de split "split_debit": "0.00", Tipo Decimal / Valor de debito de split "credit": "0.00", Tipo Decimal / Valor de credito "tariffs": "0.00", Tipo Decimal / Valor de tarifa "mdr": "0.00", Tipo Decimal / Valor de MDR "approvation": "0.00", Tipo Decimal / Valor de aprovação "chargeback": "0.00", Tipo Decimal / Valor de chargeback "cancellation": "0.00", Tipo Decimal / Valor de cancelamento "anticipation": "0.00", Tipo Decimal / Valor de antecipação "total": "0.00", Tipo Decimal / Valor total "liquid": "0.00", Tipo Decimal / Valor liquido "created_at": "2022-03-30 08:19:47", Tipo Date "updated_at": "2022-04-06 08:34:04" Tipo Date } ] } ], "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 1, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, "last_page": 1, Tipo Integer "is_last_page": true, "page_keys": [ 1 ], "from_item": 1, Tipo Integer "to_item": 1, Tipo Integer "total_items": 1, Tipo Integer "amount": null, Tipo Decimal "value": null, Tipo Decimal "efective": 0, Tipo Decimal "balance": 0, Tipo Decimal "low": 0, Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 1 Tipo Integer } }, "msg": [ "OK" ], "statusCode": 200 }
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

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

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

}

Body

{

"filters" : { "id":"null", "establishment_id": "null", "establishment.commercial_name": "null", "document": "null", "product_id": "null", "transaction_type_id": "null", "originator": "null", "authorization": "null", "card_number": "null", "capture_method_id": "null", "nsu_captura": "null", "serial_number": "null", "created_at": "2022-01-22", "transaction_initial_date": "null", "transaction_final_date": "null", "installment_id": "null", "installment_situation_id": "null", "installment_status_id": "null", "installment_inital_expiry_date": "null", "installment_final_expiry_date": "null", }

}

Retornos

Código	Mensagem
200	EXEMPLO: "data":[ Array { "id": 204, Tipo de dado Integer "card_number": "000589916XXXXXX0487", Tipo String / Numero do cartão "originator": "ADIQ", Tipo String / Originador "authorization": "007078", Tipo String / Autorização "nsu": "75", Tipo String / Nsu transação "company_id": 9, Tipo Integer / Id do company do estabelecimento "acquirer_id": 1, Tipo Integer / Id do Adquirente "installments": 1, Tipo Integer / Quantidade de Parcelas "amount": "1000.00", Tipo Decimal / Valor "terminal_identification": "6N281051", Tipo String / Identificação do terminal "capture_method_id": 1, Tipo Integer / Metodo de captura "product_id": 1, Tipo Integer / Id do Produto "transaction_type_id": 2, Tipo Integer / Id do tipo de transação "integration_transaction_id": "75", Tipo Integer / Id da transação integrada "transaction_canceled_id": null, Tipo Integer / Id do cancelamento da transação "date": "2022-01-26 13:45:43", Tipo Date "created_at": "2022-01-26 12:26:03", Tipo Date "updated_at": "2022-01-26 12:26:03", Tipo Date "entry_mode_id": 2, Tipo Integer / Id do meio de entrada "integration_transaction_id_2": "75", Tipo Integer / Id d transação integrada "distributor_id": 1, Tipo Integer / Id do Distribuidor "preposterou_id": 1, Tipo Integer / Id do Preposto "last_import": null, / Ultima data que foi importado "attempt": 0, Tipo Integer / Tentativas "integration_status_id": 2, Tipo Integer // Id do status de integração "cerc_status_id": 2, Tipo Integer / Id do status na CERC "external_identificator": null, Tipo String / Indentificação externa "liquid_amount": null, Tipo Decimal / Valor liquido "return_tax": null, Tipo Decimal / Taxa de retorno "service_type_id": 2, Tipo Integer / Id do tipo de serviço "alias": null, Tipo String "additional_info": null, Tipo String / Informação adicional "proccess_date": null, Tipo Date / Data de processamento "identificator": null, Tipo String / identificador "pgs_code": null, Tipo String / Código pgs "received_edi": "N", Tipo String "type": { Object "id": 2, Tipo de dado Integer "description": "Autorizada", Tipo de dado String / Descrição "created_at": null, Tipo de dado Date "updated_at": null Tipo de dado Date }, "transaction_type": { Object "id": 2, Tipo de dado Integer "description": "Autorizada", Tipo de dado String / Descrição "created_at": null, Tipo de dado Date "updated_at": null Tipo de dado Date }, "entry_mode": { Object "id": 3, Tipo de dado Integer "description": "Tarja", Tipo de dado String / Descrição "created_at": null, Tipo de dado Date "updated_at": null, Tipo de dado Date "code": null Tipo de dado String }, "get_installments": [ Array { "id": 315, Tipo de dado Integer "transaction_id": 134, Tipo Integer / Id da transação "amount": "1000.00", Tipo Decimal / Valor "number": 1, Tipo Integer / Numero da parcela "situation_id": 2, Tipo Integer / Situação de pagamento da parcela "installment_status_id": 2, Tipo Integer / Id de status da parcela "expiry_date": "2022-02-09", Tipo Date / Data de vencimento da parcela "closing_date": "2022-03-30", Tipo Date / Data de fechamento da parcela "pay_date": "2022-03-30", Tipo Date / Data de pagamento da parcela "cancel_date": null, Tipo Date / Data de cancelamento da parcela "created_at": "2022-01-26 12:26:03", Tipo Date "updated_at": "2022-03-30 08:31:34", Tipo Date "net_amount": "980.54", Tipo Decimal / Valor liquido da parcela "split_amount": "0.00", Tipo Decimal / Valor de split "split_amount_percent": "0.00", Tipo Decimal / Porcentagem de split "conciliation_status_id": null, Tipo Integer / Id do Status de conciliação "expected_payment_date": null, Tipo Date / Data estimada de pagamento "commission": "0.00", Tipo Decimal / Valor da comissão "original_expected_payment_date": null, Tipo Date / Data original de pagamento "adq_anticipation_tax": "0.00", Tipo Decimal / Taxa de antecipação Adquirente "adq_mdr_tax": "0.00", Tipo Decimal / MDR do Adquirente "cerc_status_id": 1, Tipo Integer / Id do status na CERC "job_amount": null, Tipo Decimal "external_code": null, Tipo String / Código externo "proccess_date": null, Tipo String / Data de processamento "liquid_status_id": 1, Tipo Integer / Id do status de liquidação "pgs_code": null, Tipo String / Código pgs } ], "company": { Object "id": 9, Tipo de dado Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "localization": { "id": 45, Tipo Integer "company_id": 9, Tipo Integer / Id do company do estabelecimento "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "contact": [ Array { "id": 295, Tipo de dado Integer "company_id": 3, Tipo Integer / Id do company "contact_type_id": 1, Tipo Integer / Id do tipo de contato "name": "jacqueline", Tipo String / Nome "value": "11988808096", Tipo String / Telefone ou Email "created_at": "2022-06-13 09:16:38", Tipo Date "updated_at": "2022-06-13 09:16:38", Tipo Date "contact_type": { "id": 1, Tipo Integer "description": "Celular", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, ], "detail": null, "bank_given": { Object "id": 9, Tipo de dado Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do estabelecimento "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer "account_type": { Objeto "id": 1, Tipo Integer "value": "Conta Corrente", Tipo String / Descrição do tipo da conta "created_at": null, Tipo Date "updated_at": null, Tipo Date "code": "CC" Tipo String / Código }, "holder_type": { Objeto "id": 2, Tipo Integer "value": "Pessoa Jurídica - Empresa", Tipo String / Descrição do tipo de documento representante "abbreviation": "PJE", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank": { Objeto "id": 340, Tipo Integer "code": "X1X", Tipo String / Código do banco "name": "CONTA INTERNA", Tipo String / Nome do banco "ispb": "00000000", Tipo String / Ispb do banco "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:07", Tipo Date "ispb_code": null Tipo String / Código ispb }, "holder": null }, "prepaid_card": null, "bank_given_type": { Object "id": 1, Tipo de dado Integer "value": "Conta Bancária", Tipo de dado String / Descrição do tipo da conta "abbreviation": "CB", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null, Tipo Date "status_id": 1 / Id do Status (1 - Ativo, 2 - Inativo) }, "people_type": { Object "id": 1, Tipo de dado Integer "name": "Pessoa Fisica", Tipo String / Nome "abbreviation": "PJ", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "status": { Object "id": 1, Tipo de dado Integer "description": "Ativo", Tipo de dado String / Descrição "created_at": null, Tipo de dado Date "updated_at": null Tipo de dado Date }, "establishment": { Object "id": 1, Tipo Integer "commercial_name": Xampson", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão } }, "product": { Object "id": 7, Tipo de dado Integer "brand_id": 2, Tipo Integer / Id da bandeira "payment_method_id": 1, Tipo Integer / Id do metodo de pagamento "created_at": null, Tipo Date "updated_at": "2021-09-29 11:47:33", Tipo Date "cip_product_id": 1, Tipo Integer / Id do produto cip "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "brand": { "id": 2, Tipo Integer "name": "Mastercard", Tipo String / Nome da bandeira "icons": "data:image/png;base64", Tipo String / Icone em base 64 "created_at": null, Tipo Date "updated_at": null Tipo Date }, "payment_method": { "id": 1, Tipo Integer "description": "Crédito rotativo", Tipo String / Descrição "max_installments": 1, Tipo Integer / Quantidade maxima de parcelas "min_installments": 1, Tipo Integer / Quantidade minima de parcelas "created_at": null, Tipo Date "updated_at": null, Tipo Date "rules": "default" Tipo String / Regra } }, "canceled_transaction": null, "capture_method": { Object "id": 1, Tipo de dado Integer "description": "POS", Tipo de dado String / Descrição "tariff_column": "value", Tipo de dado String "created_at": null, Tipo de dado Date "updated_at": "2021-09-29 11:47:43" Tipo de dado Date } } } ] }
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

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
200	{ "data": { "installments": { "299": { "id": 299, Tipo Integer "number": 1, Tipo Integer / Numero de parcelas "situation": "Aberta antecipada automaticamente", Tipo String / Situação da parcela "status": "Aberta", Tipo String / Status da parcela "expiry_date": "14/06/2022", Tipo Date / Data de vencimento "closing_date": "", Tipo Date / Data de fechamento "cancel_date": "", Tipo Date / Data de cancelamento "pay_date": "", Tipo Date / Data de pagamento "amount": "750,13", Tipo Integer / Valor "split": "0,00/0,00", Tipo Integer / Valor split "net_amount": "724,45", Tipo Integer / Valor liquido da parcela "original_expiry_date": "11/05/2022", Tipo Date / Data original de vencimento "taf": "7,50", Tipo Integer / Valor tarifa "mdr": "13,74", Tipo Integer / MDR "approve": "4,44", Tipo Integer / Valor da aprovação "anticipation": "0,00/0,00", Tipo Integer / Valor de antecipação "anticipation_porcent": "0,00/0,00" Tipo Integer / Valor de porcentagem da antecipação } }, "card_number": "000589916XXXXXX0487", Tipo String / Numero do cartão "quantity_installments": 2, Tipo Integer / Quantidade de parcelas "authorization": "007078", Tipo String / Autorização "nsu": "149", Tipo String / Nsu transação "terminal_identification": "6N281051", Tipo String / Identificação do terminal "capture_method": "149", Tipo String / Metodo de captura "acquirer": "Carla e Daniel Assessoria Jurídica ME", Tipo String "entry_mode": "Tarja", Tipo String / Meio de entrada "product": "Mastercard - Crédito parcelado estabelecimento", Tipo String "amount": "1.500,27", Tipo Integer / Valor "commercial_name": "Xampson", Tipo String / Nome Comercial "canceled_id": "", Tipo Integer / Id do cancelamento da transação "id": 195, Tipo Integer "transaction_date": "11/04/2022 13:45:43", Tipo Date / Data da transação "integration_date": "13/06/2022 09:17:09", Tipo Date / Data de integração "additional_info": null, Tipo String / Informação adicional "liquid_amount": "0,00", Tipo Integer / Valor liquido "return_tax": "0,00", Tipo Integer / Taxa de retorno "document": "22228816507", Tipo String / Documento "mask": "cpf-mask", Tipo String / Mascara do documento do usada "acquirer_document": "76409124000197", Tipo String / Documento do adquirente "acquirer_mask": "cnpj-mask" Tipo String / Mascara do documento do adquirente }, "statusCode": 200 }
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

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Sistema - filters[system_id] / Tipo de dado Integer
IP - filters[ip] / Tipo de dado String
ID Estabelecimento - filters[establishment_id] / Tipo de dado Integer
Id Distribuidor - filters[distributor_id] / Tipo de dado Integer
Login - filters[login] / Tipo de dado String
Data Inicial - filters[initial_date] / Tipo de dado Date
Data Final - filters[final_date] / Tipo de dado Date

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "system_id": "null", "ip": "null", "establishment_id": "null", "distributor_id": "null", "login": "null", "initial_date": "null", "final_date": "null" } }

Retornos

Código	Mensagem
200	{ "data":{ "data":[ { "id": 490, Tipo Integer "system_id": 1, Tipo Integer / Id do tipo do sistema "ip": "127.0.0.1", Tipo String / IP "client": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36", Tipo String "login": "slg@logics4u.com.br", Tipo String / Login "establishment_id": null, Tipo Integer / Id do Estabelecimento "distributor_id": null, Tipo Integer / Id do Distribuidor "created_at": "2022-06-14 12:35:48", Tipo Date "updated_at": "2022-06-14 12:35:48", Tipo Date "establishment": { "id": 21, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de ativação de comissão "company": { "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { "id": 10, Tipo Date "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date } } } "system": { "id": 1, Tipo Integer "code": "SLG", Tipo String / Código do sistema "name": "Portal do Sub Adquirente", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date }, "distributor": { "id": 1, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "company_id": 3, Tipo Integer / Id do company distribuidor "created_at": "2021-09-29 12:03:59", Tipo Date "updated_at": "2021-09-29 12:03:59", Tipo Date "commission_activation": 0, Tipo Integer / Ativação de comissão para o distribuidor "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos }, }, ] } }
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

CRÉDITOS
/establishment_credit/credits

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_credit/credits?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

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

ID - filters[id] / Tipo de dado Integer
ID Estabelecimento - filters[establishment_id] / Tipo de dado Integer
Nome Comercial - filters[commercial_name] / Tipo de dado String
Documento - filters[document] / Tipo de dado String
Descrição - filters[description] / Tipo de dado String
Data Inicial - filters[credit_initial_date] / Tipo de dado Date
Data Final - filters[credit_final_date] / Tipo de dado Date
Status - filters[credit_status_id] / Tipo de dado Integer

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "id": "null", "establishment_id": "null", "commercial_name": "null", "document": "null", "description": "null", "credit_initial_date": "null", "credit_final_date": "null", "credit_status_id": "null" } }

Retornos

Código	Mensagem
200	{ "data"{ "data":[ { "id": 8, Tipo Integer "establishment_id": 21, Tipo Integer / Id do Estabelecimento "expiry_date": "2022-06-15", Tipo Date / Data de vencimento "value": 1, Tipo Date / Valor "description": "Crédito gerado em recálculo", Tipo String / Descrição "created_at": "2022-06-14 13:03:36", Tipo Date "updated_at": "2022-06-14 13:03:36", Tipo Date "credit_status_id": 2, Tipo Integer / Id de status de credito "moneylender_solicitation_id": null, Tipo Integer / Id de solicitação de GIRO "user_id": null, Tipo Integer / Id de usuário "status_credit": { "id": 2, Tipo Integer "description": "Não Pago", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "establishment": { "id": 21, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id d situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de ativação de comissão "company": { "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { "id": 10, Tipo Date "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date } } } } ] "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 1, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo Boolean "last_page": 1, Tipo Integer "is_last_page": true, Tipo Boolean "page_keys": [ 1 ], "from_item": 1, Tipo Integer "to_item": 8, Tipo Integer "total_items": 8, Tipo Integer "amount": null, Tipo Decimal / Valor "value": null, Tipo Decimal "efective": 0, Tipo Decimal "balance": 0, Tipo Decimal "low": 0, Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 8 Tipo Integer } }, "msg": [ "OK" ], "statusCode": 200 }
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

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

ID - filters[establishment_id] / Tipo de dado Integer
Nome Comercial - filters[commercial_name] / Tipo de dado String
Documento - filters[document] / Tipo de dado String
Data Prevista - filters[date] / Tipo de dado Date

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "establishment_id": "null", "commercial_name": "null", "document": "null", "date": "null" } }

Retornos

Código	Mensagem
200	{ "data":{ "data":[ { "id": 1, Tipo Integer "establishment_id": 3, Tipo Integer / Id do Estabelecimento "status_id": 2, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "expiry_date": "2021-10-01", Tipo Date / Data de vencimento "amount": "88.2500", Tipo Decimal / Valor "created_at": null, Tipo Date "updated_at": null, Tipo Date "establishments": { "id": 3, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { "id": 13, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date } } }, "status": { "id": 2, Tipo Integer "description": "Pago", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "transfers": [ { "id": 1, Tipo Integer "transfer_resume_id": 6, Tipo Integer "balance_id": 1 Tipo Integer } ] }, ] "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 1, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo Boolean "last_page": 1, Tipo Integer "is_last_page": true, Tipo Boolean "page_keys": [ 1 ], "from_item": 1, Tipo Integer "to_item": 7, Tipo Integer "total_items": 7, Tipo Integer "amount": null, Tipo Decimal / Valor "value": null, Tipo Decimal "efective": 0, Tipo Decimal "balance": 0, Tipo Decimal "low": 0, Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 7 Tipo Integer } }, "msg": [ "OK" ], "statusCode": 200 }
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

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

ID Estabelecimento - filters[establishment_id] / Tipo de dado Integer
Nome Comercial - filters[commercial_name] / Tipo de dado String
Documento - filters[document] / Tipo de dado String
Status - filters[installment_status_id] / Tipo de dado Integer
Situação - filters[installment_situation_id] / Tipo de dado Integer
Data Inicial - filters[initial_date] / Tipo de dado Date
Data Final - filters[final_date] / Tipo de dado Date

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "establishment_id": "null", "commercial_name": "null", "document": "null", "installment_status_id": "null", "installment_situation_id": "null", "initial_date": "null", "final_date": "null" } }

Retornos

Código	Mensagem
200	{ "data":{ "data":[ { "id": 89, Tipo Integer "installment_id": 282, Tipo Integer "company_id": 13, Tipo Integer / Id do company do estabelecimento "situation_id": 13, Tipo Integer / Id da situação "installment_status_id": 2, Tipo Integer / Id do status da parcela "amount": "242.92", Tipo Decimal / Valor "amount_charged": "50.00", Tipo Decimal / Valor cobrado após tarifas "expiry_date": "2022-04-11", Tipo Date / Data de vencimento "created_at": "2022-04-06 10:31:07", Tipo Date "updated_at": "2022-04-10 17:46:18", Tipo Date "additional_information": null, Tipo String / Informação adicional "split_situations": { "id": 13, Tipo Integer "description": "Aberta antecipada", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "installment": { "id": 282, Tipo Integer "transaction_id": 134, Tipo Integer / Id da transação "amount": "1000.00", Tipo Decimal / Valor "number": 1, Tipo Integer / Numero da parcela "situation_id": 2, Tipo Integer / Situação de pagamento da parcela "installment_status_id": 2, Tipo Integer / Id de status da parcela "expiry_date": "2022-02-09", Tipo Date / Data de vencimento da parcela "closing_date": "2022-03-30", Tipo Date / Data de fechamento da parcela "pay_date": "2022-03-30", Tipo Date / Data de pagamento da parcela "cancel_date": null, Tipo Date / Data de cancelamento da parcela "created_at": "2022-01-26 12:26:03", Tipo Date "updated_at": "2022-03-30 08:31:34", Tipo Date "net_amount": "980.54", Tipo Decimal / Valor liquido da parcela "split_amount": "0.00", Tipo Decimal / Valor de split "split_amount_percent": "0.00", Tipo Decimal / Porcentagem de split "conciliation_status_id": null, Tipo Integer / Id do Status de conciliação "expected_payment_date": null, Tipo Date / Data estimada de pagamento "commission": "0.00", Tipo Decimal / Valor da comissão "original_expected_payment_date": null, Tipo Date / Data original de pagamento "adq_anticipation_tax": "0.00", Tipo Decimal / Taxa de antecipação Adquirente "adq_mdr_tax": "0.00", Tipo Decimal / MDR do Adquirente "cerc_status_id": 1, Tipo Integer / Id do status na CERC "job_amount": null, Tipo Decimal "external_code": null, Tipo String / Código externo "proccess_date": null, Tipo String / Data de processamento "liquid_status_id": 1, Tipo Integer / Id do status de liquidação "pgs_code": null, Tipo String / Código pgs "transaction": { "id": 186, Tipo Integer "card_number": "000589916XXXXXX0487", Tipo String / Numero do cartão "originator": "ADIQ", Tipo String / Originador "authorization": "007078", Tipo String / Autorização "nsu": "75", Tipo String / Nsu transação "company_id": 9, Tipo Integer / Id do company do estabelecimento "acquirer_id": 1, Tipo Integer / Id do Adquirente "installments": 1, Tipo Integer / Quantidade de Parcelas "amount": "1000.00", Tipo Decimal / Valor "terminal_identification": "6N281051", Tipo String / Identificação do terminal "capture_method_id": 1, Tipo Integer / Metodo de captura "product_id": 1, Tipo Integer / Id do Produto "transaction_type_id": 2, Tipo Integer / Id do tipo de transação "integration_transaction_id": "75", Tipo Integer / Id d transação integrada "transaction_canceled_id": null, Tipo Integer / Id do cancelamento da transação "date": "2022-01-26 13:45:43", Tipo Date "created_at": "2022-01-26 12:26:03", Tipo Date "updated_at": "2022-01-26 12:26:03", Tipo Date "entry_mode_id": 2, Tipo Integer / Id do meio de entrada "integration_transaction_id_2": "75", Tipo Integer / Id da transação integrada "distributor_id": 1, Tipo Integer / Id do Distribuidor "preposterou_id": 1, Tipo Integer / Id do Preposto "last_import": null, / Ultima data que foi importado "attempt": 0, Tipo Integer / Tentativas "integration_status_id": 2, Tipo Integer // Id do status de integração "cerc_status_id": 2, Tipo Integer / Id do status na CERC "external_identificator": null, Tipo String / Indentificação externa "liquid_amount": null, Tipo Decimal / Valor liquido "return_tax": null, Tipo Decimal / Taxa de retorno "service_type_id": 2, Tipo Integer / Id do tipo de serviço "alias": null, Tipo String "additional_info": null, Tipo String / Informação adicional "proccess_date": null, Tipo Date / Data de processamento "identificator": null, Tipo String / identificador "pgs_code": null, Tipo String / Código pgs "received_edi": "N", Tipo String } }, "split_status": { "id": 2, Tipo Integer "description": "Fechada", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "establishment": { "id": 21, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id d situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { "id": 13, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { "id": 10, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date } } } } ] "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 2, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo Boolean "last_page": 9, Tipo Integer "is_last_page": false, Tipo Boolean "page_keys": [ 1, 2, 3 ], "from_item": 1, Tipo Integer "to_item": 10, Tipo Integer "total_items": 83, Tipo Integer "amount": null, Tipo Decimal / Valor "value": null, Tipo Decimal "efective": 0, Tipo Decimal "balance": 0, Tipo Decimal "low": 0, Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 10 Tipo Integer } }, "total_amount": "18844.44", Tipo Decimal "msg": [ "OK" ], "statusCode": 200 }
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

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

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

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "nsu": "null", "commercial_name": "null", "companies.document": "null", "companies.company_details.document": "null", "companies.people_type_id": "null", "companies.status_id": "null" } }

Retornos

Código	Mensagem
200	"data":{ "data":[ { "id": 1, Tipo Integer "commercial_name": "Rita e Beatriz Contábil ME", Tipo String / Nome Comercial "company_id": 3, Tipo Integer / Id do company "created_at": "2021-09-29 12:03:59", Tipo Date "updated_at": "2022-06-13 09:16:38", Tipo Date "commission_activation": 1, Tipo Integer / Id do status de ativação de comissão "commission_payment": 0, Tipo Integer/ Id do status de ativação de Suspensão de pagamentos "company": { "id": 3, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "localization": { "id": 45, Tipo Integer "company_id": 45, Tipo Integer / Id do company "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "contact": [ { "id": 220, Tipo Integer "company_id": 3, Tipo Integer / Id do company "contact_type_id": 1, Tipo Integer / Id do tipo de contato "name": "jacqueline", Tipo String / Nome "value": "11988808096", Tipo String / Telefone ou Email "created_at": "2022-06-13 09:16:38", Tipo Date "updated_at": "2022-06-13 09:16:38", Tipo Date "contact_type": { "id": 1, Tipo Integer "description": "Celular", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ], "bank_given": { "id": 3, Tipo Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do distribuidor "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer "account_type": { Objeto "id": 1, Tipo Integer "value": "Conta Corrente", Tipo String / Descrição do tipo da conta "created_at": null, Tipo Date "updated_at": null, Tipo Date "code": "CC" Tipo String / Código }, "holder_type": { Objeto "id": 2, Tipo Integer "value": "Pessoa Jurídica - Empresa", Tipo String / Descrição do tipo de documento representante "abbreviation": "PJE", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank": { Objeto "id": 340, Tipo Integer "code": "X1X", Tipo String / Código do banco "name": "CONTA INTERNA", Tipo String / Nome do banco "ispb": "00000000", Tipo String / Ispb do banco "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:07", Tipo Date "ispb_code": null Tipo String / Código ispb }, }, "bank_given_type": { "id": 1, Tipo Integer "value": "Conta Bancária", Tipo String / Descrição do tipo da conta "abbreviation": "CB", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null, Tipo Date "status_id": 1 / Id do Status (1 - Ativo, 2 - Inativo) }, "people_type": { "id": 1, Tipo Integer "name": "Pessoa Jurídica", Tipo String / Nome "abbreviation": "PJ", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "commission_company": { "id": 1, Tipo Integer "validity": "2022-06-13", Tipo Date "miscellaneous_discounts": null, Tipo String "observation": null, Tipo String "commission_model_id": 8, Tipo Integer "company_id": 3, Tipo Integer / Id do company distribuidor "created_at": "2022-06-13 09:16:38", Tipo Date / Id do company do mesmo "updated_at": "2022-06-13 09:16:38", Tipo Date } }, "layout": { "id": 10, Tipo Integer "host": "Distribuidor", Tipo String / Host "company_id": 3, Tipo Integer / Id do company distribuidor "layout_id": 12, Tipo Integer / Id do layout "layout_email_id": null, Tipo Integer / Id do layout do e-mail "created_at": "2022-01-17 08:21:51", Tipo Date "updated_at": "2022-01-17 08:21:51", Tipo Date "email": null, Tipo String / E-mail "term_of_use": null, Tipo String / Termos de uso "system": null / Tipo do sistema } }, ] "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 2, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo Boolean "last_page": 9, Tipo Integer "is_last_page": false, Tipo Boolean "page_keys": [ 1, 2, 3 ], "from_item": 1, Tipo Integer "to_item": 10, Tipo Integer "total_items": 83, Tipo Integer "amount": null, Tipo Decimal / Valor "value": null, Tipo Decimal "efective": 0, Tipo Decimal "balance": 0, Tipo Decimal "low": 0, Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 10 Tipo Integer } }, "exist_link": true, Tipo Boolean "msg": [ "OK" ], "statusCode": 200 }
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.

Tipo de dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
200	{ "data": { "id": 1, Tipo Integer "commercial_name": "Rita e Beatriz Contábil ME", Tipo String / Nome Comercial "company_id": 3, Tipo Integer / Id do company do distribuidor "created_at": "2021-09-29 12:03:59", Tipo Date / Id do company do mesmo "updated_at": "2022-06-13 09:16:38", Tipo Date "commission_activation": 1, Tipo Integer / Id de status de comissão "commission_payment": 0, Tipo Integer / Id de status de suspensão de pagamentos "company": { "id": 3, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "localization": { "id": 3, Tipo Integer "company_id": 45, Tipo Integer / Id do company distribuidor "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 8, Tipo Integer "uf": "ES", Tipo String / Abreviação "name": "Espírito Santo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "contact": [ { "id": 220, Tipo Integer "company_id": 3, Tipo Integer / Id do company do distribuidor "contact_type_id": 1, Tipo Integer / Id do tipo de contato "name": "jacqueline", Tipo String / Nome "value": "11988808096", Tipo String / Telefone ou Email "created_at": "2022-06-13 09:16:38", Tipo Date "updated_at": "2022-06-13 09:16:38", Tipo Date "contact_type": { "id": 1, Tipo Integer "description": "Celular", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ], "bank_given": { "id": 3, Tipo Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do distribuidor "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer "account_type": { Objeto "id": 1, Tipo Integer "value": "Conta Corrente", Tipo String / Descrição do tipo da conta "created_at": null, Tipo Date "updated_at": null, Tipo Date "code": "CC" Tipo String / Código }, "holder_type": { Objeto "id": 2, Tipo Integer "value": "Pessoa Jurídica - Empresa", Tipo String / Descrição do tipo de documento representante "abbreviation": "PJE", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank": { Objeto "id": 340, Tipo Integer "code": "X1X", Tipo String / Código do banco "name": "CONTA INTERNA", Tipo String / Nome do banco "ispb": "00000000", Tipo String / Ispb do banco "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:07", Tipo Date "ispb_code": null Tipo String / Código ispb }, }, "bank_given_type": { "id": 1, Tipo Integer "value": "Conta Bancária", Tipo String / Descrição do tipo da conta "abbreviation": "CB", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null, Tipo Date "status_id": 1 / Id do Status (1 - Ativo, 2 - Inativo) }, "people_type": { "id": 1, Tipo Integer "name": "Pessoa Jurídica", Tipo String / Nome "abbreviation": "PJ", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "commission_company": { "id": 1, Tipo Integer "validity": "2022-06-13", Tipo Date / Validade "miscellaneous_discounts": null, "observation": null, Tipo String / Observação "commission_model_id": 8, Tipo Integer / Id do modelo de comissão "company_id": 3, Tipo Integer / Id do company do distribuidor "created_at": "2022-06-13 09:16:38", Tipo Date "updated_at": "2022-06-13 09:16:38", Tipo Date } }, "layout": { "id": 10, Tipo Integer "host": "Distribuidor", Tipo String "company_id": 3, Tipo Integer / Id do company do distribuidor "layout_id": 12, Tipo Integer / Id do layout "layout_email_id": null, Tipo Integer / Id do layout do e-mail "created_at": "2022-01-17 08:21:51", Tipo Date "updated_at": "2022-01-17 08:21:51", Tipo Date "email": null, Tipo String / E-mail "term_of_use": null, Tipo String / Termos "system": null Tipo String / Sistema } }, "msg": [ "OK" ], "statusCode": 206 }
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

Filtros

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

ID - filters[id] / Tipo de dado Integer
Data - filters[date] / Tipo de dado Date
Status - filters[transaction_file_status_id] / Tipo de dado Integer
Nome do Arquivo- filters[fileName] / Tipo de dado String

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "id":"null", "date":"null", "transaction_file_status_id":"null", "fileName":"null" } }

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 TRANSAÇÃO 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

Tipo de Dado
ID: Integer

Parâmetros

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

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

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "id": "null", "date": "null", "transaction_file_status_id": "null", "fileName": "null" } }

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

Tipo de Dado
ID: Integer

Parâmetros

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

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

Filtros

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Sistema - filters[system_id] / Sistema
IP - filters[ip] / IP
ID de estabelecimento - filters[establishment_id] / ID de estabelecimento
ID de distribuidor- filters[distributor_id] / ID de distribuidor
Login- filters[login] / Login
Período- filters[datefilter_datefinal] / Período

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

Instituição Financeira
/report_cerc/financial_instituional

Detalhes

Filtros

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

ID - filters[id] / ID
Nome - filters[name] / Nome
Razão Social - filters[reason] / Razão Social
Documento- filters[document] / Documento

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

Efeitos de contratos
/report_cerc/imported_config

Detalhes

Filtros

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Nome Fantasia - filters[establishment] / Nome Fantasia
Documento - filters[document] / Documento
Documento da instuição financeira - filters[expiry_date] / Documento da instuição financeira
Protocolo- filters[protocol] / Protocolo
Vencimento- filters[expiry_date] / Vencimento
Arranjo de pagamento- filters[cip_product_id] / Arranjo 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

GET

Pagamentos CERC
/cerc_payments

Detalhes

Filtros

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Doc. Estabelecimento - filters[document] / Doc. Estabelecimento
Doc. Financeira - filters[destiny_document] / Doc. Financeira
Status - filters[status_id] / Status
Data- filters[date] / Data
Valor (R$)- filters[total] / Valor (R$)
ID Recebível- filters[receivable_id] / ID Recebível
Identificador recebível- filters[receivable_identifier] / Identificador recebível

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 Manutenção de Conciliação
report_cerc/ap009

Detalhes

Filtros

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Arquivo - filters[filename] /Arquivo
Envio - filters[date] / Envio
Processamento - filters[proccess_date] / Processamento
Status- filters[status] / Status

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 Retorno AP010
/report_cerc/ap010

Detalhes

Filtros

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Arquivo - filters[filename] /Arquivo
Envio - filters[date] / Envio
Status - filters[status] / Status

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

Man. Estab
/report_cerc/man_estab

Detalhes

Filtros

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Nome Fantasia - filters[establishment] /Nome Fantasia
Documento - filters[document] / Documento
Ref. Externa - filters[external_ref] / Ref. Externa
Criação da CERC - filters[created_at_cerc] / Criação da CERC
Último Envio - filters[last_send] / Último Envio
Situação - filters[situation] / Situação
Liquidação - filters[liquidation] / Liquidação
Status - filters[status] / Status

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

Tarifas Antecipação
/report_tariff_anticipation

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

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Documento - filters[document] / Documento
Tipo - filters[type] / Tipo
Período - filters[period] / Período
Valor (R$) - filters[amount] / Valor (R$)
Método de Captura - filters[method_id] / Método de Captura
Vigência (Período) - filters[datefilter_datefinal] / Vigência (Período)

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "date":"null", "fileName":"null" } }

Retornos

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

GET

Tarifas Antecipação por id
/report_tariff_anticipation/{id}

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

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "date":"null", "fileName":"null" } }

Retornos

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

GET

Dimp
/reports/dimp

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

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Arquivo - filters[fileName] / Arquivo
Data Inicio - filters[date_init] / Data Inicio
Data Final - filters[date_end] / Data Final
ID da transação - filters[transaction_id] / ID da transação
ID do Estabelecimento - filters[establishment_id] / ID do Estabelecimento
Estado - filters[states] / Estado
Status - filters[status_id] / Status

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "date":"null", "fileName":"null" } }

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

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "id": "null", "date": "null", "transaction_file_status_id": "null", "fileName": "null" } }

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.

Tipo de Dado
ID: Integer

Parâmetros

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

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

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "id": "null", "date": "null", "transaction_file_status_id": "null", "fileName": "null" } }

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.

Tipo de Dado
ID: Integer

Parâmetros

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

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

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Data - filters[date] / Tipo de dado Date
Nome do Arquivo- filters[fileName] / Tipo de dado String

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "date":"null", "fileName":"null" } }

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.

Tipo de Dado
ID: Integer

Parâmetros

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

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

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Data - filters[date] / Tipo de dado Date
Nome do Arquivo- filters[fileName] / Tipo de dado String

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "date":"null", "fileName":"null" } }

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.

Tipo de Dado
ID: Integer

Parâmetros

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

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

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

ID - filters[id] / Tipo de dado Integer
Documento - filters[document] / Tipo de dado String
ID Estabelecimento - filters[establishment_id] / Tipo de dado Integer
Nome Comercial - filters[establishment.commercial_name] / Tipo de dado String
Produto - filters[product_id] / Tipo de dado Integer
Status - filters[status_id] / Tipo de dado Integer

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "id":"null", "document":"null", "establishment_id":"null", "establishment.commercial_name":"null", "product_id":"null", "status_id":"null" } }

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.

Tipo de Dado
ID: Integer

Parâmetros

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

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

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Data - filters[date] / Tipo de dado Date
Nome do Arquivo - filters[filename] / Tipo de dado String

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "date":"null", "fileName":"null" } }

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.

Tipo de Dado
ID: Integer

Parâmetros

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

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

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Data - filters[date] / Tipo de dado Date
Nome do Arquivo - filters[filename] / Tipo de dado String

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "date":"null", "fileName":"null" } }

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.

Tipo de Dado
ID: Integer

Parâmetros

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

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

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

ID Transação - filters[transaction_id] / Tipo de dado Integer
NSU Transação - filters[nsu] / Tipo de dado String
Autorização - filters[authorization] / Tipo de dado String
Originador - filters[originator_id] / Tipo de dado Integer
Data da Transação - filters[transaction_date] / Tipo de dado Date
Data de Liquidação - filters[liquid_date] / Tipo de dado Date

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "transaction_id":"null", "nsu":"null", "authorization":"null", "originator_id":"null", "transaction_date":"null", "liquid_date":"null" } }

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.

Tipo de Dado
ID: Integer

Parâmetros

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

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

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Id de Estabelecimento - filters[nsu] / Tipo de dado String
Nome Comercial - filters[commercial_name] / Tipo de dado String
Documento - filters[document] / Tipo de dado String
Tipo de pessoa - filters[companies.people_type_id] / Tipo de dado Integer
Status na CERC - filters[cerc] / Tipo de dado Integer
Situação - filters[establishment_situation_id] / Tipo de dado Integer
Distribuidor - filters[distributor.id] / Tipo de dado Integer
Preposto - filters[preposterou.id] / Tipo de dado Integer
Grupo econômico - filters[economic_group.id] / Tipo de dado Integer
Data de cadastro - filters[date] / Tipo de dado Date

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "nsu":"null", "commercial_name":"null", "document":"null", "companies.people_type_id":"null", "companies.status_id":"null", "establishment_situation_id":"null", "distributor.id":"null", "preposterou.id":"null", "economic_group.id":"null", "date":"null" } }

Retornos

Código	Mensagem
200	EXEMPLO: { "id": 1, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "distributor": { "id": 1, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "company_id": 3, Tipo Integer / Id do company distribuidor "created_at": "2021-09-29 12:03:59", Tipo Date "updated_at": "2021-09-29 12:03:59", Tipo Date "commission_activation": 0, Tipo Integer / Ativação de comissão para o distribuidor "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos }, "mccs": { "id": 70, Tipo Integer "code": "5511", Tipo String / Código do MCC "description": "Carros e Caminhões (Novos e Usados)", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date "type_id": null, Tipo Integer / Id do tipo de mcc "minimal_balance": null, Tipo Decimal / Saldo minimo "max_post": null, Tipo Decimal / Valor minimo "min_post": null, Tipo Decimal / Valor maximo "period": null Tipo Date / Periodo }, "verification_ofac": { "id": 1, Tipo Integer "description": "Checado", Tipo String / Descrição "created_at": null, Tipo Decimal "updated_at": null Tipo Decimal }, "integration": { "id": 1, Tipo Integer "description": "Integrado", Tipo String / Descrição "created_at": null, Tipo Decimal "updated_at": null Tipo Decimal }, "antecipation": { "id": 3, Tipo Integer "description": "Liberado Geral", Tipo String / Descrição "created_at": null, Tipo Decimal "updated_at": null Tipo Decimal }, "preposterou": { "id": 1, Tipo Integer "distributor_id": 1, Tipo Integer / Id do Distribuidor "company_id": 5, Tipo Integer / Id do company do preposto "created_at": "2021-09-29 12:06:09", Tipo Date "updated_at": "2021-09-29 12:06:09", Tipo Date "name": "Marcos", Tipo String / Nome do Preposto "commission_activation": 0, Tipo Integer / Status de comissão "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos "preposterous_credential_type_id": null Tipo Integer / Tipo de credencial do preposto }, "economic_group": { "id": 1, Tipo Integer "name": "Teste SLG", Tipo String / Nome do Grupo Econômico "code_pos": 1, Tipo String / Código POS "code_menu": 2, Tipo String / Código menu "created_at": "2021-09-29 12:15:07", Tipo Decimal "updated_at": "2021-09-29 12:15:07", Tipo Decimal }, "situation": { "id": 6, Tipo Integer "description": "Aprovado Manualmente", Tipo String / Descrição "created_at": null, Tipo Decimal "updated_at": null Tipo Decimal }, "company": { "id": 9, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "localization": { "id": 45, Tipo Integer "company_id": 45, Tipo Integer / Id do company do estabelecimento "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "localization_delivery": { "id": 1, Tipo Integer "company_id": 9, Tipo Integer / Id do company do estabelecimento "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "contact": [ { "id": 202, Tipo Integer "company_id": 3, Tipo Integer / Id do company do estabelecimento "contact_type_id": 1, Tipo Integer / Id do tipo de contato "name": "jacqueline", Tipo String / Nome "value": "11988808096", Tipo String / Telefone ou Email "created_at": "2022-06-13 09:16:38", Tipo Date "updated_at": "2022-06-13 09:16:38", Tipo Date "contact_type": { "id": 1, Tipo Integer "description": "Celular", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ] "bank_given": { "id": 9, Tipo Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do estabelecimento "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer "account_type": { Objeto "id": 1, Tipo Integer "value": "Conta Corrente", Tipo String / Descrição do tipo da conta "created_at": null, Tipo Date "updated_at": null, Tipo Date "code": "CC" Tipo String / Código }, "holder_type": { Objeto "id": 2, Tipo Integer "value": "Pessoa Jurídica - Empresa", Tipo String / Descrição do tipo de documento representante "abbreviation": "PJE", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank": { Objeto "id": 340, Tipo Integer "code": "X1X", Tipo String / Código do banco "name": "CONTA INTERNA", Tipo String / Nome do banco "ispb": "00000000", Tipo String / Ispb do banco "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:07", Tipo Date "ispb_code": null Tipo String / Código ispb }, }, "bank_given_type": { "id": 1, Tipo Integer "value": "Conta Bancária", Tipo String / Descrição do tipo da conta "abbreviation": "CB", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null, Tipo Date "status_id": 1 / Id do Status (1 - Ativo, 2 - Inativo) }, "people_type": { "id": 1, Tipo Integer "name": "Pessoa Fisica", Tipo String / Nome "abbreviation": "PJ", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Decimal "updated_at": null Tipo Decimal } }, "internal_parameter": { "id": 1, Tipo Integer "max_amount_day": "9999.00", Tipo Decimal / Valor maximo diario "max_amount": "99999999.00", Tipo Decimal / Valor maximo "quantity_operator_day": 1000, Tipo Decimal / Quantidade maxima de operações diarias "created_at": "2022-03-20 17:43:09", Tipo Date "updated_at": "2022-03-20 17:43:09", Tipo Date "establishment_id": 17 Tipo Integer / Id do Estabelecimento }, "automatic_anticipations": [ { "id": 1, Tipo Integer "establishment_id": 1, Tipo Integer / Id do estabelecimento "economic_group_id": null, Tipo Integer / Id do grupo econômico "anticipation_application_mode_id": 2, Tipo Integer / Id forma de aplicação da antecipação automatica "anticipation_mode_id": 1, Tipo Integer / Id do tipo de aplicação da antecipação automatica "value": 1, Tipo Integer / Prazo D+ "created_at": "2022-06-13 08:49:27", Tipo Date "updated_at": "2022-06-13 08:49:27", Tipo Date "application_mode": { "id": 2, Tipo Integer "description": "Parcela", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "mode": { "id": 1, Tipo Integer "description": "Diário", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ], "payment_status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "cerc_status": { "id": 2, Tipo Integer "description": "Recusado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 1, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo boolean "last_page": 1, Tipo Integer "is_last_page": true, Tipo boolean "page_keys": [ 1 ], "from_item": 1, Tipo Integer "to_item": 1, Tipo Integer "total_items": 1, Tipo Integer "amount": null, Tipo Decimal "value": null, Tipo Decimal "efective": 0, Tipo Decimal "balance": 0, Tipo Decimal "low": 0, Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 1 Tipo Integer } }, "msg": [ "OK" ], "statusCode": 200
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

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
200	EXEMPLO: { "id": 1, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "distributor": { "id": 1, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "company_id": 3, Tipo Integer / Id do company do distribuidor "created_at": "2021-09-29 12:03:59", Tipo Date "updated_at": "2021-09-29 12:03:59", Tipo Date "commission_activation": 0, Tipo Integer / Ativação de comissão para o distribuidor "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos }, "mccs": { "id": 70, Tipo Integer "code": "5511", Tipo String / Código do MCC "description": "Carros e Caminhões (Novos e Usados)", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date "type_id": null, Tipo Integer "minimal_balance": null, Tipo Decimal / Saldo minimo "max_post": null, Tipo Decimal / Valor minimo "min_post": null, Tipo Decimal / Valor maximo "period": null Tipo Date / Periodo }, "verification_ofac": { "id": 1, Tipo Integer "description": "Checado", Tipo String / Descrição "created_at": null, Tipo Decimal "updated_at": null Tipo Decimal }, "integration": { "id": 1, Tipo Integer "description": "Integrado", Tipo String / Descrição "created_at": null, Tipo Decimal "updated_at": null Tipo Decimal }, "antecipation": { "id": 3, Tipo Integer "description": "Liberado Geral", Tipo String / Descrição "created_at": null, Tipo Decimal "updated_at": null Tipo Decimal }, "preposterou": { "id": 1, Tipo Integer "distributor_id": 1, Tipo Integer / Id do Distribuidor "company_id": 5, Tipo Integer / Id do company do preposto "created_at": "2021-09-29 12:06:09", Tipo Date "updated_at": "2021-09-29 12:06:09", Tipo Date "name": "Marcos", Tipo String / Nome do Preposto "commission_activation": 0, Tipo Integer / Status de comissão "commission_payment": 0 Tipo Integer / Status de ativação de Suspensão de pagamentos "preposterous_credential_type_id": null Tipo Integer / Tipo de credencial do preposto }, "economic_group": { "id": 1, Tipo Integer "name": "Teste SLG", Tipo String / Nome do Grupo Econômico "code_pos": 1, Tipo String / Código POS "code_menu": 2, Tipo String / Código menu "created_at": "2021-09-29 12:15:07", Tipo Decimal "updated_at": "2021-09-29 12:15:07", Tipo Decimal "automatic_anticipations": [] }, "situation": { "id": 6, Tipo Integer "description": "Aprovado Manualmente", Tipo String / Descrição "created_at": null, Tipo Decimal "updated_at": null Tipo Decimal }, "company": { "id": 9, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "localization": { "id": 45, Tipo Integer "company_id": 45, Tipo Integer / Id do company do estabelecimento "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "localization_delivery": { "id": 1, Tipo Integer "company_id": 9, Tipo Integer / Id do company estabelecimento "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "contact": [ { "id": 202, Tipo Integer "company_id": 3, Tipo Integer / Id do company do estabelecimento "contact_type_id": 1, Tipo Integer / Id do tipo de contato "name": "jacqueline", Tipo String / Nome "value": "11988808096", Tipo String / Telefone ou Email "created_at": "2022-06-13 09:16:38", Tipo Date "updated_at": "2022-06-13 09:16:38", Tipo Date "contact_type": { "id": 1, Tipo Integer "description": "Celular", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ] "id": 9, Tipo Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do estabelecimento "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer "account_type": { Objeto "id": 1, Tipo Integer "value": "Conta Corrente", Tipo String / Descrição do tipo da conta "created_at": null, Tipo Date "updated_at": null, Tipo Date "code": "CC" Tipo String / Código }, "holder_type": { Objeto "id": 2, Tipo Integer "value": "Pessoa Jurídica - Empresa", Tipo String / Descrição do tipo de documento representante "abbreviation": "PJE", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank": { Objeto "id": 340, Tipo Integer "code": "X1X", Tipo String / Código do banco "name": "CONTA INTERNA", Tipo String / Nome do banco "ispb": "00000000", Tipo String / Ispb do banco "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:07", Tipo Date "ispb_code": null Tipo String / Código ispb }, }, "bank_given_type": { "id": 1, Tipo Integer "value": "Conta Bancária", Tipo String / Descrição do tipo da conta "abbreviation": "CB", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null, Tipo Date "status_id": 1 / Id do Status (1 - Ativo, 2 - Inativo) }, "people_type": { "id": 1, Tipo Integer "name": "Pessoa Fisica", Tipo String / Nome "abbreviation": "PJ", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Decimal "updated_at": null Tipo Decimal } }, "internal_parameter": { "id": 1, Tipo Integer "max_amount_day": "9999.00", Tipo Decimal / Valor maximo diario "max_amount": "99999999.00", Tipo Decimal / Valor maximo "quantity_operator_day": 1000, Tipo Decimal / Quantidade maxima de operações diarias "created_at": "2022-03-20 17:43:09", Tipo Date "updated_at": "2022-03-20 17:43:09", Tipo Date "establishment_id": 17 Tipo Integer / Id do Estabelecimento }, "automatic_anticipations": [ { "id": 1, Tipo Integer "establishment_id": 1, Tipo Integer / Id do estabelecimento "economic_group_id": null, Tipo Integer / Id do grupo econômico "anticipation_application_mode_id": 2, Tipo Integer / Id forma de aplicação da antecipação automatica "anticipation_mode_id": 1, Tipo Integer / Id do tipo de aplicação da antecipação automatica "value": 1, Tipo Integer / Prazo D+ "created_at": "2022-06-13 08:49:27", Tipo Date "updated_at": "2022-06-13 08:49:27", Tipo Date "application_mode": { "id": 2, Tipo Integer "description": "Parcela", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "mode": { "id": 1, Tipo Integer "description": "Diário", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ], "payment_status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "cerc_status": { "id": 2, Tipo Integer "description": "Recusado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 1, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo boolean "last_page": 1, Tipo Integer "is_last_page": true, Tipo boolean "page_keys": [ 1 ], "from_item": 1, Tipo Integer "to_item": 1, Tipo Integer "total_items": 1, Tipo Integer "amount": null, Tipo Decimal "value": null, Tipo Decimal "efective": 0, Tipo Decimal "balance": 0, Tipo Decimal "low": 0, Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 1 Tipo Integer } }, "msg": [ "OK" ], "statusCode": 200
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.

Filtros

Caso não queira filtrar por algum dos campos abaixo, apenas apague a linha do campo dentro do objeto filters.

Repasses com valores zerados ? (0 - Não, 1 - Sim) - filters[total.all] / Tipo de Dado: Integer
ID do Repasse - filters[nsu] / Tipo de Dado: Integer
Data do Repasse - filters[date] / Tipo de Dado: Date
Status do Repasse - filters[status_id]/ Tipo de Dado: Integer
Valor Repasse - filters[total] / Tipo de Dado: Double
Documento - filters[document] / Tipo de Dado: String
Nome Comercial do Estabelecimento - filters[establishment.commercial_name] / Tipo de Dado: String
ID Estabelecimento - filters[establishment_id] / Tipo de Dado: Integer

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "nsu": "null", "date": "null", "companies.company_details.document": "null", "companies.document": "null", "status_id": "null", "establishment.commercial_name": "null", "total": "null", } }

Retornos

Código	Mensagem
200	{ "data":{ "data":[ { "id": 42, Tipo Integer "establishment_id": 21, Tipo Integer / Id do Estabelecimento "bank_given_id": 68, Tipo Integer / Id da Conta Bancaria "status_id": 4, Tipo Integer / Id de status de repasse "tariff_tax": "2.23", Tipo Decimal / do valor da Tarifa "cancelation_tax": "0.00", Tipo Decimal / Taxa de cancelamento "chargeback_tax": "0.00", Tipo Decimal / Taxa de chargeback "transaction_tax": "0.00", Tipo Decimal / Taxa de transação "additional_tax": "0.00", Tipo Decimal / Taxa Adicional "payment_tax": "0.00", Tipo Decimal / Taxa de Pagamento "anticipation_tax": "0.00", Tipo Decimal / Taxa de Antecipação "installments": "0.00", Tipo Decimal / Parcelas "credit_granted": "0.00", Tipo Decimal / Subtotal "balance": "0.00", Tipo Decimal / Saldo "debit": "2.23", Tipo Decimal / Valor de debito "credit": "0.00", Tipo Decimal / Valor de credito "total": "-2.23", Tipo Decimal / Total "date": "2022-06-13", Tipo Date / Data "created_at": "2022-06-13 08:51:28", Tipo Date "updated_at": "2022-06-13 08:51:28", Tipo Date "split_credit": "0.00", Tipo Decimal / Valor de credito de split "split_debit": "0.00", Tipo Decimal / Valor de debito de split "external_code": null, Tipo String / Código externo "partial_credit": "0.00", Tipo Decimal / Credito Parcial "partial_debit": "2.23", Tipo Decimal / Debito Parcial "refunds": "0.00", Tipo Decimal / Reembolso "payment_date": "2022-06-13", Tipo Date / Data de Pagamento "antecipated_credit": "0.00", Tipo Decimal / Credito Antecipado "raw_credit": "0.00", Tipo Decimal "mdr_credit": "0.00", Tipo Decimal / Credito MDR "commission_ec": null, "transfer_status": { "id": 4, Tipo Integer "description": "Pagamento efetuado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "establishment": { "id": 21, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 9, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { "id": 51, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { "id": 35, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date }, "people_type": { "id": 2, Tipo Integer "name": "Pessoa Jurídica", Tipo String / Nome "abbreviation": "PJ", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date } } }, }, ] "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 2, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo Boolean "last_page": 3, Tipo Integer "is_last_page": false, Tipo Boolean "page_keys": [ 1, 2, 3 ], "from_item": 1, Tipo Integer "to_item": 10, Tipo Integer "total_items": 28, Tipo Integer "amount": 106044.19, Tipo Decimal / Valor "value": null, Tipo Decimal "efective": "99832.98", Tipo Decimal "balance": "-1.75", Tipo Decimal "low": "56.02", Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 10 Tipo Integer } }, "msg": [ "OK" ], "statusCode": 200 }
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.

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
200	{ "data": { Objeto "id": 31, Tipo Integer "establishment_id": 2, Tipo Integer / Id do Estabelecimento "bank_given_id": 28, Tipo Integer / Id da Conta Bancária "status_id": 4, Tipo Integer / Id de status de repasse "tariff_tax": "1.00", Tipo Decimal / do valor da Tarifa "cancelation_tax": "0.00", Tipo Decimal / Taxa de cancelamento "chargeback_tax": "0.00", Tipo Decimal / Taxa de chargeback "transaction_tax": "0.00", Tipo Decimal / Taxa de transação "additional_tax": "0.00", Tipo Decimal / Taxa Adicional "payment_tax": "0.00", Tipo Decimal / Taxa de Pagamento "anticipation_tax": "0.00", Tipo Decimal / Taxa de Antecipação "installments": "0.00", Tipo Decimal / Parcelas "credit_granted": "0.00", Tipo Decimal / Subtotal "balance": "0.00", Tipo Decimal / Saldo "debit": "1.00", Tipo Decimal / Valor de debito "credit": "3144.64", Tipo Decimal / Valor de credito "total": "3143.64", Tipo Decimal / Valor total "date": "2022-03-31", Tipo Date / Data "created_at": "2022-03-31 14:37:00", Tipo Date "updated_at": "2022-03-31 14:37:00", Tipo Date "split_credit": "3144.64", Tipo Decimal / Valor de credito do split "split_debit": "0.00", Tipo Decimal / Valor de debito de split "external_code": null, Tipo String / Código externo "partial_credit": "3144.64", Tipo Decimal / Credito Parcial "partial_debit": "1.00", Tipo Decimal / Debito Parcial "refunds": "0.00", Tipo Decimal / Reembolso "payment_date": "2022-03-31", Tipo Date / Data de Pagamento "antecipated_credit": "0.00", Tipo Decimal / Credito Antecipado "raw_credit": "0.00", Tipo Decimal "mdr_credit": "0.00", Tipo Decimal / Credito MDR "commission_ec": null, Tipo Integer "transfer_status": { Objeto "id": 4, Tipo Integer "description": "Pagamento efetuado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank_given": { Objeto "id": 28, Tipo Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do estabelecimento "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer / Id do status de liquidação "account_type": { Objeto "id": 1, Tipo Integer "value": "Conta Corrente", Tipo String / Descrição do tipo da conta "created_at": null, Tipo Date "updated_at": null, Tipo Date "code": "CC" Tipo String / Código }, "holder_type": { Objeto "id": 2, Tipo Integer "value": "Pessoa Jurídica - Empresa", Tipo String / Descrição do tipo de documento representante "abbreviation": "PJE", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank": { Objeto "id": 340, Tipo Integer "code": "X1X", Tipo String / Código do banco "name": "CONTA INTERNA", Tipo String / Nome do banco "ispb": "00000000", Tipo String / Ispb do banco "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:07", Tipo Date "ispb_code": null Tipo String / Código ispb }, }, "establishment": { "id": 2, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 13, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { Objeto "id": 13, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { Objeto "id": 10, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date "branch_type": { Objeto "id": 1, Tipo Integer "description": "Matriz", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "people_type": { Objeto "id": 2, Tipo Integer "name": "Pessoa Jurídica", Tipo String / Nome "abbreviation": "PJ", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank_given": { Objeto "id": 28, Tipo Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do estabelecimento "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer "account_type": { Objeto "id": 1, Tipo Integer "value": "Conta Corrente", Tipo String / Descrição do tipo da conta "created_at": null, Tipo Date "updated_at": null, Tipo Date "code": "CC" Tipo String / Código }, "holder_type": { Objeto "id": 2, Tipo Integer "value": "Pessoa Jurídica - Empresa", Tipo String / Descrição do tipo de documento representante "abbreviation": "PJE", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank": { Objeto "id": 340, Tipo Integer "code": "X1X", Tipo String / Código do banco "name": "CONTA INTERNA", Tipo String / Nome do banco "ispb": "00000000", Tipo String / Ispb do banco "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:07", Tipo Date "ispb_code": null Tipo String / Código ispb }, }, "prepaid_card": null, "bank_given_type": { Objeto "id": 1, Tipo Integer "value": "Conta Bancária", Tipo String / Descrição do tipo da conta "abbreviation": "CB", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null, Tipo Date "status_id": 1 / Id do Status (1 - Ativo, 2 - Inativo) } } }, "transfer_credit": [ Array { "transfer_resume_id":"31", Tipo Integer / Id do repasse "credit_id":"1", Tipo Integer / Id do credito do estabelecimento "establishment_credits":{ Objeto "establishment_id": 2, Tipo Integer / Id do Estabelecimento "expiry_date":"2021-10-01", Tipo Date / Data de vencimento "value":"250.00", Tipo Decimal / Valor "description":"teste", Tipo String / Descrição "credit_status_id":"1", Tipo Integer / Status de pagamento do credito "moneylender_solicitation_id": null Tipo Integer / Id da solicitação de GIRO "establishment":{ Objeto "id": 2, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2021-09-29 13:10:33", Tipo Date / Data de ativação "company_id": 13, Tipo Integer / Id do company do estabelecimento "mcc_id": 3, Tipo Integer / Id do MCC "establishment_situation_id": 6, Tipo Integer / Situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 1, Tipo Integer / Status de OFAC "integration_status_id": 1, Tipo Integer / Status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2021-09-29 12:34:36", Tipo Date "updated_at": "2022-04-07 07:27:16", Tipo Date "payment_status_id": 1, Tipo Integer / Status de pagamento "external_unique_identification": "-2", Tipo String / Indentificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "1", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Id refente ao tipo de split "status_anticipation": 1, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data de criação da CERC "payment_link_status_id": 1, Tipo Integer / Status do link de pagamento "has_delivery_address": 2, Tipo Integer / Status do endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de antecipação automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data de contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { Objeto "id": 13, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { Objeto "id": 10, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date "branch_type": { Objeto "id": 1, Tipo Integer "description": "Matriz", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, }, }, } ], "transfer_balances": [ Array { "transfer_resume_id":"31", Tipo Integer "balance_id":"1", Tipo Integer "establishment_balances":{ Objeto "establishment_id": 2, Tipo Integer / Id do Estabelecimento "expiry_date":"2021-10-01", Tipo Date / Data de vencimento "amount":"250.00", Tipo Decimal / Valor "status_id":"1" Tipo Integer / Status de pagamento "establishment_credits":{ "establishment_id": 2, Tipo Integer / Id do Estabelecimento "expiry_date":"2021-10-01", Tipo Date / Data de vencimento "value":"250.00", Tipo Decimal / Valor "description":"teste", Tipo String / Descrição "credit_status_id":"1", Tipo Integer / Status de pagamento do credito "moneylender_solicitation_id": null, Tipo Integer / Id da solicitação de GIRO "status":{ Objeto "id": 1, Tipo Integer "description": "Não Pago", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } "establishment":{ Objeto "id": 2, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2021-09-29 13:10:33", Tipo Date / Data de ativação "company_id": 13, Tipo Integer / Id do company do estabelecimento "mcc_id": 3, Tipo Integer / Id do MCC "establishment_situation_id": 6, Tipo Integer / Situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 1, Tipo Integer / Status de OFAC "integration_status_id": 1, Tipo Integer / Status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2021-09-29 12:34:36", Tipo Date "updated_at": "2022-04-07 07:27:16", Tipo Date "payment_status_id": 1, Tipo Integer / Status de pagamento "external_unique_identification": "-2", Tipo String / Indentificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "1", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Id refente ao tipo de split "status_anticipation": 1, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data de criação da CERC "payment_link_status_id": 1, Tipo Integer / Status do link de pagamento "has_delivery_address": 2, Tipo Integer / Status do endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de antecipação automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data de contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { Objeto "id": 13, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { Objeto "id": 10, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date "branch_type": { Objeto "id": 1, Tipo Integer "description": "Matriz", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, }, }, } } ], "transfer_anticipations": [ Array { ""id": 29, Tipo Integer "transfer_resume_id": 24, Tipo Integer "anticipation_installment_id": 165, Tipo Integer "installment_anticipations":{ "id": 165, Tipo Integer "transaction_id": 134, Tipo Integer / Id da transação "amount": "1000.00", Tipo Decimal / Valor "number": 1, Tipo Integer / Numero da parcela "situation_id": 2, Tipo Integer / Situação de pagamento da parcela "installment_status_id": 2, Tipo Integer / Id de status da parcela "expiry_date": "2022-02-09", Tipo Date / Data de vencimento da parcela "closing_date": "2022-03-30", Tipo Date / Data de fechamento da parcela "pay_date": "2022-03-30", Tipo Date / Data de pagamento da parcela "cancel_date": null, Tipo Date / Data de cancelamento da parcela "created_at": "2022-01-26 12:26:03", Tipo Date "updated_at": "2022-03-30 08:31:34", Tipo Date "net_amount": "980.54", Tipo Decimal / Valor liquido da parcela "split_amount": "0.00", Tipo Decimal / Valor de split "split_amount_percent": "0.00", Tipo Decimal / Porcentagem de split "conciliation_status_id": null, Tipo Integer / Id do Status de conciliação "expected_payment_date": null, Tipo Date / Data estimada de pagamento "commission": "0.00", Tipo Decimal / Valor da comissão "original_expected_payment_date": null, Tipo Date / Data original de pagamento "adq_anticipation_tax": "0.00", Tipo Decimal / Taxa de antecipação Adquirente "adq_mdr_tax": "0.00", Tipo Decimal / MDR do Adquirente "cerc_status_id": 1, Tipo Integer / Id do status na CERC "job_amount": null, Tipo Decimal "external_code": null, Tipo String / Código externo "proccess_date": null, Tipo String / Data de processamento "liquid_status_id": 1, Tipo Integer / Id do status de liquidação "pgs_code": null, Tipo String / Código pgs "tariff":[ Array { "id": 304, Tipo Integer "installment_id": 165, Tipo Integer / Id da parcela "tariff_id": 175, Tipo Integer / Id da tarifa "amount_charged": "14.20", Tipo Decimal / Valor cobrado após tarifas "tariff_amount": "1.42", Tipo Decimal / Valor da tarifa "tariff_type_id": 2, Tipo Integer / Tipo de aplicação da tarifa "created_at": "2022-01-26 12:26:03", Tipo Date "updated_at": "2022-01-26 12:26:03", Tipo Date "tariff": { Objeto "id": 175, Tipo Integer "description": "1 Parcela", Tipo String / Descrição "value": "1.55", Tipo Decimal / Valor "complement": null, Tipo String / Complemento "tariff_type_id": 2, Tipo Integer / Id do tipo de tarifa "frequency_id": 5, Tipo Integer / Id da frequencia da tarifa "created_at": null, Tipo Date "updated_at": "2021-12-06 12:55:43", Tipo Date "franchise_qtd": 0, Tipo Decimal / Qtd Franquia "franchise_type_id": null, Tipo Integer / Id do Tipo de Franquia "franchise_rule_id": null, Tipo Integer / Id da Regra Frequência "installments": 1, Tipo Integer / Quantidade de Parcelas "product_id": 1, Tipo Integer / Id do Produto "discount_status": 2, Tipo Integer / Status de Desconto "ecommerce_value": "1.55" Tipo Decimal / Valor Ecommerce } }, ], "anticipation": { Objeto "id": 33, Tipo Integer "installment_id": 165, Tipo Integer / Id da Parcela "original_expiry_date": "2022-02-25", Tipo Date / Data original de vencimento "created_at": "2022-02-08 08:36:54", Tipo Date "updated_at": "2022-02-08 08:36:54" Tipo Date }, "installment_situation": { Objeto "id": 2, Tipo Integer "description": "Paga", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "status": { Objeto "id": 2, Tipo Integer "description": "Fechada", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "transaction":{ Objeto "id": 134, Tipo Integer "card_number": "000589916XXXXXX0487", Tipo String / Numero do cartão "originator": "ADIQ", Tipo String / Originador "authorization": "007078", Tipo String / Autorização "nsu": "75", Tipo String / Nsu transação "company_id": 9, Tipo Integer / Id do company do estabelecimento "acquirer_id": 1, Tipo Integer / Id do Adquirente "installments": 1, Tipo Integer / Quantidade de Parcelas "amount": "1000.00", Tipo Decimal / Valor "terminal_identification": "6N281051", Tipo String / Identificação do terminal "capture_method_id": 1, Tipo Integer / Metodo de captura "product_id": 1, Tipo Integer / Id do Produto "transaction_type_id": 2, Tipo Integer / Id do tipo de transação "integration_transaction_id": "75", Tipo Integer / Id da transação integrada "transaction_canceled_id": null, Tipo Integer / Id do cancelamento da transação "date": "2022-01-26 13:45:43", Tipo Date "created_at": "2022-01-26 12:26:03", Tipo Date "updated_at": "2022-01-26 12:26:03", Tipo Date "entry_mode_id": 2, Tipo Integer / Id do meio de entrada "integration_transaction_id_2": "75", Tipo Integer / Id da transação integrada "distributor_id": 1, Tipo Integer / Id do Distribuidor "preposterou_id": 1, Tipo Integer / Id do Preposto "last_import": null, / Ultima data que foi importado "attempt": 0, Tipo Integer / Tentativas "integration_status_id": 2, Tipo Integer / Id do status de integração "cerc_status_id": 2, Tipo Integer / Id do status na CERC "external_identificator": null, Tipo String / Indentificação externa "liquid_amount": null, Tipo Decimal / Valor liquido "return_tax": null, Tipo Decimal / Taxa de retorno "service_type_id": 2, Tipo Integer / Id do tipo de serviço "alias": null, Tipo String "additional_info": null, Tipo String / Informação adicional "proccess_date": null, Tipo Date / Data de processamento "identificator": null, Tipo String / identificador "pgs_code": null, Tipo String / Código pgs "received_edi": "N", Tipo String "product": { Objeto "id": 1, Tipo Integer "brand_id": 2, Tipo Integer / Id da bandeira "payment_method_id": 1, Tipo Integer / Id do metodo de pagamento "created_at": null, Tipo Date "updated_at": "2021-09-29 11:47:33", Tipo Date "cip_product_id": 1, Tipo Integer / Id do produto cip "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "brand": { "id": 2, Tipo Integer "name": "Mastercard", Tipo String / Nome da bandeira "icons": "data:image/png;base64", Tipo String / Icone em base 64 "created_at": null, Tipo Date "updated_at": null Tipo Date }, "payment_method": { "id": 1, Tipo Integer "description": "Crédito rotativo", Tipo String / Descrição "max_installments": 1, Tipo Integer / Quantidade maxima de parcelas "min_installments": 1, Tipo Integer / Quantidade minima de parcelas "created_at": null, Tipo Date "updated_at": null, Tipo Date "rules": "default" Tipo String / Regra } } } } ], "transfer_cancelations": [ Array Retorna o a mesma estrutura de transfer_anticipations, com os dados das transações de canceladas ], "transfer_chargebacks": [ Array Retorna o a mesma estrutura de transfer_anticipations, com os dados das transações de chargeback ], "transfer_installments": [ Array Retorna o a mesma estrutura de transfer_anticipations, com os dados das parcelas ], "transfer_splits": [ Array { "id": 26, Tipo Integer "transfer_resume_id": 31, Tipo Integer "split_id": 39, Tipo Integer "installment_splits": { Objeto "id": 39, Tipo Integer "installment_id": 216, Tipo Integer / Id da Parcela "company_id": 13, Tipo Integer / Id do company do estabelecimento "situation_id": 2, Tipo Integer / Id da situação da parcela "installment_status_id": 2, Tipo Integer / Id do Status da parcela "amount": "242.92", Tipo Decimal / Valor "amount_charged": "50.00", Tipo Decimal / Valor cobrado após tarifas "expiry_date": "2022-03-31", Tipo Date "created_at": "2022-02-17 20:38:22", Tipo Date "updated_at": "2022-03-31 14:37:00", Tipo Date "additional_information": "G01-01", Tipo String / Informação adicional "installment": { Objeto "id": 216, Tipo Integer "transaction_id": 134, Tipo Integer / Id da transação "amount": "1000.00", Tipo Decimal / Valor "number": 1, Tipo Integer / Numero da parcela "situation_id": 2, Tipo Integer / Situação de pagamento da parcela "installment_status_id": 2, Tipo Integer / Id de status da parcela "expiry_date": "2022-02-09", Tipo Date / Data de vencimento da parcela "closing_date": "2022-03-30", Tipo Date / Data de fechamento da parcela "pay_date": "2022-03-30", Tipo Date / Data de pagamento da parcela "cancel_date": null, Tipo Date / Data de cancelamento da parcela "created_at": "2022-01-26 12:26:03", Tipo Date "updated_at": "2022-03-30 08:31:34", Tipo Date "net_amount": "980.54", Tipo Decimal / Valor liquido da parcela "split_amount": "0.00", Tipo Decimal / Valor de split "split_amount_percent": "0.00", Tipo Decimal / Porcentagem de split "conciliation_status_id": null, Tipo Integer / Id do Status de conciliação "expected_payment_date": null, Tipo Date / Data estimada de pagamento "commission": "0.00", Tipo Decimal / Valor da comissão "original_expected_payment_date": null, Tipo Date / Data original de pagamento "adq_anticipation_tax": "0.00", Tipo Decimal / Taxa de antecipação Adquirente "adq_mdr_tax": "0.00", Tipo Decimal / MDR do Adquirente "cerc_status_id": 1, Tipo Integer / Id do status na CERC "job_amount": null, Tipo Decimal "external_code": null, Tipo String / Código externo "proccess_date": null, Tipo String / Data de processamento "liquid_status_id": 1, Tipo Integer / Id do status de liquidação "pgs_code": null, Tipo String / Código pgs "transaction": { Objeto "id": 164, Tipo Integer "card_number": "000589916XXXXXX0487", Tipo String / Numero do cartão "originator": "ADIQ", Tipo String / Originador "authorization": "007078", Tipo String / Autorização "nsu": "75", Tipo String / Nsu transação "company_id": 9, Tipo Integer / Id do company do estabelecimento "acquirer_id": 1, Tipo Integer / Id do Adquirente "installments": 1, Tipo Integer / Quantidade de Parcelas "amount": "1000.00", Tipo Decimal / Valor "terminal_identification": "6N281051", Tipo String / Identificação do terminal "capture_method_id": 1, Tipo Integer / Metodo de captura "product_id": 1, Tipo Integer / Id do Produto "transaction_type_id": 2, Tipo Integer / Id do tipo de transação "integration_transaction_id": "75", Tipo Integer / Id da transação integrada "transaction_canceled_id": null, Tipo Integer / Id do cancelamento da transação "date": "2022-01-26 13:45:43", Tipo Date "created_at": "2022-01-26 12:26:03", Tipo Date "updated_at": "2022-01-26 12:26:03", Tipo Date "entry_mode_id": 2, Tipo Integer / Id do meio de entrada "integration_transaction_id_2": "75", Tipo Integer / Id da transação integrada "distributor_id": 1, Tipo Integer / Id do Distribuidor "preposterou_id": 1, Tipo Integer / Id do Preposto "last_import": null, / Ultima data que foi importado "attempt": 0, Tipo Integer / Tentativas "integration_status_id": 2, Tipo Integer // Id do status de integração "cerc_status_id": 2, Tipo Integer / Id do status na CERC "external_identificator": null, Tipo String / Indentificação externa "liquid_amount": null, Tipo Decimal / Valor liquido "return_tax": null, Tipo Decimal / Taxa de retorno "service_type_id": 2, Tipo Integer / Id do tipo de serviço "alias": null, Tipo String "additional_info": null, Tipo String / Informação adicional "proccess_date": null, Tipo Date / Data de processamento "identificator": null, Tipo String / identificador "pgs_code": null, Tipo String / Código pgs "received_edi": "N", Tipo String "company": { Objeto "id": 9, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "establishment": { Objeto "id": 1, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 9, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão }, "detail": null } } }, "split_situations": { Objeto "id": 2, Tipo Integer "description": "Paga", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "split_status": { Objeto "id": 2, Tipo Integer "description": "Fechada", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } }, ], "transfer_tariffs": [ { "id": 49, Tipo Integer "transfer_resume_id": 31, Tipo Integer / Id do repasse "tariff_type_id": 1, Tipo Integer / Id do tipo de tarifa "tariff_id": 3, Tipo Integer / Id da tarifa "amount_charged": "1.00", Tipo Decimal / Valor cobrado após tarifas "tariff_amount": "1.00", Tipo Decimal / Valor da tarifa "created_at": "2022-03-31 14:37:00", Tipo Date "updated_at": "2022-03-31 14:37:00", Tipo Date "description": "Transferência entre bancos", Tipo String / Descrição "tariff": { Objeto "id": 3, Tipo Integer "description": "Transferência entre bancos", Tipo String / Descrição "value": "0", Tipo Decimal / Valor "complement": null, Tipo String / Complemento "tariff_type_id": 1, Tipo Integer / Id do tipo da tarifa "frequency_id": 7, Tipo Integer / Id da frequencia em que a tarifa é aplicada "created_at": null, Tipo Date "updated_at": "2021-10-04 08:26:02", Tipo Date "franchise_qtd": 0, Tipo Decimal / Qtd Franquia "franchise_type_id": null, Tipo Integer / Id do Tipo de Franquia "franchise_rule_id": null, Tipo Integer / Id da Regra Frequência "installments": 1, Tipo Integer / Numero de parcelas que a tarifa se aplica "product_id": null, Tipo Integer / Id do Produto "discount_status": 2, Tipo Integer / Status do Desconto "ecommerce_value": "0.00", Tipo Decimal / Valor ecommerce "franchise_type": null, Tipo Integer "franchise_rule": null, Tipo Integer "frequency": {Objeto "id": 7, Tipo Integer "description": "Repasse", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, }, "tariff_types": { Objeto "id": 1, Tipo Integer "description": "R$", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ], }, "msg": [ "OK" ], "statusCode": 206 }
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

ATUALIZAR DADOS BANCARIOS DO REPASSE ID
/transfer_resume/refresh/{id}

Detalhes

Ao realizar a chamada, a API irá apresentar um determinado Repasse, filtrado pelo ID.
Para atualizar os dados baancarios do repasse é necessario ativar a conta bancaria que deseja do estabelecimento, e informe o id do repasse que ira ter os dados bancarios alterados.
Só é possivel alterar os dados bancarios se o status do repasse forem (1 - Aguardando pagamento; 8 - Erro no processamento; 9 - Erro no pagamento)

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
200	{ "data": null, "msg": [ "Dado bancário atualizado" ], "statusCode": 200 }
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.

Filtros

Caso não queira filtrar por algum dos campos abaixo, apenas apague a linha do campo dentro do objeto filters.

Repasses com valores zerados ? (0 - Não, 1 - Sim) - filters[total.all]
ID do Repasse - filters[nsu] / Tipo de Dado: Integer
Status - filters[status] / Tipo de Dado: Integer
Valor Repasse - filters[total] / Tipo de Dado: Decimal
Documento - filters[document] / Tipo de Dado: String
Valor Original - filters[amount] / Tipo de Dado: Decimal
Valor Calculado - filters[new_amount] / Tipo de Dado: Decimal
Diferença Débito - filters[debit] / Tipo de Dado: Decimal
Diferença Crédito - filters[credit]/ Tipo de Dado: Decimal

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "nsu": "null", "status": "null", "document": "null", "amount": "null", "new_amount": "null", "debit": "null", / Valor de debito "credit": "null", / Valor de credito "total": "null" } }

Retornos

Código	Mensagem
200	{ "data": [ { "id":1, Tipo Integer "transfer_resume_id":31, Tipo Integer / Id do Repasse "amount":"1.00", Tipo Decimal / Valor "new_amount":"1.00", Tipo Decimal / Valor alterado "debit":"1.00", Tipo Decimal / Debito "credit":"1.00", Tipo Decimal / Credito "status_id":2, Tipo Integer / Id de status do repasse invalido "created_at":null, Tipo Date "updated_at":"2022-06-10 08:57:45", Tipo Date "transfer":{ "id":31, Tipo Integer "establishment_id": 21, Tipo Integer / Id do Estabelecimento "bank_given_id": 68, Tipo Integer / Id da Conta Bancaria "status_id": 4, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "tariff_tax": "2.23", Tipo Decimal / do valor da Tarifa "cancelation_tax": "0.00", Tipo Decimal / Taxa de cancelamento "chargeback_tax": "0.00", Tipo Decimal / Taxa de chargeback "transaction_tax": "0.00", Tipo Decimal / Taxa de transação "additional_tax": "0.00", Tipo Decimal / Taxa Adicional "payment_tax": "0.00", Tipo Decimal / Taxa de Pagamento "anticipation_tax": "0.00", Tipo Decimal / Taxa de Antecipação "installments": "0.00", Tipo Decimal / Quantidade de Parcelas "credit_granted": "0.00", Tipo Decimal / Subtotal "balance": "0.00", Tipo Decimal / Saldo "debit": "2.23", Tipo Decimal / Valor de debito "credit": "0.00", Tipo Decimal / Valor de credito "total": "-2.23", Tipo Decimal / Valor total "date": "2022-06-13", Tipo Date / Data "created_at": "2022-06-13 08:51:28", Tipo Date "updated_at": "2022-06-13 08:51:28", Tipo Date "split_credit": "0.00", Tipo Decimal / Valor de Credito do split "split_debit": "0.00", Tipo Decimal / Valor de debito de split "external_code": null, Tipo String / Código externo "partial_credit": "0.00", Tipo Decimal / Credito Parcial "partial_debit": "2.23", Tipo Decimal / Debito Parcial "refunds": "0.00", Tipo Decimal / Reembolso "payment_date": "2022-06-13", Tipo Date / Data de Pagamento "antecipated_credit": "0.00", Tipo Decimal / Credito Antecipado "raw_credit": "0.00", Tipo Decimal "mdr_credit": "0.00", Tipo Decimal / Credito MDR "commission_ec": null, "establishment":{ "id":2, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2021-09-29 13:10:33", Tipo Date / Data de ativação "company_id": 13, Tipo Integer / Id do company do estabelecimento "mcc_id": 3, Tipo Integer / Id do MCC "establishment_situation_id": 6, Tipo Integer / Situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 1, Tipo Integer / Status de OFAC "integration_status_id": 1, Tipo Integer / Status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2021-09-29 12:34:36", Tipo Date "updated_at": "2022-04-07 07:27:16", Tipo Date "payment_status_id": 1, Tipo Integer / Status de pagamento "external_unique_identification": "-2", Tipo String / Indentificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "1", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Id refente ao tipo de split "status_anticipation": 1, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data de criação da CERC "payment_link_status_id": 1, Tipo Integer / Status do link de pagamento "has_delivery_address": 2, Tipo Integer / Status do endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de antecipação automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data de contrato "commission_activation": 1, Tipo Integer / Status de comissão } }, "status":{ "id":2, Tipo Integer "description":"Encerrado", Tipo String / Descrição "created_at":null, Tipo Date "updated_at":null Tipo Date } } ], "paginator":{ "current_page":1, Tipo Integer "prev_page":1, Tipo Integer "next_page":1, Tipo Integer "first_page":1, Tipo Integer "is_first_page":true, Tipo Boolean "last_page":1, Tipo Integer "is_last_page":true, Tipo Boolean "page_keys":[1], "from_item":1, Tipo Integer "to_item":1, Tipo Integer "total_items":1, Tipo Integer "amount":null, Tipo Decimal "value":null, Tipo Decimal "efective":0, Tipo Decimal "balance":0, Tipo Decimal "low":0, Tipo Decimal "manual":0, Tipo Decimal "per_page":10, Tipo Integer "display_items":1 Tipo Integer } }
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.

Tipo de Dado
ID do Repasse: Integer

Parâmetros

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

Retornos

Código	Mensagem
200	{ "data": null, "msg": [ "ok" ], "statusCode": 200 }
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.

Tipo de Dado
ID do Repasse: Integer

Parâmetros

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

Retornos

Código	Mensagem
200	{ "data": null, "msg": [ "ok" ], "statusCode": 200 }
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	{ "data":{ "data":[ { "id": 5, Tipo Integer "description": "Recarga de Celular", Tipo String / Descrição "activate": 2, Tipo Integer / Id do status de ativação "created_at": null, Tipo Date "updated_at": "2021-12-14 08:27:55" Tipo Date } ] "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 1, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo Boolean "last_page": 1, Tipo Integer "is_last_page": true, Tipo Boolean "page_keys": [ 1 ], "from_item": 1, Tipo Integer "to_item": 5, Tipo Integer "total_items": 5, Tipo Integer "amount": null, Tipo Decimal / Valor "value": null, Tipo Decimal "efective": 0, Tipo Decimal "balance": 0, Tipo Decimal "low": 0, Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 5 Tipo Integer } }, "msg": [ "OK" ], "statusCode": 200 }
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" : "Descrição" }

Retornos

Código	Mensagem
200	{ "data": { "id": 1, Tipo Integer "description": "Transação", Tipo String / Descrição "activate": 1, Tipo Integer / Id do status de ativação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "msg": [ "OK" ], "statusCode": 206 }
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	{ "data": { "id": 1, Tipo Integer "description": "Transação", Tipo String / Descrição "activate": 1, Tipo Integer / Id do status de ativação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "msg": [ "OK" ], "statusCode": 206 }
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Sistema

GET

meio_entrada
/entry_modes

Detalhes

Ao chamar a API realiza a meio_entrada dos meios de entradas

Retornos

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

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

DELETE

meio de entrada
/entry_modes/{id}

Detalhes

Ao chamar a API realiza a deletar 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

GET

Perfil
/profiles

Detalhes

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

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!

Filtros

Caso não queira filtrar por algum dos campos abaixo, apenas apague a linha do campo dentro do objeto filters.

Nome fantasia - filters[commercial_name] / Tipo de dado: String
Documento - filters[document] / Tipo de dado: Integer
Status - filters[companies.people_type_id] / Tipo de dado: Integer

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "document": "null", "commercial_name": / Nome Comercial"null", "companies.people_type_id": "null", } }

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.

Tipo de Dado
ID: Integer

Parâmetros

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

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

GET

LISTAGEM DE TIPO DE SPLIT
combo/split_type

Detalhes

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

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
200	{ "data": [ { "id": 1, Tipo Integer "type": "Origem" Tipo String / Tipo do split }, { "id": 2, Tipo Integer "type": "Destino" Tipo String / Tipo do split } ], "msg": [ "OK" ], "statusCode": 200 }
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.

Tipo de Dado
ID: Integer

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.

Tipo de Dado
ID: Integer

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.

Tipo de Dado
ID: Integer

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 )

Tipo de Dado
ID: Integer
document: String
people_type_id: Integer
value: Integer

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	VALUE, PEOPLE_TYPE_ID, DOCUMENT
Body	{ "document" : "null", "people_type_id" : "null", "value" : "null", "services" : "[Id do tipo de serviço]" }

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

Status

GET

LISTAGEM DE STATUS
/combo/status

Detalhes

Aqui, poderemos basicamente visualizar todos os tipos de status.

Parâmetros

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

Retornos

Código	Mensagem
200	{ "data": Array [ { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date }, { "id": 2, Tipo Integer "description": "Inativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date } ], "msg": [ "OK" ], "statusCode": 200, Tipo Integer }
400	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM DE STATUS DE PARCELAS
/combo/installment_status

Detalhes

Aqui, poderemos basicamente visualizar todos os tipos de status das parcelas.

Parâmetros

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

Retornos

Código	Mensagem
200	{ "data": Array [ { "id": 1, Tipo Integer "description": "Aberta", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date }, { "id": 2, Tipo Integer "description": "Fechada", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date } { "id": 3, Tipo Integer "description": "Processado Parcialmente", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date } { "id": 4, Tipo Integer "description": "Pago Parcialmente", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date } ], "msg": [ "OK" ], "statusCode": 200, Tipo Integer }
400	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM DE STATUS DE SITUAÇÃO DAS PARCELAS
/combo/installment_situations

Detalhes

Aqui, poderemos basicamente visualizar todos os tipos de status das parcelas.

Parâmetros

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

Retornos

Código	Mensagem
200	"data": [ { "id": 1, Tipo Integer "description": "Aberta", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, { "id": 2, Tipo Integer "description": "Paga", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, { "id": 3, Tipo Integer "description": "Paga antecipada", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, { "id": 4, Tipo Integer "description": "Cancelada aberta", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, { "id": 5, Tipo Integer "description": "Cancelada paga", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, { "id": 6, Tipo Integer "description": "Chargeback aberta", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, { "id": 7, Tipo Integer "description": "Chargeback paga", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, { "id": 8, Tipo Integer "description": "Prorrogada Baixo Valor", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, { "id": 9, Tipo Integer "description": "Prorrogada Dados Incorretos", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, { "id": 10, Tipo Integer "description": "Prorrogada DOC", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, { "id": 11, Tipo Integer "description": "Duplicada", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, { "id": 12, Tipo Integer "description": "Cancelada", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, { "id": 13, Tipo Integer "description": "Aberta antecipada", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, { "id": 14, Tipo Integer "description": "Aberta antecipada automaticamente", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, { "id": 15, Tipo Integer "description": "Em Pagamento", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } ], "msg": [ "OK" ], "statusCode": 200 }
400	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM DE STATUS DE REPASSES
/combo/transfer_status

Detalhes

Aqui, poderemos basicamente visualizar todos os tipos de status das repasses.

Parâmetros

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

Retornos

Código	Mensagem
200	{ "data": Array [ { "id": 1, Tipo Integer "description": "Aguardando pagamento", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date }, { "id": 2, Tipo Integer "description": "Enviado ao banco", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date } { "id": 4, Tipo Integer "description": "Pagamento efetuado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date } { "id": 5, Tipo Integer "description": "Pagamento manual efetuado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date } { "id": 6, Tipo Integer "description": "Prorrogado baixo valor", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date }, { "id": 7, Tipo Integer "description": "Processado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date } { "id": 8, Tipo Integer "description": "Erro no processamento", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date } { "id": 9, Tipo Integer "description": "Erro no pagamento", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date } { "id": 10, Tipo Integer "description": "Suspenso", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date }, { "id": 11, Tipo Integer "description": "Processado Parcialmente", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date } { "id": 12, Tipo Integer "description": "Pago Parcialmente", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date } { "id": 13, Tipo Integer "description": "Prorrogado manualmente", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date } { "id": 15, Tipo Integer "description": "Pagamento de Saldo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date } { "id": 16, Tipo Integer "description": "Estorno", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo Date } ], "msg": [ "OK" ], "statusCode": 200, Tipo Integer }
400	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM DE STATUS CERC
/combo/cerc_status

Detalhes

Aqui, poderemos basicamente visualizar todos os tipos de status da cerc.

Parâmetros

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

Retornos

Código	Mensagem
200	{ "data": [ { "id": 1, Tipo Integer "description": "Aceito", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, { "id": 2, Tipo Integer "description": "Recusado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, { "id": 3, Tipo Integer "description": "Pendente", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } ], "msg": [ "OK" ], "statusCode": 200 }
400	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAGEM DE STATUS DE INTEGRAÇÃO DO ESTABELECIMENTO
/combo/integration_status

Detalhes

Aqui, poderemos basicamente visualizar todos os tipos de status da cerc.

Parâmetros

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

Retornos

Código	Mensagem
200	{ "data": [ { "id": 1, Tipo Integer "description": "Integrado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, { "id": 2, Tipo Integer "description": "Não Integrado", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, ], "msg": [ "OK" ], "statusCode": 200 }
400	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Sub Adquirente

GET

LISTAGEM
/sub_acquirers

Detalhes

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

Filtros

Caso não utilize algum filtro abaixo, apenas retire o campo da requisição.

Nome fantasia - filters[commercial_name] Tipo de dado String
Documento - filters[companies.company_details.document] Tipo de dado Inteiro
Status - filters[status_id] Tipo de dado Inteiro

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "commercial_name": "null", "companies.company_details.document": "null", "status_id": "null" } }

Retornos

Código	Mensagem
200	"data":{ "data":[ { "id": 1, TIpo Integer "code_facilitator_elo": "2", Tipo Integer / Codigo Facilitador elo "commercial_name": "Camila e Larissa Esportes Ltda", Tipo String / Nome comercial "company_id": 1, Tipo Integer /Id do company do Sub adquirente "created_at": "2021-09-29 12:01:19", Tipo Date "updated_at": "2022-04-10 17:50:27", Tipo Date "link_ec": "http://dev.slg-web-ec/", Tipo String / Url do portal estabelecimento "link_pd": "http://dev.slg-web-pd/", Tipo String / Url do portal distribuidor "single_connection_key": null, Tipo String / chave unica de conexão "access_key": null, Tipo String / Chave de acesso "basic_auth": null, Tipo String / Chave basica de Autenificação "company": { "id": 1, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "localization": { "id": 45, Tipo Integer "company_id": 45, Tipo Integer / Id do company do sub adquirente "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "contact": [ { "id": 240, Tipo Integer "company_id": 3, Tipo Integer / Id do company do sub adquirente "contact_type_id": 1, Tipo Integer / Id do tipo de contato "name": "jacqueline", Tipo String / Nome "value": "11988808096", Tipo String / Telefone ou Email "created_at": "2022-06-13 09:16:38", Tipo Date "updated_at": "2022-06-13 09:16:38", Tipo Date "contact_type": { "id": 1, Tipo Integer "description": "Celular", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ], "detail": { "id": 31, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 1, Tipo Integer / Id do company do sub adquirente "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date "branch_type": { "id": 1, Tipo Integer "description": "Matriz", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "bank_given": { "id": 46, Tipo Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do sub adquirente "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer "account_type": { Objeto "id": 1, Tipo Integer "value": "Conta Corrente", Tipo String / Descrição do tipo da conta "created_at": null, Tipo Date "updated_at": null, Tipo Date "code": "CC" Tipo String / Código }, "holder_type": { Objeto "id": 2, Tipo Integer "value": "Pessoa Jurídica - Empresa", Tipo String / Descrição do tipo de documento representante "abbreviation": "PJE", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank": { Objeto "id": 340, Tipo Integer "code": "X1X", Tipo String / Código do banco "name": "CONTA INTERNA", Tipo String / Nome do banco "ispb": "00000000", Tipo String / Ispb do banco "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:07", Tipo Date "ispb_code": null Tipo String / Código ispb }, "holder": null }, "prepaid_card": null, "bank_given_type": { "id": 1, Tipo Integer "value": "Conta Bancária", Tipo String / Descrição do tipo da conta "abbreviation": "CB", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null, Tipo Date "status_id": 1 / Id do Status (1 - Ativo, 2 - Inativo) }, "people_type": { "id": 2, Tipo Integer "name": "Pessoa Jurídica", Tipo String / Nome "abbreviation": "PJ", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } }, ] }
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.

Se o titular da conta for ‘Terceira Pessoa Física’ (holder_type_id = “3”), os dados para ser preenchido são: name, document (bank_given_holder).

Se o titular da conta for ‘Terceira Pessoa Jurídica’ (holder_type_id = “4”), os dados para ser preenchido são: name e document (bank_given_holder).

Tipo de Dado
code_facilitator_elo: String DZ link_ec: Integer
link_pd: Integer
commercial_name: String
company: Array
last_name: String
rg: String
document: String
company_details: Array
social_reason: String
localization: Array
address: String
number: String
district: String
city: String
state_id: Integer
countrie_id: Integer
complement: String
contacts: Array
contact_type_id: Integer
name: String
value: String
bank_given: Array
bank_account_type_id: Integer
holder_type_id: Integer
bank_id: Integer
agency: String
digit_agency: String
account: String
digit_account: String
bank_given_holder: Array
name: String
document: String

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" : "Codigo Facilitador ELO", "link_ec" : "Url do portal do estabelecimento", "link_pd" : "Url do portal do distribuidor", "commercial_name" : "Nome comercial", "company" : { "name": "Nome", "last_name":"Ultimo nome", "rg":"RG", "nationality":"Nacionalidade", "telephone":"Telefone", "email":"E-mail", "birth":"Data de nascimento", "document":"Documento", "bank_given_type_id": "Tipo de conta bancaria", "people_type_id": "Tipo pessoa, fisica ou jiridica", "company_details": { "social_reason": "Razão social", "document": "documento", "cnpj_matriz":"CNPJ da matriz", "branch_type_id": "Id do tipo da empresa (1 - Matriz, 2 - Filial)" } }, "localization" : { "cep": "CEP", "address": "Rua", "number": "Numero", "district": "Distrito", "city": "Cidade", "state_id": "Id do Estado", "countrie_id": "Id do Pais", "complement": "Complemento" }, "contacts" : [{ "contact_type_id": "Id do tipo de contato", "name": "nome", "value": "O contato em si (Numero de telefone ou e-mail de acordo com o tipo selecionado)" }], "bank_given" : { "holder_type_id": "Id do tipo de documento", "bank_account_type_id": "Id do tipo de conta bancaria", "bank_id": "Id do banco", "agency": "Agencia", "account": "Conta", "digit_agency": "digito da agencia", "digit_account": "digito da conta", "countrie_id": "Id do Pais", "complement": "Complemento" } , "bank_given_holder" : { "name": "Nome", "document": "Documento" } }

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 Campo bank_given_holder.document é obrigatório Campo bank_given_holder.document é Inválido Campo bank_given_holder.name é obrigatório O Tamanho Máximo para o campo bank_given_holder.name é de 255 caracteres 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.

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
206	" { "data": { "id": 1, Tipo Integer "code_facilitator_elo": "2", Tipo String / Código Facilitador ELO "commercial_name": "Camila e Larissa Esportes Ltda", Tipo String / Nome comercial "company_id": 1, Tipo Integer / Id do company do sub adquirente "created_at": "2021-09-29 12:01:19", Tipo Date "updated_at": "2022-04-10 17:50:27", Tipo Date "link_ec": "http://dev.slg-web-ec/", Tipo String / Url do portal do estabelecimento "link_pd": "http://dev.slg-web-pd/", Tipo String / Url do portal do distribuidor "single_connection_key": null, Tipo String / Chave de conexão "access_key": null, Tipo String / Chave de acesso "basic_auth": null, Tipo String / Autenificação basica "company": { "id": 1, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "localization": { "id": 45, Tipo Integer "company_id": 45, Tipo Integer / Id do company do sub adquirente "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "contact": [ { "id": 240, Tipo Integer "company_id": 3, Tipo Integer / Id do company do sub adquirente "contact_type_id": 1, Tipo Integer / Id do tipo de contato "name": "jacqueline", Tipo String / Nome "value": "11988808096", Tipo String / Telefone ou Email "created_at": "2022-06-13 09:16:38", Tipo Date "updated_at": "2022-06-13 09:16:38", Tipo Date "contact_type": { "id": 1, Tipo Integer "description": "Celular", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } ], "detail": { "id": 31, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 1, Tipo Integer / Id do company do sub adquirente "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date "branch_type": { "id": 1, Tipo Integer "description": "Matriz", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "bank_given": { "id": 46, Tipo Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do sub adquirente "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer "account_type": { Objeto "id": 1, Tipo Integer "value": "Conta Corrente", Tipo String / Descrição do tipo da conta "created_at": null, Tipo Date "updated_at": null, Tipo Date "code": "CC" Tipo String / Código }, "holder_type": { Objeto "id": 2, Tipo Integer "value": "Pessoa Jurídica - Empresa", Tipo String / Descrição do tipo de documento representante "abbreviation": "PJE", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank": { Objeto "id": 340, Tipo Integer "code": "X1X", Tipo String / Código do banco "name": "CONTA INTERNA", Tipo String / Nome do banco "ispb": "00000000", Tipo String / Ispb do banco "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:07", Tipo Date "ispb_code": null Tipo String / Código ispb }, "holder": null }, "prepaid_card": null, "bank_given_type": { "id": 1, Tipo Integer "value": "Conta Bancária", Tipo String / Descrição do tipo da conta "abbreviation": "CB", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null, Tipo Date "status_id": 1 / Id do Status (1 - Ativo, 2 - Inativo) }, "people_type": { "id": 2, Tipo Integer "name": "Pessoa Jurídica", Tipo String / Nome "abbreviation": "PJ", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "status": { "id": 1, Tipo Integer "description": "Ativo", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } } }, }
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ATUALIZAÇÃO
/sub_acquirers/{id}

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.

Se o titular da conta for ‘Terceira Pessoa Física’ (holder_type_id = “3”), os dados para ser preenchido são: name, document (bank_given_holder).

Se o titular da conta for ‘Terceira Pessoa Jurídica’ (holder_type_id = “4”), os dados para ser preenchido são: name e document (bank_given_holder).

Tipo de Dado
code_facilitator_elo: String
link_ec: Integer
link_pd: Integer
commercial_name: String
company: Array
last_name: String
rg: String
document: String
company_details: Array
social_reason: String
localization: Array
address: String
number: String
district: String
city: String
state_id: Integer
countrie_id: Integer
complement: String
contacts: Array
contact_type_id: Integer
name: String
value: String
bank_given: Array
bank_account_type_id: Integer
holder_type_id: Integer
bank_id: Integer
agency: String
digit_agency: String
account: String
digit_account: String
bank_given_holder: Array
name: String
document: String

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" : "Codigo Facilitador ELO", "link_ec" : "Url do portal estabelecimento", "commercial_name" : "Nome comercial Atualizado", "company" : { "name": "Nome", "last_name":"Ultimo nome", "rg":"RG", "nationality":"Nacionalidade", "telephone":"Telefone", "email":"E-mail", "birth":"Data de nascimento", "document":"Documento", "bank_given_type_id": "Tipo de conta bancaria", "people_type_id": "Tipo pessoa, fisica ou jiridica", "company_details": { "social_reason": "Razão social", "document": "documento", "cnpj_matriz":"CNPJ da matriz", "branch_type_id": "Id do tipo da empresa (1 - Matriz, 2 - Filial)" } }, "localization" : { "cep": "CEP", "address": "Rua", "number": "Numero", "district": "Distrito", "city": "Cidade", "state_id": "Id do Estado", "countrie_id": "Id do Pais", "complement": "Complemento" }, "contacts" : [{ "contact_type_id": "Id do tipo de contato", "name": "nome", "value": "O contato em si (Numero de telefone ou e-mail de acordo com o tipo selecionado)" }], "bank_given" : { "holder_type_id": "Id do tipo de documento", "bank_account_type_id": "Id do tipo de conta bancaria", "bank_id": "Id do banco", "agency": "Agencia", "account": "Conta", "digit_agency": "digito da agencia", "digit_account": "digito da conta", "countrie_id": "Id do Pais", "complement": "Complemento" } , "bank_given_holder" : { "name": "Nome", "document": "Documento" } }

Retornos

Código	Mensagem
200	{ "data": { "id": 1, "code_facilitator_elo": "2", Tipo String / Código Facilitador ELO "commercial_name": "Camila e Larissa Esportes Ltda", Tipo String / Nome comercial "company_id": 1, Tipo Integer / Id do company do sub adquirente "created_at": "2021-09-29 12:01:19", Tipo Date "updated_at": "2022-04-10 17:50:27", Tipo Date "link_ec": "http://dev.slg-web-ec/", Tipo String / Url do portal do estabelecimento "link_pd": "http://dev.slg-web-pd/", Tipo String / Url do portal do distribuidor "single_connection_key": null, Tipo String / Chave de conexão "access_key": null, Tipo String / Chave de acesso "basic_auth": null, Tipo String / Autenificação basica "company": { "id": 1, "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { "id": 31, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 1, Tipo Integer / Id do company do sub adquirente "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date "branch_type": { "id": 1, Tipo Integer "description": "Matriz", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, } }, "msg": [ "OK" ], "statusCode": 200 }
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 Campo bank_given_holder.document é obrigatório Campo bank_given_holder.document é Inválido Campo bank_given_holder.name é obrigatório O Tamanho Máximo para o campo bank_given_holder.name é de 255 caracteres 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.

Tipo de Dado
ID: Integer

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

Ao realizar a chamada, teremos uma resposta da API retornando 10 últimos registros de tarifas adicionais 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/additional_tariffs?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

Caso não queira filtrar por algum dos campos abaixo, apenas apague a linha do campo dentro do objeto filters.

Nome Fantasia - filters[commercial_name] / Tipo de Dado: String
Documento - filters[document] / Tipo de Dado: String
Tipo de Pessoa - filters[companies.people_type_id] / Tipo de Dado: Integer

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : { "document": "null", "commercial_name": / Nome Comercial"null", "companies.people_type_id": "null", } }

Retornos

Código	Mensagem
200	EXEMPLO: "data":{ Objeto "data": [ Array { "id": 17, "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { "id": 45, Tipo Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { "id": 31, Tipo Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date } } }, ], "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 1, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo Boolean "last_page": 1, Tipo Integer "is_last_page": true, Tipo Boolean "page_keys": [ 1 ], "from_item": 1, Tipo Integer "to_item": 9, Tipo Integer "total_items": 9, Tipo Integer "amount": null, Tipo Decimal / Valor "value": null, Tipo Decimal "efective": 0, Tipo Decimal "balance": 0, Tipo Decimal "low": 0, Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 9, Tipo Integer } }
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. É necessário lembrar que o ID precisa corresponder a um estabelecimento cadastrado.

Tipo de Dado
ID: Integer, do id do estabelecimento

Parâmetros

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

Retornos

Código	Mensagem
200	EXEMPLO: { "data": { "id": 1, Tipo integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { "id": 9, Tipo integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade }, "additional_tariffs": [ { "id": 3, Tipo integer "expiry_date": "2022-06-01", Tipo Date "description": "aaa", Tipo String / Descrição "value": "1.00",Tipo Decimal / Valor "tariff_id": 6, Tipo integer / Id da tarifa "establishment_id": 1, Tipo integer / Id do Estabelecimento "payment_status_id": 1, Tipo integer "created_at": "2022-05-31 15:02:39", Tipo Date "updated_at": "2022-05-31 15:02:39", Tipo String "moneylender_solicitation_id": null, Tipo integer / Id da solicitação de GIRO "user_id": null, Tipo integer / Id do Usuario "pay_status": { "id": 1, Tipo integer "description": "Não Pago", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null, Tipo String }, "tariff": { "id": 6, Tipo integer "description": "Transferência entre bancos", Tipo String / Descrição "value": "0", Tipo Decimal / Valor "complement": null, Tipo String / Complemento "tariff_type_id": 1, Tipo Integer / Id do tipo da tarifa "frequency_id": 7, Tipo Integer / Id da frequencia em que a tarifa é aplicada "created_at": null, Tipo Date "updated_at": "2021-10-04 08:26:02", Tipo Date "franchise_qtd": 0, Tipo Decimal / Qtd Franquia "franchise_type_id": null, Tipo Integer / Id do Tipo de Franquia "franchise_rule_id": null, Tipo Integer / Id da Regra Frequência "installments": 1, Tipo Integer / Numero de parcelas que a tarifa se aplica "product_id": null, Tipo Integer / Id do Produto "discount_status": 2, Tipo Integer / Status do Desconto "ecommerce_value": "0.00", Tipo Decimal / Valor ecommerce "franchise_type": null, Tipo Integer "franchise_rule": null, Tipo Integer "tariff_type": { "id": 1, Tipo integer "description": "R$", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo String } } } ] }, "tariff": { "data": [ { "id": 3, Tipo integer "expiry_date": "2022-06-01", Tipo Date "description": "aaa", Tipo String / Descrição "value": "1.00",Tipo Decimal / Valor "tariff_id": 6, Tipo integer / Id da tarifa "establishment_id": 1, Tipo integer / Id do Estabelecimento "payment_status_id": 1, Tipo integer "created_at": "2022-05-31 15:02:39", Tipo Date "updated_at": "2022-05-31 15:02:39", Tipo String "moneylender_solicitation_id": null, Tipo integer / Id da solicitação de GIRO "user_id": null, Tipo integer / Id do Usuario "tariff": { "id": 6, Tipo integer "description": "Transferência entre bancos", Tipo String / Descrição "value": "0", Tipo Decimal / Valor "complement": null, Tipo String / Complemento "tariff_type_id": 1, Tipo Integer / Id do tipo da tarifa "frequency_id": 7, Tipo Integer / Id da frequencia em que a tarifa é aplicada "created_at": null, Tipo Date "updated_at": "2021-10-04 08:26:02", Tipo Date "franchise_qtd": 0, Tipo Decimal / Qtd Franquia "franchise_type_id": null, Tipo Integer / Id do Tipo de Franquia "franchise_rule_id": null, Tipo Integer / Id da Regra Frequência "installments": 1, Tipo Integer / Numero de parcelas que a tarifa se aplica "product_id": null, Tipo Integer / Id do Produto "discount_status": 2, Tipo Integer / Status do Desconto "ecommerce_value": "0.00", Tipo Decimal / Valor ecommerce "franchise_type": null, Tipo Integer "franchise_rule": null, Tipo Integer }, "pay_status": { "id": 1, Tipo integer "description": "Não Pago", Tipo String/ Descrição "created_at": null, Tipo Date "updated_at": null Tipo String } } ], "paginator": { "current_page": 1, Tipo Integer "prev_page": 1, Tipo Integer "next_page": 1, Tipo Integer "first_page": 1, Tipo Integer "is_first_page": true, Tipo String "last_page": 1, Tipo Integer "is_last_page": true, Tipo String "page_keys": [ 1 ], "from_item": 1, Tipo Integer "to_item": 1, Tipo Integer "total_items": 1, Tipo Integer "amount": null, Tipo Decimal / Valor "value": null, Tipo Decimal "efective": 0, Tipo Decimal "balance": 0, Tipo Decimal "low": 0, Tipo Decimal "manual": 0, Tipo Decimal "per_page": 10, Tipo Integer "display_items": 1 Tipo Integer } }, "msg": [ "OK" ], "statusCode": 200 Tipo Integer }
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.

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
200	EXEMPLO: { "data": null, "msg": [ "OK" ], "statusCode": 200 }
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.

Tipo de Dado
ID: Integer
value: Decimal
description: String
tariff_id: Integer
expiry_date: Date

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	VALUE, DESCRIPTION, EXPIRY_DATE, TARIFF_ID
Body	{ "value" : "Valor", "description" : "Descrição", "tariff_id" : "Id da tarifa", "expiry_date" : "Data de vencimento" }

Retornos

Código	Mensagem
200	EXEMPLO: { "data": null, "msg": [ "OK" ], "statusCode": 200 }
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.

Filtros

Caso não queira filtrar por algum dos campos abaixo, apenas apague a linha do campo dentro do objeto filters.

Nome fantasia - filters[commercial_name] / Tipo de dado: String
Documento - filters[document] / Tipo de dado: String
Tipo de Pessoa - filters[companies.people_type_id] / Tipo de dado: Integer

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Body	{ "filters" : {"commercial_name": "null", "document": "null", "companies.people_type_id": "null" } }

Retornos

Código	Mensagem
200	EXEMPLO: { "data":{Objeto "data"[ Array { "id": 17, Tipo de dado Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão "company": { Objeto "id": 45, Tipo de dado Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "detail": { Objeto "id": 31, Tipo de dado Integer "social_reason": "Exemplo", Tipo String / Razão Social "document": "52764966000107", Tipo String / Documento "cnpj_matriz": null, Tipo String / CNPJ MATRIZ "company_id": 51, Tipo Integer / Id do company do estabelecimento "branch_type_id": 1, Tipo Integer / (1 - Matriz, 2 - Filial) "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:38:50" Tipo Date } } } ] } }
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAR TARIFAS POR BANDEIRA 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. É necessário lembrar que o ID precisa corresponder a um estabelecimento cadastrado.

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
200	EXEMPLO: { "establishment": {Objeto "id": 1, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 9, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão }, "data":{ Objeto "data":[ Array { "id": 256, Tipo de dado Integer "description": "Transação Aprovada", Tipo de dado String / Descrição "value": "9.99", Tipo de dado Decimal "complement": null, Tipo de dado String "tariff_type_id": 1, Tipo de dado Integer "frequency_id": 9, Tipo de dado Integer "created_at": "2021-09-29 11:47:36", Tipo de dado Date "updated_at": "2021-12-14 07:26:02", Tipo de dado Date "franchise_qtd": 0, Tipo Decimal / Qtd Franquia "franchise_type_id": null, Tipo Integer / Id do Tipo de Franquia "franchise_rule_id": null, Tipo Integer / Id da Regra Frequência "installments": 1, Tipo Integer / Quantidade de Parcelas "product_id": 1, Tipo Integer / Id do Produto "discount_status": 2, Tipo Integer / Status de Desconto "ecommerce_value": "1.55" Tipo Decimal / Valor Ecommerce "frequency": { Objeto "id": 9, Tipo de dado Integer "description": "Transação Aprovada", Tipo de dado String / Descrição "created_at": null, Tipo de dado Date "updated_at": null Tipo de dado Date }, "tariff_type": { Objeto "id": 1, Tipo de dado Integer "description": "R$", Tipo de dado String / Descrição "created_at": null, Tipo de dado Date "updated_at": null Tipo de dado Date }, "franchise_type": null, "franchise_rule": null, "product": { Objeto "id": 26, Tipo de dado Integer "brand_id": 2, Tipo Integer / Id da bandeira "payment_method_id": 1, Tipo Integer / Id do metodo de pagamento "created_at": null, Tipo Date "updated_at": "2021-09-29 11:47:33", Tipo Date "cip_product_id": 1, Tipo Integer / Id do produto cip "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "brand": { "id": 2, Tipo Integer "name": "Mastercard", Tipo String / Nome da bandeira "icons": "data:image/png;base64", Tipo String / Icone em base 64 "created_at": null, Tipo Date "updated_at": null Tipo Date }, "payment_method": { "id": 1, Tipo Integer "description": "Crédito rotativo", Tipo String / Descrição "max_installments": 1, Tipo Integer / Quantidade maxima de parcelas "min_installments": 1, Tipo Integer / Quantidade minima de parcelas "created_at": null, Tipo Date "updated_at": null, Tipo Date "rules": "default" Tipo String / Regra } }, "establishment_tariff": { Objeto "id": 72, Tipo de dado Integer "establishment_id": 1, Tipo de dado Integer / Id do Estabelecimento "tariff_id": 236, Tipo Integer / Id da tarifa "value": "1.38", Tipo Decimal / Valor "ecommerce_change": "0.00", Tipo Decimal / Valor ecommerce calculos tarifa "ecommerce_value": "0.00", Tipo Decimal / Valor ecommerce antes do comissionamento tarifa "created_at": "2021-10-04 11:41:07", Tipo Date "updated_at": "2021-10-07 09:22:54", Tipo Date "value_change": "10.00", Tipo Decimal / Valor padrão após calculos "type_change_id": 2, Tipo Integer / Id do tipo de aplicação da tarifa "type_change_ecommerce": null, Tipo Integer / Id do tipo de aplicação da tarifa ecommerce } }, ] } }
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAR TARIFAS POR BANDEIRA DO ESTABELECIMENTO
/establishment_tariffs/standard/{id}

Detalhes

Parâmetros

Body	{ "" : "" }

Retornos

Código	Mensagem
200	EXEMPLO: { "establishment": { "id": 21, Tipo Integer "commercial_name": "Exemplo", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão }, "data":{ "data":[ { "id": 2, "description": "Manutenção Mensal", Tipo String / Descrição "value": "0", Tipo Decimal / Valor "complement": null, Tipo String / Complemento "tariff_type_id": 1, Tipo Integer / Tipo da tarifa ( 1- R$, 2- %) "frequency_id": 2, Tipo Integer / Id da frequencia da tarifa "created_at": null, Tipo Date "updated_at": "2021-10-04 08:25:06", Tipo Date "franchise_qtd": 30, Tipo Decimal / Qtd Franquia "franchise_type_id": 1, Tipo Integer / Id do Tipo de Franquia "franchise_rule_id": 3, Tipo Integer / Id da Regra Frequência "installments": 1, Tipo Integer / Parcelas "product_id": null, Tipo Integer / Id do produto "discount_status": 2, Tipo Integer / Status de Desconto "ecommerce_value": "0.00", Tipo Decimal / Valor Ecommerce "frequency": { "id": 2, Tipo Integer "description": "Mensal", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "tariff_type": { "id": 1, Tipo Integer "description": "R$", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "franchise_type": { "id": 1, Tipo Integer "description": "Dia", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "franchise_rule": { "id": 3, Tipo Integer "description": "Após ativar estabelecimento", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "product": null, Tipo Integer / Id do produto (É retornado null) "establishment_tariff": null / Tarifa do estabelecimento (É retornado null) } ] } }
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.

Tipo de Dado
ID: Integer
type_change_id: Integer
tariff_id: Integer
value_change: Decimal
ecommerce_change: Decimal

Parâmetros

Required	REASON
Body	{ "type_change_id" : "Id do tipo de aplicação da tarifa", "tariff_id" : "Id da tarifa", "value_change" : "Valor padrão após calculos", "ecommerce_change" : "Valor ecommerce calculos tarifa" }

Retornos

Código	Mensagem
200	{ "data": null, "msg": [ "OK" ], "statusCode": 200 }
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.

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
200	{ "data": null, "msg": [ "OK" ], "statusCode": 200 }
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_tariffs

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==) }
Body	{ "" : "" }

Retornos

Código	Mensagem
200	EXEMPLO: { "data": { Objeto "data": [ Array { "id": 1, Tipo de dado Integer "name": "Teste SLG", Tipo de dado String / Nome do Grupo Econômico "code_pos": 1, Tipo de dado Integer / Código POS "code_menu": 2, Tipo de dado Integer / Código menu "created_at": "2021-09-29 12:15:07", Tipo de dado Date "updated_at": "2021-09-29 12:15:07" Tipo de dado Date } ], "paginator": { Objeto "current_page": 1, Tipo de dado Integer "prev_page": 1, Tipo de dado Integer "next_page": 1, Tipo de dado Integer "first_page": 1, Tipo de dado Integer "is_first_page": true, Tipo de dado Boolean "last_page": 1, Tipo de dado Integer "is_last_page": true, Tipo de dado Boolean "page_keys": [ Array 1 ], "from_item": 1, Tipo de dado Integer "to_item": 1, Tipo de dado Integer "total_items": 1, Tipo de dado Integer "amount": null, Tipo de dado Decimal / Valor "value": null, Tipo de dado Decimal "efective": 0, Tipo de dado Decimal "balance": 0, Tipo de dado Decimal "low": 0, Tipo de dado Decimal "manual": 0, Tipo de dado Decimal "per_page": 10, Tipo de dado Integer "display_items": 1 Tipo de dado Integer } }, "msg": [ "OK" ], "statusCode": 200 Tipo de dado Integer }
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAR TARIFAS DE GRUPO ECONOMICO
/economic_group_tariffs/{id}

Detalhes

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

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
200	EXEMPLO: { "economic_group": { Objeto "id": 1, Tipo de dado Integer "name": "Teste SLG", Tipo String / Nome do Grupo Econômico "code_pos": 1, Tipo String / Código POS "code_menu": 2, Tipo String / Código menu "created_at": "2021-09-29 12:15:07", Tipo Decimal "updated_at": "2021-09-29 12:15:07", Tipo Decimal }, "data":{ Objeto "data":[ Array { "id": 256, Tipo de dado Integer "description": "Transferência entre bancos", Tipo String / Descrição "value": "0", Tipo Decimal / Valor "complement": null, Tipo String / Complemento "tariff_type_id": 1, Tipo Integer / Id do tipo da tarifa "frequency_id": 7, Tipo Integer / Id da frequencia em que a tarifa é aplicada "created_at": null, Tipo Date "updated_at": "2021-10-04 08:26:02", Tipo Date "franchise_qtd": 0, Tipo Decimal / Qtd Franquia "franchise_type_id": null, Tipo Integer / Id do Tipo de Franquia "franchise_rule_id": null, Tipo Integer / Id da Regra Frequência "installments": 1, Tipo Integer / Numero de parcelas que a tarifa se aplica "product_id": null, Tipo Integer / Id do Produto "discount_status": 2, Tipo Integer / Status do Desconto "ecommerce_value": "0.00", Tipo Decimal / Valor ecommerce "frequency": { Objeto "id": 9, Tipo de dado Integer "description": "Transação Aprovada", Tipo de dado String / Descrição "created_at": null, Tipo de dado Date "updated_at": null Tipo de dado Date }, "tariff_type": { Objeto "id": 1, Tipo de dado Integer "description": "R$", Tipo de dado String / Descrição "created_at": null, Tipo de dado Date "updated_at": null Tipo de dado Date }, "franchise_type": null, Tipo de dado Integer "franchise_rule": null, Tipo de dado Integer "product": { Objeto "id": 26, Tipo de dado Integer "brand_id": 2, Tipo Integer / Id da bandeira "payment_method_id": 1, Tipo Integer / Id do metodo de pagamento "created_at": null, Tipo Date "updated_at": "2021-09-29 11:47:33", Tipo Date "cip_product_id": 1, Tipo Integer / Id do produto cip "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "brand": { "id": 2, Tipo Integer "name": "Mastercard", Tipo String / Nome da bandeira "icons": "data:image/png;base64", Tipo String / Icone em base 64 "created_at": null, Tipo Date "updated_at": null Tipo Date }, "payment_method": { "id": 1, Tipo Integer "description": "Crédito rotativo", Tipo String / Descrição "max_installments": 1, Tipo Integer / Quantidade maxima de parcelas "min_installments": 1, Tipo Integer / Quantidade minima de parcelas "created_at": null, Tipo Date "updated_at": null, Tipo Date "rules": "default" Tipo String / Regra } }, "economic_group_tariff": { Objeto "id": 76, Tipo de dado Integer "economic_group_id": 1, Tipo de dado Integer / Id do Grupo Econômico "tariff_id": 236, Tipo Integer / Id da tarifa "value": "1.38", Tipo Decimal / Valor "ecommerce_change": "0.00", Tipo Decimal / Valor ecommerce calculos tarifa "ecommerce_value": "0.00", Tipo Decimal / Valor ecommerce antes do comissionamento tarifa "created_at": "2021-10-04 11:41:07", Tipo Date "updated_at": "2021-10-07 09:22:54", Tipo Date "value_change": "10.00", Tipo Decimal / Valor padrão após calculos "type_change_id": 2, Tipo Integer / Id do tipo de aplicação da tarifa "type_change_ecommerce": null, Tipo Integer / Id do tipo de aplicação da tarifa ecommerce } }, ] } }
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

GET

LISTAR TARIFAS POR BANDEIRA DO GRUPO ECONOMICO
/economic_group_tariffs/standard/{id}

Detalhes

Parâmetros

Body	{ "" : "" }

Retornos

Código	Mensagem
200	EXEMPLO: { "economic_group": { "id": 1, Tipo Integer "name": "Teste SLG", Tipo String / Nome do Grupo Econômico "code_pos": 1, Tipo String / Código POS "code_menu": 2, Tipo String / Código menu "created_at": "2021-09-29 12:15:07", Tipo Decimal "updated_at": "2021-09-29 12:15:07", Tipo Decimal }, "data":{ "data":[ { "id": 2, "description": "Manutenção Mensal", Tipo String / Descrição "value": "0", Tipo Decimal / Valor "complement": null, Tipo String / Complemento "tariff_type_id": 1, Tipo Integer / Tipo da tarifa ( 1- R$, 2- %) "frequency_id": 2, Tipo Integer / Id da frequencia da tarifa "created_at": null, Tipo Date "updated_at": "2021-10-04 08:25:06", Tipo Date "franchise_qtd": 30, Tipo Decimal / Qtd Franquia "franchise_type_id": 1, Tipo Integer / Id do Tipo de Franquia "franchise_rule_id": 3, Tipo Integer / Id da Regra Frequência "installments": 1, Tipo Integer / Parcelas "product_id": null, Tipo Integer / Id do produto "discount_status": 2, Tipo Integer / Status de Desconto "ecommerce_value": "0.00", Tipo Decimal / Valor Ecommerce "frequency": { "id": 2, Tipo Integer "description": "Mensal", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "tariff_type": { "id": 1, Tipo Integer "description": "R$", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "franchise_type": { "id": 1, Tipo Integer "description": "Dia", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "franchise_rule": { "id": 3, Tipo Integer "description": "Após ativar estabelecimento", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date }, "product": null, Tipo Integer / Id do produto (É retornado null) "economic_group_tariff": null / Tarifa do grupo econômico (É retornado null) } ] } }
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

PUT

ADICIONAR / ATUALIZAR TARIFA GRUPO ECONOMICO
/economic_group_tariffs/{id}

Detalhes

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

Tipo de Dado
ID: Integer
type_change_id: Integer
tariff_id: Integer
value_change: Decimal
ecommerce_change: Decimal

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	REASON
Body	{ "type_change_id" : "Id do tipo de aplicação da tarifa", "tariff_id" : "Id da tarifa", "value_change" : "Valor padrão após calculos", "ecommerce_change" : "Valor ecommerce calculos tarifa" }

Retornos

Código	Mensagem
200	EXEMPLO: { "data": null, "msg": [ "Tarifa adicionada com sucesso" ], "statusCode": 200 }
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.

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
200	EXEMPLO: { "data": null, "msg": [ "OK" ], "statusCode": 200 }
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Tarifas

GET

LISTAGEM
/tariffs

Detalhes

Ao chamar a API realiza paginação da tarifa

Parâmetros

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

Retornos

Código	Mensagem
200	EXEMPLO: "data":{ Objeto "data":[ Array { "id": 256, Tipo de dado Integer "description": "Transação Aprovada", Tipo de dado String / Descrição "value": "9.99", Tipo de dado Decimal / Valor da tarifa "complement": null, Tipo de dado String / Complemento "tariff_type_id": 1, Tipo de dado Integer / Id do tipo de tarifa "frequency_id": 9, Tipo de dado Integer / Id de frequencia da tarifa "created_at": "2021-09-29 11:47:36", Tipo de dado Date "updated_at": "2021-12-14 07:26:02", Tipo de dado Date "franchise_qtd": 0, Tipo Decimal / Qtd Franquia "franchise_type_id": null, Tipo Integer / Id do Tipo de Franquia "franchise_rule_id": null, Tipo Integer / Id da Regra Frequência "installments": 1, Tipo de dado Integer / Quantidade de Parcelas "product_id": 1, Tipo Integer / Id do Produto "discount_status": 2, Tipo Integer / Status de Desconto "ecommerce_value": "0.00", Tipo Decimal / Valor ecommerce "qtd_estab_count": 1, Tipo de dado Integer / Quantidade contada de estabelecimentos "qtd_economic_group_count": 1, Tipo de dado Integer / Quantidade contada de tarifas "frequency": { Objeto "id": 9, Tipo de dado Integer "description": "Transação Aprovada", Tipo de dado String / Descrição "created_at": null, Tipo de dado Date "updated_at": null Tipo de dado Date }, "tariff_type": { Objeto "id": 1, Tipo de dado Integer "description": "R$", Tipo de dado String / Descrição "created_at": null, Tipo de dado Date "updated_at": null Tipo de dado Date }, "franchise_type": { Objeto "id": 1, Tipo de dado Integer "description": "Dia", Tipo de dado String / Descrição "created_at": null, Tipo de dado Date "updated_at": null Tipo de dado Date }, "franchise_rule": { Objeto "id": 4, Tipo de dado Integer "description": "Em primeiro Repasse", Tipo de dado String / Descrição "created_at": null, Tipo de dado Date "updated_at": null Tipo de dado Date }, "product": { Objeto "id": 26, Tipo de dado Integer "brand_id": 2, Tipo Integer / Id da bandeira "payment_method_id": 1, Tipo Integer / Id do metodo de pagamento "created_at": null, Tipo Date "updated_at": "2021-09-29 11:47:33", Tipo Date "cip_product_id": 1, Tipo Integer / Id do produto cip "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "brand": { "id": 2, Tipo Integer "name": "Mastercard", Tipo String / Nome da bandeira "icons": "data:image/png;base64", Tipo String / Icone em base 64 "created_at": null, Tipo Date "updated_at": null Tipo Date }, "payment_method": { "id": 1, Tipo Integer "description": "Crédito rotativo", Tipo String / Descrição "max_installments": 1, Tipo Integer / Quantidade maxima de parcelas "min_installments": 1, Tipo Integer / Quantidade minima de parcelas "created_at": null, Tipo Date "updated_at": null, Tipo Date "rules": "default" Tipo String / Regra } }, }, ] }
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

POST

CRIAÇÃO
/tariffs/{id}

Detalhes

Ao chamar a API realiza a criação da tarifa.
É preciso criar tarifa frequencia.
Tipo de Dado
ID: Integer
description: String
complement: String
tariff_type_id: Integer
value: Decimal
frequency_id: Integer
franchise_qtd: 0, Tipo Decimal / Qtd Franquia
franchise_type_id: Integer
franchise_rule_id: Integer
product_id: Integer

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DESCRIPTION, TYPE, VALUE, FREQUENCY_ID
Body	{ "description" : "Descrição", "complement" : "Complemento", "tariff_type_id" : "Id do tipo de tarifa", "value" : "Valor", "frequency_id" : "Id da frequencia da tarifa", "franchise_qtd" : "Qtd franquia", "franchise_type_id" : "Id do tipo de franquia", "franchise_rule_id" : "id da regra frequência", "product_id" : "Id do produto" }

Retornos

Código	Mensagem
201	EXEMPLO: { "data": { "description": "4 Parcelas", Tipo de dado String / Descrição "value": "9.99", Tipo de dado Decimal / Valor da tarifa "complement": null, Tipo de dado String / Complemento "tariff_type_id": 1, Tipo de dado Integer / Id do tipo de tarifa "frequency_id": 9, Tipo de dado Integer / Id de frequencia da tarifa "franchise_qtd": 0, Tipo Decimal / Qtd Franquia "franchise_type_id": null, Tipo Integer / Id do Tipo de Franquia "franchise_rule_id": null, Tipo Integer / Id da Regra Frequência "updated_at": "2022-06-01 13:00:25", Tipo de dado Date "created_at": "2022-06-01 13:00:25", Tipo de dado Date "id": 2400 Tipo de dado Integer }, "msg": [ "CRIADO" ], "statusCode": 201 }
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.

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
206	EXEMPLO: { "data": { Objeto "id": 1, Tipo de dado Integer "description": "Transação Aprovada", Tipo de dado String / Descrição "value": "9.99", Tipo de dado Decimal / Valor da tarifa "complement": null, Tipo de dado String / Complemento "tariff_type_id": 1, Tipo de dado Integer / Id do tipo de tarifa "frequency_id": 9, Tipo de dado Integer / Id de frequencia da tarifa "created_at": "2021-09-29 11:47:36", Tipo de dado Date "updated_at": "2021-12-14 07:26:02", Tipo de dado Date "franchise_qtd": 0, Tipo Decimal / Qtd Franquia "franchise_type_id": null, Tipo Integer / Id do Tipo de Franquia "franchise_rule_id": null, Tipo Integer / Id da Regra Frequência "installments": 1, Tipo de dado Integer / Quantidade de Parcelas "product_id": 1, Tipo Integer / Id do Produto "discount_status": 2, Tipo Integer / Status de Desconto "ecommerce_value": "0.00", Tipo Decimal / Valor ecommerce "qtd_estab_count": 1, Tipo de dado Integer / Quantidade contada de estabelecimentos "qtd_economic_group_count": 1, Tipo de dado Integer / Quantidade contada de tarifas "frequency": { Objeto "id": 10, Tipo de dado Integer "description": "Única", Tipo de dado String / Descrição "created_at": null, Tipo de dado Date "updated_at": null Tipo de dado Date }, "tariff_type": { Objeto "id": 1, Tipo de dado Integer "description": "R$", Tipo de dado String / Descrição "created_at": null, Tipo de dado Date "updated_at": null Tipo de dado Date }, "franchise_type": { Objeto "id": 1, Tipo de dado Integer "description": "Dia", Tipo de dado String / Descrição "created_at": null, Tipo de dado Date "updated_at": null Tipo de dado Date }, "franchise_rule": { Objeto "id": 4, Tipo de dado Integer "description": "Em primeiro Repasse", Tipo de dado String / Descrição "created_at": null, Tipo de dado Date "updated_at": null Tipo de dado Date }, "product": null, }, "msg": [ "OK" ], "statusCode": 206 }
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.

Tipo de Dado
ID: Integer
description: String
complement: String
tariff_type_id: Integer
value: Decimal
frequency_id: Integer
franchise_qtd: Integer
franchise_type_id: Integer
franchise_rule_id: Integer
product_id: Integer

Parâmetros

Authorization	{ Bearer Token string : (VkZSbXpSSWdFNE5qcFhpOUVPeVZxNHBtVVhhMko3Y0M5WHNsSGw0Ng==) }
Required	DESCRIPTION, TYPE, VALUE, FREQUENCY_ID
Body	{ "description" : "Descrição", "complement" : "Complemento", "tariff_type_id" : "Id do tipo de tarifa", "value" : "Valor", "frequency_id" : "Id da frequencia da tarifa", "franchise_qtd" : "Qtd franquia", "franchise_type_id" : "Id do tipo de franquia", "franchise_rule_id" : "id da regra frequência", "product_id" : "Id do produto" }

Retornos

Código	Mensagem
200	EXEMPLO: { "data": { Objeto "id": 1, Tipo de dado Integer "description": "4 Parcelas", Tipo de dado String / Descrição "value": "0", Tipo Decimal / Valor "complement": null, Tipo String / Complemento "tariff_type_id": 1, Tipo Integer / Id do tipo da tarifa "frequency_id": 7, Tipo Integer / Id da frequencia em que a tarifa é aplicada "created_at": null, Tipo Date "updated_at": "2021-10-04 08:26:02", Tipo Date "franchise_qtd": 0, Tipo Decimal / Qtd Franquia "franchise_type_id": null, Tipo Integer / Id do Tipo de Franquia "franchise_rule_id": null, Tipo Integer / Id da Regra Frequência "installments": 1, Tipo Integer / Numero de parcelas que a tarifa se aplica "product_id": null, Tipo Integer / Id do Produto "discount_status": 2, Tipo Integer / Status do Desconto "ecommerce_value": "0.00", Tipo Decimal / Valor ecommerce }, "msg": [ "OK" ], "statusCode": 200 }
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.

Tipo de Dado
ID: Integer

Parâmetros

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

Retornos

Código	Mensagem
200	EXEMPLO: { "data": null, "msg": [ "OK" ], "statusCode": 200 }
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

Transações

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.

O campo "liquid_amount" é enviado apenas em transações cujo o produto é parcelado cliente.

Exportar Produtos

Tipo de Dado
document: String
originator: String
capture_method_id: Integer
entry_mode_id: Integer
terminal_identification: String
acquirer_id: Integer
card_number: String
product_id: Integer
amount: Decimal
installments: Integer
authorization: String
integration_transaction_id: Integer
transaction_type_id: Integer
transaction_canceled_id: Integer
nsu: String
service_type_id: Integer
date: Date
identificator: String
liquid_amount: Decimal

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" : "Documento do estabelecimento", "estab_split" : "Documento do estabelecimento", "originator" : "Originador", "capture_method_id" : "Id do metodo de captura", "entry_mode_id" : "Id do modo de entrada", "terminal_identification" : "Terminal de identificação", "acquirer_id" : "Id do adquirente", "card_number" : "Numero do cartão", "product_id" : "Id do produto", "amount" : "Valor da transação", "installments" : "Quantidade de parcelas", "authorization" : "Codigo de autorização", "integration_transaction_id" : "Id de integração de transação", "transaction_type_id" : "Id do tipo de transação", "transaction_canceled_id" : "Id da transação que ira ser cancelada", "nsu" : "NSU", "service_type_id" : "Id do tipo de serviço", "date" : "Data da transação", "identificator" : "identificator da transação", "liquid_amount" : "Valor liquido" }

Retornos

Código	Mensagem
200	EXEMPLO: { "data": null, "msg": [ "OK" ], "statusCode": 200 }
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

Caso não queira filtrar por algum dos campos abaixo, apenas apague a linha do campo dentro do objeto filters.

Id de Estabelecimento - filters[establishment_id] / Tipo de dado Integer
CNPJ Estabelecimento - filters[cnpj] / Tipo de dado String
CPF Estabelecimento - filters[cpf] / Tipo de dado String
Id de Transação - filters[id] / Tipo de dado Integer
Nº de Parcelas - filters[installments] / Tipo de dado Integer
Produto - filters[product_id] / Tipo de dado Integer
Tipo da Transação - filters[transaction_type_id] / Tipo de dado Integer
Originador - filters[originator] / Tipo de dado String
Autorização - filters[authorization] / Tipo de dado String
Número de Cartão - filters[card_number] / Tipo de dado String
Método Captura - filters[capture_method_id] / Tipo de dado Integer
Meio de Entrada - filters[entry_mode_id] / Tipo de dado Integer
Data da Integração (Periodo Inicial) - filters[initial_created_at] / Tipo de dado Date
Data da Integração (Periodo Final)- filters[final_created_at] / Tipo de dado Date
Data de Transação (Período Inicial) - filters[transaction_initial_date] / Tipo de dado Date
Data de Transação (Período Final) - filters[transaction_final_date] / Tipo de dado Date
ID Parcela - filters[installment_id] / Tipo de dado Integer
Situação da Parcela - filters[installment_situation_id] / Tipo de dado Integer
Status da Parcela - filters[installment_status_id] / Tipo de dado Integer
Data de vencimento da parcela (Período Inicial) - filters[installment_inital_expiry_date] / Tipo de dado Date
Data de vencimento da parcela (Período Final) - filters[installment_final_expiry_date] / Tipo de dado 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==)

}

Body

{

"filters" : { "establishment_id": "null", "establishment.commercial_name": "null", "id": "null", "product_id": "null", "transaction_type_id": "null", "originator": "null", "authorization": "null", "card_number": "null", "capture_method_id": "null", "nsu_captura": "null", "serial_number": "null", "created_at": "null", "transaction_initial_date": "null", "transaction_final_date": "null", "installment_id": "null", "installment_situation_id": "null", "installment_status_id": "null", "installment_inital_expiry_date": "null", "installment_final_expiry_date": "null", "document": "null", }

}

Retornos

Código	Mensagem
200	EXEMPLO: "data":[ Array { "id": 204, Tipo de dado Integer "card_number": "000589916XXXXXX0487", Tipo String / Numero do cartão "originator": "ADIQ", Tipo String / Originador "authorization": "007078", Tipo String / Autorização "nsu": "75", Tipo String / Nsu transação "company_id": 9, Tipo Integer / Id do company do estabelecimento "acquirer_id": 1, Tipo Integer / Id do Adquirente "installments": 1, Tipo Integer / Quantidade de Parcelas "amount": "1000.00", Tipo Decimal / Valor "terminal_identification": "6N281051", Tipo String / Identificação do terminal "capture_method_id": 1, Tipo Integer / Metodo de captura "product_id": 1, Tipo Integer / Id do Produto "transaction_type_id": 2, Tipo Integer / Id do tipo de transação "integration_transaction_id": "75", Tipo Integer / Id da transação integrada "transaction_canceled_id": null, Tipo Integer / Id do cancelamento da transação "date": "2022-01-26 13:45:43", Tipo Date "created_at": "2022-01-26 12:26:03", Tipo Date "updated_at": "2022-01-26 12:26:03", Tipo Date "entry_mode_id": 2, Tipo Integer / Id do meio de entrada "integration_transaction_id_2": "75", Tipo Integer / Id d transação integrada "distributor_id": 1, Tipo Integer / Id do Distribuidor "preposterou_id": 1, Tipo Integer / Id do Preposto "last_import": null, / Ultima data que foi importado "attempt": 0, Tipo Integer / Tentativas "integration_status_id": 2, Tipo Integer / Id do status de integração "cerc_status_id": 2, Tipo Integer / Id do status na CERC "external_identificator": null, Tipo String / Indentificação externa "liquid_amount": null, Tipo Decimal / Valor liquido "return_tax": null, Tipo Decimal / Taxa de retorno "service_type_id": 2, Tipo Integer / Id do tipo de serviço "alias": null, Tipo String "additional_info": null, Tipo String / Informação adicional "proccess_date": null, Tipo Date / Data de processamento "identificator": null, Tipo String / identificador "pgs_code": null, Tipo String / Código pgs "received_edi": "N", Tipo String "type": { Object "id": 2, Tipo de dado Integer "description": "Autorizada", Tipo de dado String / Descrição "created_at": null, Tipo de dado Date "updated_at": null Tipo de dado Date }, "transaction_type": { Object "id": 2, Tipo de dado Integer "description": "Autorizada", Tipo de dado String / Descrição "created_at": null, Tipo de dado Date "updated_at": null Tipo de dado Date }, "entry_mode": { Object "id": 3, Tipo de dado Integer "description": "Tarja", Tipo de dado String / Descrição "created_at": null, Tipo de dado Date "updated_at": null, Tipo de dado Date "code": null Tipo de dado String }, "get_installments": [ Array { "id": 315, Tipo de dado Integer "transaction_id": 134, Tipo Integer / Id da transação "amount": "1000.00", Tipo Decimal / Valor "number": 1, Tipo Integer / Numero da parcela "situation_id": 2, Tipo Integer / Situação de pagamento da parcela "installment_status_id": 2, Tipo Integer / Id de status da parcela "expiry_date": "2022-02-09", Tipo Date / Data de vencimento da parcela "closing_date": "2022-03-30", Tipo Date / Data de fechamento da parcela "pay_date": "2022-03-30", Tipo Date / Data de pagamento da parcela "cancel_date": null, Tipo Date / Data de cancelamento da parcela "created_at": "2022-01-26 12:26:03", Tipo Date "updated_at": "2022-03-30 08:31:34", Tipo Date "net_amount": "980.54", Tipo Decimal / Valor liquido da parcela "split_amount": "0.00", Tipo Decimal / Valor de split "split_amount_percent": "0.00", Tipo Decimal / Porcentagem de split "conciliation_status_id": null, Tipo Integer / Id do Status de conciliação "expected_payment_date": null, Tipo Date / Data estimada de pagamento "commission": "0.00", Tipo Decimal / Valor da comissão "original_expected_payment_date": null, Tipo Date / Data original de pagamento "adq_anticipation_tax": "0.00", Tipo Decimal / Taxa de antecipação Adquirente "adq_mdr_tax": "0.00", Tipo Decimal / MDR do Adquirente "cerc_status_id": 1, Tipo Integer / Id do status na CERC "job_amount": null, Tipo Decimal "external_code": null, Tipo String / Código externo "proccess_date": null, Tipo String / Data de processamento "liquid_status_id": 1, Tipo Integer / Id do status de liquidação "pgs_code": null, Tipo String / Código pgs } ], "company": { Object "id": 9, Tipo de dado Integer "name": "Exemplo", Tipo String / Nome "last_name": "Exemplo", Tipo String / Ultimo nome "rg": "1111111111", Tipo String / RG "birth": "2022-03-08", Tipo Date / Data de nascimento "document": "87128483101", Tipo String / Documento "city_insc": "1111111111", Tipo String "state_insc": "1111111111", Tipo String "bank_given_type_id": 1, Tipo Integer / Tipo de conta bancaria "people_type_id": 2, Tipo Integer / Tipo pessoa, fisica ou jiridica "company_type_id": 1, Tipo Integer / Id do tipo do cadastro "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "commission_liquid_status": 2, Tipo Integer / Status de liquidação de comissão "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-03-21 06:39:15", Tipo Date "email": "exemplo@paynet.net.br", Tipo String / Email "telephone": "(11)11111-1111", Tipo String / Telefone "nationality": "brasil", Tipo String / Nacionalidade "localization": { "id": 45, Tipo Integer "company_id": 9, Tipo Integer / Id do company do estabelecimento "cep": "08745140", Tipo String / CEP "address": "Avenida Saraiva", Tipo String / Rua "district": "Vila Cintra", Tipo String / Distrito "city": "Mogi das Cruzes", Tipo String / Cidade "complement": null, Tipo String / Complemento "state_id": 25, Tipo Integer / Id do Estado "countrie_id": 1, Tipo Integer / Id do Pais "created_at": "2021-09-30 12:41:59", Tipo Date "updated_at": "2021-09-30 12:41:59", Tipo Date "number": null, Tipo String / Numero "countrie": { "id": 1, Tipo Integer "abbreviation": "BR", Tipo String / Abreviação "name": "Brasil", Tipo String / Nome "created_at": "2021-09-29 11:47:29", Tipo Date "updated_at": "2021-09-29 11:47:29" Tipo Date }, "state": { "id": 25, Tipo Integer "uf": "SP", Tipo String / Unidade Federativa "name": "São Paulo", Tipo String / Nome "created_at": null, Tipo Date "updated_at": null Tipo Date } }, "contact": [ Array { "id": 295, Tipo de dado Integer "company_id": 3, Tipo Integer / Id do company do estabelecimento "contact_type_id": 1, Tipo Integer / Id do tipo de contato "name": "jacqueline", Tipo String / Nome "value": "11988808096", Tipo String / Telefone ou Email "created_at": "2022-06-13 09:16:38", Tipo Date "updated_at": "2022-06-13 09:16:38", Tipo Date "contact_type": { "id": 1, Tipo Integer "description": "Celular", Tipo String / Descrição "created_at": null, Tipo Date "updated_at": null Tipo Date } }, ], "detail": null, "bank_given": { Object "id": 9, Tipo de dado Integer "agency": "111111111", Tipo String / Numero da Agencia "digit_agency": "22", Tipo String / Digito da Agencia "account": "333333333333", Tipo String / Numero da Conta "digit_account": "44", Tipo String / Digito da Conta "company_id": 13, Tipo Integer / Id do company do mesmo estabelecimento "bank_account_type_id": 1, Tipo Integer / Tipo da Conta "bank_id": 340, Tipo Integer / Id do banco "holder_type_id": 2, Tipo Integer / Tipo de documento representante da conta "created_at": "2021-09-29 13:18:29", Tipo Date "updated_at": "2022-03-21 14:37:49", Tipo Date "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "liquid": "1", Tipo Integer "account_type": { Objeto "id": 1, Tipo Integer "value": "Conta Corrente", Tipo String / Descrição do tipo da conta "created_at": null, Tipo Date "updated_at": null, Tipo Date "code": "CC" Tipo String / Código }, "holder_type": { Objeto "id": 2, Tipo Integer "value": "Pessoa Jurídica - Empresa", Tipo String / Descrição do tipo de documento representante "abbreviation": "PJE", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "bank": { Objeto "id": 340, Tipo Integer "code": "X1X", Tipo String / Código do banco "name": "CONTA INTERNA", Tipo String / Nome do banco "ispb": "00000000", Tipo String / Ispb do banco "created_at": null, Tipo Date "updated_at": "2021-09-29 11:48:07", Tipo Date "ispb_code": null Tipo String / Código ispb }, "holder": null }, "prepaid_card": null, "bank_given_type": { Object "id": 1, Tipo de dado Integer "value": "Conta Bancária", Tipo de dado String / Descrição do tipo da conta "abbreviation": "CB", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null, Tipo Date "status_id": 1 / Id do Status (1 - Ativo, 2 - Inativo) }, "people_type": { Object "id": 1, Tipo de dado Integer "name": "Pessoa Fisica", Tipo String / Nome "abbreviation": "PJ", Tipo String / Abreviação "created_at": null, Tipo Date "updated_at": null Tipo Date }, "status": { Object "id": 1, Tipo de dado Integer "description": "Ativo", Tipo de dado String / Descrição "created_at": null, Tipo de dado Date "updated_at": null Tipo de dado Date }, "establishment": { Object "id": 1, Tipo Integer "commercial_name": Xampson", Tipo String / Nome Comercial "activation_date": "2022-03-21 06:39:15", Tipo Date / Data de ativação "company_id": 51, Tipo Integer / Id do company do estabelecimento "mcc_id": 1, Tipo Integer / Id do mcc "establishment_situation_id": 6, Tipo Integer / Id da situação do estabelecimento "preposterou_id": 1, Tipo Integer / Id do Preposto "distributor_id": 1, Tipo Integer / Id do Distribuidor "ofac_status_id": 2, Tipo Integer / Id do status do OFAC "integration_status_id": 2, Tipo Integer / Id do status de integração "economic_group_id": 1, Tipo Integer / Id do grupo econômico "anticipation_status_id": 3, Tipo Integer / Id do status de antecipação "created_at": "2022-03-21 06:38:50", Tipo Date "updated_at": "2022-06-13 14:14:54", Tipo Date "payment_status_id": 1, Tipo Integer / Id do status de pagamento "external_unique_identification": null, Tipo Integer / Identificação unica externa "last_import": null, Tipo Date / Ultima data que foi importado "cerc_status_id": 2, Tipo Integer / Status do estabelecimento na CERC "moneylender_status_id": 2, Tipo Integer / Status de GIRO "pdv_code": "11111111111111", Tipo String / Código PDV "split_type_id": 2, Tipo Integer / Tipo de Split "status_anticipation": 2, Tipo Integer / Status de antecipação "created_at_cerc": null, Tipo Date / Data que foi criado na CERC "payment_link_status_id": 2, Tipo Integer / Status de link de pagamento "has_delivery_address": 2, Tipo Integer / Endereço de entrega "automatic_transfer_status_id": 1, Tipo Integer / Status de transferencia automatica "contract_type_id": null, Tipo Integer / Tipo de contrato "virtual_account_status_id": 2, Tipo Integer / Status de conta virtual "contract_date": null, Tipo Date / Data do contrato "commission_activation": 1, Tipo Integer / Status de comissão } }, "product": { Object "id": 7, Tipo de dado Integer "brand_id": 2, Tipo Integer / Id da bandeira "payment_method_id": 1, Tipo Integer / Id do metodo de pagamento "created_at": null, Tipo Date "updated_at": "2021-09-29 11:47:33", Tipo Date "cip_product_id": 1, Tipo Integer / Id do produto cip "status_id": 1, Tipo Integer / Id do Status (1 - Ativo, 2 - Inativo) "brand": { "id": 2, Tipo Integer "name": "Mastercard", Tipo String / Nome da bandeira "icons": "data:image/png;base64", Tipo String / Icone em base 64 "created_at": null, Tipo Date "updated_at": null Tipo Date }, "payment_method": { "id": 1, Tipo Integer "description": "Crédito rotativo", Tipo String / Descrição "max_installments": 1, Tipo Integer / Quantidade maxima de parcelas "min_installments": 1, Tipo Integer / Quantidade minima de parcelas "created_at": null, Tipo Date "updated_at": null, Tipo Date "rules": "default" Tipo String / Regra } }, "canceled_transaction": null, "capture_method": { Object "id": 1, Tipo de dado Integer "description": "POS", Tipo de dado String / Descrição "tariff_column": "value", Tipo de dado String "created_at": null, Tipo de dado Date "updated_at": "2021-09-29 11:47:43" Tipo de dado Date } } } ] }
402	Token não encontrado. Token expirado. Token é inválido.
500	Houve um erro interno

Transações não 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

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

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 realiza listagem de um único usuário em API

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

financeiro

GET

Conta Operacional
/operational_account

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