Formas de pago

Cada venta que registras por la API lleva uno o más pagos, y cada pago dice con qué forma de pago se cobró. Este endpoint te da la lista de formas de pago con las que tu tienda puede cobrar.

GET /payment-methods

Pide el permiso orders:write, el mismo que registrar una venta.

curl https://api.zenci.app/public/v1/payment-methods \
  -H "Authorization: Bearer $ZENCI_API_KEY"

{
  "data": [
    { "id": "m1a5s9d3f7g2h6j0k4l8z2x6", "name": "Efectivo", "kind": "cash" },
    { "id": "m7q1w5e9r3t6y0u4i8o2p6a0", "name": "Tarjeta", "kind": "card" },
    { "id": "m3z7x1c5v9b2n6m0l4k8j2h6", "name": "Yappy", "kind": "custom" }
  ]
}

Campo	Descripción
id	El valor que envías como paymentMethodId en cada pago de
name	Nombre de la forma de pago, como la configuró el comercio
kind	cash (efectivo), card (tarjeta) o custom (otra forma configurada por el comercio, como una transferencia o una billetera digital)

La respuesta no se pagina: trae todas las formas de pago a la vez.

Qué formas de pago aparecen

Solo las que el comercio tiene activas y que representan dinero real que entra en esa venta. No aparecen:

• Crédito: una venta a crédito es una cuenta por cobrar, y una venta por API no tiene quién la cobre después.
• Nota de crédito y tarjeta de regalo: gastan un saldo emitido antes y necesitan un código que la API no recibe.
• Retención de impuestos: es un mecanismo fiscal que se registra en el POS.

Usa en tus ventas solo los id de esta lista. Zenci revisa los pagos antes de registrar la venta, con la misma regla de esta lista: un id que no existe o que el comercio desactivó responde 400 (Unknown or disabled payment method "…"), y uno de crédito, nota de crédito, tarjeta de regalo o retención responde 400 ("…" cannot be used to charge a sale through the API…). En los dos casos no se crea nada.

Vuelto

Las formas de pago que dan vuelto (normalmente el efectivo) aceptan un monto mayor que el total: la venta registra lo que entregó el comprador y el vuelto. Las demás deben cobrar el monto exacto; un monto de más con tarjeta responde 400. El detalle está en .

Cuándo volver a consultarla

Las formas de pago cambian poco. Consúltalas al configurar tu integración y guarda la correspondencia entre tus métodos de cobro y los id de Zenci. Vuelve a leerlas si una venta falla con 400 en un pago: puede que el comercio haya desactivado esa forma de pago.

Siguientes pasos

• — Registra una venta con sus pagos.
• — Errores y límites.