Crédito digitado 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": "20190415123",
    "Payment": {
        "SubordinatedMerchantId": "",
        "Type": "PhysicalCreditCard",
        "SoftDescriptor": "Transação API",
        "PaymentDateTime": "2024-06-03T10:40:58.158Z",
        "Amount": 100,
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": true,
        "ProductId": 1,
        "CreditCard": {
            "CardNumber": "EC9A221AC2E165A7",
            "ExpirationDate": "12/2030",
            "SecurityCodeStatus": "Collected",
            "SecurityCode": "1234",
            "EncryptedCardData": {
                "EncryptionType": "Dukpt3DesCBC",
                "InitializationVector": "0000000000000000",
                "CardNumberKSN": "FFFFF99995C1B4400004"
            },
            "BrandId": 1,
            "IssuerId": 1001,         
            "InputMode": "Typed",
            "AuthenticationMethod": "NoPassword",
            "TruncateCardNumberWhenPrinting": true,
            "SaveCard": true
        },
        "PinPadInformation": {
            "PhysicalCharacteristics": "PinPadWithChipReaderWithoutSamAndContactless",
            "ReturnDataInfo": "00",
            "SerialNumber": "0820471929",
            "TerminalId": "00000001"
        }
    }
}


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.InstallmentsInteger2SimDefault: 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.InterestString10NãoDefault: 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.ProductIdInteger—SimCódigo do produto identificado através do bin do cartão.
CreditCard.CardNumberString—SimNúmero do cartão (PAN) criptografado
CreditCard.EncryptedCardData.EncryptionTypeString—SimTipo de encriptação utilizada Enum: “DukptDes” = 1, “MasterKey” = 2 “Dukpt3Des” = 3, “Dukpt3DesCBC” = 4
CreditCard.EncryptedCardData.CardNumberKSNString——Identificador KSN da criptografia do número do cartão
CreditCard.EncryptedCardData.IsDataInTLVFormatBool—NãoIdentifica se os dados criptografados estão no formato TLV (tag / length / value).
CreditCard.EncryptedCardData.InitializationVectorString—SimVetor de inicialização da encryptação
CreditCard.ExpirationDateStringMM/yyyySimData de validade do cartão. Dado obtido através do comando PP_GetCard na BC no momento da captura da transação.
CreditCard.SecurityCodeStatusString—SimEnum: Collected Unreadable Nonexistent Status da coleta de código de segurança (CVV)
CreditCard.SecurityCodeString5SimCódigo de segurança (CVV)
CreditCard.BrandIdInteger—SimIdentificação da bandeira obtida através do campo BrandId da PRODUCT TABLE.
CreditCard.IssuerIdInteger—SimCódigo do emissor obtido através do campo IssuerId da BIN TABLE.
CreditCard.InputModeString—SimEnum: 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.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(). 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.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.SaveCardBooleano——Identifica se vai salvar/tokenizar o cartão.
CreditCard.IsFallbackBooleano——Identifica se é uma transação de fallback.
PinPadInformation.TerminalIdString8SimNúmero Lógico definido no Concentrador Cielo.
PinPadInformation.SerialNumberString20SimNúmero de Série do Equipamento.
PinPadInformation.PhysicalCharacteristicsString—SimEnum: WithoutPinPad PinPadWithoutChipReader PinPadWithChipReaderWithoutSamModule PinPadWithChipReaderWithSamModule NotCertifiedPinPad PinPadWithChipReaderWithoutSamAndContactless PinPadWithChipReaderWithSamModuleAndContactless SemPIN-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.
PinPadInformation.ReturnDataInfoString—SimRetorno da função PP_GetInfo() da biblioteca compartilhada

Resposta

{

    "MerchantOrderId": "20190415123",
    "Customer": {
        "Name": "[Guest]"
    },
    "Payment": {
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": true,
        "CreditCard": {
            "CardNumber": "EC9A221AC2E165A7",
            "ExpirationDate": "12/2030",
            "SecurityCodeStatus": "Collected",
            "SecurityCode": "***",
            "BrandId": 1,
            "IssuerId": 1001,
            "TruncateCardNumberWhenPrinting": true,
            "InputMode": "Typed",
            "AuthenticationMethod": "NoPassword",
            "IsFallback": false,
            "BrandInformation": {
                "Type": "VENDA A CREDITO",
                "Name": "VISA"
            },
            "SaveCard": true,
            "CardToken": "6947e72b-1b29-4b21-b251-04aa3e432c30",
            "EncryptedCardData": {
                "EncryptionType": 4,
                "CardNumberKSN": "FFFFF99995C1B4400004",
                "InitializationVector": "0000000000000000",
                "IsDataInTLVFormat": false
            }
        },
        "Amount": 100,
        "ReceivedDate": "2024-06-03T13:45:46Z",
        "CapturedAmount": 100,
        "CapturedDate": "2024-06-03T13:45:47Z",
        "Provider": "Cielo",
        "Status": 2,
        "PhysicalTransactionStatus": 2,
        "IsSplitted": false,
        "ReturnMessage": "APROVADA 271290",
        "ReturnCode": "000",
        "PaymentId": "38a5ec9e-85b4-4d37-9e94-bafe860f371d",
        "Type": "PhysicalCreditCard",
        "Currency": "BRL",
        "Country": "BRA",
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/physicalSales/38a5ec9e-85b4-4d37-9e94-bafe860f371d"
            },
            {
                "Method": "PUT",
                "Rel": "confirm",
                "Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/38a5ec9e-85b4-4d37-9e94-bafe860f371d/confirmation"
            },
            {
                "Method": "DELETE",
                "Rel": "reverse",
                "Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/38a5ec9e-85b4-4d37-9e94-bafe860f371d"
            }
        ],
        "PaymentDateTime": "2024-06-03T10:45:47.151Z",
        "ServiceTaxAmount": 0,
        "SoftDescriptor": "Transação API",
        "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": "808826"
            },
            {
                "Field": "DATE",
                "Label": "DATA",
                "Content": "03/06/24"
            },
            {
                "Field": "HOUR",
                "Label": "HORA",
                "Content": "10:45"
            },
            {
                "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": "AUTHORIZATION_CODE",
                "Label": "AUTORIZAÇÃO",
                "Content": "271290"
            },
            {
                "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": "Transação API"
            }
        ],
        "Receipt": {
            "MerchantName": "Feira ACBR",
            "MerchantAddress": "Alameda Xingu, 512",
            "MerchantCity": "BARUERI",
            "MerchantState": "SP",
            "MerchantCode": "0010255016990001",
            "Terminal": "42001001",
            "Nsu": "808826",
            "Date": "03/06/24",
            "Hour": "10:45",
            "IssuerName": "CIELO#VISA CREDITO",
            "CardNumber": "476173-0010",
            "Brand": "VISA",
            "TransactionType": "VENDA A CREDITO",
            "AuthorizationCode": "271290",
            "TransactionMode": "ONL",
            "InputMethod": "X",
            "CpfCnpj": "24904219000183",
            "Value": "1,00",
            "SoftDescriptor": "Transação API"
        },
        "AuthorizationCode": "271290",
        "ProofOfSale": "808826",
        "InitializationVersion": 1711483206145,
        "ConfirmationStatus": 0,
        "SubordinatedMerchantId": "ddb891bf-73ae-41b0-8d37-380a9902438c",
        "OfflinePaymentType": "Online",
        "MerchantAcquirerId": "0010255016990001",
        "TerminalAcquirerId": "42001001"
    }
}

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.
CreditCard.ExpirationDateStringMM/yyyySimData de validade do cartão.Dado obtido através do comando PP_GetCard na BC no momento da captura da transação.
CreditCard.BrandIdInteger—SimIdentificação da bandeira obtida através do campo BrandId da PRODUCT TABLE.
CreditCard.IssuerIdInteger—SimCódigo do emissor obtido através do campo IssuerId da BIN TABLE.
CreditCard.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 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(). 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.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.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.SerialNumberString20SimNúmero de Série do Equipamento.
PinPadInformation.PhysicalCharacteristicsString-SimEnum: 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.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————