Ejecuciones

10min
Monto de la operación. Formato XXX.xx donde el PUNTO es el separador decimal.
GET
Request
Query Parameters
id
String
required
ID de la suscripción.
sid
String
required
ID del suscriptor.
Header Parameters
x-api-key
String
required
Clave API de su aplicación.
x-access-token
String
required
Token de Acceso a la entidad para la cual desea realizar la operación.
﻿
El monto con el que se ejecuta la suscripción puede ser diferente al definido en la suscripción o el suscriptor.
POST
Request
Query Parameters
id
String
required
ID de la suscripción
sid
String
required
ID del suscriptor
Header Parameters
x-api-key
String
required
Clave API de su aplicación.
x-access-token
String
required
Token de Acceso a la entidad para la cual desea realizar la operación.
Body Parameters
total
Number
optional
Total a cobrar al suscriptor. Si no se envia se cobrará el monto asignado al Suscriptor ( Monto personalizado por Suscriptor ) o el monto de la Suscripción. Formato XXX.xx donde el PUNTO es el separador decimal.
reference
String
optional
Referencia del Cobro a Ejecutar. Esta referencia deberá ser única.
test
Boolean
optional
Activa el modo de pruebas para la ejecución.
source
String
optional
Siempre que el suscriptor tenga adherida una tarjeta alternativa, se podrá seleccionar sobre que tarjeta generar el cobro manual.
Valores admitidos: "primary" / "secondary".
description
String
optional
Permite definir una descripción para el cobro a realizar, el cual será visualizado en el listado de operaciones.
softDescriptor
String
optional
Permite definir una descripción para el cobros, visible por el tarjeta-habiente en su resumen (dependiente de su banco emisor). Utilice este campo solo en casos requeridos. Longitud máxima 25 caracteres.
﻿
Permite ejecutar cobros masivos dentro de una misma suscripción. Tenga en cuenta que esta API solamente retornará que el proceso fue aceptado exitosamente. La ejecución se realizará de fondo y se notificará via Webhooks.
POST
Request
Query Parameters
id
String
required
ID de la suscripción
Header Parameters
x-api-key
String
required
Clave API de su aplicación.
x-access-token
String
required
Token de Acceso a la entidad para la cual desea realizar la operación.
Body Parameters
Array
required
El body es un Array de Objetos de Tipo JSON
Object
required
Objeto con los datos del suscriptor a cobrar
sid
String
required
Identificador del Suscriptor
total
Number
optional
Monto de la operación. Formato XXX.xx donde el PUNTO es el separador decimal.
reference
String
required
Referencia que identifique el cobro al suscriptor.
description
String
optional
Permite personalizar la descripción del Cobro.
test
Boolean
optional
Marca la ejecución como Prueba. Valores aceptados: true / false. Defecto: false
source
String
optional
Siempre que el suscriptor tenga adherida una tarjeta alternativa, se podrá seleccionar sobre que tarjeta generar el cobro manual.
Valores admitidos: "primary" / "secondary".
﻿
POST
Request
Query Parameters
id
String
required
ID de la suscripción
sid
String
required
ID del suscriptor
Header Parameters
x-api-key
String
required
Clave API de su aplicación
x-access-token
String
required
Token de Acceso a la entidad para la cual desea realizar la operación.
Body Parameters
date
Object
required
Objecto con la fecha de ejecución futura. La fecha definida debe ser al menos 4 días posterior a la fecha actual.
date.day
Integer
required
Día a agendar.
date.month
Integer
required
Mes a agendar.
date.year
Integer
required
Año a agendar.
total
Number
optional
Total específico a cobrar al suscriptor. Si no se envía se cobrará el monto asignado al Suscriptor ( Monto personalizado por Suscriptor ) o el monto de la Suscripción.
﻿
Acciones sobre una ejecución
GET
Request
Query Parameters
id
String
required
ID de la suscripción
sid
String
required
ID del suscriptor
eid
String
required
ID de la ejecución a reintentar
Header Parameters
x-api-key
String
required
Clave API de su aplicación.
x-access-token
String
required
Token de Acceso a la entidad para la cual desea realizar la operación.
﻿
GET
Request
Query Parameters
id
String
required
ID de la suscripción.
sid
String
required
ID del suscriptor.
eid
String
required
ID de la ejecución a marcar como paga.
Header Parameters
x-api-key
String
required
Clave API de su aplicación.
x-access-token
String
required
Token de Acceso a la entidad para la cual desea realizar la operación.
﻿
WebHooks
Los webhooks siempre serán enviados en formato application/x-www-form-urlencoded
Nueva Suscripción
JSON
{
    "type": "subscription:registration",
    "data": {
        "result": true,
        "view": {
            "type": "card"
        },
        "payment": {
            "id": "ABABBB78798",
            "description": "Esto es un registro!",
            "operation": {
                "type": "validation"
            },
            "status": {
                "code": "200",
                "text": "Aprobado",
                "message": "Transacción Aprobada"
            },
            "total": 14.3,
            "currency": {
                "code": "ARS",
                "text": "Peso Argentino",
                "symbol": "$"
            },
            "riskAnalysis": {
                "band": "N/A",
                "level": "N/A"
            },
            "created": "2020-12-02T18:12:11.122Z",
            "updated": "2020-12-02T18:12:12.768Z",
            "reference": "extenal_reference",
            "source": {
                "name": "Visa Débito",
                "type": "card",
                "reference": "visa.debit",
                "number": "4515 00** **** 1234",
                "expiration": {
                    "month": "01",
                    "year": "26"
                },
                "installment": {
                    "description": "Débito",
                    "amount": 14.3,
                    "count": 1,
                    "reference": "1"
                }
            }
        },
        "entity": {
            "name": "Demo Entity",
            "uid": "demo_entity"
        },
        "customer": {
            "uid": "12123123",
            "name": "Juan Perez Wayne",
            "phone": "12123123",
            "identification": "110303456",
            "email": "[email protected]"
        },
        "user": {
            "name": "Juan Perez Wayne",
            "email": "[email protected]"
        },
        "source": {
            "name": "Visa Débito",
            "type": "card",
            "reference": "visa.debit"
        },
        "subscription": {
            "uid": "DRXR14KIUC4V8TFBRL",
            "interval": "1m",
            "limit": 4,
            "name": "El nombre de mi suscripción",
            "description": "Esto es GENIAL",
            "reference": "external_reference",
            "total": 1595
        },
        "subscriber": {
            "uid": "RLY80US2JZ8ZHTSCPH",
            "reference": "3447",
            "customer": {
                "identification": "12123123",
                "email": "[email protected]",
                "name": "Juan Perez Wayne"
            }
        },
        "context": {
            "status": "success"
           },
        "execution": {}
    }
}
{
    "type": "subscription:registration",
    "data": {
        "result": true,
        "view": {
            "type": "card"
        },
        "payment": {
            "id": "ABABBB78798",
            "description": "Esto es un registro!",
            "operation": {
                "type": "validation"
            },
            "status": {
                "code": "200",
                "text": "Aprobado",
                "message": "Transacción Aprobada"
            },
            "total": 14.3,
            "currency": {
                "code": "ARS",
                "text": "Peso Argentino",
                "symbol": "$"
            },
            "riskAnalysis": {
                "band": "N/A",
                "level": "N/A"
            },
            "created": "2020-12-02T18:12:11.122Z",
            "updated": "2020-12-02T18:12:12.768Z",
            "reference": "extenal_reference",
            "source": {
                "name": "Visa Débito",
                "type": "card",
                "reference": "visa.debit",
                "number": "4515 00** **** 1234",
                "expiration": {
                    "month": "01",
                    "year": "26"
                },
                "installment": {
                    "description": "Débito",
                    "amount": 14.3,
                    "count": 1,
                    "reference": "1"
                }
            }
        },
        "entity": {
            "name": "Demo Entity",
            "uid": "demo_entity"
        },
        "customer": {
            "uid": "12123123",
            "name": "Juan Perez Wayne",
            "phone": "12123123",
            "identification": "110303456",
            "email": "soybatman@wayneinc.com"
        },
        "user": {
            "name": "Juan Perez Wayne",
            "email": "juan.perez@mimail.com"
        },
        "source": {
            "name": "Visa Débito",
            "type": "card",
            "reference": "visa.debit"
        },
        "subscription": {
            "uid": "DRXR14KIUC4V8TFBRL",
            "interval": "1m",
            "limit": 4,
            "name": "El nombre de mi suscripción",
            "description": "Esto es GENIAL",
            "reference": "external_reference",
            "total": 1595
        },
        "subscriber": {
            "uid": "RLY80US2JZ8ZHTSCPH",
            "reference": "3447",
            "customer": {
                "identification": "12123123",
                "email": "juan.perez@mimail.com",
                "name": "Juan Perez Wayne"
            }
        },
        "context": {
            "status": "success"
           },
        "execution": {}
    }
}
﻿
Cambio de Método de Pago
JSON
{
    "type": "subscription:change_source",
    "data": {
            "result": true,
            "view": {
                "type": "card"
            },
            "payment": {
                "id": "ABC123123",
                "description": "Validación de Tarjeta.",
                "operation": {
                    "type": "validation"
                },
                "status": {
                    "code": "410",
                    "text": "Denegada, Fondos insuficientes",
                    "message": "Denegada, fondos insuficientes. (Cod. 51)"
                },
                "total": 17.15,
                "currency": {
                    "code": "ARS",
                    "text": "Peso Argentino",
                    "symbol": "$"
                },
                "riskAnalysis": {
                    "band": "N/A",
                    "level": "N/A"
                },
                "created": "2020-12-02T11:31:56.544Z",
                "updated": "2020-12-02T11:31:58.243Z",
                "reference": "external_reference",
                "source": {
                    "name": "Visa",
                    "type": "card",
                    "reference": "visa",
                    "number": "4515 00** **** 1234",
                    "expiration": {
                        "month": "01",
                        "year": "24"
                    },
                    "installment": {
                        "description": "1 Cuota",
                        "amount": 17.15,
                        "count": 1,
                        "reference": "1"
                    }
                }
            },
            "entity": {
                "name": "Demo Entity",
                "uid": "demo_entity"
            },
            "customer": {
                "uid": "12123123",
                "name": "Juan Perez Wayne",
                "phone": "12123123",
                "identification": "110303456",
                "email": "[email protected]"
            },
            "user": {
                "name": "Juan Perez Wayne",
                "email": "[email protected]"
            },
            "source": {
                "name": "Visa",
                "type": "card",
                "reference": "visa"
            },
            "subscription": {
                "uid": "4546465465465",
                "interval": "1m",
                "limit": 0,
                "name": "Mi Suscripción",
                "description": "Débitos automáticos? Todavía existe eso?",
                "reference": "external_reference",
                "total": 8000.14
            },
            "subscriber": {
                "uid": "Fvon4enAv5",
                "reference": "5defe0af-e9be-4288-bed1-423a5cc41920",
                "customer": {
                    "email": "[email protected]",
                    "name": "Juan Perez Wayne",
                    "identification": "12123123",
                    "phone": "1112341234"
                }
            },
            "context": {
                "status": "success"
               },
            "execution": {}
        }
    }
}
{
    "type": "subscription:change_source",
    "data": {
            "result": true,
            "view": {
                "type": "card"
            },
            "payment": {
                "id": "ABC123123",
                "description": "Validación de Tarjeta.",
                "operation": {
                    "type": "validation"
                },
                "status": {
                    "code": "410",
                    "text": "Denegada, Fondos insuficientes",
                    "message": "Denegada, fondos insuficientes. (Cod. 51)"
                },
                "total": 17.15,
                "currency": {
                    "code": "ARS",
                    "text": "Peso Argentino",
                    "symbol": "$"
                },
                "riskAnalysis": {
                    "band": "N/A",
                    "level": "N/A"
                },
                "created": "2020-12-02T11:31:56.544Z",
                "updated": "2020-12-02T11:31:58.243Z",
                "reference": "external_reference",
                "source": {
                    "name": "Visa",
                    "type": "card",
                    "reference": "visa",
                    "number": "4515 00** **** 1234",
                    "expiration": {
                        "month": "01",
                        "year": "24"
                    },
                    "installment": {
                        "description": "1 Cuota",
                        "amount": 17.15,
                        "count": 1,
                        "reference": "1"
                    }
                }
            },
            "entity": {
                "name": "Demo Entity",
                "uid": "demo_entity"
            },
            "customer": {
                "uid": "12123123",
                "name": "Juan Perez Wayne",
                "phone": "12123123",
                "identification": "110303456",
                "email": "soybatman@wayneinc.com"
            },
            "user": {
                "name": "Juan Perez Wayne",
                "email": "juan.perez@mimail.com"
            },
            "source": {
                "name": "Visa",
                "type": "card",
                "reference": "visa"
            },
            "subscription": {
                "uid": "4546465465465",
                "interval": "1m",
                "limit": 0,
                "name": "Mi Suscripción",
                "description": "Débitos automáticos? Todavía existe eso?",
                "reference": "external_reference",
                "total": 8000.14
            },
            "subscriber": {
                "uid": "Fvon4enAv5",
                "reference": "5defe0af-e9be-4288-bed1-423a5cc41920",
                "customer": {
                    "email": "juan.perez@mimail.com",
                    "name": "Juan Perez Wayne",
                    "identification": "12123123",
                    "phone": "1112341234"
                }
            },
            "context": {
                "status": "success"
               },
            "execution": {}
        }
    }
}
﻿
Suscripción Ejecutada
El servicio para este Webhook utiliza los webhooks estandares descriptos en la sección Webhooks de esta documentación agregando los nodos "subscription" y "subscriber"
JSON
{
    "type": "subscription:execution",
    "data": {
        "result": true,
        "view": {
            "type": "card"
        },
        "payment": {
            "id": "ABC121232",
            "description": "Cobro Ejecutado",
            "operation": {
                "type": "payment.v2"
            },
            "status": {
                "code": "410",
                "text": "Denegada, Fondos insuficientes",
                "message": "Denegada, fondos insuficientes. (Cod. 51)"
            },
            "total": 1533.11,
            "currency": {
                "code": "ARS",
                "text": "Peso Argentino",
                "symbol": "$"
            },
            "riskAnalysis": {
                "band": "N/A",
                "level": "N/A"
            },
            "created": "2020-12-02T01:00:55.994Z",
            "updated": "2020-12-02T01:00:57.091Z",
            "reference": "external_reference",
            "source": {
                "name": "Visa Débito",
                "type": "card",
                "reference": "visa.debit",
                "number": "4515 00** **** 1234",
                "expiration": {
                    "month": "02",
                    "year": "26"
                },
                "installment": {
                    "description": "Débito",
                    "amount": 1546.55,
                    "count": 1,
                    "reference": "1"
                }
            }
        },
        "entity": {
                "name": "Demo Entity",
                "uid": "demo_entity"
        },
        "customer": {
            "uid": "12123123",
            "name": "Juan Perez Wayne",
            "phone": "12123123",
            "identification": "110303456",
            "email": "[email protected]"
        },
        "user": {
            "name": "Juan Perez Wayne",
            "email": "[email protected]"
        },
        "source": {
            "name": "Visa Débito",
            "type": "card",
            "reference": "visa.debit"
        },
        "subscription": {
            "uid": "fdSxU7RbC",
            "interval": "1m",
            "limit": 5,
            "name": "Mi Suscripción",
            "description": "Dinosaurios",
            "reference": "external_reference",
            "total": 1547
        },
        "subscriber": {
            "uid": "CBA456456",
            "reference": "exernal_reference",
            "period": -1,
            "customer": {
                "identification": "123123132",
                "email": "[email protected]",
                "name": "Juan Perez Wayne"
            }
        },
        "context": {
            "status": "success"
           },
        "execution": {
            "uid": "54Z45DRXEZ01QWYLUL"
        }
    }
}
{
    "type": "subscription:execution",
    "data": {
        "result": true,
        "view": {
            "type": "card"
        },
        "payment": {
            "id": "ABC121232",
            "description": "Cobro Ejecutado",
            "operation": {
                "type": "payment.v2"
            },
            "status": {
                "code": "410",
                "text": "Denegada, Fondos insuficientes",
                "message": "Denegada, fondos insuficientes. (Cod. 51)"
            },
            "total": 1533.11,
            "currency": {
                "code": "ARS",
                "text": "Peso Argentino",
                "symbol": "$"
            },
            "riskAnalysis": {
                "band": "N/A",
                "level": "N/A"
            },
            "created": "2020-12-02T01:00:55.994Z",
            "updated": "2020-12-02T01:00:57.091Z",
            "reference": "external_reference",
            "source": {
                "name": "Visa Débito",
                "type": "card",
                "reference": "visa.debit",
                "number": "4515 00** **** 1234",
                "expiration": {
                    "month": "02",
                    "year": "26"
                },
                "installment": {
                    "description": "Débito",
                    "amount": 1546.55,
                    "count": 1,
                    "reference": "1"
                }
            }
        },
        "entity": {
                "name": "Demo Entity",
                "uid": "demo_entity"
        },
        "customer": {
            "uid": "12123123",
            "name": "Juan Perez Wayne",
            "phone": "12123123",
            "identification": "110303456",
            "email": "soybatman@wayneinc.com"
        },
        "user": {
            "name": "Juan Perez Wayne",
            "email": "juan.perez@mimail.com"
        },
        "source": {
            "name": "Visa Débito",
            "type": "card",
            "reference": "visa.debit"
        },
        "subscription": {
            "uid": "fdSxU7RbC",
            "interval": "1m",
            "limit": 5,
            "name": "Mi Suscripción",
            "description": "Dinosaurios",
            "reference": "external_reference",
            "total": 1547
        },
        "subscriber": {
            "uid": "CBA456456",
            "reference": "exernal_reference",
            "period": -1,
            "customer": {
                "identification": "123123132",
                "email": "juan.perez@mimail.com",
                "name": "Juan Perez Wayne"
            }
        },
        "context": {
            "status": "success"
           },
        "execution": {
            "uid": "54Z45DRXEZ01QWYLUL"
        }
    }
}
﻿
Suscriptor Suspendido
JSON
{
    "type": "subscription:subscriber:suspended",
    "data": {
        "subscription": {
            "uid": "JmfI3Ml3D",
            "interval": "1m",
            "limit": 0,
            "name": "Nombre de la Suscripción",
            "description": "Descripción de la Suscripción",
            "total": 500
        },
        "subscriber": {
            "uid": "qy82noStM",
            "reference": "qy82noStM",
            "customer": {
                "name": "Juan Batman",
                "identification": "999999",
                "email": "[email protected]"
            }
        }
    }
}
{
    "type": "subscription:subscriber:suspended",
    "data": {
        "subscription": {
            "uid": "JmfI3Ml3D",
            "interval": "1m",
            "limit": 0,
            "name": "Nombre de la Suscripción",
            "description": "Descripción de la Suscripción",
            "total": 500
        },
        "subscriber": {
            "uid": "qy82noStM",
            "reference": "qy82noStM",
            "customer": {
                "name": "Juan Batman",
                "identification": "999999",
                "email": "soybatman@gmail.com"
            }
        }
    }
}
﻿
Suscriptor Activado
JS
{
    "type": "subscription:subscriber:active",
    "data": {
        "subscription": {
            "uid": "JmfI3Ml3D",
            "interval": "1m",
            "limit": 0,
            "name": "Nombre de la Suscripción",
            "description": "Descripción de la Suscripción",
            "total": 500
        },
        "subscriber": {
            "uid": "qy82noStM",
            "reference": "qy82noStM",
            "customer": {
                "name": "Juan Batman",
                "identification": "999999",
                "email": "[email protected]"
            }
        }
    }
}
{
    "type": "subscription:subscriber:active",
    "data": {
        "subscription": {
            "uid": "JmfI3Ml3D",
            "interval": "1m",
            "limit": 0,
            "name": "Nombre de la Suscripción",
            "description": "Descripción de la Suscripción",
            "total": 500
        },
        "subscriber": {
            "uid": "qy82noStM",
            "reference": "qy82noStM",
            "customer": {
                "name": "Juan Batman",
                "identification": "999999",
                "email": "soybatman@gmail.com"
            }
        }
    }
}
﻿
Redirección
Cuando el servicio redirige al suscriptor a la return_url definida al crear la suscripción, se agregan un conjunto de parámetros en la url para indicarle al sitio el resultado de la suscripción.
Los parámetros de tipo query que se agregan a la url definida son:
reference: referencia asignada al suscriptor.
status: estado de la transacción asociada a la operación de suscripción.
uid: ID de la suscripción.
sid: ID del suscriptor.
Cuando se cancela el proceso de suscripción, el status será 0.
Updated 17 Feb 2025
Did this page help you?
Suscriptores
Suscripciones con split