API · Pagos de suscriptor

POST /api/v1/getSuscriptorPayments

Qué hace#

Devuelve los pagos de los suscriptores de un plan recurrente.

Autenticación#

Requiere el token bearer del API en el header Authorization — ver autenticación.

Parámetros#

Ejemplo de request#

Los valores <...> son marcadores: reemplazalos por tus credenciales y datos.

{
  "key": "<api_key>",
  "id": "1"
}

Respuesta#

{
  "type": "200",
  "message": "Success",
  "data": [
    {
      "id": 150,
      "commerce_id": 37,
      "suscriptor_id": 86,
      "reference": "0",
      "currency": "USD",
      "amount": "0.00",
      "status": 0,
      "data": "{\"first\":1,\"expire\":\"2024-12-28T19:05:29.572648Z\",\"amount\":0,\"activeAmount\":0,\"originalAmount\":0,\"key\":\"XXXX-XXXX-XXXX-XXXX-XXXX\"}",
      "create": "2024-12-13 13:05:06"
    }
  ]
}

El campo data de cada pago es una cadena que contiene JSON, no un objeto: hay que deserializarla aparte después de deserializar la respuesta. El key que viene dentro es la llave de la integración; acá está enmascarado. La fecha de creación viene en create, con formato Y-m-d H:i:s — ver convenciones de las respuestas.

Para interpretar una respuesta que no es de éxito, ver cómo leer una respuesta de error.