website logo
Consola de Desarrolladores
Navigate through spaces
āŒ˜K
šŸ’ŖPRIMEROS PASOS
Primeros Pasos
šŸ”„IntegraciĆ³n Embebida
šŸ•¹ļøMƓDULOS
šŸ’øCheckout
šŸ”—Link de Pago
šŸ”Suscripciones/Recurrencia
MĆ©todos de Pago y Cuotas
šŸŽFidelizaciĆ³n
šŸ“œCĆ³digos de Barra y QR
šŸ’¾TokenizaciĆ³n de Tarjetas y Cuentas Bancarias - Wallet Transparent
āœ‚ļøMarketplace y Split de pagos
šŸ›’ECOMMERCE Y LIBRERIAS
E-Commerce
Cliente Desktop (CLI)
Marketplace
INFORMACION GENERAL
Tabla de PaĆ­ses
Cod. de Provincias Argentinas
šŸ“ØWebhooks
šŸ’³Tarjetas de Prueba
šŸ’±ConversiĆ³n de Monedas
SUSCRIPCIONES Y LIBRERIAS
Suscripciones
WooCommerce Suscriptions
MOBBEX AVANZADO
Mobbex.JS
šŸŽØPersonalizaciĆ³n de la UI de Pago
Operatoria en 2 pasos
šŸ”Œ SDK
NodeJS
PHP
Windows
OPERACIONES
Consulta de Operaciones
Devoluciones
CĆ³digos de Estado
CĆ³digos de Estado por Estado de Orden
CONNECT
Dev Connect
šŸ“±Aplicaciones MĆ³viles
šŸ‡ŗšŸ‡øEnglish
šŸ’ŖFirst Steps
šŸ”„Embedded Integration
šŸ•¹ļøModules
šŸ’øCheckout
Docs powered by
Archbee
MƓDULOS
Suscripciones/Recurrencia

Suscriptores

22min
Esa API permite obtener todos los suscriptores de una suscripciĆ³n
GET
Params
Path Params
id
required
String
ID de la suscripciĆ³n
Query Parameters
page
required
String
NĆŗmero de pĆ”gina a mostrar iniciando desde 0
search
optional
String
Permite buscar suscriptores por el valor de alguno de sus campos.
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.
ļ»æ
Permite crear un suscriptor para una determinada suscripciĆ³n
POST
Params
Query Parameters
id
required
String
ID de la suscripciĆ³n donde va a ser creado el 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
customer
required
Object
Objeto con los datos del suscriptor.
customer.email
required
String
Email del cliente. Este parƔmetro es necesario.
customer.name
required
String
Nombre del cliente.
customer.identification
required
String
DNI del cliente.
customer.phone
optional
String
TelƩfono del cliente
startDate
required
Object
Fecha a partir de la cual estĆ” Activo el suscriptor. SĆ³lo requerido en suscripciones DinĆ”micas. La fecha definida debe ser al menos 1 dĆ­a posterior a la fecha actual. Ejemplo de formato para ingresar Lunes 2 de Enero del aƱo 2023. Notas: - Si la suscripciĆ³n es de "Agenda FIja", se va a cobrar en el primer initialDay en que el startDate se haya cumplido. - Si el startDate se cumpliĆ³, y el valor del "StartOnInitialDay" es false y estĆ” charge_on_first_source se cobra el proporcional.
startDate.day
required
Number
Dia de inicio de la suscripciĆ³n. Ejemplo de formato: "day": 2
startDate.month
required
Number
Mes de inicio de la suscripciĆ³n. Ejemplo de formato: "month": 1
startDate.year
optional
Number
AƱo de inicio de la suscripciĆ³n ( Opcional ). Si no se provee se tomarĆ” el aƱo corriente. Ejemplo de Formato: "year": 2023
test
optional
Boolean
Marca al suscriptor como un suscriptor de prueba, lo que le permite utilizar las tarjetas de prueba para simular el proceso de suscripciĆ³n. Valor por defecto: False.
total
optional
Number
Importe a cobrar al suscriptor (Opcional). Si no se envĆ­a este parĆ”metro, se considera el importe definido en la suscripciĆ³n. Formato XXX.xx donde el PUNTO es el separador decimal.
reference
optional
String
Referencia que identifique al suscriptor.
voucher
optional
String
Referencia del voucher o cupĆ³n de descuento a aplicar en el suscriptor
ļ»æ

Valores importantes en la respuesta:

  • sourceUrl: URL a la que debe enviar al usuario a aƱadir la Tarjeta
  • subscriberUrl: URL de Control del Suscriptor.
Permite ver un suscriptor en particular en base al ID de suscripciĆ³n y ID del suscriptor
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.
ļ»æ
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
Clave de acceso a la entidad
Body Parameters
total
optional
Number
Nuevo importe a cobrar al suscriptor. Este valor predominarĆ” sobre el de la suscripciĆ³n.
reference
optional
Number
Referencia del suscriptor
customerData
optional
Object
Objeto con los datos del suscriptor que se quieren modificar
customerData.email
optional
String
Email del suscriptor
customerData.name
optional
String
Nombre del suscriptor.
customerData.identification
optional
String
DNI del suscriptor
customerData.phone
optional
String
TelƩfono del suscriptor
ļ»æ

ļ»æ

Cambiar estado del suscriptor

Permite re-activar los cobros a un suscriptor en particular
POST
Params
Query Parameters
uid
required
String
uID 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.
ļ»æ
Permite suspender los cobros que se realicen a un suscriptor en particular
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.
ļ»æ
Permite suspender los cobros que se realicen a un suscriptor en particular
DELETE
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.
ļ»æ

Cambiar Agenda del Suscriptor

Esta acciĆ³n re-generarĆ” toda la agenda del suscriptor basado en la fecha de inicio indicada.
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
startDate
required
Object
Objecto con la fecha de inicio. La fecha construida debe ser al menos 4 dĆ­as posterior a la fecha actual.
startDate.day
required
Integer
Dia de inicio de la suscripciĆ³n.
startDate.month
required
Integer
Mes de inicio de la suscripciĆ³n.
startDate.year
optional
Integer
AƱo de inicio de la suscripciĆ³n ( Opcional ). Si no se provee se tomarĆ” el aƱo corriente.
ļ»æ

Mover Suscriptor a otra SuscripciĆ³n

Tenga en cuenta que sĆ³lo se podrĆ” mover un suscriptor a otra suscripciĆ³n dentro de la misma entidad. Durante el proceso de mover al suscriptor la agenda del mismo serĆ” recalculada cuando la suscripciĆ³n sea "dynamic"

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
sid
required
String
ID de la nueva suscripciĆ³n
ļ»æ

ļ»æ

Ejecuciones

ļ»æ

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.
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.
taxes
optional
Array
DescripciĆ³n de los impuestos aplicados al cobro
optional
Object
ļ»æ
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
|
{
    "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": "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": "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": "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": "soybatman@gmail.com"
            }
        }
    }
}
ļ»æ

ļ»æ

Updated 03 Mar 2023
Did this page help you?
PREVIOUS
Suscripciones
NEXT
Ejecuciones
Docs powered by
Archbee
Obtener Suscriptores