Criar um cliente
Cadastre ou atualize um cliente na empresa e no ambiente da sua chave de API.
Cria ou atualiza um cliente pelo CPF ou CNPJ na empresa e no ambiente da sua chave de API. Um documento já cadastrado atualiza o cliente existente e mantém seu identificador.
Quando somente zip_code é informado para o endereço, a Raims pode preencher
street, neigh, city e uf com os dados do CEP. Para usar esse
preenchimento, deixe street, neigh, city, uf, street_number e
complement sem valor. Qualquer dado nesses campos impede o preenchimento
automático; campos vazios ou só com espaços não impedem. Se o CEP não for
encontrado, o cliente ainda pode ser cadastrado.
Consulte Criar um cliente para ver as regras do cadastro. Use a referência no seu sistema para relacionar esse cliente ao identificador usado na sua integração.
Parâmetros do corpo
Nome completo do pagador.
Até 120 caracteres
CPF ou CNPJ válido, com ou sem pontos, barra, hífen e espaços.
1 a 20 caracteres
E-mail do pagador. Cadastrar o e-mail não envia uma mensagem.
Até 254 caracteres
Código de discagem internacional. Pode ser informado sem phone_local.
Até 5 caracteres
Número de telefone sem o código de discagem, com ou sem pontuação. Pode ser informado sem dial_code.
Até 20 caracteres
CEP do endereço, com ou sem hífen. Se street, neigh, city, uf, street_number e complement estiverem vazios, o CEP pode preencher rua, bairro, cidade e estado. O preenchimento não inclui número nem complemento.
Até 15 caracteres
Logradouro do endereço.
Até 120 caracteres
Número do endereço.
Até 10 caracteres
Complemento do endereço.
Até 40 caracteres
Bairro do endereço.
Até 80 caracteres
Cidade do endereço.
Até 80 caracteres
Sigla do estado, como SP.
Até 5 caracteres
Identificador do cliente no seu sistema. Para um cliente já cadastrado, omita para manter a referência ou envie null ou texto vazio para removê-la. Use external_reference na listagem de clientes para buscar esse valor.
Até 120 caracteres
Dados de integração associados ao recurso. Informe pares de chave e texto. Chaves diferenciam maiúsculas de minúsculas. Omitir ou enviar {} preserva os dados; null remove todos os pares, e null em uma chave remove somente essa chave. Texto vazio é um valor válido.
Até 32 entradas, Chaves: até 40 caracteres, Valores: até 500 caracteres, JSON: até 8192 bytes UTF-8
Respostas
Para os erros gerais, consulte Códigos HTTP das respostas.