Actualizar monto

Actualizar monto

Para este servicio se debe consumir el siguiente endpoint:

A continuación, se muestra el paso a paso para actualizar el monto de  una suscripción en nuestro API de forma exitosa:

1. Crear el objeto JSON a enviar

El objeto json debe tener la siguiente estructura:

Ejemplo de JSON a enviar en el request
  1. {
  2.   "subscriptionId": "id returned when subscription was created",
  3.   "merchantId": "your merchantid",
  4.   "secret": "your secret",
  5.   "user": "Some user name",
  6.   "amount": 100
  7. }

A continuación, se muestra la descripción de los parámetros:

  1. subscriptionId: Es el identificador que se recibe en la respuesta cuando se crea una suscripción
  2. secret: secret provisto por GreenPay.
  3. merchant: merchantId provisto por GreenPay.
  4. user: Usuario que actualizará la suscripción.
  5. amount: Monto por el que se actualizará la suscripción.

Consideraciones

El parámetro “user” es para llevar la auditoría de los usuarios que cambian el método de pago.

2. Enviar la solicitud de actualización del monto

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

Una vez que se ha enviado la solicitud de actualización del monto y esta se haya realizado 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:

Ejemplo de respuesta exitosa
  1. {
  2.   "status": "SUCCESS",
  3.   "code": 200,
  4.   "result": {
  5.       "id": "3",
  6.       "merchant_id": "143b28c9-32ad-4635-8ed8-d6abfb6863a0",
  7.       "status": "ACTIVE",
  8.       "user_id": "Aaron",
  9.       "user_type": 1,
  10.       "card_tokens": [
  11.           "bf0bd94a-a4e7-4ef6-96c6-2350f3963f93"
  12.       ],
  13.       "purchase_order": {
  14.           "secret": "QUY5MzBEMkRDMzVCMDFCRDc2NzEwRjZCQjE3NjhFNkE0NjhEQ0MxRjkxQzkzMjAwNzVDNUVGNkY5RTc0N0M0NzkzNUEyQUZFQjczMEYyODEyRjJEMDc5Q0ExNTk1NTA0NjdCMkNBODg1N0Q4MzY2MjI0NEREMUVGQjk4NTcwMzg=",
  15.           "currency": "CRC",
  16.           "optional": {
  17.               "key": "value",
  18.               "key1": "value1"
  19.           },
  20.           "terminal": "deKokoTest-eb29-BNCR-CRC",
  21.           "description": "subscription description",
  22.           "subscription": [
  23.               {
  24.                   "amount": 5500.99,
  25.                   "cadence": {
  26.                       "day": 15,
  27.                       "mode": "EVERY",
  28.                       "unit": "MONTH",
  29.                       "every": 1
  30.                   },
  31.                   "endDate": 1544853600000,
  32.                   "startDate": 1536991200000
  33.               }
  34.           ],
  35.           "initialPayment": {
  36.               "amount": 100,
  37.               "description": "some set up description"
  38.           }
  39.       },
  40.       "next_payment": null,
  41.       "enabled": true,
  42.       "inserted_at": "2018-12-21T20:55:06.299Z",
  43.       "updated_at": "2018-12-21T22:01:11.341Z",
  44.       "general_info": {
  45.           "user": "UserBot"
  46.       }
  47.   },
  48.   "errors": []
  49. }

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

Ejemplo de código para envío del request
  1. var unirest = require("unirest");

  3. var req = unirest("POST", "https://sandbox-merchant.greenpay.me/subscriptions/update");

  5. req.headers({
  6.    "Postman-Token": "bc6f3d94-d5b0-4b76-afc8-4e13b08f576f",
  7.    "cache-control": "no-cache",
  8.    "Content-Type": "application/json"
  9. });

  11. req.type("json");
  12. req.send({
  13.    "subscriptionId": "f39a928e9c1f1fa32f30e1de1df35656",
  14.    "secret": "QUY5MzBEMkRDMzVCMDFCRDc2NzEwRjZCQjE3NjhFNkE0NjhEQ0MxRjkxQzkzMjAwNzVDNUVGNkY5RTc0N0M0NzkzNUEyQUZFQjczMEYyODEyRjJEMDc5Q0ExNTk1NTA0NjdCMkNBODg1N0Q4MzY2MjI0NEREMUVGQjk4NTcwMzg=",
  15.    "merchantId": "143b28c9-32ad-4635-8ed8-d6abfb6863a0",
  16.    "user": "User Bot",
  17.    "amount": 5500.99
  18. });

  20. req.end(function (res) {
  21.    if (res.error) throw new Error(res.error);

  23.    console.log(res.body);
  24. });

3. Posibles errores a recibir

  • Merchant doesn't exist.

Si se intenta actualizar el monto de una suscripción con credenciales incorrectas, la respuesta retornada será la siguiente.

Ejemplo de respuesta - Credenciales inválidas
  1. {
  2.   "code": 500,
  3.   "status": "FAIL",
  4.   "result": [],
  5.   "errors": [
  6.       ""Merchant doesn't exist"."
  7.   ]
  8. }
  • Subscription not found. Impossible to change amount.

Si se intenta actualizar una suscripción inactiva o pendiente de pago, la respuesta retornada será la siguiente.

Ejemplo de respuesta - Suscripción no encontrada
  1. {
  2.   "code": 500,
  3.   "status": "FAIL",
  4.   "result": [],
  5.   "errors": [
  6.       "Subscription not found. Impossible to pay manually."
  7.   ]
  8. }​



    • Related Articles

    • Actualizar método de pago

      Para este servicio se debe consumir el siguiente endpoint: https://sandbox-merchant.greenpay.me/subscriptions/update/card_token A continuación, se muestra el paso a paso para cancelar  una suscripción en nuestro API de forma exitosa: 1. Crear el ...

    • Actualizar token de tarjeta

      Consideraciones Para utilizar el servicio de tokenización se debe tomar en cuenta los siguiente: Utilizar el servicio en los endpoints:  Sandbox: https://sandbox-checkout.greenpay.me/tokenize/update ...

    • Proceso para actualizar token con formulario

      Consideraciones Para utilizar el formulario de tokenización de tarjetas se debe considerar los siguiente: El formulario está disponible en: Sandbox: http://sandbox-tokenizeform.greenpay.me/ Producción: https://tokenizeform.greenpay.me/ Tener ...

    • 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 ...

    • 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 ...