ℹ️
Saiba mais sobre essa funcionalidade na documentação.

Confira os campos a serem enviados na transação caso a opção escolhida seja a integração externa:

Requisição

Ambiente	Método	Endpoint
Sandbox	post	`https://apisandbox.cieloecommerce.cielo.com.br/1/sales`
Produção	post	`https://api.cieloecommerce.cielo.com.br/1/sales`

Parâmetros no cabeçalho (header)

Parâmetro	Descrição	Tipo	Tamanho	Obrigatório
Content-Type	Tipo de mídia aceito pelo recurso.	String	40	Sim
MerchantId	Identificador da loja na Cielo.	String	36	Sim
MerchantKey	Chave pública para autenticação dupla na Cielo.	String	40	Sim
RequestId	Identificador da requisição, usado quando a loja usa diferentes servidores para cada GET/POST/PUT.	String	36	Não

Parâmetros no corpo (body)

Confira a requisição padrão de cartão de crédito para verificar todos os campos obrigatórios. A tabela abaixo apresenta os parâmetros exclusivos para a tokenização via integração externa.

Parâmetro	Tipo	Tamanho	Obrigatório	Descrição
`Payment.CreditCard.CardNumber`	Texto	19	Sim	Token gerado pela bandeira (DPAN). A indicação de que o `CardNumber` deve ser preenchido com o DPAN para caso de tokenização de bandeira.
`Payment.CreditCard.Holder`	Texto	25	Sim	Nome do Comprador impresso no cartão.
`Payment.CreditCard.Cryptogram`	Texto	28	Condicional*	Criptograma gerado pela bandeira. Deve ser enviado caso a tokenização seja feita na bandeira (integração externa).
`Payment.CreditCard.ExpirationDate`	Texto	7	Sim	Data de validade do token gerado pela bandeira.
`Payment.CreditCard.SecurityCode`	Texto	4	Não	Código de segurança impresso no verso do cartão - Ver Anexo.
`Payment.CreditCard.SaveCard`	Booleano	***	Não (Default false)	Booleano que identifica se o cartão será salvo para gerar o CardToken. Saiba mais sobre Tokenização.
`Payment.CreditCard.Brand`	Texto	10	Sim	Bandeira do cartão (Visa / Master / Amex / Elo / Aura / JCB / Diners / Discover / Hipercard).

*Deve ser enviado caso a tokenização seja feita na bandeira (integração externa).

Exemplo da requisição

{
  "MerchantOrderId": "Loja123456",
  "Customer": {
    "Name": "Comprador Teste",
    "Email": "[email protected]",
    "Birthdate": "1991-01-02",
    "Address": {
      "Street": "Rua Teste",
      "Number": "123",
      "Complement": "AP 123",
      "ZipCode": "12345987",
      "City": "Rio de Janeiro",
      "State": "RJ",
      "Country": "BRA"
    },
    "DeliveryAddress": {
      "Street": "Rua Teste",
      "Number": "123",
      "Complement": "AP 123",
      "ZipCode": "12345987",
      "City": "Rio de Janeiro",
      "State": "RJ",
      "Country": "BRA"
    }
  },
  "Payment": {
    "Type": "CreditCard",
    "Amount": 15700,
    "Currency": "BRL",
    "Country": "BRA",
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": false,
    "SoftDescriptor": "123456789ABCD",
    "CreditCard": {
      "CardNumber": "1234123412341231",
      "Holder": "Teste Holder",
      "Cryptogram": "abcdefghijklmnopqrstuvw==",
      "ExpirationDate": "12/2030",
      "SecurityCode": "123",
      "SaveCard": "true",
      "Brand": "Visa"
    }
  }
}

Resposta

{
    "MerchantOrderId": "Loja123456",
    "Customer": {
        "Name": "Comprador Teste",
        "Identity":"11225468954",
        "IdentityType":"CPF",
        "Email": "[email protected]",
        "Birthdate": "1991-01-02",
        "Address": {
            "Street": "Rua Teste",
            "Number": "123",
            "Complement": "AP 123",
            "ZipCode": "12345987",
            "City": "Rio de Janeiro",
            "State": "RJ",
            "Country": "BRA"
        },
        "DeliveryAddress": {
            "Street": "Rua Teste",
            "Number": "123",
            "Complement": "AP 123",
            "ZipCode": "12345987",
            "City": "Rio de Janeiro",
            "State": "RJ",
            "Country": "BRA"
        }
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": true,
        "Authenticate": false,
        "CreditCard": {
            "CardNumber": "455187******0183",
            "Holder": "Teste Holder",
            "ExpirationDate": "12/2030",
            "SaveCard": true,
            "CardToken": "d37bf475-307d-47be-b50a-8dcc38c5056c",
            "Brand": "Visa"
        },
        "ProofOfSale": "674532",
        "Tid": "0305020554239",
        "AuthorizationCode": "123456",
        "SoftDescriptor":"123456789ABCD",
        "PaymentId": "24bc8366-fc31-4d6c-8555-17049a836a07",
        "Type": "CreditCard",
        "Amount": 15700,
        "CapturedAmount": 15700,
        "Country": "BRA",
        "ExtraDataCollection": [],
        "Status": 2,
        "ReturnCode": "6",
        "ReturnMessage": "Operation Successful",
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}"
            }
            {
                "Method": "PUT",
                "Rel": "void",
                "Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void"
            }
        ]
    }
}

Propriedades da resposta

Parâmetro	Descrição	Tipo	Tamanho	Formato
`ProofOfSale`	Número da autorização, idêntico ao NSU.	Texto	6	Texto alfanumérico
`Tid`	Id da transação na adquirente.	Texto	20	Texto alfanumérico
`AuthorizationCode`	Código de autorização.	Texto	6	Texto alfanumérico
`SoftDescriptor`	Texto que será impresso na fatura bancária do portador - disponível apenas para VISA/MASTER - não permite caracteres especiais	Texto	13	Texto alfanumérico
`PaymentId`	Número de identificação do pagamento, necessário para operações como Consulta, Captura e Cancelamento.	GUID	36	xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
`ECI`	Eletronic Commerce Indicator. Representa o quão segura é uma transação.	Texto	2	Exemplos: 7
`Status`	Status da Transação.	Byte	***	2
`ReturnCode`	Código de retorno da adquirência.	Texto	32	Texto alfanumérico
`ReturnMessage`	Mensagem de retorno da adquirência.	Texto	512	Texto alfanumérico
`Cardtoken`	Token de identificação do Cartão.	GUID	36	xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx