Débito por tarja com cartão criptografado


AmbienteMétodoEndpoint
SandboxPOSThttps://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/
HomologaçãoPOSThttps://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/
ProduçãoPOSThttps://api.cieloecommerce.cielo.com.br/1/physicalSales/

Requisição

{
    "MerchantOrderId": "123456789123456",
    "Payment": {
        "SubordinatedMerchantId": "",
        "Type": "PhysicalDebitCard",
        "SoftDescriptor": "Teste API",
        "PaymentDateTime": "2020-06-18T17:16:16-03:00",
        "Amount": 1300,
        "Installments": 1,
        "Capture": true,
        "Interest": "ByMerchant",
        "ProductId": 2,
        "DebitCard": {
            "InputMode": "MagStripe",
            "ExpirationDate": "07/2007",
            "SecurityCodeStatus": "Collected",
            "SecurityCode": "123",
            "TrackOneData": "4341FF573858F8A70D98D57FA648C8CC8E9DDA85EE6579E4D49A5DD8D853F143432F8E46572D5CDA1D398FCB3A31526ED624707C25E88908597D1E2C6727F0730E",
            "TrackTwoData": "1B70490711F4B7F8441F1FCDAC07366DB66A9512533B7A68",
            "EncryptedCardData": {
                "EncryptionType": "Dukpt3DesCBC",
                "InitializationVector": "0000000000000000",
                "TrackOneDataKSN": "FFFFF99995C18C800089",
                "TrackTwoDataKSN": "FFFFF99995C18C80008A"
            },
            "PanSequenceNumber": "0",
            "BrandId": 1,
            "IssuerId": 1501,
            "AuthenticationMethod": "OnlineAuthentication",
            "PinBlock": {
                "EncryptedPinBlock": "F4079D718CD5EED5",
                "EncryptionType": "Dukpt3Des",
                "KsnIdentification": "FFFFF99999C19FC00063"
            }
        },
        "PinPadInformation": {
            "TerminalId": "00000001",
            "SerialNumber": "6C651996",
            "PhysicalCharacteristics": "PinPadWithChipReaderWithSamModuleAndContactless",
            "ReturnDataInfo": "00"
        }
    }
}

PropriedadeTipoTamanhoObrigatórioDescrição
MerchantOrderIdString15SimNú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.SubordinatedMerchantIdString—SimCódigo identificador da loja.
Payment.TypeString—SimValue: PhysicalCreditCard / Tipo da Transação
Payment.SoftDescriptorString13NãoIdentificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura.
Payment.PaymentDateTimeStringdate-timeSimData e Hora da captura da transação
Payment.AmountInteger(int64)15SimValor da transação (1079 = R$10,79)
Payment.CaptureBooleano—NãoDefault: 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.InstallmentsInteger2NãoDefault: 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.InterestString10NãoDefault: 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.ProductIdInteger—SimCódigo do produto identificado através do bin do cartão.
Payment.DebitCard.ExpirationDateStringMM/yyyySimData de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação.
Payment.DebitCard.BrandIdInteger—SimIdentificação da bandeira obtida através do campo BrandId da PRODUCT TABLE.
Payment.DebitCard.IssuerIdInteger—SimCódigo do emissor obtido através do campo IssuerId da BIN TABLE.
Payment.DebitCard.InputModeString—SimEnum: 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.DebitCard.AuthenticationMethodString—SimEnum: 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().
Payment.DebitCard.TrackOneDataString—SimDados da trilha 1 Obtidos através do comando PP_GetCard na BC no momento da captura da transação
Payment.DebitCard.TrackTwoDataString—NãoDados da trilha 2 Obtidos através do comando PP_GetCard na BC no momento da captura da transação
Payment.DebitCard.EncryptedCardData.EncryptionTypeString—SimTipo de encriptação utilizada Enum: “DukptDes” = 1, “MasterKey” = 2 “Dukpt3Des” = 3, “Dukpt3DesCBC” = 4
Payment.DebitCard.EncryptedCardData.CardNumberKSNString—SimIdentificador KSN da criptografia do número do cartão
Payment.DebitCard.EncryptedCardData.IsDataInTLVFormatBool—NãoIdentifica se os dados criptografados estão no formato TLV (tag / length / value).
Payment.DebitCard.EncryptedCardData.InitializationVectorString—SimVetor de inicialização da encriptação
Payment.DebitCard.PinBlock.EncryptedPinBlockString—NãoPINBlock Criptografado obtido via PP_GoOnChip ou PP_GetPin, conforme tipo de leitura do cartão
Payment.DebitCard.PinBlock.EncryptionTypeString—NãoTipo de Criptografia Enum: “DukptDes” “Dukpt3Des” “MasterKey”
Payment.DebitCard.PinBlock.KsnIdentificationString—NãoIdentificação do KSN obtida via PP_GoOnChip ou PP_GetPin
Payment.PinPadInformation.TerminalIdString8SimNúmero Lógico definido no Concentrador Cielo.
Payment.PinPadInformation.SerialNumberString20SimNúmero de Série do Equipamento.
Payment.PinPadInformation.PhysicalCharacteristicsString—SimEnum: WithoutPinPad, PinPadWithoutChipReader, PinPadWithChipReaderWithoutSamModule, PinPadWithChipReaderWithSamModule, NotCertifiedPinPad, PinPadWithChipReaderWithoutSamAndContactless, PinPadWithChipReaderWithSamModuleAndContactless.
Payment.PinPadInformation.ReturnDataInfoString—SimRetorno da função PP_GetInfo() da biblioteca compartilhada

Resposta

{
     "MerchantOrderId": "123456789123456",
    "Customer": {
        "Name": "[Guest]"
    },
    "Payment": {
        "DebitCard": {
            "ExpirationDate": "07/2007",
            "SecurityCodeStatus": "Collected",
            "SecurityCode": "***",
            "BrandId": 1,
            "IssuerId": 1501,
            "TruncateCardNumberWhenPrinting": false,
            "PanSequenceNumber": 0,
            "InputMode": "MagStripe",
            "AuthenticationMethod": "OnlineAuthentication",
            "TrackOneData": "4341FF573858F8A70D98D57FA648C8CC8E9DDA85EE6579E4D49A5DD8D853F143432F8E46572D5CDA1D398FCB3A31526ED624707C25E88908597D1E2C6727F0730E",
            "TrackTwoData": "************************************************",
            "IsFallback": false,
            "PinBlock": {
                "EncryptedPinBlock": "F4079D718CD5EED5",
                "EncryptionType": "Dukpt3Des",
                "KsnIdentification": "FFFFF99999C19FC00063"
            },
            "BrandInformation": {
                "Type": "VENDA A DEBITO",
                "Name": "VISA"
            },
            "SaveCard": false,
            "EncryptedCardData": {
                "EncryptionType": 4,
                "TrackOneDataKSN": "FFFFF99995C18C800089",
                "TrackTwoDataKSN": "FFFFF99995C18C80008A",
                "InitializationVector": "0000000000000000",
                "IsDataInTLVFormat": false
            }
        },
        "Amount": 1300,
        "ReceivedDate": "2024-06-03T19:55:13Z",
        "CapturedAmount": 1300,
        "CapturedDate": "2024-06-03T19:55:15Z",
        "Provider": "Cielo",
        "Status": 2,
        "PhysicalTransactionStatus": 2,
        "IsSplitted": false,
        "ReturnMessage": "APROVADA 316736",
        "ReturnCode": "000",
        "PaymentId": "27d9e507-cb6b-4a87-940c-012f706b4fb8",
        "Type": "PhysicalDebitCard",
        "Currency": "BRL",
        "Country": "BRA",
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/physicalSales/27d9e507-cb6b-4a87-940c-012f706b4fb8"
            },
            {
                "Method": "PUT",
                "Rel": "confirm",
                "Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/27d9e507-cb6b-4a87-940c-012f706b4fb8/confirmation"
            },
            {
                "Method": "DELETE",
                "Rel": "reverse",
                "Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/27d9e507-cb6b-4a87-940c-012f706b4fb8"
            }
        ],
        "PaymentDateTime": "2024-06-03T16:55:14.595Z",
        "ServiceTaxAmount": 0,
        "SoftDescriptor": "Teste API",
        "ProductId": 2,
        "PinPadInformation": {
            "TerminalId": "00000001",
            "SerialNumber": "6C651996",
            "PhysicalCharacteristics": "PinPadWithChipReaderWithSamModuleAndContactless",
            "ReturnDataInfo": "00"
        },
        "PrintMessage": [],
        "ReceiptInformation": [
            {
                "Field": "MERCHANT_NAME",
                "Label": "NOME DO ESTABELECIMENTO",
                "Content": "Loja 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": "568804"
            },
            {
                "Field": "DATE",
                "Label": "DATA",
                "Content": "03/06/24"
            },
            {
                "Field": "HOUR",
                "Label": "HORA",
                "Content": "16:55"
            },
            {
                "Field": "ISSUER_NAME",
                "Label": "EMISSOR",
                "Content": "CIELO#VISA ELECTRON"
            },
            {
                "Field": "CARD_HOLDER",
                "Label": "NOME DO CLIENTE",
                "Content": "FERNANDA S CASTRO  "
            },
            {
                "Field": "CARD_NUMBER",
                "Label": "CARTÃO",
                "Content": "498446-0205"
            },
            {
                "Field": "BRAND",
                "Label": "BANDEIRA",
                "Content": "VISA"
            },
            {
                "Field": "TRANSACTION_TYPE",
                "Label": "TIPO DE TRANSAÇÃO",
                "Content": "VENDA A DEBITO"
            },
            {
                "Field": "AUTHORIZATION_CODE",
                "Label": "AUTORIZAÇÃO",
                "Content": "515351"
            },
            {
                "Field": "TRANSACTION_MODE",
                "Label": "MODO DA TRANSAÇÃO",
                "Content": "ONL"
            },
            {
                "Field": "INPUT_METHOD",
                "Label": "MODO DE ENTRADA",
                "Content": "D"
            },
            {
                "Field": "CPF_CNPJ",
                "Label": "CPF OU CNPJ",
                "Content": "73096766000195"
            },
            {
                "Field": "VALUE",
                "Label": "VALOR",
                "Content": "13,00"
            },
            {
                "Field": "SOFT_DESCRIPTOR",
                "Label": "SOFT DESCRIPTOR",
                "Content": "Teste API"
            }
        ],
        "Receipt": {
            "MerchantName": "Loja Teste",
            "MerchantAddress": "Alameda Xingu, 512",
            "MerchantCity": "BARUERI",
            "MerchantState": "SP",
            "MerchantCode": "0023137868169300",
            "Terminal": "41786816",
            "Nsu": "568804",
            "Date": "03/06/24",
            "Hour": "16:55",
            "IssuerName": "CIELO#VISA ELECTRON",
            "CardHolder": "FERNANDA S CASTRO  ",
            "CardNumber": "498446-0205",
            "Brand": "VISA",
            "TransactionType": "VENDA A DEBITO",
            "AuthorizationCode": "515351",
            "TransactionMode": "ONL",
            "InputMethod": "D",
            "CpfCnpj": "73096766000195",
            "Value": "13,00",
            "SoftDescriptor": "Teste API"
        },
        "AuthorizationCode": "515351",
        "ProofOfSale": "568804",
        "InitializationVersion": 1716234911942,
        "ConfirmationStatus": 0,
        "SubordinatedMerchantId": "",
        "OfflinePaymentType": "Online",
        "MerchantAcquirerId": "0023137868169300",
        "TerminalAcquirerId": "41786816"
    }
}

PropriedadeTipoTamanhoObrigatórioDescrição
MerchantOrderIdString15SimNú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.NameString———
Customer.Identity————
Customer.IdentityType————
Customer.Email————
Customer.Birthday————
Address.StreetString———
Address.NumberString———
Address.ComplementString———
Address.ZipCodeString———
Address.CityString———
Address.StateString———
Address.CountryString———
DeliveryAddress.StreetString———
DeliveryAddress.NumberString———
DeliveryAddress.ComplementString———
DeliveryAddress.ZipCodeString———
DeliveryAddress.CityString———
DeliveryAddress.StateString———
DeliveryAddress.CountryString———
Payment.InstallmentsInteger——Default: 1 / Quantidade de Parcelas: Varia de 2 a 99 para transação de financiamento. Deve ser verificado os atributos maxOfPayments1, maxOfPayments2, maxOfPayments3 e minValOfPayments da tabela productTable.
Payment.InterestString——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.CaptureBooleano——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.
DebitCard.ExpirationDateStringMM/yyyySimData de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação.
DebitCard.BrandIdInteger—SimIdentificação da bandeira obtida através do campo BrandId da PRODUCT TABLE.
DebitCard.IssuerIdInteger—SimCódigo do emissor obtido através do campo IssuerId da BIN TABLE.
DebitCard.TruncateCardNumberWhenPrintingBooleano——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 confParamOp03 presente nas tabelas BIN TABLE, PARAMETER TABLE e ISSUER TABLE.
CreditCard.InputModeString—SimEnum: 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.
CreditCard.AuthenticationMethodString—SimEnum: 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().
CreditCard.EmvDataString——Dados da transação EMV Obtidos através do comando PP_GoOnChip na BC.
PinBlock.EncryptedPinBlock————
PinBlock.EncryptionTypeString———
PinBlock.KsnIdentificationString———
CreditCard.PanSequenceNumberNumber——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————
CreditCard.IsFallback————
Payment.CreditCard.EncryptedCardData.EncryptionTypeString—SimTipo de encriptação utilizada Enum: “DukptDes” = 1, “MasterKey” = 2 “Dukpt3Des” = 3, “Dukpt3DesCBC = 4
Payment.CreditCard.EncryptedCardData.CardNumberKSNString—SimIdentificador KSN da criptografia do número do cartão
Payment.CreditCard.EncryptedCardData.IsDataInTLVFormatBool—NãoIdentifica se os dados criptografados estão no formato TLV (tag / length / value).
Payment.CreditCard.EncryptedCardData.InitializationVectorString—SimVetor de inicialização da encriptação
Payment.PaymentDateTimeStringdate-timeSimData e Hora da captura da transação
Payment.ServiceTaxAmount————
Payment.SoftDescriptorString13—Identificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura.
Payment.ProductIdInteger—SimCódigo do produto identificado através do bin do cartão.
PinPadInformation.TerminalIdString—SimNúmero Lógico definido no Concentrador Cielo.
PinPadInformation.PhysicalCharacteristicsString-SimEnum: WithoutPinPad PinPadWithoutChipReader PinPadWithChipReaderWithoutSamModule PinPadWithChipReaderWithSamModule NotCertifiedPinPad PinPadWithChipReaderWithoutSamAndContactless PinPadWithChipReaderWithSamModuleAndContactless
PinPadInformation.SerialNumberString20SimNúmero de Série do Equipamento.
PinPadInformation.ReturnDataInfoString—SimRetorno da função PP_GetInfo() da biblioteca compartilhada
Payment.AmountInteger (int64)—SimValor da transação (1079 = R$10,79)
Payment.ReceivedDate————
Payment.CapturedAmount————
Payment.ProviderString———
Payment.ConfirmationStatus————
Payment.InitializationVersion————
Payment.EmvResponseData————
Payment.Status————
Payment.IsSplittedBooleano———
Payment.ReturnCode————
Payment.ReturnMessageString———
Payment.PaymentId————
Payment.TypeString—SimValue: PhysicalCreditCard / Tipo da Transação
Payment.CurrencyString——Default: “BRL” / Value: “BRL” / Moeda (Preencher com “BRL”)
Payment.CountryString——Default: “BRA” / Value: “BRA” / País (Preencher com “BRA”)
Payment.Receipt.MerchantNameString255SimNome da loja
Payment.Receipt.MerchantAddressString255SimEndereço da loja
Payment.Receipt.MerchantCityString255SimCidade da loja
Payment.Receipt.MerchantStateString2SimEstado da loja
Payment.Receipt.MerchantCodeString16SimCodigo de identificação da loja
Payment.Receipt.TerminalString8SimIdentificação do Terminal
Payment.Receipt.NsuString6SimNumero de identificação da transação Cielo
Payment.Receipt.DateStringdd/MM/yySimData da transação
Payment.Receipt.HourStringHH:mmSimHorario da transação
Payment.Receipt.IssuerNameString255SimNome do emissor obtido através do campo IssuerId no objeto BinEntry.
Payment.Receipt.CardHolderString255NãoNome do titular do cartão.
Payment.Receipt.CardNumberString19SimNúmero do cartão
Payment.Receipt.BrandString255SimBandeira do cartão
Payment.Receipt.TransactionTypeString255SimTipo de transação
Payment.Receipt.AuthorizationCodeString6SimCódigo da autorização
Payment.Receipt.TransactionModeString3SimModo da transação
Payment.Receipt.InputMethodString1SimMetodo de entrada
Payment.Receipt.ValueString15SimValor do pagamento
Payment.Receipt.SoftDescriptorString13NãoIdentificação do estabelecimento (nome reduzido) a ser impresso e identificado na fatura.
RecurrentPayment.RecurrentPaymentId————
RecurrentPayment.ReasonCode————
RecurrentPayment.ReasonMessage————
RecurrentPayment.NextRecurrency————
RecurrentPayment.EndDate————
RecurrentPayment.Interval————
SplitPayments.SubordinateMerchantId————
SplitPayments.Amount————
SplitPayments.Fares.Mdr————
SplitPayments.Fares.Fee————
SplitErrors.Code————
SplitErrors.Message————