Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

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.

Chamada

POST {url}

Informações da Requisição (Request Information)

Parâmetros

...

Não há.

Parâmetros do Corpo (Body Parameters)

ParâmetroTipoDescrição
DocumentStringNúmero do documento de identificação da pessoa
DocumentTypeString

Tipo de documento de identificação

cdtIDInternal - Código interno

cdtCPF - CFP

cdtCNPJ - CNPJ

cdtIDForeign

A seguir exemplos de como executar esta operação.

O campo para identificação do cliente,Identification, contém os seguintes campos : 

...

Formatos de Requisição (Request Formats)

application/json

Exemplo (Sample)

Bloco de código
languageactionscript3
{
   "id":"{E20B5192-1CDB-4F92-99C4-BB0F8CD700DB}",
   "version":1,
   "identification":{
      "document":"111",
      "documentType":"cdtCPF"
   }
}


Informações para Resposta (Response Information)


PARÂMETROTIPOTAMANHOOBRIGATÓRIODESCRIÇÃO
IdentificationArray of objects
true

Informações para identificação da pessoa

ParâmetroTipoDescrição
DocumentStringNúmero do documento de
identificação da pessoa
DocumentTypeStringTipo de documento de
identificação
CorporateNameString50trueNome / Razão social
FantasyNameString 50trueApelido / Nome fantasia
KindString
true

Tipo de pessoa

cktPhysical - Física 
cktLegal - Jurídica

TaxpayerString
true

Contribuinte de ICMS

yntYes - Sim
yntNo - Não

PublicAgencyString
true

Órgão público

yntYes - Sim
yntNo - Não

TaxRegimeInteger5falseRegime de tributação
GlobalLimitDouble(9, 2)falseValor limite global
DeadlineInteger3falsePrazo máximo em dias
CreditStatusString
true

Situação do crédito

ccsAlert - Alerta 
ccsReleased - Liberado
ccsBlocked - Bloqueado
ccsSuspended - Suspenso

NoteString250falseObservação
CardNumberInteger15falseNúmero do cartão
BusinessSituationString
true

Situação comercial

bstReleased - Liberado 
bstBlocked - Bloqueado

IdSegmentInteger3trueNúmero do segmento
PublicPlaceCodeInteger
trueCódigo do logradouro
KindAddressString
true

Tipo do endereço

katMain - Principal 
katCharge - Cobrança 
katDelivery - Entrega 
katCorrespondence - Correspondência 
katPickUp - Retirada

PublicPlaceString60trueDescrição do logradouro
PublicPlaceNumberString10falseNúmero do logradouro
NeighbourhoodString50trueDescrição do bairro
ComplementString60falseComplemento de endereço
CityString60trueNome da cidade
FederativeUnitString2trueEstado da cidade
ZipCodeInteger8trueCep
IBGEInteger12falseCódigo da cidade no IBGE

...