Casos de uso

Esta es una lista no exhaustiva de los casos de uso en los que se crea un formToken (al llamar al Web Service Charge/createPayment ).

Transmitir el número de pedido

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

{
    "orderId" : "CX-1254"
}

Transmitir los datos del comprador

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:

• se muestran en el Back Office Vendedor, en la información de la transacción (pestaña Comprador ),
• devueltos en la IPN, sin cambios.

Para ello, utilice el campo customer :

Ejemplo

{
    "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"
        }
    }
}

Transmitir los datos de entrega

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

Estos datos son:

• se muestran en el Back Office Vendedor, en la información de la transacción (pestaña Envío ),
• devueltos en la IPN, sin cambios.

Ejemplo para una entrega de tipo “Retiro en tienda”

La dirección de envío corresponde a la de la tienda.

La dirección de facturación es distinta a la dirección de envío.

El nombre del destinatario es el mismo que 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"
        }
    }
}

Ejemplo para una entrega de tipo “punto de retiro”

La dirección de envío corresponde a la del punto de retiro.

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

Se transmite la dirección del punto de retiro en la primera línea de dirección de envío.

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

La dirección de facturación es distinta a la dirección de envío.

{
    "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"
        }
    }
}

Transmisión del contenido del carrito

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

Estos datos se muestran en el Back Office Vendedor, en la información de la transacción (pestaña Carrito ).

Para ello, utilice el campo cartItemInfo (tabla de objetos json) durante la llamada al Web Service Charge/CreatePayment.

Ejemplo para definir 2 artículos en el carrito

{
"customer": {

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

}

Observaciones:

• El campo cartItemInfo siempre se devuelve vacío en la respuesta.
• Para que la pestaña Carrito se muestre correctamente en el Back Office Vendedor, debe trasmitir por lo menos el campo productAmount de cada producto.

Transmitir los datos del subvendedor

El facilitador de pago puede transmitir los datos del subvendedor concernido por la transacción.

Estos datos serán:

• se muestran en el Back Office Vendedor, en la información de la transacción (pestaña Subvendedor ),
• devueltos en la IPN, sin cambios.

La tabla describe los campos comunes disponibles con la información del subvendedor.

Ofrecer el registro del medio de pago

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 web comercial en el campo paymentMethodToken.

De esta manera, el comprador ya no necesitará ingresar su medio 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 modo 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 control.

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.

Forzar el registro del 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>"
    }
}

Utilizar un medio de pago registrado

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 rellenan automáticamente. El comprador solo debe introducir su código de seguridad (CVV) para finalizar la 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",
}

Utilizar un medio de pago registrado sin mostrar el formulario incrustado

Este modo permite crear una transacción sin mostrar el formulario de pago y sin autentificación (llamada de servidor a servidor).

{
    "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.
• Utilice la referencia de encadenamiento en el campoinitialIssuerTransactionIdentifier, si esta está ausente, los emisores pueden rechazar la transacción.("Soft Decline").
• Ver: Paiement 0 clic

Transmitir la preferencia del vendedor

Utilisez le champ strongAuthentication (lien vers le playground : strongAuthentication).

Ce champ indique la préférence du marchand au sujet de l'authentification de l'acheteur.

• Sin interacción del titular ( frictionless ).
• Con interacción del titular (autentificación fuerte o challenge ).
• Sin preferencia del vendedor.

Tabla de exenciones (valor DISABLED)

Aumentar la probabilidad de frictionless en 3DS2

Transmita estos datos para aumentar la probabilidad de frictionless durante el pago.

Lista de campos a enviar

Transmitir datos personalizados

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á:

• se muestran en el Back Office Vendedor, en la información de la transacción (pestaña 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 Web Service Charge/CreatePayment :

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

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

Sobrecargar la URL de notificación instantánea (desaconsejado)

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.

Esta función es incompatible con la ejecución desde el Back Office Vendedor de la solicitud enviada a la URL de notificación instantánea.

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 sobrescribir la URL de la página que se notifica.

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

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