v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB
Marketplace

Registra uma seller

Registra um cliente no sistema de Pagamentos vinculado ao cliente que está executando a chamada da API.

Uma seller é utilizada nas operações de split e identificada através do campo ClienteId.

  • Cada CNPJ só pode ser registrado uma única vez, considerando a matriz.
  • A ligação entre matriz e seller ocorre com base no CNPJ.
  • Para movimentações e repasses, utilize sempre o ClienteId retornado.

Requisição

CampoTipoDescriçãoObrigatório
PessoaTextoTipo de pessoa: F (Física) ou J (Jurídica)Sim
CPFCNPJTextoCPF (11 dígitos) ou CNPJ (14 dígitos), somente númerosSim
NomeTextoNome do seller (usado internamente)Sim
RazaoSocialTextoRazão Social ou nome completo (repete o Nome para PF)Sim
TitularidadeTextoNome exato do titular da conta conforme registro bancárioSim
NomeCurtoTextoNome curto usado em notificações (ex: SMS)Sim
EmailTextoEndereço de e-mail válidoSim
TelefoneTextoTelefone com DDD no formato 00-0000-0000Sim
CepTextoCEP (somente números)Sim
LogradouroTextoEndereço (rua, avenida, etc.)Sim
ComplementoTextoComplemento do endereçoNão
NumeroTextoNúmero do endereço (usar "S/N" se não houver número)Sim
BairroTextoNome do bairroSim
CidadeTextoNome da cidadeSim
UFTextoUnidade da federação (UF), ex: SP, RJSim
CodigoBancoTextoCódigo do banco (3 dígitos, conforme padrão Febraban)Sim
AgenciaContaTextoNúmero da agência bancária (sem dígito)Sim
DigitoAgenciaContaTextoDígito da agênciaNão
NumeroContaTextoNúmero da conta bancária (sem dígito)Sim
DigitoNumeroContaTextoDígito da conta bancáriaNão

Resposta

CampoTipoDescrição
DetalhesErroTextoMensagem de erro, caso o retorno seja ERRO
ClientIdTextoGUID do seller cadastrado
ContaDestinoIdTextoGUID da conta bancária vinculada
DadosAcessoTextoCredenciais de acesso (usuário e senha) geradas
post/api/marketplace/seller

Headers

Aeskeystring required

Request body

Pessoastring required
CPFCNPJstring required
Nomestring required
RazaoSocialstring required
Titularidadestring required
NomeCurtostring required
Emailstring required
Telefonestring required
Cepstring required
Logradourostring required
Complementostring
Numerostring required
Bairrostring required
Cidadestring required
UFstring required
CodigoBancostring required
AgenciaContastring required
DigitoAgenciaContastring
NumeroContastring required
DigitoNumeroContastring

Example request

{
  "Pessoa": "F",
  "CPFCNPJ": "48455151480",
  "Nome": "Renato Samuel Augusto Baptista",
  "RazaoSocial": "Renato Samuel Augusto Baptista",
  "Titularidade": "Renato Samuel Augusto Baptista",
  "NomeCurto": "Renato Samuel Augusto Baptista",
  "Email": "renatosamuel@umdominio.com.br",
  "Telefone": "999293802",
  "Cep": "82510290",
  "Logradouro": "Rua Canadá, 257",
  "Complemento": "",
  "Numero": "22",
  "Bairro": "Bacacheri",
  "Cidade": "Curitiba",
  "UF": "PR",
  "CodigoBanco": "213",
  "AgenciaConta": "0001",
  "DigitoAgenciaConta": "9",
  "NumeroConta": "55016709",
  "DigitoNumeroConta": "9"
}

Response

Retorno da criacao do conteudo

DetalhesErrostring
ClientIdstring
ContaDestinoIdstring
DadosAcessostring