Agendar recorrência

ℹ️
Saiba mais sobre essa funcionalidade na documentação.

Diferente da autorização de recorrência, este exemplo não autoriza imediatamente, mas agenda uma autorização futura.

Para agendar a primeira transação da série de recorrências:

Envie Payment.RecurrentPayment.AuthorizeNow = "false";
Adicione o parâmetro Payment.RecurrentPayment.StartDate e envie a data para autorização.

ℹ️
Ao configurar uma recorrência com uma data de início (StartDate) anterior à data atual, o sistema realizará cobranças retroativas diárias, uma para cada pagamento pendente até a data atual. Esse processo continua até que a próxima data de cobrança seja futura.

⚠️
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".

Requisição

Ambiente	Método	Endpoint
Sandbox	post	`https://apisandbox.braspag.com.br/v2/sales/`
Produção	post	`https://api.braspag.com.br/v2/sales/`

{  
   "MerchantOrderId":"2017091101",
   "Customer":{  
      "Name":"Nome do Comprador",
      "Identity":"12345678909",
      "IdentityType":"CPF",
      "Address":{  
         "Street":"Alameda Xingu",
         "Number":"512",
         "Complement":"27 andar",
         "ZipCode":"12345987",
         "City":"São Paulo",
         "State":"SP",
         "Country":"BRA",
         "District":"Alphaville"
      }
   },
   "Payment":{
      "Provider":"Simulado",
      "Type":"CreditCard",
      "Amount":10000,
      "Installments":1,
      "SolutionType": "ExternalLinkPay",
      "CreditCard":{
         "CardNumber":"5412217070050381",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2021",
         "SecurityCode":"123",
         "Brand":"Visa"
      },
      "RecurrentPayment":{
         "AuthorizeNow":false,
         "StartDate":"2017-12-31",
         "EndDate":"2019-12-31",
         "Interval":"Monthly"
      }
   }
}

A seguir, a listagem de campos da Requisição:

Propriedade	Descrição	Tipo	Tamanho	Obrigatório?
`Payment.Provider`	Nome do provedor do meio de pagamento.	texto	15	Sim
`Payment.Type`	Tipo do meio de pagamento.	texto	100	Sim
`Payment.Amount`	Valor do pedido, em centavos.	número	15	Sim
`Payment.Installments`	Número de parcelas.	número	2	Sim
`Payment.RecurrentPayment.StartDate`	Data para início da recorrência.	texto	10	Não
`Payment.RecurrentPayment.EndDate`	Data para término da recorrência.	texto	10	Não
`Payment.RecurrentPayment.Interval`	Intervalo da recorrência. Monthly (default) / Bimonthly / Quarterly / SemiAnnual / Annual	texto	10	Não
`Payment.RecurrentPayment.DailyInterval`	Padrão da recorrência em dias. Não utilizar em conjunto com `Interval`.	número	2	Não*
`Payment.RecurrentPayment.AuthorizeNow`	"true" - autoriza no momento da requisição. "false" - para agendamento futuro.	booleano		Sim
`Payment.SolutionType`	Origem do pagamento. Obrigatório para transação de cartão da bandeira Elo oriunda de link de pagamento. Enviar como "ExternalLinkPay".	string	15	Não
`CreditCard.CardNumber`	Número do cartão do comprador.	texto	19	Sim
`CreditCard.Holder`	Nome do comprador impresso no cartão. Obs.: Regras de tamanho do campo podem variar de acordo com a adquirente.	texto	25	Sim
`CreditCard.ExpirationDate`	Data de validade impressa no cartão, no formato MM/AAAA.	texto	7	Sim
`CreditCard.SecurityCode`	Código de segurança impresso no verso do cartão.	texto	4	Sim
`CreditCard.Brand`	Bandeira do cartão.	texto	10	Sim

Resposta

{
    "Payment": {
      "ServiceTaxAmount": 0,
      "Installments": 1,
      "Interest": "ByMerchant",
      "Capture": true,
      "Authenticate": false,
      "Recurrent": false,
      "SolutionType": "ExternalLinkPay",
      "CreditCard": {
        "CardNumber": "455187******0181",
        "Holder": "Nome do Portador",
        "ExpirationDate": "12/2021",
        "SaveCard": false,
        "Brand": "Undefined"
      },
      "Type": "CreditCard",
      "Amount": 10000,
      "Currency": "BRL",
      "Country": "BRA",
      "Provider": "Simulado",
      "Status": 20,
      "RecurrentPayment": {
        "RecurrentPaymentId": "32703035-7dfb-4369-ac53-34c7ff7b84e8",
        "ReasonCode": 0,
        "ReasonMessage": "Successful",
        "NextRecurrency": "2017-12-31",
        "StartDate": "2017-12-31",
        "EndDate": "2019-12-31",
        "Interval": "Monthly",
        "AuthorizeNow": false
      }
    }
  }

A seguir, a listagem de campos da Resposta:

Propriedade	Descrição	Tipo	Tamanho	Formato
`RecurrentPaymentId`	Campo identificador da próxima recorrência.	GUID	36	xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
`NextRecurrency`	Data da próxima recorrência.	texto	7	05/2019 (MM/YYYY)
`StartDate`	Data do início da recorrência.	texto	7	05/2019 (MM/YYYY)
`EndDate`	Data do fim da recorrência.	texto	7	05/2019 (MM/YYYY)
`Interval`	Intervalo entre as recorrências.	texto	10	Monthly / Bimonthly / Quarterly / SemiAnnual / Annual
`AuthorizeNow`	Define se a primeira recorrência já irá ser autorizada ou não.	booleano	***	true ou false