API · Crear cobros

API v1

Una herramienta del MCP envuelve esta operación: Tarjetas guardadas y cobros masivos.

POST /api/v1/collect/set/payments

Qué hace#

Crear cobros.

Autenticación#

Servidor: https://app.tilopay.com. Requiere el token bearer del API en Authorization: Bearer <token> y la llave de la integración en el cuerpo (key).

Obtener el token del API.

Parámetros#

keystringrequerido#

Llave de la integración.

captureinteger#

1 captura; 0 solo autoriza.

reasonstringrequerido#

Concepto del cobro.

usersarray#

Afiliados: arreglo de {id, amount, currency, date}.

groupsarray#

Grupos: arreglo de {id, amount, currency, date}; amount es el monto por afiliado.

El campo date vacío indica cobro inmediato; YYYY-MM-DD programa el cobro. En groups, amount es el monto por afiliado.

Ejemplo de request#

<api_key> es el marcador de tu llave de integración.

{
  "key": "<api_key>",
  "capture": 1,
  "reason": "Cobro mensualidad",
  "users": [
    {
      "id": "5",
      "amount": "500.00",
      "currency": "CRC",
      "date": ""
    },
    {
      "id": "32",
      "amount": "1000.00",
      "currency": "CRC",
      "date": "2024-06-20"
    },
    {
      "id": "25",
      "amount": "10.00",
      "currency": "USD",
      "date": "2024-06-20"
    }
  ],
  "groups": [
    {
      "id": "10",
      "amount": "25.00",
      "currency": "USD",
      "date": ""
    }
  ]
}

Respuesta#

batch es el code del lote para get/massive/detail. date vacío = cobro inmediato; YYYY-MM-DD = programado. Repetir esta operación genera otro cobro.

statusunknown#

status.

errorsunknown#

errors.

users_errorsstring | array#

users_errors.

groups_errorsstring | array#

groups_errors.

programedsobject#

programeds.

batchunknown#

batch.

{
  "status": 200,
  "errors": "",
  "users_errors": "",
  "groups_errors": "",
  "programeds": {
    "users": [
      "5",
      "32",
      "25"
    ],
    "groups": [
      "10"
    ]
  },
  "batch": "SGZqbHlHalJiWmRNSEszd3ZEZHo4dz09"
}

{
  "type": "object",
  "properties": {
    "status": {
      "type": "integer"
    },
    "errors": {
      "type": "string"
    },
    "users_errors": {
      "type": [
        "string",
        "array"
      ],
      "items": {}
    },
    "groups_errors": {
      "type": [
        "string",
        "array"
      ],
      "items": {}
    },
    "programeds": {
      "type": "object",
      "properties": {
        "users": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "groups": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "batch": {
      "type": "string"
    }
  }
}

Respuesta de error#

HTTP 400:

{
  "status": "400",
  "errors": "Please verify the data sent",
  "users_errors": [
    {
      "id": "32",
      "amount": "1000.00",
      "currency": "CRC",
      "date": "invalidDate"
    }
  ],
  "groups_errors": [
    {
      "id": "10",
      "amount": "25.00",
      "currency": null,
      "date": null
    }
  ]
}

Reintentos seguros.

Última verificación: 2026-10-20

Ver como Markdown crudo