| 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/ |
Para operação de Subadquirente é obrigatório o envio dos dados indicados no objeto
PaymentFacilitator.
Requisição
{
"MerchantOrderId": "{merchantOrderId}",
"Payment": {
"SubordinatedMerchantId": "{LojaSubordinada}",
"Installments": 1,
"SoftDescriptor": "Chip",
"CreditCard": {
"ExpirationDate": "12/2030",
"BrandId": 1,
"IssuerId": 1010,
"InputMode": "Emv",
"AuthenticationMethod": "OnlineAuthentication",
"TrackTwoData": "A3CE8E13D475CE75BE954B53C804265E6F07202158933F5B",
"EmvData": "9F02060000000001009F1A020076950542C00000005F2A0209869A0321100482025C009F360200019F100706011A039000009F260894A26A9922DE03EC9F2701005F3401018407A0000000031010",
"EncryptedCardData": {
"EncryptionType": "Dukpt3DesCBC",
"IsDataInTLVFormat": false,
"InitializationVector": "0000000000000000",
"TrackTwoDataKSN": "FFFFF999950000000001"
},
"PinBlock": {
"EncryptedPinBlock": "ED9822DCD929BD14",
"EncryptionType": "Dukpt3Des",
"KsnIdentification": "FFFFF99999C19FC00072"
},
"PanSequenceNumber": 1,
"SaveCard": false,
"IsFallback": false
},
"Type": "PhysicalCreditCard",
"PaymentDateTime": "2024-06-03T18:45:17.252Z",
"Interest": "ByMerchant",
"Amount": 100,
"Capture": true,
"ProductId": 1,
"PinPadInformation": {
"TerminalId": "00000001",
"SerialNumber": "205fae17775b1955",
"PhysicalCharacteristics": "WithoutPinPad",
"ReturnDataInfo": "00"
},
"PaymentFacilitator": {
"EstablishmentCode": "123456",
"TerminalAcquirerId": "00000001",
"SubEstablishment": {
"EstablishmentCode": "251093",
"Mcc": "3640",
"Address": "Avenida do teste",
"City": "São Paulo",
"State": "SP",
"PostalCode": "93534620",
"PhoneNumber": "1234567890123",
"CountryCode": "076",
"DocumentType": "CNPJ",
"DocumentNumber": "01088564000190",
"LegalBusinessName": "Razão teste"
}
}
}
}| 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. |
| 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 | Não | 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.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.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 da BIN TABLE. |
| 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.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 |
| Payment.CreditCard.TrackOneData | String | — | Sim | Dados da trilha 1 Obtidos através do comando PP_GetCard na BC no momento da captura da transação |
| Payment.CreditCard.TrackTwoData | String | — | Sim | Trilha dois do cartão criptografado |
| Payment.CreditCard.PinBlock.EncryptedPinBlock | String | — | Não | 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(). |
| Payment.CreditCard.PinBlock.EncryptionType | String | — | Não | Tipo de Criptografia Enum: “DukptDes” “Dukpt3Des” “MasterKey” |
| Payment.CreditCard.PinBlock.KsnIdentification | String | — | Não | 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(). |
| Payment.CreditCard.EncryptedCardData.EncryptionType | String | — | Sim | Tipo de encriptação utilizada Enum: “DukptDes” = 1, “MasterKey” = 2 “Dukpt3Des” = 3, “Dukpt3DesCBC = 4 |
| Payment.CreditCard.EncryptedCardData.TrackOneDataKSN | String | — | — | Identificador KSN da criptografia da trilha 1 do cartão |
| Payment.CreditCard.EncryptedCardData.TrackTwoDataKSN | String | — | — | Identificador KSN da criptografia da trilha 2 do cartão |
| Payment.CreditCard.EncryptedCardData.IsDataInTLVFormat | Booleano | — | 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 encryptação |
| Payment.PinPadInformation.TerminalId | String | 8 | Não | Número Lógico definido no Concentrador Cielo. |
| Payment.PinPadInformation.SerialNumber | String | 20 | Não | Número de Série do Equipamento. |
| Payment.PinPadInformation.PhysicalCharacteristics | String | — | Não | 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 | — | Não | Retorno da função PP_GetInfo() da biblioteca compartilhada |
| PaymentFacilitator.EstablishmentCode | String | 10 | Sim | Código do lojista - SMID - Obs: Informar o SMID do SubSeller que está realizando a transação |
| PaymentFacilitator.TerminalAcquirerId | String | 8 | Sim | Código do TerminalID do SubSeller |
| PaymentFacilitator.SubEstablishment.EstablishmentCode | String | 15 | Sim | Código do Subadquirente - PFID - Obs: Informar o PFID específico de cada bandeira |
| PaymentFacilitator.SubEstablishment.Mcc | Integer | 4 | Sim | Ramo de atividade do SubSeller - MCC |
| PaymentFacilitator.SubEstablishment.Address | String | 50 | Sim | Endereço do SubSeller |
| PaymentFacilitator.SubEstablishment.City | String | 50 | Sim | Cidade do SubSellerr |
| PaymentFacilitator.SubEstablishment.State | String | 2 | Sim | Estado do SubSeller |
| PaymentFacilitator.SubEstablishment.PostalCode | Integer | 9 | Sim | CEP do SubSeller |
| PaymentFacilitator.SubEstablishment.PhoneNumber | String | 13 | Sim | Telefone do SubSeller |
| PaymentFacilitator.SubEstablishment.CountryCode | String | 3 | Sim | Código do País do SubSeller - Obs: 076 - Brasil |
| PaymentFacilitator.SubEstablishment.DocumentType | String | 4 | Sim | Tipo do documento do SubSeller - CPF ou CNPJ |
| PaymentFacilitator.SubEstablishment.DocumentNumber | String | 14 | Sim | Número do CPF ou CNPJ do SubSeller |
| PaymentFacilitator.SubEstablishment.LegalBusinessName | String | 40 | Sim | Nome da Razão Social do SubSeller |
Resposta
{
"MerchantOrderId": "951461481488155",
"Customer": {
"Name": "[Guest]"
},
"Payment": {
"Installments": 1,
"Interest": "ByMerchant",
"Capture": true,
"CreditCard": {
"ExpirationDate": "12/2030",
"BrandId": 1,
"IssuerId": 1010,
"TruncateCardNumberWhenPrinting": false,
"PanSequenceNumber": 1,
"InputMode": "Emv",
"AuthenticationMethod": "OnlineAuthentication",
"TrackTwoData": "************************************************",
"EmvData": "************************************************************************************************************************************************************",
"IsFallback": false,
"PinBlock": {
"EncryptedPinBlock": "ED9822DCD929BD14",
"EncryptionType": "Dukpt3Des",
"KsnIdentification": "FFFFF99999C19FC00072"
},
"BrandInformation": {
"Type": "VENDA A CREDITO",
"Name": "VISA"
},
"SaveCard": false,
"EncryptedCardData": {
"EncryptionType": 4,
"TrackTwoDataKSN": "FFFFF999950000000001",
"InitializationVector": "0000000000000000",
"IsDataInTLVFormat": false
}
},
"Amount": 100,
"ReceivedDate": "2026-04-27T19:27:31Z",
"CapturedAmount": 100,
"CapturedDate": "2026-04-27T19:27:34Z",
"Provider": "Cielo",
"Status": 2,
"PhysicalTransactionStatus": 2,
"IsSplitted": false,
"ReturnMessage": "APROVADA 907541",
"ReturnCode": "000",
"ExtendedMessage": "Transação aprovada.",
"PaymentId": "9da9f4f0-477b-4c0f-adf5-5b8ea772bbc0",
"Type": "PhysicalCreditCard",
"Currency": "BRL",
"Country": "BRA",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/physicalSales/9da9f4f0-477b-4c0f-adf5-5b8ea772bbc0"
},
{
"Method": "PUT",
"Rel": "confirm",
"Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/9da9f4f0-477b-4c0f-adf5-5b8ea772bbc0/confirmation"
},
{
"Method": "DELETE",
"Rel": "reverse",
"Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/9da9f4f0-477b-4c0f-adf5-5b8ea772bbc0"
}
],
"PaymentDateTime": "2024-06-03T18:45:17.252Z",
"ServiceTaxAmount": 0,
"SoftDescriptor": "Chip",
"ProductId": 1,
"PinPadInformation": {
"TerminalId": "00000001",
"SerialNumber": "205fae17775b1955",
"PhysicalCharacteristics": "WithoutPinPad",
"ReturnDataInfo": "00"
},
"PrintMessage": [],
"ReceiptInformation": [
{
"Field": "MERCHANT_NAME",
"Label": "NOME DO ESTABELECIMENTO",
"Content": "TESTE"
},
{
"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": "0023137868169300"
},
{
"Field": "TERMINAL",
"Label": "POS",
"Content": "41786816"
},
{
"Field": "NSU",
"Label": "DOC",
"Content": "816889"
},
{
"Field": "DATE",
"Label": "DATA",
"Content": "27/04/26"
},
{
"Field": "HOUR",
"Label": "HORA",
"Content": "16:27"
},
{
"Field": "ISSUER_NAME",
"Label": "EMISSOR",
"Content": "CIELO#VISA CREDITO"
},
{
"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": "SALE_CODE",
"Label": "COD.VENDA",
"Content": "2604271131563200"
},
{
"Field": "AUTHORIZATION_CODE",
"Label": "AUTORIZAÇÃO",
"Content": "907541"
},
{
"Field": "TRANSACTION_MODE",
"Label": "MODO DA TRANSAÇÃO",
"Content": "ONL"
},
{
"Field": "INPUT_METHOD",
"Label": "MODO DE ENTRADA",
"Content": "C"
},
{
"Field": "CPF_CNPJ",
"Label": "CPF OU CNPJ",
"Content": "73096766000195"
},
{
"Field": "VALUE",
"Label": "VALOR",
"Content": "1,00"
},
{
"Field": "SOFT_DESCRIPTOR",
"Label": "SOFT DESCRIPTOR",
"Content": "Chip"
}
],
"Receipt": {
"MerchantName": "TESTE",
"MerchantAddress": "Alameda Xingu, 512",
"MerchantCity": "BARUERI",
"MerchantState": "SP",
"MerchantCode": "0023137868169300",
"Terminal": "41786816",
"Nsu": "816889",
"Date": "27/04/26",
"Hour": "16:27",
"IssuerName": "CIELO#VISA CREDITO",
"CardNumber": "476173-0010",
"Brand": "VISA",
"TransactionType": "VENDA A CREDITO",
"SaleCode": "2604271131563200",
"AuthorizationCode": "907541",
"TransactionMode": "ONL",
"InputMethod": "C",
"CpfCnpj": "73096766000195",
"Value": "1,00",
"SoftDescriptor": "Chip"
},
"AuthorizationCode": "907541",
"ProofOfSale": "816889",
"InitializationVersion": 1776082430740,
"ConfirmationStatus": 0,
"EmvResponseData": "9108ff133b9a00860000",
"SubordinatedMerchantId": "4c7449ce-cdcf-48e6-90db-5f0744fcde75",
"OfflinePaymentType": "Online",
"MerchantAcquirerId": "0023137868169300",
"TerminalAcquirerId": "41786816",
"PaymentFacilitator": {
"TerminalAcquirerId": "00000001",
"SubEstablishment": {
"DocumentType": 2,
"DocumentNumber": "01088564000190",
"LegalBusinessName": "Razão teste",
"EstablishmentCode": "251093",
"Mcc": "3640",
"Address": "Avenida do teste",
"City": "São Paulo",
"State": "SP",
"PostalCode": "93534620",
"PhoneNumber": "1234567890123",
"CountryCode": "076"
},
"EstablishmentCode": "123456"
}
}
}| 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 |
| 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.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 |
| InitializationVersion | Integer int16 | — | Sim | Número de versão dos parametros baixados na inicialização do equipamento. |
| Payment.ConfirmationStatus | Integer | 2 | Não | Status da confirmação. 0 = Pendente 1 = Confirmado 2 = Desfeito |
| Payment.SubordinatedMerchantId | String | — | Sim | Código identificador da loja. |
| Payment.Status | Integer | 2 | Sim | Status da transação 0 = Não Finalizado 1 = Autorizado 2 = Pago 3 = Negado 10 = Cancelado 13 = Abortado |
| 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.SoftDescriptor | String | 13 | — | Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura. |
| 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.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 da BIN TABLE. |
| 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.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 |
| Payment.CreditCard.TrackOneData | String | — | Sim | Dados da trilha 1 Obtidos através do comando PP_GetCard na BC no momento da captura da transação |
| Payment.CreditCard.TrackTwoData | String | — | Sim | Trilha dois do cartão criptografado |
| Payment.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(). |
| Payment.CreditCard.PinBlock.EncryptionType | String | — | Sim | Tipo de Criptografia Enum: “DukptDes” “Dukpt3Des” “MasterKey” |
| Payment.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(). |
| Payment.CreditCard.EncryptedCardData.EncryptionType | String | — | Sim | Tipo de encriptação utilizada Enum: “DukptDes” = 1, “MasterKey” = 2 “Dukpt3Des” = 3, “Dukpt3DesCBC = 4 |
| Payment.CreditCard.EncryptedCardData.TrackOneDataKSN | String | — | — | Identificador KSN da criptografia da trilha 1 do cartão |
| Payment.CreditCard.EncryptedCardData.TrackTwoDataKSN | String | — | — | Identificador KSN da criptografia da trilha 2 do cartão |
| Payment.CreditCard.EncryptedCardData.IsDataInTLVFormat | Booleano | — | 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 encryptação |
| Payment.PinPadInformation.TerminalId | String | 8 | Não | Número Lógico definido no Concentrador Cielo. |
| Payment.PinPadInformation.SerialNumber | String | 20 | Não | Número de Série do Equipamento. |
| Payment.PinPadInformation.PhysicalCharacteristics | String | — | Não | 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 | — | Não | 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.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. |
| PaymentFacilitator.EstablishmentCode | String | 10 | Sim | Código do lojista - SMID - Obs: Informar o SMID do SubSeller que está realizando a transação |
| PaymentFacilitator.TerminalAcquirerId | String | 8 | Sim | Código do TerminalID do SubSeller |
| PaymentFacilitator.SubEstablishment.EstablishmentCode | String | 15 | Sim | Código do Subadquirente - PFID - Obs: Informar o PFID específico de cada bandeira |
| PaymentFacilitator.SubEstablishment.Mcc | Integer | 4 | Sim | Ramo de atividade do SubSeller - MCC |
| PaymentFacilitator.SubEstablishment.Address | String | 50 | Sim | Endereço do SubSeller |
| PaymentFacilitator.SubEstablishment.City | String | 50 | Sim | Cidade do SubSellerr |
| PaymentFacilitator.SubEstablishment.State | String | 2 | Sim | Estado do SubSeller |
| PaymentFacilitator.SubEstablishment.PostalCode | Integer | 9 | Sim | CEP do SubSeller |
| PaymentFacilitator.SubEstablishment.PhoneNumber | String | 13 | Sim | Telefone do SubSeller |
| PaymentFacilitator.SubEstablishment.CountryCode | String | 3 | Sim | Código do País do SubSeller - Obs: 076 - Brasil |
| PaymentFacilitator.SubEstablishment.DocumentType | String | 4 | Sim | Tipo do documento do SubSeller - CPF ou CNPJ |
| PaymentFacilitator.SubEstablishment.DocumentNumber | String | 14 | Sim | Número do CPF ou CNPJ do SubSeller |
| PaymentFacilitator.SubEstablishment.LegalBusinessName | String | 40 | Sim | Nome da Razão Social do SubSeller |