Web service Subscription/Update
O Web Service REST Subscription/Update permite modificar uma assinatura, ou seja:
- as parcelas de pagamento: um valor, uma moeda, uma data de vencimento, um status, etc.
- e também os dados sobre o comprador.
Esta operação não pode ser realizada se a data de vigência for atingida.
Configurações de entrada
amount
Montante da transação na menor unidade monetária (centavo para o Real). Ex: 1234 para 12,34 BRL.
Exemplo: 30050 para 300,50 EUR.
Formato
currency
Moeda do pagamento. Código alfabético em maiúsculas de acordo com ISO 4217 alfa-3.
Exemplo: "EUR” para o euro.
Formato
Valores possíveis
Os valores possíveis são os seguintes:
| Moeda | CODIFICAÇÃO ISO 4217 | Unidade fracionária |
|---|---|---|
| Dólar australiano (036) | AUD | 2 |
| Dólar canadense (124) | CAD | 2 |
| Franco suíço (756) | CHF | 2 |
| Coroa dinamarquesa (208) | DKK | 2 |
| Euro (978) | EUR | 2 |
| Libra Esterlingo (826) | GBP | 2 |
| Iene japonês (392) | JPY | 0 |
| Coroa norueguesa (578) | NOK | 2 |
| Coroa sueca (752) | SEK | 2 |
| Dólar dos Estados-Unidos (840) | USD | 2 |
description
Descrição associada à assinatura.
Formato
effectDate
Data de início da assinatura no formato ISO 8601 definido por W3C.
Formato
initialAmount
Valor das primeiras parcelas. O valor dela deve ser um número inteiro positivo (ex: 1234 para 12.34 EUR).
Formato
initialAmountNumber
Quantidade de parcelas nas quais será aplicado o valor definido em initialAmount.
Formato
paymentMethodToken
Token associado a um meio de pagamento.
Formato
rrule
Descrição da regra da assinatura sob a forma de (RFC-5545).
Para maiores informações sobre como gerenciar uma RRULE:
Por razões técnicas, não é possível definir períodos de assinatura menores que um dia.
As palavras-chave "SECONDLY" / "MINUTELY" / "HOURLY" não são, portanto, levadas em consideração.
Formato
subscriptionId
Código de identificação da assinatura.
Formato
paymentSource
Caminho: transactionOptions.cardOptions.paymentSource
Procedência do pagamento.
Formato
Valores possíveis
Os valores possíveis são os seguintes:
| VALOR | Descrição |
|---|---|
| EC | E-Commerce: os dados do meio de pagamento são digitados pelo comprador. Este valor permite ter uma autenticação alta no pagamento. |
| MOTO | MAIL OR TELEPHONE ORDER: Digitação realizada por um operador. Os dados do meio de pagamento são enviados por correio ou por e-mail. Requer um contrato de tipo VAD. |
| CC | Call Center: pagamento efetuado via um call center. Requer um contrato de tipo VAD. |
| OTHER | Outro canal de venda. Valor de saída retornado para pagamentos feitos desde |
| Absent ou null | O valor por default é "EC". |
mid
Caminho: transactionOptions.cardOptions.mid
Número de contrato Estabelecimento Comercial. Se este campo é informado, tomar cuidado em utilizar o contrato certo em relação à rede do cartão.
Um contrato STONE não pode ser usado para uma transação AMEX.
Formato
manualValidation
Caminho: transactionOptions.cardOptions.manualValidation
Modo de validação da transação.
Formato
Valores possíveis
Os valores possíveis são os seguintes:
| VALOR | Descrição |
|---|---|
| NO | Validação automática pela plataforma de pagamento. |
| YES | Validação manual pelo Estabelecimento Comercial. |
| null | Configuração padrão da loja escolhida (pode ser configurado no |
captureDelay
Caminho: transactionOptions.cardOptions.captureDelay
Prazo para aplicar na data de captura.
Descrição
Indica o prazo em número de dias antes da captura no banco.
Se este parâmetro não é enviado, então o valor padrão definido no
Este último pode ser configurado no
Se o prazo anterior à captura for superior a 365 dias na solicitação de pagamento, ele será automaticamente redefinido a 365 dias.
Formato
firstInstallmentDelay
Caminho: transactionOptions.cardOptions.firstInstallmentDelay
Quantidade de meses adiados para aplicar na primeira parcela para um pagamento parcelado. Campo específico aos adquirentes da América Latina.
Formato
installmentNumber
Caminho: transactionOptions.cardOptions.installmentNumber
Quantidade de parcelas.
Formato
retry
Caminho: transactionOptions.cardOptions.retry
Quantidade de novas tentativas disponíveis no caso de uma recusa de pagamento (1 por padrão).
Formato
debitCreditSelector
Caminho: transactionOptions.cardOptions.debitCreditSelector
Campo específico ao Brasil para a gestão dos cartões "múltiplo".
Os cartões “múltiplo” são cartões de pagamento (Elo, Visa ou Mastercard), que permitem pagar:
- ou em débito imediato: o valor é debitado imediatamente, e o EC será creditado o dia seguinte.
- ou em crédito: o débito é diferido e o valor pode ser debitado em uma ou mais vezes. Mais tarde, o EC é creditado da totalidade ou de apenas uma parte do valor total.
Este campo permite forçar o uso do cartão em débito ou em crédito.
Valores possíveis
| valores | Descrição |
|---|---|
| DEBIT | Uso da função "débito" do cartão |
| CREDIT | Uso da função "crédito" do cartão |
Formato
Referência da resposta
O web service retorna o objeto seguinte:
| Resposta | Contexto |
|---|---|
| Objeto contendo o código de retorno do web service. |
Consultar a referência da resposta para maiores detalhes.