Create a debit card payment

Environment

Method

Endpoint

Sandbox

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

Production

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

Warning

  • In a standard debit card transaction (with authentication), send Authenticate = "true".
  • Mastercard debit transactions with stored credentials: Mastercard requires the Transaction Initiation Indicator for credit and debit card purchases using stored card data. The goal is to indicate whether the transaction was initiated by the cardholder (Cardholder-Initiated Transaction - CIT) or by the merchant (Merchant-Initiated Transaction - MIT). In this scenario, it is mandatory to send the InitiatedTransactionIndicator node with the Category and SubCategory parameters for Mastercard transactions, within the Payment node. Check the list of categories in the Category parameter description and the complete table of subcategories in Mastercard Transaction Initiation Indicator.
  • It is not possible to perform a transaction with an Amount = 0. To verify if a card is valid, use Zero Auth.
  • To confirm if authentication was accepted in the authorization, check the ECI value returned in Payment.Eci. The API replicates the ECI informed by the merchant in the Payment.ExternalAuthentication field. However, the value actually used by the brand in the authorization is the one shown in Payment.Eci.
⚠️

Identification of transactions originating from payment links for Elo cards

Starting October 17, 2025, it will be mandatory to identify transactions originating from payment links for Elo-branded cards. Send the parameter Payment.SolutionType = "ExternalLinkPay".

Debit card transaction response

Following table presents the main parameters that may be returned by the API when creating a debit card payment.

Property

Description

Type

Syze

ProofOfSale

Authorization number, identical to NSU

string

6

Tid

Acquirer transaction identifier

string

20

AuthorizationCode

Authorization code

string

6

PaymentId

Payment identification number. PaymentId will be used in future operations such as query, capture, and void.

GUID

36

Status

Transaction Status. See the complete table of transactional status.

byte


ReturnCode

Return code

string

32

ReturnMessage

Return message

string

512

SentOrderId

Indicates which order number was sent to the acquirer.

  • If the number provided is in an invalid format, the acquirer will generate a new identifier, returned in the SentOrderId field.
  • If the format is valid and accepted by the acquirer, the SentOrderId field will contain the same value provided in MerchantOrderId.

GUID

Payment.MerchantAdviceCode

Brand return code that defines the retry period. Valid only for Mastercard brand. Learn more about card brands retry programs

string

2

TryAutomaticCancellation

Returns "true" if the Void Guarantee is enabled and an error occurs during authorization (status Not Finalized - "0").

boolean


Payment.CreditCard.PaymentAccountReference

PAR (Payment Account Reference) is the number that associates different tokens to the same card. It will be returned by Master and Visa card brands and passed on to Cielo e-commerce clients. If the card brand does not send the information, the field will not be returned.

string

29

Language
Click Try It! to start a request and see the response here!