DocumentaciónAPIDevToolsRecipesForoTarjetas de PruebasEstado del ServicioChangelog
Documentación
Iniciar Sesión

Cargo único

Acepta pagos únicos con Efectivo

Suggest Edits

En esta documentación explicamos cómo aceptar pagos únicos con Efectivo a través del Component. Podrás utilizar todo el poder de nuestra API de Pagos con un front end pre-diseñado que se adapta a las necesidades de tu marca de tu negocio en línea.

1100

Configurar tu Servidor

Instalar el SDK de Conekta

Instala el SDK de Conekta para el lenguaje de programación de tu preferencia.

pip install conekta

gem install conekta

npm install conekta

Crear un customer

Antes de realizar el cobro al usuario, necesitarás crear un Customer. Este Objeto permite representar a tu cliente en Conekta para realizar cobros a su nombre.

Con la siguiente llamada crearás un Customer y obtendrás un customer_id, los cuales deberás guardar para realizar cobros en el futuro a la misma persona si así lo requieres.

curl --location --request POST 'https://api.conekta.io/customers' \
	--header 'Accept: application/vnd.conekta-v2.0.0+json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer key_DwaOLXoX6YCGGvfNifZ3IPwi' \
  --data-raw '{
  	"name": "Felipe Gomez",
    "email": "[email protected]"
  }'

import conekta

conekta.locale = "es"
conekta.api_key = "key_DwaOLXoX6YCGGvfNifZ3IPwi"

# Creación de Customer
customer = conekta.Customer.create(
  {
    "name": "Felipe Gomez",
    "email": "[email protected]"
  }
)

require 'conekta'

Conekta.locale = :es
Conekta.api_key = 'key_DwaOLXoX6YCGGvfNifZ3IPwi'

  customer = Conekta::Customer.create(
    {
      name: 'Felipe Gomez',
      email: '[email protected]'
    }
  )

const conekta = require('conekta');

conekta.locale = 'es';
conekta.api_key = 'key_DwaOLXoX6YCGGvfNifZ3IPwi';

const customer = await conekta.Customer.create({
      name: 'Felipe Gomez',
      email: '[email protected]'
    });

🚧

Importante:

Si ya tienes un customer_id asociado al usuario al que quieres cobrar, no es necesario que realices este paso.

Crear una Orden

Agrega un endpoint en tu servidor para crear una Orden.

📘

¿Qué es una Orden?

Una Orden representa la intención de compra de tu cliente. Incluye todos los detalles relacionados a ella, como métodos de pago, información de envío, lista de productos a comprar, cargos, descuentos, impuesto, etc.

Habilitar el método de pago de Efectivo

📘

Recuerda que...

Con Conekta obtienes los tres métodos de pago (Tarjetas, Efectivo y Transferencias) con una sola integración. Revisa el siguiente tutorial para mas

Habilita efectivo como método de pago usando el atributo allowed_payment_methods en el objeto Checkout de la orden al momento de crearla.

curl --location --request POST 'https://api.conekta.io/orders' \
	--header 'Accept: application/vnd.conekta-v2.0.0+json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer key_DwaOLXoX6YCGGvfNifZ3IPwi' \
  --data-raw '{
  	"currency": "MXN",
    "customer_info": {
    	"customer_id": "cus_2neG7CYEdeda9BBGU"
     },
     "line_items": [
     		{
        	"name": "Nintendo Switch OLED",
          "unit_price": 9000000,
          "quantity": 3
        }
     ],
     "checkout": {
     		"type": "Integration",
        "allowed_payment_methods": ["cash"] //Habilita efectivo como metodo de pago
     },
	}'

import conekta
import uvicorn
from fastapi import FastAPI, Request, APIRouter
from fastapi.templating import Jinja2Templates

router = APIRouter()
app = FastAPI()

conekta.api_key = "key_DwaOLXoX6YCGGvfNifZ3IPwi"
conekta.locale = "es"

@router.post("/create-order")
async def create_order(request: Request):

    # Creacion de una Orden
    order = conekta.Order.create(
        {
            "currency": "MXN",
            "customer_info": {
                "customer_id": "cus_2neG7CYEdeda9BBGU"
            },
            "line_items": [
                {
                    "name": "Nintendo Switch OLED",
                    "unit_price": 9000000,
                    "quantity": 3
                }
            ],
            "checkout": {
                "type": "Integration",
                "allowed_payment_methods": ["cash", "card", "bank_transfer"] #Habilita todos los metodos de pago
            },
	    }
    )
    # Obtener el Checkout ID
    checkout_id = order["checkout"]["id"]
    
    # Envia el Checkout ID al template HTML a renderizar para inicializar el componente de pago.
    return templates.TemplateResponse("index.html", {"request": request, "checkout_id": checkout_id})

app.include_router(router)

if __name__ == "__main__":
    uvicorn.run(app, host="0.0.0.0", port=8000)

require 'conekta'
require 'sinatra'

Conekta.locale = :es
Conekta.api_key = 'key_DwaOLXoX6YCGGvfNifZ3IPwi'

set :static, true
set :port, 9292

YOUR_DOMAIN = 'http://localhost:4242'.freeze

post '/create-order' do
  order_params =
    {
      currency: 'MXN',
      customer_info: {
        customer_id: 'cus_2neG7CYEdeda9BBGU'
      },
      line_items: [
        {
          name: 'Nintendo Switch OLED',
          unit_price: 9000000,
          quantity: 3
        }
      ],
      checkout: {
        type: 'Integration',
        allowed_payment_methods: %w[cash card bank_transfer], #Habilita todos los metodos de pago
      }
    }

  order = Conekta::Order.create(order_params)
end

const express = require('express');
const conekta = require('conekta');

const port = 9292;
const yourDomain = 'http://localhost:9292';

const app = express();

conekta.locale = 'es';
conekta.api_key = 'key_DwaOLXoX6YCGGvfNifZ3IPwi';

app.use(express.static('public'));

app.post('/create-order', async (_, res) => {
  try {
  
    const order = await conekta.Order.create({
      currency: 'MXN',
      customer_info: {
        customer_id: 'cus_2neG7CYEdeda9BBGU'
      },
      line_items: [
        {
          name: 'Nintendo Switch OLED',
          unit_price: 9000000,
          quantity: 3
        }
      ],
      checkout: {
        type: 'Integration',
        allowed_payment_methods: ['cash', 'card', 'bank_transfer'], //Habilita todos los metodos de pago
      }
    })

    const orderObject = order.toObject();

  } catch(e) {
    console.log(e);
  }  
});

app.listen(port, () => {
  console.log(`Example app listening on port ${port}`);
});

Una vez creada la orden deberás obtener el Checkout ID asociado para inicializar el Component embebido en tu página de checkout.

Crear una página de pago en el cliente.

Inicializar el Component

Carga nuestro paquete de JavaScript para mantenerte en cumplimiento con PCI asegurando que los detalles de pago sean enviados directamente a Conekta sin pasar por tu servidor.

Inicializa el Component con tu Llave Pública para completar el pago desde el Cliente

<html>
  <head>
    <meta charset="utf-8" />
    <title>Checkout</title>
    <script
      type="module"
      crossorigin
      src="https://assets.conekta.com/component/2.0.0/assets/iframe.min.js"
    ></script>
    <!-- En este archivo esta la config del componente -->
    <script type="module" crossorigin src="./init.js" defer></script>
  </head>
  <body>
    <div id="example" style="width: 500px; margin: 0 auto"></div>
  </body>
</html>

const config = {
  checkoutRequestId: '00000000-0000-0000-0000-000000000', //Checkout ID enviado desde el servidor para inicializar el componente de pago.
  publicKey: 'key_Adnb8659Bfsg5bM0cKe2wZy',
  targetIFrame: 'example',
};

const callbacks = {
  onFinalizePayment: (event) => console.log(event),
  onErrorPayment: (event) => console.log(event),
  onGetInfoSuccess: (event) => console.log(event),
};

window.Integration({ config, callbacks });

Nota: Es requerido utilizar la versión 2.0.0 o posteriores ya que las anteriores han sido deprecadas.

📘

Recuerda que...

Tu negocio podrá operar con nuestras redes de efectivo de acuerdo a la información que proporcionaste en el proceso de onboarding. A continuación podrás ver como se vería el componente de pago según el proveedor de Efectivo que tengas activado.

Pagos con efectivo en OXXO

Pagos con efectivo en otras cadenas

Con el Component inicializado en tu Checkout, tu cliente solo deberá ingresar la información requerida para pagos con efectivo y seguir las instrucciones para concretar la compra.

{
    "id": "ord_2sxz1L8TSv8RufVZV",
    "reference": "646180111812345678",
    "charge": {
        "id": "638e615afede9b001793237e",
        "currency": "MXN",
        "payment_method": {
            "type": "cash"
        },
        "status": "pending_payment",
        "customer_id": "",
        "order_id": "ord_2sxz1L8TSv8RufVZV"
    },
    "metaData": {}
}

Por último, una vez confirmado el pago, se generará un evento onFinalizePayment en el Cliente el cual te mostrará la información de la orden y el cargo. En este momento podrás tomar decisiones relacionadas con el estado de la compra como re-direccionar a una página de pago exitoso o a una página con el resumen de la compra.

Servicio de Notificaciones

Conekta dispone de un servicio de notificaciones a usuario final que se activarán por default enviando mails a la dirección de correo que proporcionó el customer:

NotificaciónDescripciónVía
Generación de la referenciaCuando se genera la referencia se envía un mail con la información de la misma y las instrucciones, para que el usuario final acuda a una de las tiendas de conveniencia a realizar el pagoMail
Pago de la referenciaCuando el usuario final realiza el pago, se envía un aviso de transacción exitosa.Mail
Expiración de la referenciaCuando la referencia expira y ya no tiene validezMail
Cancelación de la referenciaCuando canceles la referencia se le enviará un mail al usuario finalMail

A continuación podrás encontrar los ejemplos de las notificaciones que se envían a tu cliente.

Notificación: Generación de la referencia - Pagos en OXXO

Notificación: Generación de la referencia - Pagos en otras cadenas

Notificación: Pago de la referencia

Notificación: Expiración de la Referencia

Notificación: Cancelación de la referencia

Capturar eventos del pago

Automatiza tus procesos a través de los eventos que se generan en el flujo de pago. Para recibir estos eventos y ejecutar acciones sigue la guía de webhooks

Te recomendamos capturar los siguientes eventos:

EventoDescripción
order.paidEnviado cuando el cliente completa un pago de forma exitosa
order.pending_paymentEnviado cuando una orden es creada pero está pendiente de pago
order.declinedEnviado cuando el pago de una orden es declinado.

Al capturar estos eventos podrás tomar acciones postventa como:

  • Ejecutar un flujo de logística.
  • Actualizar tus bases de datos de órdenes.
  • Actualizar tus sistemas contables.

Updated over 1 year ago