This page will help you get started with Recurrence.
Ambiente | Método | Endpoint |
|---|---|---|
Sandbox | post |
|
Produção | post |
|
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;
- The
IssuerTransactionIdandTransactionLinkIdfields are only returned with theSimuladoprovider and the authorized-transaction scenario.
Card brand identifiers: in scheduled recurrence, the
IssuerTransactionIdandTransactionLinkIdfields are sent automatically in subsequent transactions. See more details in Card Brand Identifiers.
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 |
|---|---|---|---|
| Authorization number, identical to NSU. | string | 6 |
| Transaction identifier at the acquirer. | string | 20 |
| Authorization code. | string | 6 |
| Payment identification number. | GUID | 36 |
| Transaction status. See the complete table of transactional status. | byte | |
| Return code. | string | 32 |
| Return message. | string | 512 |
| Return code from the card brand that defines retry period. Valid only for Mastercard. Learn more Card brands retry program for Mastercard. | string | 2 |
| 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 |
| Field identifier of the next recurrence. | GUID | 36 |
| Date of the next recurrence. | string | 7 |
| End date of the recurrence. | string | 7 |
| Interval between recurrences. | integer | 10 |
| Boolean to know if the first recurrence will be authorized or not. | boolean | |
| Mastercard account status feedback
| string | |
| Transaction identifier generated by the card brand and returned in the response of the CIT transaction. Store the value to send it in subsequent MIT transactions: sending is mandatory, for all card brands, in recurring, incremental, and reauthorized transactions. See more details in Card Brand Identifiers. | string | 30 |
| Unique identifier (TLID) generated by Mastercard and returned in the response, used to link the CIT transaction to subsequent MIT transactions. For Mastercard, send the original | string | 22 |
Fields returned by Renova Fácil
Propriedade | Descrição | Tipo | Tamanho |
|---|---|---|---|
| Shopper's new card number. | string | 16 |
| New expiry date of the card. | string | 7 |
| Card brand. | string | 10 |
| Identifies whether the card generated | booleano |