| Nombre | Tipo | Formato | Descripción |
|---|
| type | String |
| Tipo de suscripción. Valores: - subscription: Genera cobranzas de acuerdo al importe, concepto y periodicidad otorgadas.
- adhesión: Las cobranzas son informadas por la entidad.
- plan: Genera cobranzas como subscription, pero el pagador no puede cancelarlas.
|
| collector_id | String |
| Identificador del comercio. |
| return_url | String |
| URL a la cual redirige el formulario de ingreso de datos una vez realizada la suscripción. |
| back_url | String |
| URL a la cual redirige el formulario de pago al realizar clic en el botón regresar. |
| notification_url | String |
| URL a la cual se estarán enviado las notificaciones del pago. |
| detail | Object |
| Detalle de la suscripción. También se puede enviar suscripciones a diferentes comercios los cuales deben declarar y registrar la relación de los mismos. |
| external_reference | String |
| Referencia o id externo a la plataforma para uso del comercio. |
| concept_id | String |
| Identificador del concepto de la suscripción definido por el comercio. |
| concept_description | String |
| Descripción del concepto de la suscripción definido por el comercio. |
| amount | Float | ##.00 | Monto de la suscripción. |
| collector_id | String |
| Identificador del comercio. Se puede enviar un identificador distinto al del comercio que esta realizando la transacción, los cuales deben declarar y registrar la relación de los mismos. |
| rate | Float | ##.00 | Tasa de interés anual a cobrar pasada la fecha de vencimiento. |
| charge_delay | Float | ##.00 | Monto fijo a cobrar pasada la fecha de vencimiento. |
| currency_id | String |
| Identificador de moneda. Valores: |
| payment_method | Object |
|
|
| authorization_transaction_id | String |
| ID de transacción de autorización. |
| media_payment_id | Integer |
| Identificador del medio de pago. |
| number | String |
| Número del medio de pago. |
| promotion_id | String |
| Identificador de la promoción. |
| expiration_year | Integer |
| Año de expiración de la tarjeta |
| expiration_month | Integer |
| Mes de expiración de la tarjeta |
| security_code | String |
| Código de seguridad de la tarjeta. |
| holder | Object |
| Titular del medio de pago. |
| name | String |
| Nombre. |
| identification | Object |
| Documento del titular. |
| type | String |
| Tipo de documento. |
| number | String |
| Número. |
| country | String | ISO 3166-1 alfa-3 | País de expedición. |
| payer | Object |
| |
| id | String |
| Identificador del pagador. Se obtiene del servicio de CUSTOMERS |
| external_reference | String |
| Referencia del pagador en la entidad. |
| name | String |
| Nombre. |
| email | String |
| Email. |
| identification | Object |
| Documento del pagador. |
| type | String |
| Tipo de documento. |
| number | String |
| Número. |
| country | String | ISO 3166-1 alfa-3 | País de expedición. |
| phones | Array (Object) |
| Listado de números telefónicos. |
| description | String |
| Descripción del número. |
| country_code | Integer |
| Código de país. |
| area_code | Integer |
| Código de área. |
| number | Integer |
| Números telefónico. |
| extension | Integer |
| Extensión. |
| due_day | Integer | yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone | Días desde el comienzo del período hasta la fecha de vencimiento. Es decir, fecha aproximada en la que se realizara el cobro. - Por defecto 1/3 del tiempo que dura el período
- Las fechas a utilizar van desde el 1 al 20 (inclusive) de cada mes.
|
| last_due_day | Integer | yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone | Días desde el comienzo del período hasta el último vencimiento (Por defecto al finalizar el período de la suscripción). |
| start_date | Integer | yyyy-MM-dd'T'HH:mm:ssZ RFC 822 time zone | Fecha de inicio de la suscripción. (siempre y cuando la suscripción se encuentre activa) |
| start_in_current_period | Boolean | True / False | True: La suscripción activa comienza a generar cobros en el periodo actual. False: La suscripción comienza en el siguiente periodo. |
| metadata | Object |
| Objeto JSON para adjuntar datos a la suscripción. |
| recurrence | String |
| Tipos de recurrencia (por defecto monthly): - fortnight: Quincenalmente.
- monthly: Mensual.
- bimonthly: bimestral.
- quarterly: trimestral.
- fourmonth: cuatrimestral.
- biannual: semestral.
- annual: anual.
|
| periods | Integer |
| Cantidad de periodos de duración de la suscripción (por defecto 0, infinitos periodos). |