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-methodsPide uno de los permisos para registrar ventas: orders:write, layaways:write u orders:pending.
curl https://api.zenci.app/public/v1/payment-methods \
-H "Authorization: Bearer $ZENCI_API_KEY"{
"data": [
{ "id": "m1a5s9d3f7g2h6j0k4l8z2x6", "name": "Efectivo", "kind": "cash", "requiresConfirmationNumber": false },
{ "id": "m7q1w5e9r3t6y0u4i8o2p6a0", "name": "Tarjeta", "kind": "card", "requiresConfirmationNumber": false },
{ "id": "m3z7x1c5v9b2n6m0l4k8j2h6", "name": "Transferencia", "kind": "custom", "requiresConfirmationNumber": true },
{ "id": "m9g3h7j1k5l8z2x6c0v4b8n2", "name": "Tarjeta de Regalo", "kind": "gift_card", "requiresConfirmationNumber": false }
]
}| 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 | El tipo de forma de pago, por ejemplo cash (efectivo), card (tarjeta), custom (otra forma configurada por el comercio, como una transferencia o una billetera digital) o gift_card (tarjeta de regalo) |
requiresConfirmationNumber | true si el dinero llega al banco como transferencia. Envía el número de la operación en confirmationNumber: sin él, el cobro se acepta igual, pero aparece como excepción en la del comercio |
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: gasta un saldo a favor emitido antes, que se canjea en el POS.
- Retención de impuestos: es un mecanismo fiscal que se registra en el POS.
- Tarjeta de regalo, salvo que tu clave tenga el permiso
gift_cards:redeem. Con él, aparece conkind: "gift_card"y cada pago con ella lleva el código de la tarjeta engiftCardCode; consulta .
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 o retención responde 400 ("…" cannot be used to charge through the API…). La tarjeta de regalo sin giftCardCode, o giftCardCode con otra forma de pago, también responde 400. En todos los casos no se crea nada.
La misma lista vale para los abonos de un apartado, salvo la tarjeta de regalo, y para el reembolso de una , salvo el efectivo.
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.
- — Cobra con el saldo de una tarjeta.
- — Errores y límites.