...
Esta operação ocorre nos eventos 'Identificar o cliente', 'Cadastrar pessoa' e também no pagamento por convênio, caso o cliente não tenha sido identificado durante a compra.
POST {url}
Se os parâmetros de autenticação estiver configurado será enviado no Header no formato Basic Authentication.
| Bloco de código |
|---|
Authorization: Basic dGVzdGU6MTIz |
Parâmetros do
...
Corpo (Body Parameters)
| Parâmetro | Tipo | Descrição |
| Document | String | Número do documento de identificação da pessoa |
| DocumentType | String | Tipo de documento de identificação cdtCPF - CFP cdtCNPJ - CNPJ |
...
| PARÂMETRO | TIPO | TAMANHO | OBRIGATÓRIO | DESCRIÇÃO | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Identification | Object Json | Sim | Informações do tipo de identificação do cliente
| ||||||||||
| Name | String | 50 | Sim | Nome / Razão social | |||||||||
| String | 80 | Não | Email do cliente | ||||||||||
| Kind | String | Sim | Tipo de pessoa cktPhysical - Física | ||||||||||
| Taxpayer | String | Não | Contribuinte de ICMS yntYes - Sim | ||||||||||
| PublicAgency | String | Não | Órgão público yntYes - Sim | ||||||||||
| TaxRegime | Integer | 5 | Não | Regime de tributação | |||||||||
| GlobalLimit | Double | 9, 2 | Não | Valor limite global | |||||||||
| Deadline | Integer | 3 | Não | Prazo máximo em dias | |||||||||
| CreditStatus | String | Não | Situação do crédito ccsAlert - Alerta | ||||||||||
| Note | String | 250 | Não | Observação | |||||||||
| CardNumber | Integer | 15 | Não | Número do cartão | |||||||||
| BusinessSituation | String | Não | Situação comercial bstReleased - Liberado | ||||||||||
| KindAddress | String | Sim | Tipo do endereço katMain - Principal | ||||||||||
| PublicPlace | String | 60 | Sim | Descrição do logradouro | |||||||||
| PublicPlaceNumber | String | 10 | Não | Número do logradouro | |||||||||
| Neighbourhood | String | 50 | Sim | Descrição do bairro | |||||||||
| Complement | String | 60 | Não | Complemento de endereço | |||||||||
| City | String | 60 | Sim | Nome da cidade | |||||||||
| FederativeUnit | String | 2 | Sim | Estado da cidade | |||||||||
| ZipCode | Integer | 8 | Sim | Cep sem formatação | |||||||||
| IBGE | Integer | 12 | Não | Código da cidade no IBGE |
...