English
Docs
AtendimentoAPI Status

Autorização com autenticação

ℹ️

Confira os exemplos completos de requisição e resposta para cada meio de pagamento:

Após a conclusão da autenticação do portador do cartão, a loja deve submeter a transação ao processo de autorização, enviando os dados de autenticação no modelo de "autenticação externa" (nó ExternalAuthentication), tanto para 3DS Server interno quanto para 3DS Server externo.

Veja a seguir um exemplo de requisição de autorização à API E-commerce Cielo:


Requisição de autorização com o nó da autenticação

Confira a seguir o exemplo de uma autorização de cartão de crédito com o nó da autenticação.

EnvironmentMethodEndpoint
Sandbox
post
https://apisandbox.cieloecommerce.cielo.com.br/1/sales
Production
post
https://api.cieloecommerce.cielo.com.br/1/sales
{
   "MerchantOrderId":"2017051002",
   "Customer":
   {
     (...)
   },
   "Payment":
   {
     (...)
     "Authenticate":true,
     "CreditCard":{
         "CardNumber":"4000000000001000",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2021",
         "SecurityCode":"123",
         "Brand":"Visa",
         "SaveCard":"false"
     },
     "ExternalAuthentication":{
       "Cavv":"AAABB2gHA1B5EFNjWQcDAAAAAAB=",
       "Xid":"Uk5ZanBHcWw2RjRCbEN5dGtiMTB=",
       "Eci":"5",
       "Version":"2",
       "ReferenceID":"a24a5d87-b1a1-4aef-a37b-2f30b91274e6"
     }
   }
}

curl
--request POST "https://apisandbox.cieloecommerce.cielo.com.br/1/sales"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
--header "MerchantKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
--data-binary
--verbose
{
   "MerchantOrderId":"2017051002",
   "Customer":
   {
     (...)
   },
   "Payment":
   {
     (...)
     "Authenticate":true,
     "CreditCard":{
         "CardNumber":"4000000000001000",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2021",
         "SecurityCode":"123",
         "Brand":"Visa",
         "SaveCard":"false"
     },
     "ExternalAuthentication":{
       "Cavv":"AAABB2gHA1B5EFNjWQcDAAAAAAB=",
       "Xid":"Uk5ZanBHcWw2RjRCbEN5dGtiMTB=",
       "Eci":"5",
       "Version":"2",
       "ReferenceId":"a24a5d87-b1a1-4aef-a37b-2f30b91274e6"
     }
   }
}
CampoDescriçãoTipoTamanhoObrigatório
Payment.ProviderNome do provedor do meio de pagamento (Cielo30).texto15 posiçõesSim.
Payment.AuthenticateDefine se o comprador será direcionado ao emissor para autenticação do cartão.booleano ("true" / "false")-Sim, caso a autenticação seja validada.
Payment.ExternalAuthentication.CavvAssinatura retornada nos cenários de sucesso na autenticação.texto-Sim, caso a autenticação seja validada.
Payment.ExternalAuthentication.XidXID retornado no processo de autenticação.texto-Sim, quando a versão do 3DS for "2" ou superior.
Payment.ExternalAuthentication.EciElectronic Commerce Indicator retornado no processo de autenticação.número1 posiçãoSim.
Payment.ExternalAuthentication.VersionVersão do 3DS aplicado no processo de autenticação.
Valores possíveis:

- Visa e Mastercard: "2.2.0"
- Elo e Amex: "2.1.0"		alfanumérico5 posições.Sim, quando a versão do 3DS for "2" ou superior.
Payment.ExternalAuthentication.ReferenceIDRequestID retornado no processo de autenticação.GUID36 posiçõesSim, quando a versão do 3DS for "2" ou superior.

A resposta irá seguir o padrão de uma resposta de transação de crédito ou débito. Confira os detalhes na Referência da API.

Updated 3 months ago