Create a recurrent payment

This page will help you get started with Recurrence.

Ambiente

Método

Endpoint

Sandbox

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

Produção

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

Guidelines for creating recurring transactions in sandbox:

  • The card must end in 0, 1, or 4;
  • Card must be valid according to mod10 (Luhn Algorithm), as the recurring transaction stores the card in a tokenized form.

Recurring credit card transaction response

The table below presents the main parameters that can be returned by the API when creating a recurring credit card payment. The response will also contain the data provided during the creation of the recurring payment.

Property

Description

Type

Size

ProofOfSale

Authorization number, identical to NSU.

string

6

Tid

Transaction identifier at the acquirer.

string

20

AuthorizationCode

Authorization code.

string

6

PaymentId

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

GUID

36

Status

Transaction status. See the complete table of transactional status.

byte


ReturnCode

Return code.

string

32

ReturnMessage

Return message.

string

512

Payment.MerchantAdviceCode

Return code from the card brand that defines retry period. Valid only for Mastercard. Learn more Card brands retry program for Mastercard.

string

2

Payment.CreditCard.PaymentAccountReference

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

string

29

RecurrentPaymentId

Field identifier of the next recurrence.

GUID

36

NextRecurrency

Date of the next recurrence.

string

7

EndDate

End date of the recurrence.

string

7

Interval

Interval between recurrences.

integer

10

AuthorizeNow

Boolean to know if the first recurrence will be authorized or not.

boolean


CardBrandStatus

Mastercard account status feedback

  • VALID: Valid card or no updates on base
  • UNKNOWN: Card not available at ABU
  • NON_PARTICIPATING: Card not available at ABU
  • ACCOUNT_CLOSED: Card is closed
  • UPDATE: vUpdate plastic or expiration
  • EXPIRY: Validity update
  • ERROR: There was an error in the update (Timeout for example)
    Find out more in the documentation

string


Payment.IssuerTransactionId

Transaction identifier generated by the card brand; it must be sent to reference the original/previous transaction in related operations, such as recurring payments. See more details in IssuerTransactionId.

string

30

Payment.TransactionLinkId

TransactionLinkId is a unique identifier generated by Mastercard for each transaction. It must be used to link the initial transaction to subsequent related transactions. See more details in TLID Mastercard
Format: 22 alphanumeric characters (A–Z, a–z), case-sensitive, and may include hyphens (-) and underscores (_).

string

22

Fields returned by Renova Fácil

Propriedade

Descrição

Tipo

Tamanho

NewCard.CardNumber

Shopper's new card number.

string

16

NewCard.ExpirationDate

New expiry date of the card.

string

7

NewCard.Brand

Card brand.

string

10

NewCard.SaveCard

Identifies whether the card generated Cardtoken during the transaction. Find out more about Tokenization of Cards.

booleano


Body Params
string
required

Order identification number. Warning: Allowed characters are a-z, A-Z, 0-9. Special characters and blank spaces are not allowed. Size: 20.

Customer
object
Payment
object
Headers
string
required
Defaults to 8937bd5b-9796-494d-9fe5-f76b3e4da633

Store identifier in API E-commerce Cielo. Size: 36. This documentation provides a default MerchantId to allow testing in the sandbox, but you can also provide the enabled MerchantId during the deployment process.

string
required
Defaults to XKGHUBSBKIRXKAVPSKWLVXYCLVJUGTNZLIHPUSYV

Public Key for Double Authentication in API E-commerce Cielo. Size: 40. This documentation provides a default MerchantKey to allow testing in the sandbox, but you can also provide the enabled MerchantKey during the deployment process.

string

Request Identifier, used when the merchant uses different servers for each GET/POST/PUT. Size: 36.

Response

Language
LoadingLoading…
Response
Choose an example:
application/json