Criar pagamento recorrente

Autoriza uma recorrência com cartão de crédito

Ambiente

Método

Endpoint

Sandbox

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

Produção

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

ℹ️

Saiba mais sobre essa funcionalidade na documentação.

Adicione o nó RecurrentPayment ao nó Payment para configurar uma recorrência ao autorizar uma transação pela primeira vez na série de recorrências.

ℹ️

CNPJs alfanuméricos serão implementados pela Receita Federal em julho de 2026

Essa mudança afeta apenas novas inscrições, não havendo mudanças em CNPJs existentes.

O CNPJ alfanumérico já está sendo suportado pela Cielo, sem mudanças na sua integração.

Recomendamos verificar a necessidade de possíveis ajustes nos sistemas próprios de checkout de sua loja.

Identificadores de bandeira: na recorrência programada, os campos IssuerTransactionId e TransactionLinkId são enviados automaticamente nas transações seguintes. Em sandbox, esses campos só são retornados com o provider Simulado e cenário de transação autorizada. Saiba mais em Identificadores da bandeira para adquirente Cielo.

TLID Mastercard

O Transaction Link Identifier (TLID), enviado e retornado no campo TransactionLinkId, é um identificador único gerado pela bandeira Mastercard durante uma transação CIT, usado para vincular as transações MIT relacionadas. O TLID vale para a resposta do VerifyCard (apenas resposta) e para as transações de crédito, débito e recorrência.

Na Mastercard, envie IssuerTransactionId e TransactionLinkId juntos nas transações MIT: os dois parâmetros são obrigatórios.

FaseDescrição
Fase 1Vigente. O campo TransactionLinkId está disponível na resposta da validação de cartão por VerifyCard, criação de pagamento com cartão de crédito, criação de pagamento com cartão de débito e na consulta por PaymentId.
Fase 2Envio obrigatório do TransactionLinkId no request (MIT) a partir de 23/10/2026.

Recorrência programada: nas transações seguintes, os campos IssuerTransactionId e TransactionLinkId são enviados automaticamente.

O TransactionLinkId enviado no request deve ter exatamente 22 caracteres (A-Z, a-z, 0-9, hífen e sublinhado). Se o valor estiver fora desse formato, a Cielo o ignora, sem retornar erro. Quando a Cielo envia o TLID à bandeira, a resposta traz também o SentTransactionLinkId, com o valor enviado. O request do VerifyCard não aceita o campo.

Saiba mais em Identificadores da bandeira para adquirente Cielo.


Resposta da transação de pagamento recorrente

A tabela a seguir apresenta os principais parâmetros que podem ser retornados pela API na criação de um pagamento recorrente.

Propriedade

Descrição

Tipo

Tamanho

RecurrentPaymentId

ID que representa a recorrência, utilizada para consultas e alterações futuras.

string

36

NextRecurrency

Data de quando acontecerá a próxima recorrência.

string

10

EndDate

Data do fim da recorrência.

string

10

Interval

Intervalo entre as recorrências.

string

10

AuthorizeNow

Define se a primeira recorrência já irá ser autorizada ou não.
Caso deseje autorizar uma recorrência posteriormente, veja como Agendar uma recorrência.

booleano


CardBrandStatus

Retorno de status da conta Mastercard

  • VALID: Cartão Valido ou sem atualizações na base;
  • UNKNOWN: Cartão não está disponível na ABU;
  • NON_PARTICIPATING: Cartão não está disponível na ABU;
  • ACCOUNT_CLOSED: Cartão está encerrado;
  • UPDATE: Atualização de plástico ou validade;
  • EXPIRY: Atualização da validade;
  • ERROR: Houve algum erro na atualização (ex: timeout).
    Saiba mais na documentação

string


Payment.IssuerTransactionId

Identificador da transação gerado pela bandeira e retornado na resposta da transação CIT. Armazene o valor para enviá-lo nas transações MIT seguintes: o envio é obrigatório, para todas as bandeiras, em transações recorrentes, incrementais e reautorizadas. Consulte mais informações em Identificadores da bandeira para adquirente Cielo.

string

30

Payment.TransactionLinkId

Identificador único (TLID) gerado pela Mastercard e retornado na resposta, usado para vincular a transação CIT às transações MIT seguintes. Na Mastercard, envie o TransactionLinkId original junto com o IssuerTransactionId: os dois são obrigatórios, e o envio do TransactionLinkId é obrigatório a partir de 23/10/2026. Consulte mais informações em Identificadores da bandeira para adquirente Cielo.

Formato: 22 caracteres alfanuméricos (A-Z, a-z), com diferenciação entre maiúsculas e minúsculas e podem incluir hífens (-) e sublinhados (_).

string

22

Campos retornados pelo Renova Fácil

Caso a loja tenha o Renova Fácil ou o ABU habilitado, e exista um novo cartão disponível, os dados atualizados serão retornados no nó NewCard da resposta.

Propriedade

Descrição

Tipo

Tamanho

NewCard.CardNumber

Novo número do cartão do comprador.

string

16

NewCard.ExpirationDate

Nova data de validade do cartão.

string

7

NewCard.Brand

Bandeira do cartão.

string

10

NewCard.SaveCard

Identifica se o cartão gerou Cardtoken durante a transação. Saiba mais sobre Tokenização

booleano


⚠️

Adquirente Rede

  • Para o provider Rede2, a resposta irá retornar o BrandTransactionId, que é o identificador de transações recorrentes junto às bandeiras na adquirente Rede.
  • A cada nova transação da sequência de recorrências é necessário informar o BrandTransactionId.
  • Para bandeiras Visa ou Elo informe o BrandTransactionId recebido na primeira transação.
  • Para bandeira Mastercard informe o BrandTrasactionId recebido na primeira transação ou na transação anterior.
  • O valor do BrandTransactionId será novo a cada resposta da transação recorrente.

Meio de pagamento aceito: cartão de crédito.

Body Params
string
required

Número de identificação do pedido. Tamanho: 50.

Customer
object
Payment
object
Headers
string
required
Defaults to e3c24810-18bb-4bd7-88a0-a36d6b4a0731

Identificador da loja no Gateway de Pagamento. Tamanho: 36. Formato: GUID.
Esta documentação traz um MerchantId padrão para permitir os testes em sandbox, mas você também pode informar o MerchantId habilitado durante o processo de implantação.

string
required
Defaults to GQUAIWVDKUINZRHDQPLHUVHAIIFEIXFEXWPOYGHY

Chave pública para autenticação dupla no Gateway de Pagamento. Tamanho: 40. Formato: GUID.
Esta documentação traz um MerchantKey padrão para permitir os testes em sandbox, mas você também pode informar o MerchantKey habilitado durante o processo de implantação.

string

Identificador do request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT. Tamanho: 36.

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json