Data Only authenticated payment

ℹ️

Please refer to the API Reference for complete request and response for the desired payment method:


After the authentication step in Data Only model is completed (field bpmpi_auth_notifyonly set as "true"), the transaction undergoes the authorization process by sending the authentication data in the “external authentication” model (node ExternalAuthentication).

See the example below, describing how Data Only authentication data should be sent to API E-commerce Cielo :

Data Only request

Environment

Method

Endpoint

Sandbox

https://apisandbox.cieloecommerce.cielo.com.br/1/sales/

Produção

https://apisandbox.cieloecommerce.cielo.com.br/1/sales/

{  
   "MerchantOrderId":"2017051002",
   "Customer":
   {  
     (...)
   },
   "Payment":
   {  
     (...)
     "Authenticate":false,
     "CreditCard":{  
         "CardNumber":"4000000000001000",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2027",
         "SecurityCode":"123",
         "Brand":"Mastercard",
         "SaveCard":"false"
     },
     "ExternalAuthentication":{
       "Eci":"4",
       "ReferenceID":"a24a5d87-b1a1-4aef-a37b-2f30b91274e6",
       "Xid":"Uk5ZanBHcWw2RjRCbEN5dGtiMTB=",
       "Version":"2.2.0",
       "dataonly":true
     }
   }
}
--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":false,
     "ReturnUrl":"http://www.loja.com.br",
     "CreditCard":{  
         "CardNumber":"4000000000001000",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2027",
         "SecurityCode":"123",
         "Brand":"Mastercard",
         "SaveCard":"false"
     },
     "ExternalAuthentication":{
       "Eci":"4",
       "ReferenceID":"a24a5d87-b1a1-4aef-a37b-2f30b91274e6",
       "Xid":"Uk5ZanBHcWw2RjRCbEN5dGtiMTB=",
       "Version":"2.2.0",
       "dataonly":true
     }
   }
}

Parameters

Description

Type/Size

Required

Payment.Authenticate

Defines if the shopper will be directed to the issuing bank for authentication

Boolean (true or false)

Yes.

  • *For Data Only transactions the value must be "false".**.

Payment.ExternalAuthentication.Eci

  • E-commerce Indicator_ returned in authentication process

Numeric ase refer to

Yes

Payment.ExternalAuthentication.ReferenceId

RequestId returned in authentication process

GUID Please refer t

Yes

Payment.ExternalAuthentication.DataOnly

Defines if transaction is Data Only

Boolean (true or false)

Yes. For Data Only transactions the value must be "true".

Payment.ExternalAuthentication.Cavv

Signature returned in the script output when succesful (event OnSuccess).

text

Yes, if authentication was successful.

Payment.ExternalAuthentication.Version

Version of the 3DS protocol applied in the authentication process.\
Possible values:

  • Visa and Mastercard: "2.2.0"
  • Elo and Amex: "2.1.0"

text Please refer

Yes