Alterar os dados de pagamento da recorrência

AmbienteMétodoEndpoint
Sandboxhttps://apisandbox.braspag.com.br/v2/RecurrentPayment/{RecurrentPaymentId}/Payment
Produçãohttps://api.braspag.com.br/v2/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).

⚠️

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

{  
   "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": "#Braspag2018@NOMEDALOJA#",
      "Signature": "001"
   }
}
--request PUT "https://apisandbox.braspag.com.br/v2/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": "#Braspag2018@NOMEDALOJA#",
      "Signature": "001"
   }
}
--verbose

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

Propriedade (header)TipoTamanhoObrigatórioDescrição
MerchantIdGuid36SimIdentificador da loja no Split de Pagamento
MerchantKeyTexto40SimChave Publica para Autenticação Dupla no Split de Pagamento
Content-TypeHeader40SimApplication/json
RequestIdGUID36NãoIdentificador do request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT.
Propriedade (body)DescriçãoTipoTamanhoObrigatório?
RecurrentPaymentIdNúmero de identificação da recorrência.Texto50Sim (envio no endpoint)
ProviderNome do provedor do meio de pagamento.Texto15Sim
TypeTipo do meio de pagamento.Texto100Sim
AmountValor do pedido, em centavos.Número15Sim
InstallmentsNúmero de parcelas.Número2Sim
SoftDescriptorTexto que será impresso na fatura do portador.Texto13Não
CreditCard.CardNumberNúmero do cartão do comprador.Texto16Sim
CreditCard.HolderNome do comprador impresso no cartão. Obs.: Regras de tamanho do campo podem variar de acordo com a adquirente.Texto25Sim
CreditCard.ExpirationDateData de validade impressa no cartão.Texto7Sim
CreditCard.SecurityCodeCódigo de segurança impresso no verso do cartão.Texto4Sim
CreditCard.BrandBandeira do cartão.Texto10Sim
Credentials.CodeAfiliação gerada pela adquirente.Texto100Condicional*
Credentials.KeyChave de afiliação/token gerado pela adquirente.Texto100Condicional*
Credentials.UsernameUsuá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).Texto50Condicional*
Credentials.PasswordSenha 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).Texto50Condicional*
Credentials.SignatureEnviar 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--Condicional*
  • **Obrigatório caso a afiliação não esteja pré configurada nos meios de pagamento do MerchantID utilizado.
  • Em ambiente sandbox usando o provider Simulado, não é necessário enviar o nó Credentials.

Resposta

HTTP Status 200

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