Autorizar recorrência com cartão de crédito

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/`

⚠️

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

Os parâmetros Payment.RecurrentPayment.Interval e Payment.RecurrentPayment.DailyInterval, marcados com um "*" na coluna "OBRIGATÓRIO", não devem ser utilizados em conjunto.

Requisição

post https://apisandbox.cieloecommerce.cielo.com.br/1/sales/

{  
   "MerchantOrderId":"2017051001",
   "Customer":{  
      "Name":"Nome do Comprador",
      "Identity":"12345678909",
      "IdentityType":"CPF",
      "Email":"[email protected]",
      "Birthdate":"1991-01-02",
      "IpAddress":"127.0.0.1",
      "Address":{  
         "Street":"Alameda Xingu",
         "Number":"512",
         "Complement":"27 andar",
         "ZipCode":"12345987",
         "City":"São Paulo",
         "State":"SP",
         "Country":"BRA",
         "District":"Alphaville"
      },
      "DeliveryAddress":{  
         "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,
      "CreditCard": {
         "CardNumber":"5412217070050381",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2021",
         "SecurityCode":"123",
         "Brand":"Visa"
      },
      "RecurrentPayment": {
         "AuthorizeNow":"true",
         "EndDate":"2019-12-31",
         "Interval":"Monthly"
      }
   }
}

--request POST "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{  
   "MerchantOrderId":"2017051001",
   "Customer":{  
      "Name":"Nome do Comprador",
      "Identity":"12345678909",
      "IdentityType":"CPF",
      "Email":"[email protected]",
      "Birthdate":"1991-01-02",
      "IpAddress":"127.0.0.1",
      "Address":{  
         "Street":"Alameda Xingu",
         "Number":"512",
         "Complement":"27 andar",
         "ZipCode":"12345987",
         "City":"São Paulo",
         "State":"SP",
         "Country":"BRA",
         "District":"Alphaville"
      },
      "DeliveryAddress":{  
         "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,
      "CreditCard": {
         "CardNumber":"5412217070050381",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2021",
         "SecurityCode":"123",
         "Brand":"Visa"
      },
      "RecurrentPayment": {
         "AuthorizeNow":"true",
         "EndDate":"2019-12-31",
         "Interval":"Monthly"
      }
   }
}
--verbose

A seguir, veja as propriedades de campo nesta requisição:

Propriedade (header)	Tipo	Tamanho	Obrigatório	Descrição
`MerchantId`	Guid	36	Sim	Identificador da loja no Split de Pagamento
`MerchantKey`	Texto	40	Sim	Chave Publica para Autenticação Dupla no Split de Pagamento
`Content-Type`	Header	40	Sim	Application/json
`RequestId`	Guid	36	Não	Identificador do request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT.

Propriedade (body)	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. A recorrência só permite uma parcela. Valores possíveis: 01 ou 1.	Número	2	Sim
`Payment.RecurrentPayment.EndDate`	Data para término da recorrência.	Texto	10	Não
`Payment.RecurrentPayment.Interval`	Intervalo da recorrência. Não utilizar em conjunto com `DailyInterval`. 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
`CreditCard.CardNumber`	Número do cartão do comprador.	Texto	16	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 impresso 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,
    "CreditCard": {
      "CardNumber": "455187******0181",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2021",
      "SaveCard": false,
      "Brand": "Visa"
    },
    "ProofOfSale": "5646418",
    "AcquirerTransactionId": "0511045646418",
    "AuthorizationCode": "100024",
    "PaymentId": "067f73ce-62fb-4d76-871d-0bcbb88fbd22",
    "Type": "CreditCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-11 16:56:46",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "Status": 1,
    "ProviderReturnCode": "4",
    "ProviderReturnMessage": "Operation Successful",
    "RecurrentPayment": {
      "RecurrentPaymentId": "808d3631-47ca-43b4-97f5-bd29ab06c271",
      "ReasonCode": 0,
      "ReasonMessage": "Successful",
      "NextRecurrency": "2017-06-11",
      "EndDate": "2019-12-31",
      "Interval": "Monthly",
      [...]
    }
  }
}

--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
  [...]
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "CardNumber": "455187******0181",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2021",
      "SaveCard": false,
      "Brand": "Visa"
    },
    "ProofOfSale": "5646418",
    "AcquirerTransactionId": "0511045646418",
    "AuthorizationCode": "100024",
    "PaymentId": "067f73ce-62fb-4d76-871d-0bcbb88fbd22",
    "Type": "CreditCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-11 16:56:46",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "Status": 1,
    "ProviderReturnCode": "4",
    "ProviderReturnMessage": "Operation Successful",
    "RecurrentPayment": {
      "RecurrentPaymentId": "808d3631-47ca-43b4-97f5-bd29ab06c271",
      "ReasonCode": 0,
      "ReasonMessage": "Successful",
      "NextRecurrency": "2017-06-11",
      "EndDate": "2019-12-31",
      "Interval": "Monthly",
      [...]
    }
  }
}

Propriedade	Descrição	Tipo	Tamanho	Formato
`RecurrentPaymentId`	ID que representa a recorrência, utilizada para consultas e alterações futuras.	GUID	36	xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
`NextRecurrency`	Data de quando acontecerá a próxima recorrência.	Texto	10	2019-12-11 (YYYY-MM-DD)
`EndDate`	Data do fim da recorrência.	Texto	10	2019-12-31 (YYYY-MM-DD)
`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"