| Ambiente | Método | Endpoint |
|---|---|---|
| Sandbox | POST | https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/ |
| Homologação | POST | https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/ |
| Produção | POST | https://api.cieloecommerce.cielo.com.br/1/physicalSales/ |
Requisição
{
"MerchantOrderId": "",
"Customer": {
"Name": "Comprador crédito completo",
"Identity": "11225468954",
"IdentityType": "CPF",
"Email": "[email protected]",
"Birthday": "1991-01-02",
"Address": {
"Street": "Rua Teste",
"Number": "123",
"Complement": "AP 123",
"ZipCode": "12345987",
"City": "São Paulo",
"State": "SP",
"Country": "BRA"
},
"DeliveryAddress": {
"Street": "Rua Teste",
"Number": "123",
"Complement": "AP 123",
"ZipCode": "12345987",
"City": "São Paulo",
"State": "SP",
"Country": "BRA"
}
},
"Payment": {
"SubordinatedMerchantId": "",
"Type": "PhysicalCreditCard",
"SoftDescriptor": "Teste",
"PaymentDateTime": "2024-06-03T15:22:30.370Z",
"Amount": 100,
"Installments": 1,
"Interest": "ByMerchant",
"Capture": true,
"ProductId": 1,
"CreditCard": {
"CardNumber": "EC9A221AC2E165A7",
"ExpirationDate": "12/2030",
"SecurityCodeStatus": "Collected",
"SecurityCode": "123",
"EncryptedCardData": {
"EncryptionType": "Dukpt3DesCBC",
"InitializationVector": "0000000000000000",
"CardNumberKSN": "FFFFF99995C1B4400004"
},
"BrandId": 1,
"IssuerId": 1511,
"InputMode": "Typed",
"AuthenticationMethod": "NoPassword",
"TruncateCardNumberWhenPrinting": true,
"SaveCard": true
},
"PinPadInformation": {
"PhysicalCharacteristics": "PinPadWithChipReaderWithoutSamAndContactless",
"ReturnDataInfo": "00",
"SerialNumber": "0820471929",
"TerminalId": "00000001"
}
}
}| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
|---|---|---|---|---|
| MerchantOrderId | String | 15 | Sim | Número utilizado para identificação da transação e que deve ser gerado pela aplicação integrada com o Conecta. Aceita apenas valores numéricos de 1 a 15 dígitos e não pode ser duplicado. |
| Customer.Name | String | 255 | Não | Nome do comprador |
| Customer.Identity | String | 14 | Não | Numero do cpf ou cnpj do cliente |
| Customer.IdentityType | String | 255 | Não | Tipo de documento de identificação do comprador (CPF ou CNPJ) |
| Customer.Email | String | 255 | Não | Email do comprador |
| Customer.Birthday | String | 10 | Não | Data de nascimento do comprador no formato AAAA-MM-DD |
| Customer.Address.Street | String | 255 | Não | Endereço de contato do comprador |
| Customer.Address.Number | String | 15 | Não | Número do endereço de contato do comprador |
| Customer.Address.Complement | String | 50 | Não | Complemento do endereço de contato do comprador |
| Customer.Address.ZipCode | String | 9 | Não | CEP do endereço de contato do comprador |
| Customer.Address.City | String | 50 | Não | Cidade do endereço de contato do comprador |
| Customer.Address.State | String | 2 | Não | Estado do endereço de contato do comprador |
| Customer.Address.Country | String | 35 | Não | País do endereço de contato do comprador |
| Customer.DeliveryAddress.Street | String | 255 | Não | Endereço de entrega do comprador |
| Customer.DeliveryAddress.Number | String | 15 | Não | Número do endereço de entrega |
| Customer.DeliveryAddress.Complement | String | 50 | Não | Complemento do endereço de entrega |
| Customer.DeliveryAddress.ZipCode | String | 9 | Não | CEP do endereço de entrega |
| Customer.DeliveryAddress.City | String | 50 | Não | Cidade do endereço de entrega |
| Customer.DeliveryAddress.State | String | 2 | Não | Estado do endereço de entrega |
| Customer.DeliveryAddress.Country | String | 35 | Não | País do endereço de entrega |
| Payment.SubordinatedMerchantId | String | — | Sim | Código identificador da loja. |
| Payment.Type | String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação |
| Payment.SoftDescriptor | String | 13 | Não | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
| Payment.PaymentDateTime | String | date-time | Sim | Data e Hora da captura da transação |
| Payment.Amount | Integer(int64) | 15 | Sim | Valor da transação (1079 = R$10,79) |
| Payment.Capture | Booleano | — | Não | Default: false / Booleano que identifica que a autorização deve ser com captura automática. A autorização sem captura automática é conhecida também como pré-autorização. |
| Payment.Installments | Integer | 2 | Sim | Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos MaximumNumberOfInstallmentsWhenFinancingByCreditCardCompany, MaximumNumberOfInstallmentsWhenFinancingByStore e MinimumNumberOfInstallmentsWhenFinancingByStore da objeto ProductEntry da baixa de parametros. |
| Payment.Interest | String | 10 | Não | Default: ByMerchant Enum: ByMerchant, ByIssuer Tipo de Parcelamento: - Se os campos AllowFinancingByStore presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se os campos AllowFinancingByCreditCardCompany presente nos objetos IssuerEntry, BinEntry e ProductEntry da baixa de parametros estiverem todos habilitados indica que o tipo de parcelamento com juros pode ser efetuado. Sem juros = “ByMerchant”; Com juros = “ByIssuer”. |
| Payment.ProductId | Integer | — | Sim | Código do produto identificado através do bin do cartão. |
| Payment.CreditCard.CardNumber | String | - | Sim | Número do cartão (PAN) criptografado |
| Payment.CreditCard.ExpirationDate | String | MM/yyyy | Sim | Data de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação. |
| Payment.CreditCard.SecurityCodeStatus | String | — | Sim | Enum: Collected Unreadable Nonexistent Status da coleta de código de segurança (CVV) |
| Payment.CreditCard.SecurityCode | String | 5 | Sim | Código de segurança (CVV) |
| Payment.CreditCard.BrandId | Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. |
| Payment.CreditCard.IssuerId | Integer | — | Sim | Código do emissor obtido através do campo IssuerId no objeto BinEntry da baixa de parametros. |
| Payment.CreditCard.InputMode | String | — | Sim | Enum: Typed, MagStripe, Emv, ContactlessEmv Identificação do modo de captura do cartão na transação. Essa informação deve ser obtida através do retorno da função PP_GetCard da BC. “00” – Magnético “01” - Moedeiro VISA Cash sobre TIBC v1 “02” - Moedeiro VISA Cash sobre TIBC v3 “03” – EMV com contato “04” - Easy-Entry sobre TIBC v1 “05” - Chip sem contato simulando tarja “06” - EMV sem contato. |
| Payment.CreditCard.AuthenticationMethod | String | — | Sim | Enum: NoPassword OnlineAuthentication OfflineAuthentication Método de autenticação - Se o cartão foi lido a partir da digitação verificar o campo RequiresPasswordExceptForEMVCard dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados, a senha deve ser capturada e o authenticationMethod assume valor 2. Caso contrário, assume valor 1; - Se o cartão foi lido a partir da trilha verificar o campo RequiresPassword dos objetos BinEntry, ParameterEntry e IssuerEntry da baixa de parametros. Se todos estiverem habilitados deve ser capturada a senha, se algum estiver desabilitado a captura da senha vai depender do último dígito do service code; - Se o cartão foi lido através do chip EMV, o authenticationMethod será preenchido com base no retorno da função PP_GoOnChip(). No resultado PP_GoOnChip(), onde se o campo da posição 003 do retorno da PP_GoOnChip() estiver com valor 1 indica que o pin foi validado off-line, o authenticationMethod será 3. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valor 0, o authenticationMethod será 1. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valores 0 e 1 respectivamente, o authenticationMethod será 2. 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”. |
| Payment.CreditCard.TruncateCardNumberWhenPrinting | Booleano | — | Não | Indica se o número do cartão será truncado no momento da impressão do comprovante. A solução de captura deve tomar essa decisão com base no campo AllowPrintingPartialCardNumberInReceipt presente nos objetos BinEntry, ParameterEntry e IssuerEntry. |
| Payment.CreditCard.SaveCard | Booleano | — | Não | Identifica se vai salvar/tokenizar o cartão. |
| Payment.CreditCard.EncryptedCardData.EncryptionType | String | — | Sim | Tipo de encriptação utilizada Enum: “DukptDes” = 1, “MasterKey” = 2, “Dukpt3Des” = 3, “Dukpt3DesCBC” = 4 |
| Payment.CreditCard.EncryptedCardData.CardNumberKSN | String | — | Sim | Identificador KSN da criptografia do número do cartão |
| Payment.CreditCard.EncryptedCardData.IsDataInTLVFormat | Bool | — | Não | Identifica se os dados criptografados estão no formato TLV (tag / length / value). |
| Payment.CreditCard.EncryptedCardData.InitializationVector | String | — | Sim | Vetor de inicialização da encriptação |
| Payment.CreditCard.IsFallback | Booleano | — | Não | Identifica se é uma transação de fallback. |
| Payment.PinPadInformation.TerminalId | String | 8 | Sim | Número Lógico definido no Concentrador Cielo. |
| Payment.PinPadInformation.SerialNumber | String | 20 | Sim | Número de Série do Equipamento. |
| Payment.PinPadInformation.PhysicalCharacteristics | String | — | Sim | Enum: WithoutPinPad, PinPadWithoutChipReader, PinPadWithChipReaderWithoutSamModule, PinPadWithChipReaderWithSamModule, NotCertifiedPinPad, PinPadWithChipReaderWithoutSamAndContactless, PinPadWithChipReaderWithSamModuleAndContactless Sem PIN-pad = WithoutPinPad; PIN-pad sem leitor de Chip = PinpadWithoutChipReader; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule; PIN-pad não homologado = NotCertifiedPinPad; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato = PinpadWithChipReaderWithSamAndContactless. Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
| Payment.PinPadInformation.ReturnDataInfo | String | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada |
Resposta
{
"MerchantOrderId": "1717438898453",
"Customer": {
"Name": "Comprador crédito completo",
"Identity": "11225468954",
"IdentityType": "CPF",
"Email": "[email protected]",
"Address": {
"Street": "Rua Teste",
"Number": "123",
"Complement": "AP 123",
"ZipCode": "12345987",
"City": "São Paulo",
"State": "SP",
"Country": "BRA"
},
"DeliveryAddress": {
"Street": "Rua Teste",
"Number": "123",
"Complement": "AP 123",
"ZipCode": "12345987",
"City": "São Paulo",
"State": "SP",
"Country": "BRA"
}
},
"Payment": {
"Installments": 1,
"Interest": "ByMerchant",
"Capture": true,
"CreditCard": {
"CardNumber": "EC9A221AC2E165A7",
"ExpirationDate": "12/2030",
"SecurityCodeStatus": "Collected",
"SecurityCode": "***",
"BrandId": 1,
"IssuerId": 1511,
"TruncateCardNumberWhenPrinting": true,
"InputMode": "Typed",
"AuthenticationMethod": "NoPassword",
"IsFallback": false,
"BrandInformation": {
"Type": "VENDA A CREDITO",
"Name": "VISA"
},
"SaveCard": true,
"CardToken": "b81c4d5a-877e-4bbe-af6f-476a9b0f1b95",
"EncryptedCardData": {
"EncryptionType": 4,
"CardNumberKSN": "FFFFF99995C1B4400004",
"InitializationVector": "0000000000000000",
"IsDataInTLVFormat": false
}
},
"Amount": 100,
"ReceivedDate": "2024-06-03T18:22:26Z",
"CapturedAmount": 100,
"CapturedDate": "2024-06-03T18:22:30Z",
"Provider": "Cielo",
"Status": 2,
"PhysicalTransactionStatus": 2,
"IsSplitted": false,
"ReturnMessage": "APROVADA 316736",
"ReturnCode": "000",
"PaymentId": "ac49c25b-3f08-4a88-9a7f-b9d88e4aea50",
"Type": "PhysicalCreditCard",
"Currency": "BRL",
"Country": "BRA",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/physicalSales/ac49c25b-3f08-4a88-9a7f-b9d88e4aea50"
},
{
"Method": "PUT",
"Rel": "confirm",
"Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/ac49c25b-3f08-4a88-9a7f-b9d88e4aea50/confirmation"
},
{
"Method": "DELETE",
"Rel": "reverse",
"Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/ac49c25b-3f08-4a88-9a7f-b9d88e4aea50"
}
],
"PaymentDateTime": "2024-06-03T15:22:30.370Z",
"ServiceTaxAmount": 0,
"SoftDescriptor": "Teste",
"ProductId": 1,
"PinPadInformation": {
"TerminalId": "00000001",
"SerialNumber": "0820471929",
"PhysicalCharacteristics": "PinPadWithChipReaderWithoutSamAndContactless",
"ReturnDataInfo": "00"
},
"PrintMessage": [],
"ReceiptInformation": [
{
"Field": "MERCHANT_NAME",
"Label": "NOME DO ESTABELECIMENTO",
"Content": "Feira ACBR"
},
{
"Field": "MERCHANT_ADDRESS",
"Label": "ENDEREÇO DO ESTABELECIMENTO",
"Content": "Alameda Xingu, 512"
},
{
"Field": "MERCHANT_CITY",
"Label": "CIDADE DO ESTABELECIMENTO",
"Content": "BARUERI"
},
{
"Field": "MERCHANT_STATE",
"Label": "ESTADO DO ESTABELECIMENTO",
"Content": "SP"
},
{
"Field": "MERCHANT_CODE",
"Label": "COD.ESTAB.",
"Content": "0010255016990001"
},
{
"Field": "TERMINAL",
"Label": "POS",
"Content": "42001001"
},
{
"Field": "NSU",
"Label": "DOC",
"Content": "322923"
},
{
"Field": "DATE",
"Label": "DATA",
"Content": "03/06/24"
},
{
"Field": "HOUR",
"Label": "HORA",
"Content": "15:22"
},
{
"Field": "ISSUER_NAME",
"Label": "EMISSOR",
"Content": "CIELO#VISA ELECTRON"
},
{
"Field": "CARD_NUMBER",
"Label": "CARTÃO",
"Content": "476173-0010"
},
{
"Field": "BRAND",
"Label": "BANDEIRA",
"Content": "VISA"
},
{
"Field": "TRANSACTION_TYPE",
"Label": "TIPO DE TRANSAÇÃO",
"Content": "VENDA A CREDITO"
},
{
"Field": "AUTHORIZATION_CODE",
"Label": "AUTORIZAÇÃO",
"Content": "950700"
},
{
"Field": "TRANSACTION_MODE",
"Label": "MODO DA TRANSAÇÃO",
"Content": "ONL"
},
{
"Field": "INPUT_METHOD",
"Label": "MODO DE ENTRADA",
"Content": "X"
},
{
"Field": "CPF_CNPJ",
"Label": "CPF OU CNPJ",
"Content": "24904219000183"
},
{
"Field": "VALUE",
"Label": "VALOR",
"Content": "1,00"
},
{
"Field": "SOFT_DESCRIPTOR",
"Label": "SOFT DESCRIPTOR",
"Content": "Teste"
}
],
"Receipt": {
"MerchantName": "Feira ACBR",
"MerchantAddress": "Alameda Xingu, 512",
"MerchantCity": "BARUERI",
"MerchantState": "SP",
"MerchantCode": "0010255016990001",
"Terminal": "42001001",
"Nsu": "322923",
"Date": "03/06/24",
"Hour": "15:22",
"IssuerName": "CIELO#VISA ELECTRON",
"CardNumber": "476173-0010",
"Brand": "VISA",
"TransactionType": "VENDA A CREDITO",
"AuthorizationCode": "950700",
"TransactionMode": "ONL",
"InputMethod": "X",
"CpfCnpj": "24904219000183",
"Value": "1,00",
"SoftDescriptor": "Teste"
},
"AuthorizationCode": "950700",
"ProofOfSale": "322923",
"InitializationVersion": 1711483206145,
"ConfirmationStatus": 0,
"SubordinatedMerchantId": "ddb891bf-73ae-41b0-8d37-380a9902438c",
"OfflinePaymentType": "Online",
"MerchantAcquirerId": "0010255016990001",
"TerminalAcquirerId": "42001001"
}
}| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
|---|---|---|---|---|
| MerchantOrderId | String | 15 | Sim | Número utilizado para identificação da transação e que deve ser gerado pela aplicação integrada com o Conecta. Aceita apenas valores numéricos de 1 a 15 dígitos e não pode ser duplicado. Caso não seja informada uma data via parâmetro (opcional), o sistema irá considerar automaticamente a data atual. |
| Payment.Installments | Integer | 2 | Sim | Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos MaximumNumberOfInstallmentsWhenFinancingByCreditCardCompany, MaximumNumberOfInstallmentsWhenFinancingByStore e MinimumNumberOfInstallmentsWhenFinancingByStore da objeto ProductEntry da baixa de parametros. |
| Payment.Interest | String | 10 | Não | Default: ByMerchant Enum: ByMerchant ByIssuer Tipo de Parcelamento: - Se os campos AllowFinancingByStore presente nos objetos IssuerEntry, BinEntry e ProductEntry estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se os campos AllowFinancingByCreditCardCompany presente nos objetos IssuerEntry, BinEntry e ProductEntry estiverem todos habilitados indica que o tipo de parcelamento com juros pode ser efetuado. Sem juros = “ByMerchant”; Com juros = “ByIssuer”. |
| Payment.Capture | Booleano | — | Não | Default: false / Booleano que identifica que a autorização deve ser com captura automática. A autorização sem captura automática é conhecida também como pré-autorização. |
| Payment.PaymentDateTime | String | date-time | Sim | Data e Hora da captura da transação |
| Payment.ServiceTaxAmount | Integer | 15 | Não | Aplicável apenas para empresas aéreas. Montante do valor da autorização que deve ser destinado à taxa de serviço. Obs.: Esse valor não é adicionado ao valor da autorização. |
| Payment.SoftDescriptor | String | 13 | Não | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
| Payment.ProductId | Integer | — | Sim | Código do produto identificado através do bin do cartão. |
| Payment.Amount | Integer(int64) | — | Sim | Valor da transação (1079 = R$10,79) |
| Payment.ReceivedDate | String (DateTime) | — | Sim | Data em que a transação foi recebida. Formato “AAAA-MM-DD HH:mm:SS” |
| Payment.CapturedAmount | Integer | 15 | Sim | Valor capturado, sem pontuação. 100 equivale a R$ 1,00 |
| Payment.CapturedDate | String (DateTime) | — | Não | Data da captura |
| Payment.Provider | String | 15 | Sim | Nome do provedor do meio de pagamento |
| Payment.ConfirmationStatus | Integer | 2 | Não | Status da confirmação. 0 = Pendente 1 = Confirmado 2 = Desfeito |
| Payment.InitializationVersion | Integer int16 | — | Sim | Número de versão dos parametros baixados na inicialização do equipamento. |
| Payment.Status | Integer | 2 | Sim | Status da transação 0 = Não Finalizado 1 = Autorizado 2 = Pago 3 = Negado 10 = Cancelado 13 = Abortado |
| Payment.IsSplitted | Booleano | — | Não | Indica se o pagamento tem split ou não. Default: false |
| Payment.ReturnCode | String | 3 | Sim | Código de erro/resposta da transação da Adquirência. |
| Payment.ReturnMessage | String | — | Sim | Mensagem de erro/resposta da transação da Adquirência. |
| Payment.PaymentId | String (Guid) | 36 | Sim | Código do Pagamento |
| Payment.Type | String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação |
| Payment.Currency | String | 3 | Não | Default: “BRL” / Value: “BRL” / Moeda (Preencher com “BRL”) |
| Payment.Country | String | 3 | Não | Default: “BRA” / Value: “BRA” / País (Preencher com “BRA”) |
| Payment.CreditCard.CardNumber | String | – | Sim | Número do cartão (PAN) criptografado |
| Payment.CreditCard.ExpirationDate | String | MM/yyyy | Sim | Data de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação. |
| Payment.CreditCard.SecurityCodeStatus | String | — | Sim | Enum: Collected Unreadable Nonexistent Status da coleta de código de segurança (CVV) |
| Payment.CreditCard.SecurityCode | String | 5 | Sim | retorno com valor mascarado |
| Payment.CreditCard.BrandId | Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. |
| Payment.CreditCard.IssuerId | Integer | — | Sim | Código do emissor obtido através do campo IssuerId no objeto BinEntry. |
| Payment.CreditCard.TruncateCardNumberWhenPrinting | Booleano | — | Não | Indica se o número do cartão será truncado no momento da impressão do comprovante. A solução de captura deve tomar essa decisão com base no campo AllowPrintingPartialCardNumberInReceipt presente nos objetos BinEntry, ParameterEntry e IssuerEntry. |
| Payment.CreditCard.InputMode | String | — | Sim | Enum: Typed, MagStripe, Emv, ContactlessEmv Identificação do modo de captura do cartão na transação. Essa informação deve ser obtida através do retorno da função PP_GetCard da BC. “00” – Magnético “01” - Moedeiro VISA Cash sobre TIBC v1 “02” - Moedeiro VISA Cash sobre TIBC v3 “03” – EMV com contato “04” - Easy-Entry sobre TIBC v1 “05” - Chip sem contato simulando tarja “06” - EMV sem contato. |
| Payment.CreditCard.AuthenticationMethod | String | — | Sim | Enum: NoPassword, OnlineAuthentication, OfflineAuthentication Método de autenticação - Se o cartão foi lido a partir da digitação verificar o campo RequiresPasswordExceptForEMVCard dos objetos BinEntry, ParameterEntry e IssuerEntry. Se todos estiverem habilitados, a senha deve ser capturada e o authenticationMethod assume valor 2. Caso contrário, assume valor 1; - Se o cartão foi lido a partir da trilha verificar o campo RequiresPassword dos objetos BinEntry, ParameterEntry e IssuerEntry. Se todos estiverem habilitados deve ser capturada a senha, se algum estiver desabilitado a captura da senha vai depender do último dígito do service code; - Se o cartão foi lido através do chip EMV, o authenticationMethod será preenchido com base no retorno da função PP_GoOnChip(). No resultado PP_GoOnChip(), onde se o campo da posição 003 do retorno da PP_GoOnChip() estiver com valor 1 indica que o pin foi validado off-line, o authenticationMethod será 3. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valor 0, o authenticationMethod será 1. Se o campo da posição 003 e o campo da posição 006 do retorno da PP_GoOnChip() estiverem com valores 0 e 1 respectivamente, o authenticationMethod será 2. 1 - Sem senha = “NoPassword”; 2 - Senha online = “Online Authentication”; 3 - Senha off-line = “Offline Authentication”. |
| Payment.CreditCard.BrandInformation.Type | String | _ | Não | Tipo de venda. |
| Payment.CreditCard.BrandInformation.Name | String | — | Não | Nome da bandeira do cartão. |
| Payment.CreditCard.SaveCard | Booleano | — | Não | Identifica se vai salvar/tokenizar o cartão |
| Payment.CreditCard.CardToken | String(Guid) | 36 | Não | Dados do Cartão tokenizado |
| Payment.CreditCard.EncryptedCardData.EncryptionType | String | — | Sim | Tipo de encriptação utilizada Enum: “DukptDes” = 1, “MasterKey” = 2, “Dukpt3Des” = 3, “Dukpt3DesCBC” = 4 |
| Payment.CreditCard.EncryptedCardData.CardNumberKSN | String | — | Sim | Identificador KSN da criptografia do número do cartão |
| Payment.CreditCard.EncryptedCardData.IsDataInTLVFormat | Bool | — | Não | Identifica se os dados criptografados estão no formato TLV (tag / length / value). |
| Payment.CreditCard.EncryptedCardData.InitializationVector | String | — | Sim | Vetor de inicialização da encriptação |
| Payment.CreditCard.IsFallback | Booleano | — | Não | Identifica se é uma transação de fallback. |
| Payment.PinPadInformation.TerminalId | String | 8 | Sim | Número Lógico definido no Concentrador Cielo. |
| Payment.PinPadInformation.SerialNumber | String | 20 | Sim | Número de Série do Equipamento. |
| Payment.PinPadInformation.PhysicalCharacteristics | String | — | Sim | Enum: WithoutPinPad PinPadWithoutChipReader PinPadWithChipReaderWithoutSamModule PinPadWithChipReaderWithSamModule NotCertifiedPinPad PinPadWithChipReaderWithoutSamAndContactless PinPadWithChipReaderWithSamModuleAndContactless Sem PIN-pad = WithoutPinPad; PIN-pad sem leitor de Chip = PinpadWithoutChipReader; PIN-pad com leitor de Chip sem módulo SAM = PinPadWithChipReaderWithoutSamModule; PIN-pad com leitor de Chip com módulo SAM = PinPadWithChipReaderWithSamModule; PIN-pad não homologado = NotCertifiedPinPad; PIN-pad com leitor de Chip sem SAM e Cartão Sem Contato = PinpadWithChipReaderWithoutSamAndContactless; PIN-pad com leitor de Chip com SAM e Cartão Sem Contato = PinpadWithChipReaderWithSamModuleAndContactless. Obs. Caso a aplicação não consiga informar os dados acima, deve obter tais informações através do retorno da função PP_GetInfo() da BC. |
| Payment.PinPadInformation.ReturnDataInfo | String | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada |
| Payment.Receipt.MerchantName | String | 255 | Sim | Nome da loja |
| Payment.Receipt.MerchantAddress | String | 255 | Sim | Endereço da loja |
| Payment.Receipt.MerchantCity | String | 255 | Sim | Cidade da loja |
| Payment.Receipt.MerchantState | String | 2 | Sim | Estado da loja |
| Payment.Receipt.MerchantCode | String | 16 | Sim | Codigo de identificação da loja |
| Payment.Receipt.Terminal | String | 8 | Sim | Identificação do Terminal |
| Payment.Receipt.Nsu | String | 6 | Sim | Numero de identificação da transação Cielo |
| Payment.Receipt.Date | String | dd/MM/yy | Sim | Data da transação |
| Payment.Receipt.Hour | String | HH:mm | Sim | Horario da transação |
| Payment.Receipt.IssuerName | String | 255 | Sim | Nome do emissor obtido através do campo IssuerId no objeto BinEntry. |
| Payment.Receipt.CardNumber | String | — | Sim | Número do cartão |
| Payment.Receipt.CardHolder | String | 255 | Não | Nome do titular do cartão. |
| Payment.Receipt.CardNumber | String | 19 | Sim | Número do cartão |
| Payment.Receipt.Brand | String | 255 | Sim | Bandeira do cartão |
| Payment.Receipt.TransactionType | String | 255 | Sim | Tipo de transação |
| Payment.Receipt.AuthorizationCode | String | 6 | Sim | Código da autorização |
| Payment.Receipt.TransactionMode | String | 3 | Sim | Modo da transação |
| Payment.Receipt.InputMethod | String | 1 | Sim | Metodo de entrada |
| Payment.Receipt.Value | String | 15 | Sim | Valor do pagamento |
| Payment.Receipt.SoftDescriptor | String | 13 | Não | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
| Payment.Links | Array[Object] | - | Não | links de navegação. |
| Payment.Links.Method | String | - | Sim | Metodo do link de navegação. |
| Payment.Links.Rel | String | - | Sim | Links de retorno para navegação. |
| Payment.Links.Href | String | - | Sim | Endereço do links de navegação. |
| Payment.PrintMessage | Array[Object] | - | Não | Dados para impressão. |
| Payment.PrintMessage.Position | String | - | Sim | Posição para impressão. |
| Payment.PrintMessage.Message | String | - | Sim | Mensagem para impressão. |
| Payment.ReceiptInformation | Array[Object] | - | Não | Dados do recibo. |
| Payment.ReceiptInformation.Field | String | - | Sim | Nome do campo do recibo. |
| Payment.ReceiptInformation.Label | String | - | Sim | Titulo do campo do recibo. |
| Payment.ReceiptInformation.Content | String | - | Sim | conteúdo do campo do recibo. |
| Customer.Name | String | 255 | Não | Nome do comprador |
| Customer.Identity | String | 14 | Não | Numero do cpf ou cnpj do cliente |
| Customer.IdentityType | String | 255 | Não | Tipo de documento de identificação do comprador (CPF ou CNPJ) |
| Customer.Email | String | 255 | Não | Email do comprador |
| Customer.Birthday | String | 10 | Não | Data de nascimento do comprador no formato AAAA-MM-DD |
| Customer.Address.Street | String | 255 | Não | Endereço de contato do comprador |
| Customer.Address.Number | String | 15 | Não | Número do endereço de contato do comprador |
| Customer.Address.Complement | String | 50 | Não | Complemento do endereço de contato do comprador |
| Customer.Address.ZipCode | String | 9 | Não | CEP do endereço de contato do comprador |
| Customer.Address.City | String | 50 | Não | Cidade do endereço de contato do comprador |
| Customer.Address.State | String | 2 | Não | Estado do endereço de contato do comprador |
| Customer.Address.Country | String | 35 | Não | País do endereço de contato do comprador |
| Customer.DeliveryAddress.Street | String | 255 | Não | Endereço de entrega do comprador |
| Customer.DeliveryAddress.Number | String | 15 | Não | Número do endereço de entrega |
| Customer.DeliveryAddress.Complement | String | 50 | Não | Complemento do endereço de entrega |
| Customer.DeliveryAddress.ZipCode | String | 9 | Não | CEP do endereço de entrega |
| Customer.DeliveryAddress.City | String | 50 | Não | Cidade do endereço de entrega |
| Customer.DeliveryAddress.State | String | 2 | Não | Estado do endereço de entrega |
| Customer.DeliveryAddress.Country | String | 35 | Não | País do endereço de entrega |