Create recurring payment

Authorize a recurring payment with a credit card

Environment

Method

Endpoint

Sandbox

https://apisandbox.braspag.com.br/v2/sales/

Production

https://api.braspag.com.br/v2/sales/

Add the RecurrentPayment node to the Payment node to configure a recurrence when authorizing a transaction for the first time in the series of recurrences.

ℹ️

Alphanumeric CNPJs will be implemented by the Brazilian Federal Revenue Service in July 2026

This change applies only to new registrations. There will be no changes to existing CNPJs.

The alphanumeric CNPJ is already supported by Cielo, with no changes required to your integration.

We recommend checking whether adjustments are needed in your merchant’s own checkout systems.


Stored credential transaction identifiers

According to card brand rules, recurring transactions and those with stored credentials may require additional identification fields, such as IssuerTransactionId and TransactionLinkId. See more details below.

Card brand identifier: IssuerTransactionId

The card brand identifier is an identification code for recurring or stored credential transactions, returned in the authorization response or in the card verification response (VerifyCard). See more details in IssuerTransactionId.

TLID Mastercard

The Transaction Link Identifier (TLID) is a unique identifier generated by the Mastercard card brand during a transaction. It is created in the initial transaction (CIT) and must be used to associate all subsequent transactions (MIT) within the same cycle.

PhaseDescription
Phase 1Availability of the TransactionLinkId in the responses of VerifyCard by card number, credit card payment creation, debit card payment creation, and in the query by PaymentId.
Phase 2Required inclusion of the TransactionLinkId in the request (MIT) starting Oct 23, 2026

See more details in Brand identifiers for Cielo.


Recurring payment transaction response

The following table presents the main parameters that can be returned by the API when creating a recurring payment.

Property

Description

Type

Size

RecurrentPaymentId

ID that represents the recurrence, used for future queries and changes.

string

36

NextRecurrency

Date when the next recurrence will occur.

string

10

EndDate

Date when the recurrence ends.

string

10

Interval

Interval between recurrences.

string

10

AuthorizeNow

Defines whether the first recurrence will be authorized immediately or not.
If you want to authorize a recurrence later, see Schedule a recurrence.

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)

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 Brand identifiers for Cielo acquirer.

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 Brand identifiers for Cielo acquirer.
Format: 22 alphanumeric characters (A–Z, a–z), case-sensitive, and may include hyphens (-) and underscores ()._

string

22

Fields returned by Renova Fácil

PropriedadeDescriçãoTipoTamanho
NewCard.CardNumberShopper's new card number.string16
NewCard.ExpirationDateNew expiry date of the card.string7
NewCard.BrandCard brand.string10
NewCard.SaveCardIdentifies whether the card generated Cardtoken during the transaction. Find out more about Tokenization of Cardsbooleano***
⚠️

Acquirer Rede

  • For the Rede2 provider, the response will return the BrandTransactionId, which is the identifier of recurring transactions with the flags at the Rede acquirer.
  • For each new transaction in the sequence of recurrences, the BrandTransactionId must be entered.
  • For Visa or Elo brands, enter the BrandTransactionId received in the first transaction.
  • For Mastercard, enter the BrandTransactionId received on the first or previous transaction.
  • The value of the BrandTransactionId will be new with each recurring transaction response.

Body Params
string
required

Order ID number.

Customer
object
Payment
object
Headers
string
required

Store identifier at Gateway de Pagamento. Size: 36.

string
required

Public key for dual authentication at Gateway de Pagamento. Size: 40.

string

Store-defined 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