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 le
Verifique la configuración delRespuesta : Subscription.
Parámetros de entrada
amount
Monto del pago en su fracción monetaria más pequeña (el céntimo para el euro).
Ejemplo: 30050 para 300,50 EUR.
Formato
currency
Moneda del pago. Código alfabético un mayúsculas según ISO 4217 alpha-3.
Ejemplo: "EUR" para el euro.
Formato
Valores posibles
. Los valores posibles son:
| Moneda | CODIFICACIÓN ISO 4217 | Unidad fraccionaria |
|---|---|---|
| Dólar australiano (036) | AUD | 2 |
| Dólar canadiense (124) | CAD | 2 |
| Franco suizo (756) | CHF | 2 |
| Corona danesa (208) | DKK | 2 |
| Euro (978) | EUR | 2 |
| Libra esterlina (826) | GBP | 2 |
| Yen (392) | JPY | 0 |
| Corona noruega (578) | NOK | 2 |
| Corona sueca (752) | SEK | 2 |
| Dólar estadounidense (840) | USD | 2 |
comment
Comentario libre.
Formato
description
Descripción asociada a la suscripción.
Formato
effectDate
Fecha de inicio de la suscripción en formato ISO 8601 definido por W3C.
Formato
initialAmount
Monto de los primeros vencimientos. Su valor debe ser un entero positivo (por ejemplo: 1234 por EUR 12.34).
Formato
initialAmountNumber
Número de cuotas a las que se aplicará el monto definido en initalAmount.
Formato
metadata
Valores personalizados adjuntos a la transacción, en formato json.
Ejemplo de llamada
Por ejemplo, para transmitir un valor personalizado, agregue a su solicitud:
{
"metadata": {
"MyValueKey": "1234"
}
}Este valor se devolverá en el objeto de transacción recién creado.
También puede utilizar los metadatos " orderInfo ", " orderInfo2 " y " orderInfo3 " para transmitir la información adicional sobre el pedido.
Estos datos se muestran en el
Formato
paymentMethodToken
Token asociado a un medio de pago.
Formato
orderId
Referencia de pedido definida por el vendedor. No admite los caracteres UTF-8.
Formato
rrule
Descripción de la regla de la suscripción bajo la forma de rrule (RFC-5545).
Para más información sobre cómo administrar una 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
paymentSource
Camino: transactionOptions.cardOptions.paymentSource
Origen del pago.
Formato
Valores posibles
. Los valores posibles son:
| VALOR | Descripción |
|---|---|
| EC | E-Commerce: el comprador ingresa los datos del medio de pago. Este valor permite tener una autentificación fuerte al momento del pago. |
| MOTO | MAIL OR TELEPHONE ORDER: Ingreso realizado por un operador. Los datos del medio de pago se envían por correo postal o electrónico. Requiere un contrato de tipo VAD. |
| CC | Call Center: pago realizado a través de un centro de atención telefónico. Requiere un contrato de tipo VAD. |
| OTHER | Otro canal de venta. Valor de salida devuelto para los pagos realizados desde el |
| Absent ou null | El valor predeterminado es “EC”. |
mid
Camino: transactionOptions.cardOptions.mid
Número de contrato del vendedor. Si este campo es completado, asegúrese de utilizar el contrato correcto en función de la red de la tarjeta.
Un contrato de VISANET no puede utilizarse para una transacción de MASTERCARD.
Formato
manualValidation
Camino: transactionOptions.cardOptions.manualValidation
Modo de validación de la transacción.
Formato
Valores posibles
. Los valores posibles son:
| VALOR | Descripción |
|---|---|
| NO | Validación automática por la plataforma de pago. |
| YES | Validación manual por el vendedor. |
| null | Configuración por defecto de la tienda seleccionada (configurable en el |
captureDelay
Camino: transactionOptions.cardOptions.captureDelay
Fecha límite para aplicar en la fecha de captura.
Descripción
Indica el número de días antes de la captura.
Si no se transmite este parámetro, se utiliza el valor predeterminado definido en el
Este último es configurable en el
Si el tiempo de entrega es mayor a 365 días en la solicitud de pago, se reposiciona automáticamente a 365 días.
Formato
firstInstallmentDelay
Camino: transactionOptions.cardOptions.firstInstallmentDelay
Cantidad de meses en los que se aplaza el primer pago de un pago a plazos. Campo específico a los adquirentes en Latino américa.
Formato
installmentNumber
Camino: transactionOptions.cardOptions.installmentNumber
Cantidad de cuotas.
Formato
retry
Camino: transactionOptions.cardOptions.retry
Cantidad de nuevos intentos disponibles en caso de rechazo del pago (1 por defecto).
Formato
debitCreditSelector
Camino: transactionOptions.cardOptions.debitCreditSelector
Este campo es exclusivo para Brasil para la gestión de las tarjetas “multiplo”.
Las tarjetas “Multiplo” son tarjetas de pago (Elo, Visa o Mastercard) que permiten pagar:
- ya sea en débito inmediato: el monto se debita inmediatamente y se acredita al vendedor al día siguiente.
- o en crédito: el débito se difiere y el monto puede debitarse en una o más cuotas. Al vendedor se le acredita posteriormente la totalidad o solo una parte del monto total.
Este campo permite forzar el uso de la tarjeta como tarjeta de débito o de crédito.
Valores posibles
| Valores | Descripción |
|---|---|
| DEBIT | Uso de la función “débito” de la tarjeta |
| CREDIT | Uso de la función “crédito” de la tarjeta |
Formato
Referencia de la respuesta
El Web Service devuelve el siguiente objeto:
| Respuesta | Contexto |
|---|---|
| SubscriptionCreated | Objeto que contiene los detalles de la suscripción creada. |
Vea la referencia de la respuesta para más información.