Alterar os dados de pagamento da recorrência

Ambiente	Método	Endpoint
Sandbox	put	`https://apisandbox.cieloecommerce.cielo.com.br/1/RecurrentPayment/{RecurrentPaymentId}/Payment`
Produção	put	`https://api.cieloecommerce.cielo.com.br/1/RecurrentPayment/{RecurrentPaymentId}/Payment`

Durante o ciclo de vida de uma recorrência, é possível alterar:

Adquirente (ex.: de Rede para Cielo);
Cartão (em caso de cartão vencido);
Meio de pagamento (de cartão para boleto e vice-e-versa).

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

Requisição

put https://apisandbox.cieloecommerce.cielo.com.br/1/RecurrentPayment/{RecurrentPaymentId}/Payment

{  
   "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"
   },
   "Credentials": {
      "Code": "9999999",
      "Key": "D8888888",
      "Password": "LOJA9999999",
      "Username": "#Username@NOMEDALOJA#",
      "Signature": "001"
   }
}

--request PUT "https://apisandbox.cieloecommerce.cielo.com.br/1/RecurrentPayment/{RecurrentPaymentId}/Payment"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--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"
   },
   "Credentials": {
      "Code": "9999999",
      "Key": "D8888888",
      "Password": "LOJA9999999",
      "Username": "#Username@NOMEDALOJA#",
      "Signature": "001"
   }
}
--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?
`RecurrentPaymentId`	Número de identificação da recorrência.	Texto	50	Sim (envio no endpoint)
`Provider`	Nome do provedor do meio de pagamento.	Texto	15	Sim
`Type`	Tipo do meio de pagamento.	Texto	100	Sim
`Amount`	Valor do pedido, em centavos.	Número	15	Sim
`Installments`	Número de parcelas.	Número	2	Sim
`SoftDescriptor`	Texto que será impresso na fatura do portador.	Texto	13	Não
`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 impressa no cartão.	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
`Credentials.Code`	Afiliação gerada pela adquirente.	Texto	100	Sim
`Credentials.Key`	Chave de afiliação/token gerado pela adquirente.	Texto	100	Sim
`Credentials.Username`	Usuário gerado no credenciamento com a adquirente (provedores como Rede e Getnet utilizam usuário e senha nas comunicações, logo o campo deve obrigatoriamente ser enviado).	Texto	50	Não
`Credentials.Password`	Senha gerada no credenciamento com a adquirente (provedores como Rede e Getnet utilizam usuário e senha nas comunicações, logo o campo deve obrigatoriamente ser enviado).	Texto	50	Não
`Credentials.Signature`	Enviar o TerminalID da adquirente Global Payments Ex.: 001. Para Safra, colocar nome do estabelecimento, cidade e estado concatenados com ponto-e-vírgula ";". Ex.: NomedaLoja;São Paulo;SP.	Texto	--	Não

Resposta

HTTP Status 200

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