Métodos de Pago

Crear o actualizar un método de pago

Crea un nuevo método de pago o actualiza uno existente en el negocio del usuario autenticado.

  • Si el body no incluye _id, se crea un nuevo método de pago.
  • Si el body incluye _id, se actualiza el método de pago existente con ese ID.

Permisos requeridos: BU_POST

Autenticación requerida: Este endpoint requiere autenticación Bearer Token. Usar el campo tokenCurrent obtenido del servicio de login (/login) en el header: Authorization: Bearer {tokenCurrent}

post/paymentMethods

Request

  • Base URL
    https://api.pirpos.com
  • URL
    https://api.pirpos.com/paymentMethods
  • Auth
    HTTP bearer

Headers

Authorizationstring required
Example:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Token JWT obtenido del campo tokenCurrent en el servicio de login

Request body

_idstring

ID del método de pago. Incluir para actualizar un registro existente.

namestring required

Nombre del método de pago (requerido)

Example request

{
  "_id": "507f1f77bcf86cd799439011",
  "name": "Transferencia Bancaria",
  "externalIntegration": {
    "loggro": {
      "id": "lg-001",
      "bankAccount": {
        "id": "ba-456",
        "accountNumber": "123456789",
        "accountName": "Cuenta Principal"
      }
    },
    "siigo": {
      "id": 5001
    },
    "DIAN": {
      "id": "10"
    },
    "credibanco": {
      "isActive": true
    },
    "bold": {
      "name": "credit_card",
      "isActive": "active"
    }
  }
}

Response

Método de pago creado o actualizado exitosamente

_idstring

ID único del método de pago (ObjectId de MongoDB)

businessstring

ID del negocio al que pertenece el método de pago

namestring

Nombre del método de pago

deletedboolean

Indica si el registro fue eliminado lógicamente (soft delete)

modifiedOnstring date-time

Fecha de última modificación

createdOnstring date-time

Fecha de creación del registro

Example response

{
  "_id": "507f1f77bcf86cd799439011",
  "business": "507f1f77bcf86cd799439012",
  "name": "Efectivo",
  "modifiedOn": "2026-03-05T10:30:00.000Z",
  "createdOn": "2026-01-01T08:00:00.000Z",
  "externalIntegration": {
    "loggro": {
      "id": "lg-001",
      "bankAccount": {
        "id": "ba-456",
        "accountNumber": "123456789",
        "accountName": "Cuenta Principal"
      }
    },
    "siigo": {
      "id": 5001
    },
    "DIAN": {
      "id": "10"
    },
    "credibanco": {
      "isActive": true
    },
    "bold": {
      "name": "credit_card",
      "isActive": "active"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.