| 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": "1596226820548",
"Payment": {
"SubordinatedMerchantId" : "SubordinatedMerchantId",
"Type": "PhysicalCreditCard",
"SoftDescriptor": "Description",
"PaymentDateTime": "2019-04-15T12:00:00Z",
"Amount": 15798,
"Installments": 1,
"Interest": "ByMerchant",
"Capture": true,
"ProductId": 1,
"CreditCard": {
"ExpirationDate": "12/2020",
"BrandId": 1,
"IssuerId": 2,
"InputMode": "Emv",
"AuthenticationMethod": "OnlineAuthentication",
"TrackTwoData": "0123456789012345=012345678901234",
"EmvData": "112233445566778899011AABBC012D3456789E0123FF45678AB901234C5D112233445566778800",
"PinBlock": {
"EncryptedPinBlock": "2280F6BDFD0C038D",
"EncryptionType": "Dukpt3Des",
"KsnIdentification": "1231vg31fv231313123"
},
"PanSequenceNumber": 123,
"SaveCard": false,
"IsFallback": false
},
"PinPadInformation": {
"TerminalId": "10000001",
"SerialNumber": "ABC123",
"PhysicalCharacteristics": "PinPadWithChipReaderWithSamModule",
"ReturnDataInfo": "00",
"TechnicalParameter": {
"KernelEmvVersion": "v653",
"ContactlessModuleVersion": "v553",
"KernelPayPassVersion": "553",
"KernelContactlessPayWaveVersion": "553",
"HardwareModel": "S920",
"ManufacturerName": "PAX",
"FirmwareVersion": "2.4.149",
"BasicLibVersion": "001.41 200617",
"SpecificationVersion": "1.08",
"AcquirerVersion": "001.41 200617",
"SimCardNumber": "123",
"PaymentAppVersion": "123",
"PrintedLines": 99
}
}
}
}| 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.SubordinatedMerchantId | String | — | Sim | Código identificador da loja. |
| Payment.Type | String | — | Sim | Value: PhysicalCreditCard / Tipo da Transação |
| Payment.SoftDescriptor | String | 13 | — | 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) | — | 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 | Deault: 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 | — | — | Default: ByMerchant Enum: ByMerchant ByIssuer Tipo de Parcelamento: - Se o bit 6 do atributo confParamOp05, presente nas tabelas issuerTable e binTable e bit 6 do atributo confParamOp03 da tabela productTable estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se o bit 7 do atributo confParamOp05, presente nas tabelas issuerTable e binTable e bit 7 do atributo confParamOp03 da tabela productTable 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. |
| 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. |
| CreditCard.BrandId | Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. |
| CreditCard.IssuerId | Integer | — | Sim | Código do emissor obtido através do campo IssuerId no objeto BinEntry da baixa de parametros. |
| CreditCard.InputMode | String | — | Sim | Enum: Typed MagStripe Emv 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. |
| 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 bit 3 do atributo confParamOp04 das tabelas binTable, parameterTable e issuerTable. 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 bit 3 do atributo confParamOp04 das tabelas binTable, parameterTable e issuerTable. Se todos estiverem habilitados, deve ser verificado o bit 2 do mesmo campo. Se este estiver com valor 1 deve ser capturada a senha. Se estiver com valor 0 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”. |
| CreditCard.EmvData | String | — | — | O conteúdo de tags enviado no EMVData deve corresponder ao conjunto indicado no TagsFirst na tabela de EMV. Dados obtidos através do comando PP_GoOnChip na BC |
| CreditCard.PinBlock.EncryptedPinBlock | String | — | Sim | PINBlock Criptografado - Para transações EMV, esse campo é obtido através do retorno da função PP_GoOnChip(), mais especificamente das posições 007 até a posição 022; - Para transações digitadas e com tarja magnética, verificar as posições 001 até 016 do retorno da função PP_GetPin(). |
| CreditCard.PinBlock.EncryptionType | String | — | Sim | Tipo de Criptografia Enum: “DukptDes” “Dukpt3Des” “MasterKey” |
| CreditCard.PinBlock.KsnIdentification | String | — | Sim | Identificação do KSN - Para transações EMV esse campo é obtido através do retorno da função PP_GoOnChip() nas posições 023 até 042; - Para transações digitadas e com tarja magnética, verificar as posições 017 até 036 do retorno da função PP_GetPin(). |
| CreditCard.PanSequenceNumber | Number | — | — | Número sequencial do cartão, utilizado para identificar a conta corrente do cartão adicional. Mandatório para transações com cartões Chip EMV e que possuam PAN Sequence Number (Tag 5F34). |
| CreditCard.SaveCard | Booleano | — | — | Identifica se vai salvar/tokenizar o cartão. |
| CreditCard.IsFallback | Booleano | — | — | Identifica se é uma transação de fallback. |
| PinPadInformation.TerminalId | String | — | Sim | Número Lógico definido no Concentrador Cielo. |
| PinPadInformation.SerialNumber | String | 20 | Sim | Número de Série do Equipamento. |
| 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. |
| PinPadInformation.ReturnDataInfo | String | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada |
| PinPadInformation.TechnicalParameter | Object | — | Não | Objeto com os parametros da baixa tecnica |
| PinPadInformation.TechnicalParameter.KernelEmvVersion | String | — | Sim | Versão kernel EMV com contato |
| PinPadInformation.TechnicalParameter.ContactlessModuleVersion | String | — | Sim | Versão kernel EMV contactless |
| PinPadInformation.TechnicalParameter.KernelPayPassVersion | String | — | Sim | Versão kernel contactless Mastercard PayPass / MCL |
| PinPadInformation.TechnicalParameter.KernelContactlessPayWaveVersion | String | — | Sim | Versão kernel contactless Visa PayWave |
| PinPadInformation.TechnicalParameter.HardwareModel | String | — | Sim | Modelo do pinpad |
| PinPadInformation.TechnicalParameter.ManufacturerName | String | — | Sim | Nome do fabricante do pinpad |
| PinPadInformation.TechnicalParameter.FirmwareVersion | String | — | Sim | Versão do firmware |
| PinPadInformation.TechnicalParameter.BasicLibVersion | String | — | Sim | versão da aplicação básica |
| PinPadInformation.TechnicalParameter.SpecificationVersion | String | — | Sim | Versão da especificação |
| PinPadInformation.TechnicalParameter.AcquirerVersion | String | — | Sim | Versão da rede adquirente |
Resposta
{
"MerchantOrderId": "20180204",
"Customer": {
"Name": "Comprador crédito completo"
},
"Payment": {
"Installments": 1,
"Interest": "ByMerchant",
"Capture": true,
"CreditCard": {
"ExpirationDate": "12/2020",
"BrandId": 1,
"IssuerId": 2,
"TruncateCardNumberWhenPrinting": true,
"InputMode": "Emv",
"AuthenticationMethod": "OnlineAuthentication",
"EmvData": "112233445566778899011AABBC012D3456789E0123FF45678AB901234C5D112233445566778800",
"PinBlock": {
"EncryptedPinBlock": "2280F6BDFD0C038D",
"EncryptionType": "Dukpt3Des",
"KsnIdentification": "1231vg31fv231313123"
},
"PanSequenceNumber": 123,
"SaveCard": false,
"IsFallback": false
},
"PaymentDateTime": "2019-04-15T12:00:00Z",
"ServiceTaxAmount": 0,
"SoftDescriptor": "Description",
"ProductId": 1,
"PinPadInformation": {
"TerminalId": "10000001",
"SerialNumber": "ABC123",
"PhysicalCharacteristics": "PinPadWithChipReaderWithSamModule",
"ReturnDataInfo": "00",
"TechnicalParameter": {
"KernelEmvVersion": "v653",
"ContactlessModuleVersion": "v553",
"KernelPayPassVersion": "553",
"KernelContactlessPayWaveVersion": "553",
"HardwareModel": "S920",
"ManufacturerName": "PAX",
"FirmwareVersion": "2.4.149",
"BasicLibVersion": "001.41 200617",
"SpecificationVersion": "1.08",
"AcquirerVersion": "001.41 200617",
"SimCardNumber": "123",
"PaymentAppVersion": "123",
"PrintedLines": 99
}
},
"Amount": 15798,
"ReceivedDate": "2019-04-15T12:00:00Z",
"CapturedAmount": 15798,
"Provider": "Cielo",
"ConfirmationStatus": 0,
"InitializationVersion": 1558708320029,
"EmvResponseData": "123456789ABCD1345DEA",
"Status": 2,
"IsSplitted": false,
"ReturnCode": 0,
"ReturnMessage": "Successful",
"PaymentId": "f15889ea-5719-4e1a-a2da-f4e50d5bd702",
"Type": "PhysicalDebitCard",
"Currency": "BRL",
"Country": "BRA",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://api.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702"
},
{
"Method": "DELETE",
"Rel": "self",
"Href": "https://api.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702"
},
{
"Method": "PUT",
"Rel": "self",
"Href": "https://api.cieloecommerce.cielo.com.br/1/physicalSales/f15889ea-5719-4e1a-a2da-f4e50d5bd702/confirmation"
}
],
"PrintMessage": [
{
"Position": "Top",
"Message": "Transação autorizada"
},
{
"Position": "Middle",
"Message": "Informação adicional"
},
{
"Position": "Bottom",
"Message": "Obrigado e volte sempre!"
}
],
"ReceiptInformation": [
{
"Field": "MERCHANT_NAME",
"Label": "NOME DO ESTABELECIMENTO",
"Content": "Estabelecimento"
},
{
"Field": "MERCHANT_ADDRESS",
"Label": "ENDEREÇO DO ESTABELECIMENTO",
"Content": "Rua Sem Saida, 0"
},
{
"Field": "MERCHANT_CITY",
"Label": "CIDADE DO ESTABELECIMENTO",
"Content": "Cidade"
},
{
"Field": "MERCHANT_STATE",
"Label": "ESTADO DO ESTABELECIMENTO",
"Content": "WA"
},
{
"Field": "MERCHANT_CODE",
"Label": "COD.ESTAB.",
"Content": 1234567890123456
},
{
"Field": "TERMINAL",
"Label": "POS",
"Content": 12345678
},
{
"Field": "NSU",
"Label": "DOC",
"Content": 123456
},
{
"Field": "DATE",
"Label": "DATA",
"Content": "01/01/20"
},
{
"Field": "HOUR",
"Label": "HORA",
"Content": "01:01"
},
{
"Field": "ISSUER_NAME",
"Label": "EMISSOR",
"Content": "NOME DO EMISSOR"
},
{
"Field": "CARD_NUMBER",
"Label": "CARTÃO",
"Content": 5432123454321234
},
{
"Field": "TRANSACTION_TYPE",
"Label": "TIPO DE TRANSAÇÃO",
"Content": "VENDA A CREDITO"
},
{
"Field": "AUTHORIZATION_CODE",
"Label": "AUTORIZAÇÃO",
"Content": 123456
},
{
"Field": "TRANSACTION_MODE",
"Label": "MODO DA TRANSAÇÃO",
"Content": "ONL"
},
{
"Field": "INPUT_METHOD",
"Label": "MODO DE ENTRADA",
"Content": "X"
},
{
"Field": "VALUE",
"Label": "VALOR",
"Content": "1,23"
},
{
"Field": "SOFT_DESCRIPTOR",
"Label": "SOFT DESCRIPTOR",
"Content": "Simulado"
}
],
"Receipt": {
"MerchantName": "Estabelecimento",
"MerchantAddress": "Rua Sem Saida, 0",
"MerchantCity": "Cidade",
"MerchantState": "WA",
"MerchantCode": 1234567890123456,
"Terminal": 12345678,
"Nsu": 123456,
"Date": "01/01/20",
"Hour": "01:01",
"IssuerName": "NOME DO EMISSOR",
"CardNumber": 5432123454321234,
"TransactionType": "VENDA A CREDITO",
"AuthorizationCode": 123456,
"TransactionMode": "ONL",
"InputMethod": "X",
"Value": "1,23",
"SoftDescriptor": "Simulado"
}
}
}| 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. | |
| 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 | |
| Address.Street | String | 255 | Não | Endereço de contato do comprador | |
| Address.Number | String | 15 | Não | Número do endereço de contato do comprador | |
| Address.Complement | String | 50 | Não | Complemento do endereço de contato do comprador | |
| Address.ZipCode | String | 9 | Não | CEP do endereço de entrega | |
| Address.City | String | 50 | Não | Cidade do endereço de entrega | |
| Address.State | String | 2 | Não |
| |
| Address.Country | String | 35 | Não | País do endereço de entrega | |
| 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,br> MaximumNumberOfInstallmentsWhenFinancingByStore,br> MinimumNumberOfInstallmentsWhenFinancingByStore da objeto ProductEntry da baixa de parametros. | |
| Payment.Interest | String | 10 | Não | Default: ByMerchant Enum: ByMerchant ByIssuer Tipo de Parcelamento: - Se o bit 6 do atributo confParamOp05, presente nas tabelas issuerTable e binTable e bit 6 do atributo confParamOp03 da tabela productTable estiverem todos habilitados indica que o tipo de parcelamento sem juros pode ser efetuado. - Se o bit 7 do atributo confParamOp05, presente nas tabelas issuerTable e binTable e bit 7 do atributo confParamOp03 da tabela productTable 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. | |
| 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. | |
| CreditCard.BrandId | Integer | — | Sim | Identificação da bandeira obtida através do campo BrandId da PRODUCT TABLE. | |
| CreditCard.IssuerId | Integer | — | Sim | Código do emissor obtido através do campo IssuerId no objeto BinEntry. | |
| 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. | |
| CreditCard.InputMode | String | — | Sim | Enum: Typed MagStripe Emv 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. | |
| 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 bit 3 do atributo confParamOp04 das tabelas binTable, parameterTable e issuerTable. 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 bit 3 do atributo confParamOp04 das tabelas binTable, parameterTable e issuerTable. Se todos estiverem habilitados, deve ser verificado o bit 2 do mesmo campo. Se este estiver com valor 1 deve ser capturada a senha. Se estiver com valor 0 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”. | |
| CreditCard.EmvData | String | — | Sim | O conteúdo de tags enviado no EMVData deve corresponder ao conjunto indicado no TagsFirst na tabela de EMV. Dados obtidos através do comando PP_GoOnChip na BC | |
| PinBlock.EncryptedPinBlock | String | — | Sim | PINBlock Criptografado - Para transações EMV, esse campo é obtido através do retorno da função PP_GoOnChip(), mais especificamente das posições 007 até a posição 022; - Para transações digitadas e com tarja magnética, verificar as posições 001 até 016 do retorno da função PP_GetPin(). | |
| CreditCard.PanSequenceNumber | Number | — | Sim | Número sequencial do cartão, utilizado para identificar a conta corrente do cartão adicional. Mandatório para transações com cartões Chip EMV e que possuam PAN Sequence Number (Tag 5F34). | |
| CreditCard.SaveCard | Booleano | — | Não | Identifica se vai salvar/tokenizar o cartão. | |
| CreditCard.IsFallback | Booleano | — | Não | Identifica se é uma transação de fallback. | |
| 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. | |
| PinPadInformation.TerminalId | String | 8 | Sim | Número Lógico definido no Concentrador Cielo. | |
| PinPadInformation.SerialNumber | String | 20 | Sim | Número de Série do Equipamento. | |
| 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. | |
| PinPadInformation.ReturnDataInfo | String | — | Sim | Retorno da função PP_GetInfo() da biblioteca compartilhada | |
| PinPadInformation.TechnicalParameter | Object | — | Não | Objeto com os parametros da baixa tecnica | |
| PinPadInformation.TechnicalParameter.KernelEmvVersion | String | — | Sim | Versão kernel EMV com contato | |
| PinPadInformation.TechnicalParameter.ContactlessModuleVersion | String | — | Sim | Versão kernel EMV contactless | |
| PinPadInformation.TechnicalParameter.KernelPayPassVersion | String | — | Sim | Versão kernel contactless Mastercard PayPass / MCL | |
| PinPadInformation.TechnicalParameter.KernelContactlessPayWaveVersion | String | — | Sim | Versão kernel contactless Visa PayWave | |
| PinPadInformation.TechnicalParameter.HardwareModel | String | — | Sim | Modelo do pinpad | |
| PinPadInformation.TechnicalParameter.ManufacturerName | String | — | Sim | Nome do fabricante do pinpad | |
| PinPadInformation.TechnicalParameter.FirmwareVersion | String | — | Sim | Versão do firmware | |
| PinPadInformation.TechnicalParameter.BasicLibVersion | String | — | Sim | versão da aplicação básica | |
| PinPadInformation.TechnicalParameter.SpecificationVersion | String | — | Sim | Versão da especificação | |
| PinPadInformation.TechnicalParameter.AcquirerVersion | String | — | Sim | Versão da rede adquirente | |
| 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.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 | |
| InitializationVersion | Integer | int16 | — | Sim | Número de versão dos parametros baixados na inicialização do equipamento. |
| Payment.EmvResponseData | String | — | Sim | Dados da transação EMV Obtidos através do comando PP_GoOnChip na BC | |
| 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.ReturnMessag | 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.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.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. | |
| RecurrentPayment.RecurrentPaymentId | String (Guid) | 36 | Não | ID que representa a recorrência, utilizada para consultas e alterações futuras. | |
| RecurrentPayment.ReasonCode | String | — | Não | Codigo de erro/resposta da recorrencia | |
| RecurrentPayment.ReasonMessage | String | — | Não | Mensagem de erro/resposta da recorrencia | |
| RecurrentPayment.NextRecurrency | String (Date) | 10 | Não | Data de quando acontecerá a próxima recorrência. Formato “YYYY-MM-DD” | |
| RecurrentPayment.EndDate | String | 10 | Não | Data para término da recorrência. | |
| RecurrentPayment.Interval | String | 10 | Não | Intervalo da recorrência. Não utilizar em conjunto com DailyInterval. Monthly (default) / Bimonthly / Quarterly / SemiAnnual Annual | |
| SplitPayments.SubordinateMerchantId | String (Guid) | 36 | Não | Identificador do Seller na Cielo. | |
| SplitPayments.Amount | Integer | 15 | Não | Total da venda do Seller específico. R$ 100,00 = 10000 | |
| SplitPayments.Fares.Mdr | Decimal | 3,2 | Não | Taxa aplicada pela loja Master sobre o Seller para desconto | |
| SplitPayments.Fares.Fee | Integer | 15 | Não | Tarifa aplicada pela loja Master sobre o Seller para desconto | |
| SplitErrors.Code | String | — | Não | Código de erro/resposta da transação do Split | |
| SplitErrors.Message | String | — | Não | Mensagem de erro/resposta da transação do Split |