post https://apisandbox.cieloecommerce.cielo.com.br/1/sales/
Cria ou agenda transações recorrentes.
| Ambiente | Método | Endpoint |
|---|---|---|
| Sandbox | post | https://apisandbox.cieloecommerce.cielo.com.br/1/sales/ |
| Produção | post | https://api.cieloecommerce.cielo.com.br/1/sales/ |
Saiba mais sobre essa funcionalidade na documentação.
Atenção
Informe os parâmetros de acordo com a operação desejada: recorrência própria, recorrência programada ou agendamento de recorrência programada.
| Tipo de Recorrência | Particularidades |
|---|---|
| Recorrência Própria | É usada quando a loja cria a própria inteligência de repetição de compra e armazena os dados do cartão. A requisição segue a estrutura de uma transação de crédito padrão, mas o parâmetro Payment.Recurrent deve ser true; caso contrário, a transação será negada. |
| Recorrência Programada | É usada quando a Cielo é responsável pela inteligência da repetição e armazenamento dos dados do cartão. Nessa modalidade de recorrência, a primeira transação deve ser capturada ( AuthorizeNow = "true"). Todas as transações posteriores serão capturadas automaticamente. |
| Agendando uma Recorrência Programada | O agendamento não autoriza imediatamente, mas agenda uma autorização futura. Para programar a primeira transação da série de recorrências, envie o parâmetro AuthorizeNow como “false” e adicione o parâmetro StartDate. |
No quadro à direita, vá para Examples e selecione o exemplo completo do tipo de requisição que deseja visualizar.
Resposta da transação de cartão de crédito recorrente
A tabela a seguir apresenta os principais parâmetros que podem ser retornados pela API na criação de um pagamento com cartão de crédito com recorrência. A resposta também irá conter os dados informados na criação do pagamento recorrente.
| Propriedade | Descrição | Tipo | Tamanho |
|---|---|---|---|
ProofOfSale | Número da autorização, idêntico ao NSU. | string | 6 |
Tid | Identificador da transação na adquirente. | string | 20 |
AuthorizationCode | Código de autorização. | string | 6 |
PaymentId | Número de identificação do pagamento. O PaymentId será usado em futuras operações como consulta, captura e cancelamento. | GUID | 36 |
Status | Status da Transação. Veja a tabela completa de Status transacional | byte | *** |
ReturnCode | Código de retorno. | string | 32 |
ReturnMessage | Mensagem de retorno. | string | 512 |
Payment.MerchantAdviceCode | Código de retorno da bandeira que define período para retentativa. Válido somente para bandeira Mastercard. Saiba mais Programa de retentativa das bandeiras para Mastercard | string | 2 |
Payment.CreditCard.PaymentAccountReference | O PAR (Payment Account Reference) é o número que associa diferentes tokens a um mesmo cartão. Será retornado pelas bandeiras Master e Visa e repassado para os clientes do e-commerce Cielo. Caso a bandeira não envie a informação o campo não será retornado. | string | 29 |