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": "123456789123456",
    "Payment": {
        "SubordinatedMerchantId": "",
        "Type": "PhysicalCreditCard",
        "SoftDescriptor": "Teste API",
        "PaymentDateTime": "2020-06-18T17:16:16-03:00",
        "Amount": 1200,
        "Installments": 1,
        "Capture": true,
        "Interest": "ByMerchant",
        "ProductId": 80,
        "CreditCard": {
            "InputMode": "MagStripe",
            "ExpirationDate": "07/2007",
            "SecurityCodeStatus": "Collected",
            "SecurityCode": "123",
            "TrackOneData": "428AB8C3C05369D9095A9145BC75FFD638EEEA6FAE5A18E7DCEE686872AEA55AA33718CEC97A5DA615C5E91E2DEA4842937273919942838C2E",
            "TrackTwoData": "37855871F6661FC30C6E5320A18EBEBE44BD1BBB15D87932",
            "EncryptedCardData": {
                "EncryptionType": "Dukpt3Des",
                "TrackOneDataKSN": "FFFFF99995C18C800023",
                "TrackTwoDataKSN": "FFFFF99995C18C800023"
            },
            "PanSequenceNumber": "0",
            "BrandId": 2,
            "IssuerId": 2580,
            "AuthenticationMethod": "OnlineAuthentication",
            "PinBlock": {
                "EncryptedPinBlock": "30AFE7D2A93201B7",
                "EncryptionType": "Dukpt3Des",
                "KsnIdentification": "fffff99999C19FC0004F"
            }
        },
        "PinPadInformation": {
            "TerminalId": "00000001",
            "SerialNumber": "6C651996",
            "PhysicalCharacteristics": "PinPadWithChipReaderWithSamModuleAndContactless",
            "ReturnDataInfo": "00"
        }
    }
}

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
MerchantOrderId	String	15	Sim	Número utilizado para identificação da transação. 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) na fatura
Payment.PaymentDateTime	String	date-time	Sim	Data e hora da captura
Payment.Amount	Integer (int64)	15	Sim	Valor (1079 = R$10,79)
Payment.Capture	Booleano	—	Não	Default: false / Indica captura automática
Payment.Installments	Integer	2	Não	Default: 1 / Parcelas de 2 a 99 conforme regras do ProductEntry
Payment.Interest	String	10	Não	Default: ByMerchant / Enum: ByMerchant, ByIssuer
Payment.ProductId	Integer	—	Sim	Código do produto identificado via BIN
Payment.CreditCard.ExpirationDate	String	MM/yyyy	Sim	Data validade via PP_GetCard
Payment.CreditCard.BrandId	Integer	—	Sim	Identificação da bandeira
Payment.CreditCard.IssuerId	Integer	—	Sim	Código do emissor
Payment.CreditCard.InputMode	String	—	Sim	Enum: Typed, MagStripe, Emv, ContactlessEmv
Payment.CreditCard.AuthenticationMethod	String	—	Sim	Enum: NoPassword, OnlineAuthentication, OfflineAuthentication
Payment.CreditCard.TrackOneData	String	—	Sim	Dados da trilha 1 (PP_GetCard)
Payment.CreditCard.TrackTwoData	String	—	Não	Dados da trilha 2 (PP_GetCard)
Payment.CreditCard.EncryptedCardData.EncryptionType	String	—	Sim	Enum: DukptDes, MasterKey, Dukpt3Des, Dukpt3DesCBC
Payment.CreditCard.EncryptedCardData.CardNumberKSN	String	—	Sim	Identificador KSN
Payment.CreditCard.EncryptedCardData.IsDataInTLVFormat	Bool	—	Não	Indica formato TLV
Payment.CreditCard.EncryptedCardData.InitializationVector	String	—	Sim	Vetor de inicialização
Payment.CreditCard.PinBlock.EncryptedPinBlock	String	—	Não	PIN criptografado (PP_GoOnChip / PP_GetPin)
Payment.CreditCard.PinBlock.EncryptionType	String	—	Não	Tipo: DukptDes, Dukpt3Des, MasterKey
Payment.CreditCard.PinBlock.KsnIdentification	String	—	Não	Identificação KSN
Payment.PinPadInformation.TerminalId	String	8	Sim	Número lógico do terminal
Payment.PinPadInformation.SerialNumber	String	20	Sim	Número de série
Payment.PinPadInformation.PhysicalCharacteristics	String	—	Sim	Enum de características do PIN pad
Payment.PinPadInformation.ReturnDataInfo	String	—	Sim	Retorno PP_GetInfo
``

Resposta

{
    "MerchantOrderId": "123456789123456",
    "Customer": {
        "Name": "[Guest]"
    },
    "Payment": {
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": true,
        "CreditCard": {
            "ExpirationDate": "07/2007",
            "SecurityCodeStatus": "Collected",
            "SecurityCode": "***",
            "BrandId": 2,
            "IssuerId": 2580,
            "TruncateCardNumberWhenPrinting": false,
            "PanSequenceNumber": 0,
            "InputMode": "MagStripe",
            "AuthenticationMethod": "OnlineAuthentication",
            "TrackOneData": "428AB8C3C05369D9095A9145BC75FFD638EEEA6FAE5A18E7DCEE686872AEA55AA33718CEC97A5DA615C5E91E2DEA4842937273919942838C2E",
            "TrackTwoData": "************************************************",
            "IsFallback": false,
            "PinBlock": {
                "EncryptedPinBlock": "30AFE7D2A93201B7",
                "EncryptionType": "Dukpt3Des",
                "KsnIdentification": "fffff99999C19FC0004F"
            },
            "BrandInformation": {
                "Type": "VENDA A CREDITO",
                "Name": "MASTERCARD"
            },
            "SaveCard": false,
            "EncryptedCardData": {
                "EncryptionType": 3,
                "TrackOneDataKSN": "FFFFF99995C18C800023",
                "TrackTwoDataKSN": "FFFFF99995C18C800023",
                "IsDataInTLVFormat": false
            }
        },
        "Amount": 1200,
        "ReceivedDate": "2024-06-03T18:55:09Z",
        "CapturedAmount": 1200,
        "CapturedDate": "2024-06-03T18:55:10Z",
        "Provider": "Cielo",
        "Status": 2,
        "PhysicalTransactionStatus": 2,
        "IsSplitted": false,
        "ReturnMessage": "APROVADA 316736",
        "ReturnCode": "000",
        "PaymentId": "146bc3a5-50ff-44b3-bd81-392c3bda6b16",
        "Type": "PhysicalCreditCard",
        "Currency": "BRL",
        "Country": "BRA",
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/physicalSales/146bc3a5-50ff-44b3-bd81-392c3bda6b16"
            },
            {
                "Method": "PUT",
                "Rel": "confirm",
                "Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/146bc3a5-50ff-44b3-bd81-392c3bda6b16/confirmation"
            },
            {
                "Method": "DELETE",
                "Rel": "reverse",
                "Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/physicalSales/146bc3a5-50ff-44b3-bd81-392c3bda6b16"
            }
        ],
        "PaymentDateTime": "2024-06-03T15:55:10.082Z",
        "ServiceTaxAmount": 0,
        "SoftDescriptor": "Teste API",
        "ProductId": 80,
        "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": "506017"
            },
            {
                "Field": "DATE",
                "Label": "DATA",
                "Content": "03/06/24"
            },
            {
                "Field": "HOUR",
                "Label": "HORA",
                "Content": "15:55"
            },
            {
                "Field": "ISSUER_NAME",
                "Label": "EMISSOR",
                "Content": "CIELO#MAESTRO"
            },
            {
                "Field": "CARD_HOLDER",
                "Label": "NOME DO CLIENTE",
                "Content": "CUST IMP MC 351/"
            },
            {
                "Field": "CARD_NUMBER",
                "Label": "CARTÃO",
                "Content": "541333-3511"
            },
            {
                "Field": "BRAND",
                "Label": "BANDEIRA",
                "Content": "MASTERCARD"
            },
            {
                "Field": "TRANSACTION_TYPE",
                "Label": "TIPO DE TRANSAÇÃO",
                "Content": "VENDA A CREDITO"
            },
            {
                "Field": "AUTHORIZATION_CODE",
                "Label": "AUTORIZAÇÃO",
                "Content": "910253"
            },
            {
                "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": "12,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": "506017",
            "Date": "03/06/24",
            "Hour": "15:55",
            "IssuerName": "CIELO#MAESTRO",
            "CardHolder": "CUST IMP MC 351/",
            "CardNumber": "541333-3511",
            "Brand": "MASTERCARD",
            "TransactionType": "VENDA A CREDITO",
            "AuthorizationCode": "910253",
            "TransactionMode": "ONL",
            "InputMethod": "D",
            "CpfCnpj": "73096766000195",
            "Value": "12,00",
            "SoftDescriptor": "Teste API"
        },
        "AuthorizationCode": "910253",
        "ProofOfSale": "506017",
        "InitializationVersion": 1716234911942,
        "ConfirmationStatus": 0,
        "SubordinatedMerchantId": "",
        "OfflinePaymentType": "Online",
        "MerchantAcquirerId": "0023137868169300",
        "TerminalAcquirerId": "41786816"
    }
}

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
MerchantOrderId	String	15	Sim	Identificador da transação (1 a 15 dígitos numéricos, não duplicado). Se data não informada, usa a atual.
Customer.Name	String	255	Não	Nome do comprador
Payment.Type	String	—	Sim	Value: PhysicalCreditCard
Payment.SoftDescriptor	String	13	Não	Nome reduzido do estabelecimento na fatura
Payment.Amount	Integer (int64)	15	Sim	Valor da transação (ex: 1079 = R$10,79)
Payment.Capture	Booleano	—	Não	Default: false / Indica captura automática
Payment.Installments	Integer	2	Sim	Default: 1 / Parcelas de 2 a 99 conforme regras do ProductEntry
Payment.Interest	String	10	Não	Default: ByMerchant / Enum: ByMerchant, ByIssuer
Payment.ProductId	Integer	—	Sim	Código do produto pelo BIN
Payment.ReceivedDate	String (DateTime)	—	Sim	Data de recebimento (AAAA-MM-DD HH:mm:ss)
Payment.CapturedAmount	Integer	15	Sim	Valor capturado (ex: 100 = R$1,00)
Payment.CapturedDate	Datetime	—	Não	Data da captura
Payment.Provider	String	15	Sim	Provedor do pagamento
Payment.InitializationVersion	Integer (int16)	—	Sim	Versão dos parâmetros
Payment.ConfirmationStatus	Integer	2	Não	0=Pendente, 1=Confirmado, 2=Desfeito
Payment.Status	Integer	2	Sim	0=Não finalizado, 1=Autorizado, 2=Pago, 3=Negado, 10=Cancelado, 13=Abortado
Payment.ReturnCode	String	3	Sim	Código de resposta
Payment.ReturnMessage	String	—	Sim	Mensagem de resposta
Payment.PaymentId	String (GUID)	36	Sim	Identificador do pagamento
Payment.PaymentDateTime	Datetime	—	Sim	Data do pagamento
Payment.ServiceTaxAmount	Decimal	—	Não	Taxa de serviço
Payment.AuthorizationCode	String	—	Sim	Código de autorização
Payment.ProofOfSale	String	—	Sim	NSU
Payment.SubordinatedMerchantId	Guid	36	—	Identificador da loja
Payment.OfflinePaymentType	String	—	Não	Tipo de pagamento
Payment.MerchantAcquirerId	String	—	Não	Identificador da loja adquirente
Payment.TerminalAcquirerId	String	—	Não	Terminal da loja
Payment.Currency	String	3	Sim	Moeda
Payment.Country	String	3	Sim	País
Payment.IsSplitted	Booleano	—	Não	Indica split (default: false)
Payment.CreditCard.ExpirationDate	String	MM/yyyy	Sim	Validade do cartão (PP_GetCard)
Payment.CreditCard.BrandId	Integer	—	Sim	Bandeira
Payment.CreditCard.IssuerId	Integer	—	Sim	Emissor
Payment.CreditCard.InputMode	String	—	Sim	Enum: Typed, MagStripe, Emv, ContactlessEmv
Payment.CreditCard.AuthenticationMethod	String	—	Sim	Enum: NoPassword, OnlineAuthentication, OfflineAuthentication
Payment.CreditCard.TrackOneData	String	—	Sim	Dados trilha 1
Payment.CreditCard.TrackTwoData	String	—	Não	Dados trilha 2
Payment.CreditCard.EncryptedCardData.EncryptionType	String	—	Sim	Tipo de criptografia
Payment.CreditCard.EncryptedCardData.CardNumberKSN	String	—	Sim	KSN
Payment.CreditCard.EncryptedCardData.IsDataInTLVFormat	Bool	—	Não	Indica formato TLV
Payment.CreditCard.EncryptedCardData.InitializationVector	String	—	Sim	Vetor de inicialização
Payment.CreditCard.PinBlock.EncryptedPinBlock	String	—	Sim	PIN criptografado
Payment.CreditCard.PinBlock.EncryptionType	String	—	Sim	Tipo de criptografia
Payment.CreditCard.PinBlock.KsnIdentification	String	—	Sim	KSN do PIN
Payment.CreditCard.BrandInformation.Type	String	—	Sim	Tipo da bandeira
Payment.CreditCard.BrandInformation.Name	String	—	Sim	Nome da bandeira
Payment.CreditCard.BrandInformation.Description	String	—	Sim	Descrição
Payment.PinPadInformation.TerminalId	String	8	Sim	Número lógico
Payment.PinPadInformation.SerialNumber	String	20	Sim	Número de série
Payment.PinPadInformation.PhysicalCharacteristics	String	—	Sim	Enum de características do PIN pad
Payment.PinPadInformation.ReturnDataInfo	String	—	Sim	Retorno PP_GetInfo
Payment.Receipt.MerchantName	String	255	Sim	Nome da loja
Payment.Receipt.MerchantAddress	String	255	Sim	Endereço
Payment.Receipt.MerchantCity	String	255	Sim	Cidade
Payment.Receipt.MerchantState	String	2	Sim	Estado
Payment.Receipt.MerchantCode	String	16	Sim	Código da loja
Payment.Receipt.Terminal	String	8	Sim	Terminal
Payment.Receipt.Nsu	String	6	Sim	NSU
Payment.Receipt.Date	String	dd/MM/yy	Sim	Data
Payment.Receipt.Hour	String	HH:mm	Sim	Hora
Payment.Receipt.IssuerName	String	255	Sim	Nome do emissor
Payment.Receipt.CardHolder	String	255	Não	Nome do titular
Payment.Receipt.CardNumber	String	19	Sim	Número do cartão
Payment.Receipt.Brand	String	255	Sim	Bandeira
Payment.Receipt.TransactionType	String	255	Sim	Tipo
Payment.Receipt.AuthorizationCode	String	6	Sim	Código autorização
Payment.Receipt.TransactionMode	String	3	Sim	Modo
Payment.Receipt.InputMethod	String	1	Sim	Método
Payment.Receipt.Value	String	15	Sim	Valor
Payment.Receipt.SoftDescriptor	String	13	Não	Nome reduzido
Payment.Links	Array	—	Não	Links de navegação
Payment.Links.Method	String	—	Sim	Método
Payment.Links.Rel	String	—	Sim	Relação
Payment.Links.Href	String	—	Sim	URL
Payment.PrintMessage	Array	—	Não	Dados de impressão
Payment.PrintMessage.Position	String	—	Sim	Posição
Payment.PrintMessage.Message	String	—	Sim	Mensagem
Payment.ReceiptInformation	Array	—	Não	Dados do recibo
Payment.ReceiptInformation.Field	String	—	Sim	Campo
Payment.ReceiptInformation.Label	String	—	Sim	Título
Payment.ReceiptInformation.Content	String	—	Sim	Conteúdo