Objetivo
Permitir que o parceiro envie dados do cliente para o PDV. Esta Essa operação ocorre nos eventos 'Identificar o cliente', 'Cadastrar pessoa' e também no de identificação do cliente no PDV e também durante o pagamento por convênio, caso o cliente não tenha sido identificado durante a compra. Por favor, siga a documentação de configuração de ambiente para mais detalhes.
Chamada
POST {url}
Informações da Requisição (Request Information)
...
Segurança
Se os parâmetros de autenticação estiver configurado será enviado no Header no formato Basic Auth ou Bearer Token, siga a documentação de configuração para selecionar o modelo de autenticação.
Parâmetros do Corpo (Body Parameters)
Document| Id | String | Identificador da requisição |
| version | Integer | Número |
do documento de identificação pessoaDocumentTypeString | Tipo de documento de identificação| Array object Json | Lista dos tipos de documento |
| identifications[0].document | String | Documentos |
| identifications[0].documentType | String | Tipos de documentos cdtIDInternal - Código interno; cdtCPF - CFP cdtCNPJ - CNPJ cdtIE - Inscrição estadual |
cdtIDForeign Identificador único Formatos de Requisição (Request Formats)
...
| Bloco de código |
|---|
|
{
"id":"{E20B519258966376-1CDBD0D3-4F9244CC-99C4BA9B-BB0F8CD700DB22065EC4619E}",
"version":1,
"identifications":[
{
"document":"12345678909",
"identificationdocumentType":"cdtCPF"
},
{
"document":"1111000000020",
"documentType":"cdtCPFcdtIDInternal"
}
]
} |
Informações para Resposta (Response Information)
Parâmetros do Corpo (Body Parameters)
| PARÂMETRO | TIPO | TAMANHO | OBRIGATÓRIO | DESCRIÇÃO |
|---|
IdentificationInformações do tipo de identificação do cliente
| Parâmetro | Tipo | Descrição |
| Document | String | Número do documento de
identificação da pessoa |
DocumentType | String | |
|---|
| id | string |
|
| Identificado único da resposta |
| version | Integer |
|
| Número da versão |
| person | Object Json |
True |
|
| Objeto json dos dados do cliente |
| person.documents | Array object Json |
|
| Lista de documentos |
| person.documents[0].document | String |
| Sim | Documento do cliente |
| person.documents[0].documentType |
|
|
| Tipo de documento do cliente |
Tipo de documento de identificação |
cdtIDInternal - Código internocdtCPF - CFP cdtCNPJ - CNPJ cdtIE - Inscrição estadual |
cdtIDForeign Identificador único True | Nome / Razão social | | Sim | Nome |
| person.Email | String | 80 | Não | Email do cliente |
| person.Kind | String |
True
| Sim | Tipo de pessoa cktPhysical - Física
cktLegal - Jurídica |
| person.Taxpayer | String |
False
| Não | Contribuinte de ICMS yntYes - Sim
yntNo - Não |
| person.PublicAgency | String |
False
| Não | Órgão público yntYes - Sim
yntNo - Não |
| TaxRegime | Integer | 5 | False | Regime de tributação |
GlobalLimit| person.customer | Object json |
|
| Objeto json dos dados do cliente |
| person.customerGlobalLimit | Double | 9, 2 |
False| Não | Valor limite global |
| person.customer.Deadline | Integer | 3 |
False| Não | Prazo máximo em dias |
| person.customer.CreditStatus | String |
False
| Não | Situação do crédito ccsAlert - Alerta
ccsReleased - Liberado
ccsBlocked - Bloqueado
ccsSuspended - Suspenso |
| person.customer.Note | String | 250 |
False| Não | Observação |
| person.customer.CardNumber | Integer | 15 |
False| Não | Número do cartão |
| person.customer.BusinessSituation | String |
False
| Não | Situação comercial bstReleased - Liberado
bstBlocked - Bloqueado |
| person.addresses | Object json |
|
| Objeto json com os dados de endereço |
| person.addresses[0].KindAddress | String |
True
| Sim | Tipo do endereço katMain - Principal
katCharge - Cobrança
katDelivery - Entrega
katCorrespondence - Correspondência
katPickUp - Retirada |
| person.addresses[0].PublicPlace | String | 60 |
True| Sim | Descrição do logradouro |
| person.addresses[0].PublicPlaceNumber | String | 10 |
False| Não | Número do logradouro |
| person.addresses[0].Neighbourhood | String | 50 |
True| Sim | Descrição do bairro |
| person.addresses[0].Complement | String | 60 |
False| Não | Complemento de endereço |
| person.addresses[0].City | String | 60 |
True| Sim | Nome da cidade |
| person.addresses[0].FederativeUnit | String | 2 |
True| Sim | Estado da cidade |
| person.addresses[0].ZipCode | Integer | 8 |
True| Sim | Cep sem formatação |
| person.addresses[0].IBGE | Integer | 12 |
False| Não | Código da cidade no IBGE |
Formatos de Resposta (Response Formats)
...
| Bloco de código |
|---|
|
{
"id": "527dd979-6f51-4046-a6a7-a8e20c4a6a54",
"version": 1,
"person": {
"identificationdocuments":[
{
"document":"1234567890991347879846",
"documentType":"cdtCPF"
},
{
"document":"253716652",
"documentType":"cdtRG"
}
],
"Name": "NOME SOBRENOME2Edson Luan Bernardo Nogueira",
"kind": "cktPhysical",
"addresses": [
{
"kindAddress": "katMain",
"publicPlace": "RUARua 00Baiacu",
"publicPlaceNumber": "123482",
"neighbourhood": "JARDRIM TESTEEldorado",
"complement": "",
"city": "CIDADE TESTEDiadema",
"federativeUnit": "SP",
"zipCode": "1234480914065540",
"iBGE": 1234
}
]
}
} |
application/json
...
| Bloco de código |
|---|
|
{
"id": "527dd979-6f51-4046-a6a7-a8e20c4a6a54",
"version": 1,
"person": {
"identificationdocuments":[
{
"document":"1234567890991347879846",
"documentType":"cdtCPF"
},
{
"document":"253716652",
"documentType":"cdtRG"
}
],
"Name":"NOME SOBRENOME2 "Antonio Arthur João da Mota",
"email":"[email protected]",
"kind":"cktPhysical",
"taxpayer":"yntYesyntNo",
"publicAgency":"yntYesyntNo",
"customer":{
"globalLimit":0,
"deadline":0,
"creditStatus":"ccsAlertccsReleased",
"note":"",
"cardNumber":0,
"businessSituation":"bstReleased"
},
"addresses": [
{
"kindAddress": "katMain",
"publicPlace":"RUA 00 "Rua Nestor Ferreira da Rocha",
"publicPlaceNumber": "123368",
"neighbourhood": "JARDRIMVila Iolanda TESTEII",
"complement": "",
"city": "CIDADESão TESTEPaulo",
"federativeUnit": "SP",
"zipCode": "1234480908473400",
"iBGE": 1234
}
]
}
} |