Listar suscripciones

Listar suscripciones

Para este servicio se debe consumir el siguiente endpoint:

A continuación, se muestra el paso a paso para ejecutar un pago manual de una suscripción en nuestro API de forma exitosa:

Crear el objeto JSON a enviar

El objeto json debe tener la siguiente estructura:

  1. {
  2.     "merchantId": "merchantId provisto por GreenPay en el archivo de las credenciales",
  3.     "secret": "secret provisto por GreenPay en el archivo de las credenciales",
  4.     "pageSize": 25,
  5.     "page": 1,
  6.     "filters": {
  7.         "status": [
  8.             "ON_HOLD", "PENDING", "CANCELED"
  9.         ],
  10.         "user": "userId registrado cuando se creó la suscripción",
  11.         "minAmount": 0, //Mayor que cero
  12.         "maxAmount": 0, //Mayor que cero
  13.         "subsDate": "2019-06-20T06:00:51.582Z" //Timestamp de la fecha en que se creó la suscripción
  14.     }
  15. }
Todos los parámetros del campo "filters" son opcionales. Es decir si no envían el campo filters, el servicio lista todas las suscripciones que haya creado el comercio, si envía el filters puede listar 1 o más de acuerdo a los parámetros permitidos por el API.

A continuación, se muestra la descripción de los parámetros:
  1. secret: secret provisto por GreenPay en el archivo de las credenciales.
  2. merchant: merchantId provisto por GreenPay en el archivo de las credeciales.
  3. pageSize: Cantidad de registros que debe retornar el servicio
  4. page: Página que debe retornar el servicio.

Consideraciones

  • El parámetro “page” debe ser un error mayor que cero.
  • El parámetro “pageSize” debe ser un número entre uno y cien.

2. Enviar la solicitud 

Se debe enviar una solicitud HTTP de tipo POST al endpoint para ejecutar el listado con el objeto json que contiene los datos de la suscripción.

Una vez que se ha enviado la solicitud y esta se haya realizada con éxito, se obtiene un objeto de tipo JSON como respuesta.

Al recibir esta respuesta, el parámetro que se debe obtener del objeto JSON es el “body”, ya que este contiene el resultado del cambio del monto de la suscripción. En la siguiente imagen se muestra un ejemplo de la respuesta que se recibe:

  1. {
  2.     "status": "SUCCESS",
  3.     "code": 200,
  4.     "result": {
  5.         "entries": [
  6.             {
  7.                 "id": "5625d026579f64b63f250631220f8836",
  8.                 "status": "NOT_PAID",
  9.                 "user_id": "Aaron",
  10.                 "description": "subscription description",
  11.                 "currency": "CRC",
  12.                 "amount": "10",
  13.                 "startdate": "1536991200000",
  14.                 "enddate": "1544853600000",
  15.                 "cadence": "EVERY 1 MONTH",
  16.                 "next_payment_date": "2019-01-15T00:00:00.000Z"
  17.             },
  18.             {
  19.                 "id": "2d374b16dfc4937a7429cbd73636f7ba",
  20.                 "status": "NOT_PAID",
  21.                 "user_id": "Aaron",
  22.                 "description": "subscription description",
  23.                 "currency": "CRC",
  24.                 "amount": "10",
  25.                 "startdate": "1536991200000",
  26.                 "enddate": "1544853600000",
  27.                 "cadence": "EVERY 15 DAY",
  28.               "next_payment_date": "2019-01-27T00:00:00.000Z"
  29.             }
  30.         ],
  31.         "page": 1,
  32.         "totalEntries": 15,
  33.         "totalPages": 1
  34.     },
  35.     "errors": []
  36. }

A continuación, se muestra un ejemplo en javascript del envío de la solicitud al endpoint de suscripciones para listar. Esta función también obtiene el “body” del objeto tipo JSON que se recibe como respuesta.

  1. var unirest = require("unirest");

  2. var req = unirest("POST", "https://dev-merchant.greenpay.me/subscriptions/list");

  3. req.headers({
  4.  "Postman-Token": "93d00f6a-5af4-4dd1-b540-5b705107b615",
  5.  "cache-control": "no-cache",
  6.  "Content-Type": "application/json"
  7. });

  8. req.type("json");
  9. req.send({
  10.  "secret": "QUY5MzBEMkRDMzVCMDFCRDc2NzEwRjZCQjE3NjhFNkE0NjhEQ0MxRjkxQzkzMjAwNzVDNUVGNkY5RTc0N0M0NzkzNUEyQUZFQjczMEYyODEyRjJEMDc5Q0ExNTk1NTA0NjdCMkNBODg1N0Q4MzY2MjI0NEREMUVGQjk4NTcwMzg=",
  11.  "merchantId": "143b28c9-32ad-4635-8ed8-d6abfb6863a0",
  12.  "pageSize": 100,
  13.  "page": 1
  14. });

  15. req.end(function (res) {
  16.  if (res.error) throw new Error(res.error);

  17.  console.log(res.body);
  18. });

Posibles errores a recibir:

  • Merchant doesn't exist.

Si se intenta utilizar el servicio con credenciales incorrectas, la respuesta retornada será la siguiente.

  1. {
  2.   "code": 500,
  3.   "status": "FAIL",
  4.   "result": [],
  5.   "errors": [
  6.       ""Merchant doesn't exist"."
  7.   ]
  8. }
  • Bad request, check params

Si se intenta utilizar el servicio enviando valores no aceptados en los parámetros pageSize y page, la respuesta retornada será la siguiente.

  1. {
  2.    "status": "FAIL",
  3.    "code": 400,
  4.    "result": [],
  5.    "errors": [
  6.        "Bad request, check params"
  7.    ]
  8. }​



    • Related Articles

    • Listar pagos de suscripciones

      Para este servicio se debe consumir el siguiente endpoint: https://sandbox-merchant.greenpay.me/subscriptions/list/payments A continuación, se muestra el paso a paso para ejecutar un pago manual de una suscripción en nuestro API de forma exitosa: ...
    • Servicio de suscripciones - Información general

      Este servicio permite a los comercios utilizar la funcionalidad de suscribir a sus clientes a cobros automáticos en una ventana de tiempo establecida. La funcionalidad actual, solo permite el pago mensual de las suscripciones creadas, es decir, se ...
    • Suscripciones del comercio

      Consideraciones Para utilizar la funcionalidad de suscripciones debe considerar lo siguiente: El comercio debe estar habilitado, si esta deshabilitado no podrá ingresar y utilizar la funcionalidades del dashboard. Si desconoce el estado de su ...
    • Listar detalles de transacción

      Consideraciones Para hacer uso de este servicio se deben tener las siguientes consideraciones: Utilizar el servicio en el endpoint:  En sandbox: https://sandbox-merchant.greenpay.me/transactions/get En ...
    • Manual para el uso del Dashboard

      El dashboard de GreenPay es una interfaz enfocada en brindar al usuario las herramientas necesarias para administrar todas las transacciones que se realicen por medio de los servicios de GreenPay. Este permite la gestión de suscripciones y ...