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": "1234345676",
    "Payment": {
       "SubordinatedMerchantId": "",
        "Installments": 1,
        "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"
        },
        "SoftDescriptor": "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	—	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.Installments	Integer	—	—	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.Interest	String	—	—	Default: ByMerchant Enum: ByMerchant, ByIssuer. Regras dependem das configurações das tabelas issuerTable, binTable e productTable.
Payment.Capture	Booleano	—	—	Default: false / Identifica se a autorização deve ser com captura automática (quando false = pré-autorização).
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 obtida via PP_GetCard.
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. Identificação do modo de captura (retorno PP_GetCard).
Payment.CreditCard.AuthenticationMethod	String	—	Sim	Enum: NoPassword, OnlineAuthentication, OfflineAuthentication. Definido conforme modo de leitura (digitação, tarja ou EMV).
Payment.CreditCard.EmvData	String	—	—	Dados EMV obtidos via PP_GoOnChip.
Payment.CreditCard.TrackTwoData	String	—	Sim	Trilha dois do cartão criptografado.
Payment.CreditCard.EncryptedCardData.EncryptionType	String	—	Sim	Tipo de encriptação: DukptDes, MasterKey, Dukpt3Des, Dukpt3DesCBC.
Payment.CreditCard.EncryptedCardData.CardNumberKSN	String	—	Sim	Identificador KSN da criptografia do número do cartão.
Payment.CreditCard.EncryptedCardData.IsDataInTLVFormat	Bool	—	Não	Indica se os dados estão no formato TLV.
Payment.CreditCard.EncryptedCardData.InitializationVector	String	—	Sim	Vetor de inicialização da encriptação.
PinBlock.EncryptedPinBlock	String	—	Sim	PINBlock criptografado obtido via PP_GoOnChip ou PP_GetPin.
PinBlock.EncryptionType	String	—	Sim	Tipo de criptografia do PINBlock (DukptDes, Dukpt3Des, MasterKey).
PinBlock.KsnIdentification	String	—	Sim	Identificador KSN do PINBlock.
Payment.CreditCard.PanSequenceNumber	Number	—	—	Número sequencial do cartão (Tag 5F34, obrigatório em EMV quando existir).
Payment.CreditCard.SaveCard	Booleano	—	—	Indica se o cartão será tokenizado/salvo.
Payment.CreditCard.IsFallback	Booleano	—	—	Indica transação de fallback.
PinPadInformation.TerminalId	String	—	Sim	Número lógico do terminal no concentrador Cielo.
PinPadInformation.SerialNumber	String	20	Sim	Número de série do equipamento.
PinPadInformation.PhysicalCharacteristics	String	—	Sim	Enum com características do PIN-pad (com chip, SAM, contactless etc.).
PinPadInformation.ReturnDataInfo	String	—	Sim	Retorno da função PP_GetInfo().

Resposta

{
   "MerchantOrderId": "1234345676",
    "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": "2024-06-03T21:45:42Z",
        "CapturedAmount": 100,
        "CapturedDate": "2024-06-03T21:45:44Z",
        "Provider": "Cielo",
        "Status": 2,
        "PhysicalTransactionStatus": 2,
        "IsSplitted": false,
        "ReturnMessage": "APROVADA 688805",
        "ReturnCode": "000",
        "PaymentId": "950c2abd-41a5-4472-a168-8c0d26533e62",
        "Type": "PhysicalCreditCard",
        "Currency": "BRL",
        "Country": "BRA",
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/physicalSales/950c2abd-41a5-4472-a168-8c0d26533e62"
            },
            {
                "Method": "PUT",
                "Rel": "confirm",
                "Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/950c2abd-41a5-4472-a168-8c0d26533e62/confirmation"
            },
            {
                "Method": "DELETE",
                "Rel": "reverse",
                "Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/950c2abd-41a5-4472-a168-8c0d26533e62"
            }
        ],
        "PaymentDateTime": "2024-06-03T18:45:43.481Z",
        "ServiceTaxAmount": 0,
        "SoftDescriptor": "Teste",
        "ProductId": 1,
        "PinPadInformation": {
            "TerminalId": "00000001",
            "SerialNumber": "205fae17775b1955",
            "PhysicalCharacteristics": "WithoutPinPad",
            "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": "205202"
            },
            {
                "Field": "DATE",
                "Label": "DATA",
                "Content": "03/06/24"
            },
            {
                "Field": "HOUR",
                "Label": "HORA",
                "Content": "18: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": "688805"
            },
            {
                "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": "24904219000183"
            },
            {
                "Field": "VALUE",
                "Label": "VALOR",
                "Content": "1,00"
            },
            {
                "Field": "SOFT_DESCRIPTOR",
                "Label": "SOFT DESCRIPTOR",
                "Content": "Teste"
            }
        ],
        "Receipt": {
            "MerchantName": "Feira ACBR",
            "MerchantAddress": "Alameda Xingu, 512",
            "MerchantCity": "BARUERI",
            "MerchantState": "SP",
            "MerchantCode": "0010255016990001",
            "Terminal": "42001001",
            "Nsu": "205202",
            "Date": "03/06/24",
            "Hour": "18:45",
            "IssuerName": "CIELO#VISA CREDITO",
            "CardNumber": "476173-0010",
            "Brand": "VISA",
            "TransactionType": "VENDA A CREDITO",
            "AuthorizationCode": "688805",
            "TransactionMode": "ONL",
            "InputMethod": "C",
            "CpfCnpj": "24904219000183",
            "Value": "1,00",
            "SoftDescriptor": "Teste"
        },
        "AuthorizationCode": "688805",
        "ProofOfSale": "205202",
        "InitializationVersion": 1711483206145,
        "ConfirmationStatus": 0,
        "EmvResponseData": "9108ff133b9a00860000",
        "SubordinatedMerchantId": "ddb891bf-73ae-41b0-8d37-380a9902438c",
        "OfflinePaymentType": "Online",
        "MerchantAcquirerId": "0010255016990001",
        "TerminalAcquirerId": "42001001"
    }
}

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
MerchantOrderId	String	15	Sim	Número utilizado para identificação da transação e que deve ser gerado pela aplicação integrada com o Conecta. Aceita apenas valores numéricos de 1 a 15 dígitos e não pode ser duplicado. Caso não seja informada uma data via parâmetro (opcional), o sistema irá considerar automaticamente a data atual.
Customer.Name	String	—	—	—
Customer.Identity	—	—	—	—
Customer.IdentityType	—	—	—	—
Customer.Email	—	—	—	—
Customer.Birthday	—	—	—	—
Address.Street	String	—	—	—
Address.Number	String	—	—	—
Address.Complement	String	—	—	—
Address.ZipCode	String	—	—	—
Address.City	String	—	—	—
Address.State	String	—	—	—
Address.Country	String	—	—	—
DeliveryAddress.Street	String	—	—	—
DeliveryAddress.Number	String	—	—	—
DeliveryAddress.Complement	String	—	—	—
DeliveryAddress.ZipCode	String	—	—	—
DeliveryAddress.City	String	—	—	—
DeliveryAddress.State	String	—	—	—
DeliveryAddress.Country	String	—	—	—
Payment.Installments	Integer	—	—	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.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.Capture	Booleano	—	—	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.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.TruncateCardNumberWhenPrinting	Booleano	—	—	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.
Payment.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.
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 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().
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
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().
PinBlock.EncryptionType	String	—	Sim	Tipo de Criptografia Enum: “DukptDes” “Dukpt3Des” “MasterKey”
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.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).
Payment.CreditCard.SaveCard	Booleano	—	—	Identifica se vai salvar/tokenizar o cartão.
Payment.CreditCard.IsFallback	Booleano	—	—	Identifica se é uma transação de fallback.
Payment.CreditCard.TrackTwoData	String	—	Sim	Trilha dois do cartão criptografado
Payment.CreditCard.EncryptedCardData.EncryptionType	String	—	Sim	Tipo de encriptação utilizada Enum: “DukptDes” = 1, “MasterKey” = 2, “Dukpt3Des” = 3, “Dukpt3DesCBC = 4
Payment.CreditCard.EncryptedCardData.CardNumberKSN	String	—	Sim	Identificador KSN da criptografia do número do cartão
Payment.CreditCard.EncryptedCardData.IsDataInTLVFormat	Bool	—	Não	Identifica se os dados criptografados estão no formato TLV (tag / length / value).
Payment.CreditCard.EncryptedCardData.InitializationVector	String	—	Sim	Vetor de inicialização da encriptação
Payment.PaymentDateTime	String	date-time	Sim	Data e Hora da captura da transação
Payment.ServiceTaxAmount	—	—	—	—
Payment.SoftDescriptor	String	13	—	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	—	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
PinPadInformation.ReturnDataInfo	String	—	Sim	Retorno da função PP_GetInfo() da biblioteca compartilhada
Payment.Amount	Integer(int64)	—	Sim	Valor da transação (1079 = R$10,79)
Payment.ReceivedDate	—	—	—	—
Payment.CapturedAmount	—	—	—	—
Payment.Provider	String	—	—	—
Payment.ConfirmationStatus	—	—	—	—
Payment.InitializationVersion	—	—	—	—
Payment.EmvResponseData	—	—	—	—
Payment.Status	—	—	—	—
Payment.IsSplitted	Booleano	—	—	—
Payment.ReturnCode	—	—	—	—
Payment.ReturnMessage	String	—	—	—
Payment.PaymentId	—	—	—	—
Payment.Type	String	—	Sim	Value: PhysicalCreditCard / Tipo da Transação
Payment.Currency	String	—	—	Default: “BRL” / Value: “BRL”
Payment.Country	String	—	—	Default: “BRA” / Value: “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.
SplitPayments.Fares.Mdr	—	—	—	—
SplitPayments.Fares.Fee	—	—	—	—
SplitErrors.Code	—	—	—	—
SplitErrors.Message	—	—	—	—