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:
1. Crear el objeto JSON a enviar
El objeto json debe tener la siguiente estructura:
- {
- "subscriptionId": "id returned when subscription was created",
- "merchantId": "your merchantid",
- "secret": "your secret",
- }
A continuación, se muestra la descripción de los parámetros:
- subscriptionId: Es el identificador que se recibe en la respuesta cuando se crea una suscripción
- secret: secret provisto por GreenPay.
- merchant: merchantId provisto por GreenPay.
2. Enviar la solicitud de pago manual
Se debe enviar una solicitud HTTP de tipo POST al endpoint para ejecutar el pago manual 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:
- {
- "status": "SUCCESS",
- "code": 200,
- "result": {
- "status": "approved",
- "orderStatus": "ACTIVE",
- "merchantId": "143b28c9-32ad-4635-8ed8-d6abfb6863a0",
- "order": {
- "order_reference": "9541b344c3d45d421acd454d61251cde_2",
- "subscriptionId": "9541b344c3d45d421acd454d61251cde",
- "user": "UserBot",
- "amount": 100,
- "currency": "USD",
- "date": "2018-12-11T06:00:00.000Z",
- "authorization": "533735",
- "details": "",
- "errors": [],
- "reason": "Manual payment"
- }
- }
- }
A continuación, se muestra un ejemplo en javascript del envío de la solicitud al endpoint de suscripciones para ejecutar un pago manual. Esta función también obtiene el “body” del objeto tipo JSON que se recibe como respuesta.
- var unirest = require("unirest");
- var req = unirest("POST", "
- https://sandbox-merchant.greenpay.me/subscriptions/pay");
- req.headers({
- "cache-control": "no-cache",
- "Content-Type": "application/json"
- });
- req.type("json");
- req.send({
- "subscriptionId": "b69cd5773eac06bf25a702bac02e8079",
- "secret": "QUY5MzBEMkRDMzVCMDFCRDc2NzEwRjZCQjE3NjhFNkE0NjhEQ0MxRjkxQzkzMjAwNzVDNUVGNkY5RTc0N0M0NzkzNUEyQUZFQjczMEYyODEyRjJEMDc5Q0ExNTk1NTA0NjdCMkNBODg1N0Q4MzY2MjI0NEREMUVGQjk4NTcwMzg=",
- "merchantId": "143b28c9-32ad-4635-8ed8-d6abfb6863a0"
- });
- req.end(function (res) {
- if (res.error) throw new Error(res.error);
- console.log(res.body);
- });
- req.headers({
- "cache-control": "no-cache",
- "Content-Type": "application/json"
- });
- req.type("json");
- req.send({
- "subscriptionId": "b69cd5773eac06bf25a702bac02e8079",
- "secret": "QUY5MzBEMkRDMzVCMDFCRDc2NzEwRjZCQjE3NjhFNkE0NjhEQ0MxRjkxQzkzMjAwNzVDNUVGNkY5RTc0N0M0NzkzNUEyQUZFQjczMEYyODEyRjJEMDc5Q0ExNTk1NTA0NjdCMkNBODg1N0Q4MzY2MjI0NEREMUVGQjk4NTcwMzg=",
- "merchantId": "143b28c9-32ad-4635-8ed8-d6abfb6863a0"
- });
- req.end(function (res) {
- if (res.error) throw new Error(res.error);
- console.log(res.body);
- });
3. Posibles errores a recibir
Si se intenta pagar manualmente una suscripción con credenciales incorrectas, la respuesta retornada será la siguiente.
- {
- "code": 500,
- "status": "FAIL",
- "result": [],
- "errors": [
- ""Merchant doesn't exist"."
- ]
- }
- Subscription not found. Impossible to pay manually.
Si se intenta pagar manualmente una suscripción inactiva o en estado On Hold (que tenga reintentos pendientes o no se haya cobrado automáticamente), la respuesta retornada será la siguiente.
- {
- "code": 500,
- "status": "FAIL",
- "result": [],
- "errors": [
- "Subscription not found. Impossible to pay manually."
- ]
- }