Alterar os dados de pagamento da recorrência

⚠️

Atenção:

  • Essa alteração afeta a todos os dados do nó Payment. Para manter os dados anteriores, você deve informar esses campos utilizando os valores já salvos a serem mantidos;
  • Durante o ciclo de vida da recorrência, você pode atualizar o cartão caso ele esteja vencido.

Requisição

AmbienteMétodoEndpoint
Sandboxhttps://apisandbox.cieloecommerce.cielo.com.br/1/RecurrentPayment/{RecurrentPaymentId}/Payment
Produçãohttps://api.cieloecommerce.cielo.com.br/1/RecurrentPayment/{RecurrentPaymentId}/Payment

--header "Authorization: Bearer {access_token}"

{  
   "Type":"CreditCard",
   "Amount":"20000",
   "Installments":3,
   "Country":"USA",
   "Currency":"USD",
   "SoftDescriptor":"Mensagem",
   "Provider":"Simulado",
   "CreditCard":{  
      "Brand":"Master",
      "Holder":"Nome do Portador",
      "CardNumber":"5412217070050381",
      "ExpirationDate":"05/2019",
      "SecurityCode": 222
   },
}
--request PUT "https://apisandbox.cieloecommerce.cielo.com.br/1/RecurrentPayment/{RecurrentPaymentId}/Payment"
--header "Content-Type: application/json"
--header 'Bearer: {access_token}'
--data-binary
{  
   "Type":"CreditCard",
   "Amount":"20000",
   "Installments":3,
   "Country":"USA",
   "Currency":"USD",
   "SoftDescriptor":"Mensagem",
   "Provider":"Simulado",
   "CreditCard":{  
      "Brand":"Master",
      "Holder":"Nome do Portador",
      "CardNumber":"5412217070050381",
      "ExpirationDate":"05/2019",
      "SecurityCode": 222
   },
}
--verbose

Parâmetro do header

PropriedadeTipoTamanhoObrigatórioDescrição
Authorization
Bearer:access_token
String--SimToken de acesso.

Informe o access_token obtido para a autenticação OAuth2

Parâmetro do path

PropriedadeTipoTamanhoObrigatórioDescrição
RecurrentPaymentIdTexto50SimNúmero de identificação da recorrência.

Parâmetros do body

PropriedadeTipoTamanhoObrigatórioDescrição
ProviderTexto15SimNome do provedor do meio de pagamento.
TypeTexto100SimTipo do meio de pagamento.
AmountNúmero15SimValor do pedido, em centavos.
InstallmentsNúmero2SimNúmero de parcelas.
SoftDescriptorTexto13NãoTexto que será impresso na fatura do portador.
CreditCard.CardNumberTexto16SimNúmero do cartão do comprador.
CreditCard.HolderTexto25SimNome do comprador impresso no cartão. Obs.: Regras de tamanho do campo podem variar de acordo com a adquirente.
CreditCard.ExpirationDateTexto7SimData de validade impressa no cartão.
CreditCard.SecurityCodeTexto4SimCódigo de segurança impresso no verso do cartão.
CreditCard.BrandTexto10SimBandeira do cartão.

Resposta

HTTP Status 200

Consulte a lista de códigos de status HTTP para ver todos os códigos possivelmente retornados pela API.