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.

⚠️

Identificação de transações oriundas de link de pagamento para cartões da bandeira Elo

A partir de 17 de outubro de 2025 será obrigatório identificar transações oriundas de link de pagamento para cartões da bandeira Elo. Envie o parâmetro Payment.SolutionType = "ExternalLinkPay".

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

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.

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