Permitir que o parceiro envie dados cliente para o PDV.
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}| 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 |
Exemplo (Sample)
{
"id":"{E20B5192-1CDB-4F92-99C4-BB0F8CD700DB}",
"version":1,
"identification":{
"document":"111",
"documentType":"cdtCPF"
}
} |
| 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 |
Exemplo simplificado (Sample)
{
"id": "527dd979-6f51-4046-a6a7-a8e20c4a6a54",
"version": 1,
"person": {
"documents":[
{
"document":"91347879846",
"documentType":"cdtCPF"
},
{
"document":"253716652",
"documentType":"cdtRG"
}
],
"Name": "Edson Luan Bernardo Nogueira",
"kind": "cktPhysical",
"addresses": [
{
"kindAddress": "katMain",
"publicPlace": "Rua Baiacu",
"publicPlaceNumber": "482",
"neighbourhood": "Eldorado",
"complement": "",
"city": "Diadema",
"federativeUnit": "SP",
"zipCode": "14065540",
"iBGE": 1234
}
]
}
} |
Exemplo completo (Sample)
{
"id": "527dd979-6f51-4046-a6a7-a8e20c4a6a54",
"version": 1,
"person": {
"documents":[
{
"document":"91347879846",
"documentType":"cdtCPF"
},
{
"document":"253716652",
"documentType":"cdtRG"
}
],
"Name": "Antonio Arthur João da Mota",
"email":"[email protected]",
"kind":"cktPhysical",
"taxpayer":"yntNo",
"publicAgency":"yntNo",
"customer":{
"globalLimit":0,
"deadline":0,
"creditStatus":"ccsReleased",
"note":"",
"cardNumber":0,
"businessSituation":"bstReleased"
},
"addresses": [
{
"kindAddress": "katMain",
"publicPlace": "Rua Nestor Ferreira da Rocha",
"publicPlaceNumber": "368",
"neighbourhood": "Vila Iolanda II",
"complement": "",
"city": "São Paulo",
"federativeUnit": "SP",
"zipCode": "08473400",
"iBGE": 1234
}
]
}
} |