#Introdução

Este documento tem como objetivo especificar o modelo e campos dos arquivos.csv enviados para o gs-settlement com a finalidade de cadastro de lojas em produtos financeiros e em grupos de produtos financeiros.
Os tópicos abaixo descrevem a estrutura do arquivo de cadastro em lote bem como as APIs de envio do arquivo a ser consumido.

#1 - Nomenclatura e Convenções

O arquivo possui formato .CSV, não conterá header ou trailer e o seu processamento deve ser considerado linha a linha até o final do arquivo. Cada linha contém unicamente o dado do documento da loja a ser vinculada ao produto ou grupo.

#2 - Modelo de cadastro

O modelo descrito nos itens abaixo é referente ao cadastro de lojas no produto ou grupo financeiro.

#3 - Arquivos

#3.1 - Descrição dos Campos Contidos no Arquivo

Para todas as lojas a serem vinculadas a um grupo ou produto financeiro, via arquivo, devem seguir o seguinte formato abaixo.

ID	NOME DO CAMPO	Obrigatório	DESCRIÇÃO
01	Documento da loja	✅	Documento válido da loja cadastrada, conforme tabela nº1

⚠️⚠️ATENÇÃO⚠️⚠️:
O campo de documento da loja deve seguir os seguintes parâmetros:

• Somente caracteres numéricos, sem pontuação;

• O documento enviado deve sempre ser completado com zeros à esquerda;

#3.2 - Exemplo de arquivo

Dados para exemplo arquivo csv.

Exemplo criação de vínculo entre loja e grupo/produto financeiro:

csv

04252683047
00727774023
04745386000147
00856468000156

---

#4 - APIs

#4.1 - Cadastro em massa de lojas em um Grupo Financeiro

É possível cadastrar estabelecimentos comerciais em massa em grupos financeiros criados. Para isso, deve ser passado de forma obrigatória o path parameter {id} contendo o identificador único do grupo. Se o grupo for encontrado, a API retornará uma URL para enviar um arquivo .csv para ser consumido e realizar o cadastro dos estabelecimento comerciais no grupo informado.

#📌 Requisição - 1 (gerar link de upload)

🛠 Método: GET
🔗 URL:

https://api-hml.gsurfnet.com/settlement-v2/product-upload-link/{id}/group

---

Request

Path Parameters

Parâmetro	Tipo	Obrigatório	Descrição
id	string	✅	Identificador do grupo (UUID)

#📌 Requisição - 2 (envio do arquivo)

🛠 Método: PUT
🔗 URL: Utilizar URL do retorno da Requisição - 1 (gerar link de upload).

---

Request

Body

binary

Encaminhar o arquivo .csv com o conteudo estruturado da seguinte forma:
Utilizar apenas a primeira coluna, contendo em cada linha apenas um documento.

#Responses

Código	Descrição
200	OK (Recebido com sucesso)
404	Not Found (Não encontrado)
500	Internal Server Error (Erro interno no servidor)

#4.2 - Cadastro em massa de lojas em um Produto Financeiro:

É possível cadastrar estabelecimentos comerciais em massa em produtos financeiros criados. Para isso, deve ser passado de forma obrigatória o path parameter {id} contendo o identificador único do produto. Se o produto for encontrado, a API retornará uma URL para enviar um arquivo .csv para ser consumido e realizar o cadastro dos estabelecimento comerciais no grupo informado.

#📌 Requisição - 1 (gerar link de upload)

🛠 Método: GET
🔗 URL:

https://api-hml.gsurfnet.com/settlement-v2/product-upload-link/{id}/product

---

Request

Path Parameters

Parâmetro	Tipo	Obrigatório	Descrição
id	string	✅	Identificador do grupo (UUID)

#📌 Requisição - 2 (envio do arquivo)

🛠 Método: PUT
🔗 URL: Utilizar URL do retorno da Requisição - 1 (gerar link de upload).

---

Request

Body

binary

Encaminhar o arquivo .csv com o conteudo estruturado da seguinte forma:
Utilizar apenas a primeira coluna, contendo em cada linha apenas um documento.

#Responses

Código	Descrição
200	OK (Recebido com sucesso)
404	Not Found (Não encontrado)
500	Internal Server Error (Erro interno no servidor)

#5 - Tabelas

Abaixo seguem tabelas referidas acima na documentação, contendo valores variantes de cada campo

#Tabela 1 – Tipos de documentos

Identificador	Tamanho do documento
CPF	11(onze) caracteres númericos, sem pontuação, sem espaçamento, completos com zero a esquerda.
CNPJ	14(quatorze) caracteres númericos, sem pontuação, sem espaçamento, completos com zero a esquerda.