post
https://splitonboardingapisandbox.braspag.com.br/api/batch-subordinates-onboarding/upload
Envia um lote de sellers para cadastro via upload de um arquivo CSV.
| Ambiente | Método | Endpoint |
|---|---|---|
| Sandbox | post | https://splitonboardingapisandbox.braspag.com.br/api/batch-subordinates-onboarding/upload |
| Produção | post | https://splitonboardingapi.braspag.com.br/api/batch-subordinates-onboarding/upload |
Para gerar o
access_token, consulte a documentação: Obter token de acesso.
Permite enviar um lote de sellers para cadastro através do upload de um arquivo CSV, em vez de cadastrar um seller por vez via Cadastrar seller.
O master ao qual os sellers serão vinculados é determinado automaticamente pelas credenciais usadas na autenticação — não é necessário enviar nenhum outro campo além do arquivo.
A resposta do upload traz um importId, usado para acompanhar o processamento do lote em Consultar status da importação e, se houver falhas, em Consultar erros da importação.
Restrições do arquivo
- Não pode estar vazio.
- Não pode exceder 3 MB.
- Envie a parte do arquivo com
Content-Type: text/csv.
Layout do arquivo CSV
- Delimitador:
;(ponto e vírgula) — não use vírgula. - A primeira linha do arquivo é sempre ignorada pelo sistema. Pode ser usada como cabeçalho legível (recomendado, só para organização).
- 26 colunas fixas, nesta ordem exata — não pule nem reordene colunas, mesmo os campos opcionais precisam manter a posição:
DocumentNumber;DocumentType;CorporateName;FancyName;ContactName;ContactPhone;BirthdayDate;BusinessActivity;MailAddress;Website;Bank;BankAccountType;AccountNumber;Operation;VerifierDigit;AgencyNumber;AgencyDigit;Street;AddressNumber;Complement;Neighborhood;City;State;ZipCode;AgreementPercent;AgreementFeeRegras por coluna
| Coluna | Obrigatório | Regra |
|---|---|---|
DocumentNumber | Sim | Apenas dígitos, sem pontuação. CNPJ ou CPF válido, conforme DocumentType. |
DocumentType | Sim | CPF ou CNPJ. |
CorporateName | Sim | Máx. 100 caracteres. |
FancyName | Sim | Máx. 50 caracteres. |
ContactName | Sim | Máx. 100 caracteres. |
ContactPhone | Sim | Máx. 11 caracteres, apenas números. |
BirthdayDate | Somente para CPF | Formato yyyy-MM-dd. Deixe vazio para CNPJ. |
BusinessActivity | Não | Deixe vazio quando DocumentType=CNPJ. |
MailAddress | Sim | E-mail válido. |
Website | Não | — |
Bank | Não | Código do banco. |
BankAccountType | Sim | Um dos valores: CheckingAccount, SavingsAccount, PaymentAccount, DepositAccount, GuaranteedAccount, InvestmentAccount. |
AccountNumber | Sim | Máx. 12 caracteres, apenas números. |
Operation | Sim, na prática | Apenas números. Sempre preencha com um valor (ex.: 0, se não aplicável ao seu banco) — deixar em branco causa erro de validação. |
VerifierDigit | Sim | 1 caractere: número ou X. |
AgencyNumber | Sim | Máx. 4 caracteres, apenas números. |
AgencyDigit | Sim | 1 caractere: número ou X. |
Street | Sim | Máx. 100 caracteres. |
AddressNumber | Sim | Máx. 15 caracteres. |
Complement | Não | — |
Neighborhood | Sim | Máx. 50 caracteres. |
City | Sim | Máx. 50 caracteres. |
State | Sim | Sigla de UF (2 caracteres). |
ZipCode | Sim | Exatamente 8 dígitos numéricos, sem hífen. |
AgreementPercent | Sim | Numérico ≥ 0, até 2 casas decimais. |
AgreementFee | Sim | Numérico inteiro ≥ 0, em centavos. |
Erros possíveis
| Situação | Mensagem |
|---|---|
| Arquivo não enviado | File not informed |
Content-Type incorreto | The file is not in the correct format. Check if the file is in 'csv' extension and retry. |
| Arquivo vazio | The file is null. Check if it is populated and retry. |
| Arquivo maior que 3 MB | The file is too large. The maximun size is 3mb. You can split the file content. |