Órdenes

Es un servicio que te permite generar una orden de pago para una compra potencial. La orden contiene la información necesaria para la venta y es usado por el sistema de PagoEfectivo para realizar los pagos diferidos.

El servicio de órdenes retorna un order _id (ord_live_XXXXXX o ord_test_XXXXX) que sirve para identificar la orden dentro del flujo de pago.

A una orden se le asigna un tiempo máximo de pago (o expiración) y puede durar horas o días. Si no se configura, Culqi asigna por defecto 24 horas para realizar el pago.

Con Culqi puedes añadir metadata a las órdenes. La información en este campo es para tu uso interno. Puedes añadir, por ejemplo: edad, documento de identificación del cliente, etc. Toda la metadata se encuentra disponible en el CulqiPanel al visualizar el detalle de una orden, incluso puede para ser exportada. Usar este campo es ideal para que tu equipo de contabilidad o finanzas pueda fácilmente conciliar las órdenes en Culqi con los pedidos en tu sistema.

Creando una orden

Un orden se crea a partir de la información de una posible compra. Los datos necesarios para crearla son los siguientes:

{
  "amount": 1000,
  "currency_code": "PEN",
  "description": "Venta de prueba",
  "order_number": "pedido-9999",
  "client_details": {
    "first_name": "Richard",
    "last_name": "Hendricks",
    "email": "richard@piedpiper.com",
    "phone_number": "+51945145288"
  },
  "expiration_date": 1538772846
}

Anatomía de un orden

El API de orden nos retorna un objeto order con un id único (ord_live_xjmEW4dIyJM9G4cc).

{
  "object": "order",
  "id": "ord_live_xjmEW4dIyJM9G4cc",
  "amount": 6000,
  "payment_code": "13642064",
  "currency_code": "PEN",
  "description": "Venta de polo",
  "order_number": "#id-9999",
  "state": "pending",
  "total_fee": null,
  "net_amount": null,
  "fee_details": null,
  "creation_date": 1538540487000,
  "expiration_date": 1538540700000,
  "updated_at": null,
  "paid_at": null,
  "available_on": null,
  "metadata": null
}

Órdenes API

Revisa nuestra API de órdenes para obtener más información: