Web service Charge/CreateSubscription

Le Web Service REST Charge/CreateSubscription permet de réaliser des paiements récurrents (abonnements) à partir d'un alias (Création d'un alias).

Pour les prélèvements SEPA, intégrez dans le champ paymentMethodToken la référence unique du mandat (RUM) et une date d'effet supérieure ou égale à 14 jours.

Pour être notifié du résultat d'une échéance, la règle "URL de notification à la création d'un paiement récurrent" doit être activée et configurée depuis lebom_expert(menuConfigurações > Regras de notificação).

Verifique as configurações doResposta:Subscription.

Configurações de entrada

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

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:

Comentário livre.

Formato

Descrição associada à assinatura.

Formato

Data de início da assinatura no formato ISO 8601 definido por W3C.

Formato

Valor das primeiras parcelas. O valor dela deve ser um número inteiro positivo (ex: 1234 para 12.34 EUR).

Formato

Quantidade de parcelas nas quais será aplicado o valor definido em initialAmount.

Formato

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 Back Office EC.

Formato

Token associado a um meio de pagamento.

Formato

Referência do pedido definida pelo Estabelecimento Comercial. Não suporta os caracteres UTF-8.

Formato

Descrição da regra da assinatura sob a forma de (RFC-5545).

Para maiores informações sobre como gerenciar uma RRULE:

• Especificação de uma RRULE
• Gerador de RRULE
• Exemplos de regras de recorrência

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

Procedência do pagamento.

Formato

Valores possíveis

Os valores possíveis são os seguintes:

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

Modo de validação da transação.

Formato

Valores possíveis

Os valores possíveis são os seguintes:

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 Back Office EC será usado.

Este último pode ser configurado no Back Office EC por todas as pessoas devidamente autorizadas.

Se o prazo anterior à captura for superior a 365 dias na solicitação de pagamento, ele será automaticamente redefinido a 365 dias.

Formato

Quantidade de meses adiados para aplicar na primeira parcela para um pagamento parcelado. Campo específico aos adquirentes da América Latina.

Formato

Quantidade de parcelas.

Formato

Quantidade de novas tentativas disponíveis no caso de uma recusa de pagamento (1 por padrão).

Formato

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

Formato

Referência da resposta

O web service retorna o objeto seguinte:

Consultar a referência da resposta para maiores detalhes.