Assinatura de resposta
Objeto com as informações sobre uma assinatura.
Referência da resposta
subscriptionId
Código de identificação da assinatura.
Formato
shopId
Código de identificação da loja.
Formato
paymentMethodToken
Token associado a um meio de pagamento.
Formato
orderId
Referência do pedido definida pelo Estabelecimento Comercial. Não suporta os caracteres UTF-8.
Formato
metadata
Valores personalizados vinculados à transação, no formato json.
Exemplo de chamada:
Por exemplo, para passar um valor personalizado, adicione a sua solicitação:
{
"metadata": {
"MyValueKey": "1234"
}
}Esse valor é retornado no objeto da transação recém-criada.
Pode também usar os metadatas " orderInfo1 ", " orderInfo2 " e " orderInfo3 ”para enviar informações adicionais sobre o pedido.
Estes dados serão depois exibidos na aba Extra do detalhe da transação no seu
Formato
effectDate
Data de início da assinatura no formato ISO 8601 definido por W3C.
Formato
cancelDate
Data de encerramento da assinatura.
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
amount
Valor das parcelas da assinatura salvo as que podem ser definidas por initilAmount.
O valor deve ser apresentado na menor unidade monetária da moeda (o centavo para o Euro).
Formato
currency
Moeda utilizada para o pagamento das parcelas da assinatura Código alfabético em maiúsculas de acordo com ISO 4217 alfa-3.
Exemplo: "EUR” para o euro.
Valores possíveis
Os valores possíveis são os seguintes:
| Moeda | CODIFICAÇÃO ISO 4217 | Unidade fracionária |
|---|---|---|
| Dollar australien (036) | AUD | |
| Dólar canadense (124) | CAD | 2 |
| Coroa dinamarquesa (208) | DKK | 2 |
| Iene japonês (392) | JPY | 0 |
| Coroa norueguesa (578) | NOK | 2 |
| Coroa sueca (752) | SEK | 2 |
| Franco suíço (756) | CHF | 2 |
| Libra Esterlingo (826) | GBP | 2 |
| Dólar dos Estados-Unidos (840) | USD | 2 |
| Euro (978) | EUR | 2 |
Formato
pastPaymentsNumber
Quantidade de pagamentos finalizados.
Formato
totalPaymentsNumber
Quantidade total de pagamentos.
Formato
rrule
Descrição da regra da assinatura sob a forma de (RFC-5545).
Para maiores informações sobre como gerenciar uma RRULE:
Pour des raisons techniques, il est impossible de définir des périodes d'abonnement inférieures à une journée.
Les mots clés "SECONDLY" / "MINUTELY" / "HOURLY" ne sont donc pas pris en compte.
Formato
description
Descrição associada à assinatura.