14min
Ejecuciones
Monto de la operación. Formato XXX.xx donde el PUNTO es el separador decimal.
GET
Params
Query Parameters
id
required
String
ID de la suscripción.
sid
required
String
ID del suscriptor.
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-access-token
required
String
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
Params
Query Parameters
id
required
String
ID de la suscripción
sid
required
String
ID del suscriptor
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-access-token
required
String
Token de Acceso a la entidad para la cual desea realizar la operación.
Body Parameters
total
optional
Number
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
optional
String
Referencia del Cobro a Ejecutar. Esta referencia deberá ser única.
description
optional
String
Descripción de la Ejecución.
test
optional
Boolean
Activa el modo de pruebas para la ejecución.
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
Params
Query Parameters
id
required
String
ID de la suscripción
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-access-token
required
String
Token de Acceso a la entidad para la cual desea realizar la operación.
Body Parameters
required
Array
El body es un Array de Objetos de Tipo JSON
required
Object
Objeto con los datos del suscriptor a cobrar
sid
required
String
Identificador del Suscriptor
total
optional
Number
Monto de la operación. Formato XXX.xx donde el PUNTO es el separador decimal.
reference
optional
String
Referencia que identifique el cobro al suscriptor.
description
optional
String
Permite personalizar la descripción del Cobro.
test
optional
Boolean
Marca la ejecución como Prueba. Valores aceptados: true / false. Defecto: false
POST
Params
Query Parameters
id
required
String
ID de la suscripción
sid
required
String
ID del suscriptor
Header Parameters
x-api-key
required
String
Clave API de su aplicación
x-access-token
required
String
Token de Acceso a la entidad para la cual desea realizar la operación.
Body Parameters
date
required
Object
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
required
Integer
Día a agendar.
date.month
required
Integer
Mes a agendar.
date.year
required
Integer
Año a agendar.
total
optional
Number
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
Params
Query Parameters
id
required
String
ID de la suscripción
sid
required
String
ID del suscriptor
eid
required
String
ID de la ejecución a reintentar
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-access-token
required
String
Token de Acceso a la entidad para la cual desea realizar la operación.
GET
Params
Query Parameters
id
required
String
ID de la suscripción.
sid
required
String
ID del suscriptor.
eid
required
String
ID de la ejecución a marcar como paga.
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-access-token
required
String
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
|
Cambio de Método de Pago
JSON
|
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
|
Suscriptor Suspendido
JSON
|
Suscriptor Activado
JS
|
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 05 Apr 2022
Did this page help you?
Yes
No