Medios de pago
POST
Listar métodos de pago
POST /api/payment-methods/list-payment-methods
Descripción
Listado paginado de los métodos de pago aceptados por el restaurante.
Detalles
Devuelve los métodos de pago configurados con su tipo, código, ícono, color y orden de presentación. Admite búsqueda por texto y filtro por tipo de método para acotar el listado.
Permisos requeridos
admin.module
Request
| Nombre | Tipo | Requerido | Reglas |
|---|---|---|---|
| search | string | No |
max:100
|
| typeId | int | No |
min_value:1
|
Paginación
| defaultLimit | 50 |
| maxLimit | 100 |
| allowedSorts | sortOrder, name, code |
| defaultSort | sortOrder |
| defaultDir | asc |
| withTotal | true |
Ejemplo de request
curl -X POST https://app.restofy.co/api/payment-methods/list-payment-methods \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <accessToken>"
Los valores son demo: reemplázalos por datos reales del negocio.
Ejemplo de respuesta
Actualizado: 2026-07-15T13:20:48Z
HTTP 200
Request
[]
Response
{
"success": true,
"message": "Operación realizada correctamente",
"data": {
"paymentMethods": [
{
"paymentMethodId": 1,
"code": "pay.cash",
"name": "Efectivo",
"paymentMethodTypeId": 1,
"typeName": "Efectivo",
"typeCode": "cash",
"targetAccountId": null,
"accountName": null,
"iconFontAwesome": "fa-solid fa-money-bill-wave",
"color": "#22c55e",
"publicDescription": null,
"requiresReference": 0,
"followsCashSession": 1,
"requiresDeclaration": 1,
"isSystem": 1,
"sortOrder": 1,
"isActive": 1,
"isAvailable": 1
},
{
"paymentMethodId": 2,
"code": "pay.giftcard",
"name": "Gift Card",
"paymentMethodTypeId": 5,
"typeName": "Cupón/Bono/Voucher/Gift Card",
"typeCode": "coupon",
"targetAccountId": null,
"accountName": null,
"iconFontAwesome": "fa-solid fa-gift",
"color": "#eab308",
"publicDescription": null,
"requiresReference": 1,
"followsCashSession": 0,
"requiresDeclaration": 0,
"isSystem": 1,
"sortOrder": 2,
"isActive": 1,
"isAvailable": 1
},
{
"paymentMethodId": 3,
"code": "pay.advance",
"name": "Anticipo de cliente",
"paymentMethodTypeId": 6,
"typeName": "Anticipo del Cliente",
"typeCode": "customer.advance",
"targetAccountId": null,
"accountName": null,
"iconFontAwesome": "fa-solid fa-sack-dollar",
"color": "#84cc16",
"publicDescription": null,
"requiresReference": 0,
"followsCashSession": 0,
"requiresDeclaration": 0,
"isSystem": 1,
"sortOrder": 3,
"isActive": 1,
"isAvailable": 1
},
{
"paymentMethodId": 12,
"code": "pay.favor-balance",
"name": "Saldo a favor de cliente",
"paymentMethodTypeId": 10,
"typeName": "Saldo a favor de cliente",
"typeCode": "favor.balance",
"targetAccountId": null,
"accountName": null,
"iconFontAwesome": "fa-solid fa-piggy-bank",
"color": "#8b5cf6",
"publicDescription": null,
"requiresReference": 0,
"followsCashSession": 0,
"requiresDeclaration": 0,
"isSystem": 1,
"sortOrder": 12,
"isActive": 1,
"isAvailable": 1
},
{
"paymentMethodId": 11,
"code": null,
"name": "Transferencia Bancaria",
"paymentMethodTypeId": 4,
"typeName": "Transferencia",
"typeCode": "bank.transfer",
"targetAccountId": 25,
"accountName": "Banco general ",
"iconFontAwesome": "fa-solid fa-building-columns",
"color": "#0ea5e9",
"publicDescription": null,
"requiresReference": 1,
"followsCashSession": 0,
"requiresDeclaration": 1,
"isSystem": 0,
"sortOrder": 13,
"isActive": 1,
"isAvailable": 1
}
],
"pagination": {
"page": 1,
"limit": 50,
"total": 5,
"totalPages": 1,
"hasNext": false,
"hasPrev": false
}
}
}