Casos de uso

He aquí una lista no exhaustiva de los casos de uso que se definen cuando se inicializa el pago (durante la llamada al servicio web Charge/createPayment).

Para transmitir el número de pedido, utilice el campo orderId:

{
  "orderId": "CX-1254"
}

El vendedor puede transmitir la dirección de facturación y los datos del comprador (dirección de e-mail, tratamiento, número de teléfono, etc.).

Estos datos son:

• visibles dans le Back Office Expert, dans le détail de la transaction (onglet Acheteur),
• devueltos en la IPN, sin cambios.

Para ello, utilice el campo customer:

{
  "customer": {
    "reference": "C2383333540",
    "email": " sample@example.net",
    "billingDetails": {
      "category": "PRIVATE",
      "title": "M",
      "firstName": "Laurent",
      "lastName": "DURANT",
      "streetNumber": "109",
      "address": "rue de l'innovation",
      "zipCode": "31670",
      "city": "LABEGE",
      "country": "FR",
      "phoneNumber": "0123456789",
      "cellPhoneNumber": "0623456789"
    }
  }
}

El vendedor puede transmitir los datos de entrega del comprador (dirección, civilidad, número de teléfono, etc.).

Estos datos son:

• visibles dans le Back Office Expert, dans le détail de la transaction (onglet Livraison),
• devueltos en la IPN, sin cambios.

La dirección de entrega es la de la tienda.

La dirección de facturación no es la misma que la dirección de entrega.

El nombre del destinatario del envío es el de la dirección de facturación.

{
  "customer": {
    "shippingDetails": {
      "shippingMethod": "RECLAIM_IN_SHOP",
      "shippingSpeed": "STANDARD",
      "streetNumber": "230",
      "address": "avenue des Champs Elysées",
      "zipCode": "59170",
      "city": "CROIX",
      "country": "FR",
      "firstName": "Marie-Charlotte",
      "lastName": "GRIMALDI",
      "phoneNumber": "0328386789"
    }
  }
}

La dirección de entrega es la del punto de retiro.

El nombre del punto de retiro se indica en la segunda línea de la dirección de entrega.

La dirección del punto de retiro se indica en la primera línea de la dirección de entrega.

El nombre del destinatario es el de la dirección de facturación.

La dirección de facturación no es la misma que la dirección de entrega.

{
  "customer": {
    "shippingDetails": {
      "shippingMethod": "RELAY_POINT",
      "shippingSpeed": "STANDARD",
      "streetNumber": "100",
      "address": "avenue du parc Barbieux",
      "address2": "Pressing du Parc",
      "zipCode": "59170",
      "city": "CROIX",
      "country": "FR",
      "firstName": "Martine",
      "lastName": "DURAND",
      "phoneNumber": "0328386789",
      "deliveryCompanyName": "Chronospost"
    }
  }
}

Al crear un pago, el vendedor puede transmitir el contenido del carrito del comprador.

Ces données seront visibles dans le Back Office Expert, dans le détail de la transaction (onglet Panier).

Para ello, utilice el campo cartItemInfo (matriz de objetos json) durante la llamada al servicio web Charge/CreatePayment.

{
  "customer": {
    "shoppingCart": {
      "cartItemInfo": [
        {
          "productRef": "myRef1",
          "productAmount": "1200",
          "productLabel": "myLabel1",
          "productQty": "1"
        },
        {
          "productRef": "myRef2",
          "productAmount": "2400",
          "productLabel": "myLabel2",
          "productQty": "1"
        }
      ]
    }
  }
}

Notas:

• El campo cartItemInfo siempre se devuelve vacío en la respuesta.
• Pour que l’onglet Panier s’affiche correctement dans le Back Office Expert, vous devez transmettre au minimum le champ productAmount de chaque produit.

El vendedor puede ofrecer al comprador la posibilidad de facilitar sus compras solicitando el registro de sus datos bancarios en la plataforma de pago.

Gracias a esta operación, la plataforma de pago asigna un token único al medio de pago y lo devuelve al sitio del comerciante a través del campo paymentMethodToken.

De esta manera, el comprador ya no tendrá que ingresar su método de pago en sus futuras compras.

Esta solución brinda un nivel adicional de seguridad a los pagos, ya que transita únicamente el token que solo puede ser utilizado por la plataforma de pago.

Para ofrecer al comprador que registre su método de pago al momento del pago, utilice el campo formAction con el valor ASK_REGISTER_PAY

{
  "formAction": "ASK_REGISTER_PAY",
  "customer": {
    "email": " sample@example.net"
  }
}

Nota

El campo email se vuelve obligatorio al registrar el medio de pago.

Cuando se muestre el formulario, aparecerá una casilla de verificación.

De forma predeterminada, esta casilla no está marcada.

Si el comprador acepta el registro de su medio de pago, debe marcar la casilla.

Si el pago es rechazado, no se registrará el medio de pago.

Si el vendedor ha notificado al comprador en un paso previo del proceso de compra, puede "forzar" el registro del medio de pago sin mostrar una casilla adicional.

Para hacerlo, utilice el campo formAction con el valor REGISTER_PAY:

{
  "formAction": "REGISTER_PAY",
  "customer": {
    "email": " sample@example.net"
  }
}

El vendedor puede transmitir el token que se debitará al inicializarse el pago.

Cuando se muestra el formulario, los campos kr-pan y kr-expiry se completarán automáticamente. El comprador solo tendrá que ingresar su código de seguridad (CVV) para finalizar su compra.

Para ello, simplemente transmita el token a debitar en el campo paymentMethodToken y asigne al campo formAction el valor PAYMENT.

Dado que este valor es el valor predeterminado, el campo formAction ya no es necesario.

{
    "formAction" : "PAYMENT",
    "paymentMethodToken":"d3d9cc0d24a4400e9d123e9e1b8f1793",
}

Cuando el comprador desea realizar una nueva compra, el comerciante puede, si lo desea, ofrecer la lista de los métodos de pago registrados para este cliente. Para hacerlo, muestra en su página el pan oculto y la fecha de validez devueltos al registrar el o los medios de pago. El comprador selecciona el medio de pago a utilizar y el vendedor inicializa el pago con el token asociado.

Para no mostrar el formulario incrustado, simplemente utilice el parámetro formAction con el valor SILENT:

{
    "formAction" : "SILENT",
    "paymentMethodToken":"d3d9cc0d24a4400e9d123e9e1b8f1793",
}

Nota

• Este caso de uso no utiliza el cliente JavaScript, sino solo una llamada de servidor a servidor. No hay redirección hacia la URL de retorno indicada en kr-post-url-success.
• La respuesta no contiene un formToken, sino directamente un objeto Transaction.
• Dependiendo de la configuración de su tienda para los pagos por token, puede que se requiera el CVV o una autenticación 3D Secure. En tal caso, el modo SILENT no es el indicado.

Esta funcionalidad requiere la suscripción de la opción 3D Secure selectivo.

El vendedor puede indicar si desea habilitar o deshabilitar el proceso de autenticación fuerte (3D Secure o Safekey, por ejemplo) durante la llamada al servicio web charge/createPayment.

Para ello, utilice el campo strongAuthentication.

Nota

Deshabilitar 3D Secure resultará en la pérdida de la transferencia de responsabilidad. En caso de litigio o reclamación por parte del comprador, será el vendedor quien cubra los posibles gastos.

{
  "strongAuthentication": "DISABLED"
}

Con 3DS2, ya no será posible desactivar 3DS. Sin embargo, el vendedor podrá pedir una exención en su solicitud de pago (se denomina "preferencia del vendedor"). Para ello, utilice el campo strongAuthentication.

Cuando todos los actores sean operativos, será posible transmitir datos suplementarios para aumentar la probabilidad de frictionless durante el pago.

Al crear un pago, el vendedor puede enviar información específica a la plataforma de pago para atender necesidades específicas de su negocio.

Por ejemplo, transmitir un número de archivo, un número de contrato, etc.

Esta información será:

• visibles dans le Back Office Expert, dans le détail de la transaction (onglet Extras),
• visibles en el e-mail de confirmación de pago destinado al vendedor,
• devueltas en la URL de notificación, sin cambios.

Para ello, utilice los campos metadata (en formato json) durante la llamada al servicio web Charge/CreatePayment:

Ejemplo para transmitir un elemento de datos llamado “contract” y su valor:

{
  "metadata": {
    "contract": "1245KL-78/ZE"
  }
}

Puede sobrescribir la URL de notificación instantánea (también llamada IPN) en el formulario si utiliza una única tienda para diferentes canales de venta, diferentes tipos de pago, diferentes idiomas, etc.

Cette fonctionnalité est incompatible avec l’exécution, depuis le Back Office Expert, de la requête envoyée à l’URL de notification instantanée.

Se llamará a la URL definida en la regla de notificación (consulte el capítulo Configurar las notificaciones).

Utilice el campo ipnTargetUrl al inicializar el pago para sobrecargar la URL de la página que se notificará.

Si el valor del campo ipnTargetUrl es incorrecto, el formulario no será rechazado.

{
    "ipnTargetUrl" : "https://my.site/my-ipn",
}