API Doc
Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »


Acción

POST  /api/v2/suscripciones


Parámetros del mensaje


NombreTipoFormatoDescripción
typeString

Tipo de suscripción. Valores:

  • subscription: Genera cobranzas de acuerdo al importe, concepto y periodicidad otorgadas.
  • adhesion: Las cobranzas son informadas por la entidad.
  • plan: Genera cobranzas como subscription, pero el pagador no puede cancelarlas.

REQUERIDO

collector_idString

Identificador del comercio.

REQUERIDO

return_urlString
URL a la cual redirige el formulario de ingreso de datos una vez realizada la suscripción.
back_urlString
URL a la cual redirige el formulario de pago al realizar clic en el boton regresar.
notification_urlString
URL a la cual se estaran enviado las notificaciones del pago.
detailsObject

Detalles 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.

REQUERIDO

    external_referenceString

Referencia o id externo a la plataforma para uso del comercio.

    concept_idString
Identificador del concepto de la suscripción definido por el comercio.
    concept_descriptionString
Descripcion del concepto de la suscripción definido por el comercio.
    amountFloat##.00Monto de la suscripción.
    collector_idString
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.
rateFloat##.00Tasa de interes anual a cobrar pasada la fecha de vencimiento.
charge_delayFloat##.00Monto fijo a cobrar pasada la fecha de vencimiento.
currency_idString

Identificador de moneda. Valores:

  • USD: Dolar estadounidense

  • EUR: Euro
  • ARS: Pesos Argentinos
  • BRL: Reales Brazileros
  • COP: Pesos Colombianos

REQUERIDO

payment_methodObject

    authorization_transaction_idString
ID de transacción de autorización.
    media_payment_idInteger
Identificador del medio de pago.
    numberString
Número del medio de pago.
    promotion_idString
Identificador de la promoción.
    expiration_yearInteger
Año de expiración de la tarjeta
    expiration_monthInteger
Mes de expiración de la tarjeta
    securoty_codeString
Codigo de seguridad de la tarjeta.
    holderObject
Titular del medio de pago.
        nameString
Nombre.
        identificationObject
Documento del titular.
            typeString
Tipo de documento.
            numberString
Número.
            countryStringISO 3166-1 alfa-3País de expedicion.
payerObject

Datos del pagador.

REQUERIDO

    idString
Identificador del pagador. Se obtiene del servicio de CUSTOMERS
    nameString
Nombre.
    emailString
Email.
    identificationObject
Documento del pagador.
        typeString
Tipo de documento.
        numberString
Número.
        countryStringISO 3166-1 alfa-3País de expedicion.
    phonesArray (Object)
Lisado de números telefónicos.
        descriptionString
Descipción del número.
        country_codeInteger
Código de país.
        area_codeInteger
Código de área.
        numberInteger
Números telefónico.
        extensionInteger
Extensión.
due_dayInteger
Dias desde el comienzo del período hasta la fecha de vencimiento (Por defecto 1/3 del tiempo que dura el período).
last_due_dayInteger
Dias desde el comienzo del período hasta el último vencimiento (Por defecto al finalizar el período de la suscripción).
metadataObject
Objeto JSON para adjuntar datos a la suscripción.
recurrenceString

Tipos de recurrencia (por defecto monthly):

  • daily: Diaramente.
  • weekly: Semanalmente.
  • biweekly: Quincenalmente.
  • monthly: Mensual.
  • bymonthly: bimestral.
  • quarterly: trimestral.
  • fourmonth: cuatrimestral.
  • biannual: semestral.
  • annual: anual.
periodsInteger
Cantidad de periodos de duración de la suscripción (por defecto 0, infinitos periodos).
start_dateDate

yyyy-MM-dd'T'HH:mm:ssZ

RFC 822 time zone		Fecha a partir de la cual comenzará la suscripción (debe ser mayor a la fecha actual).

Suscripción con campos mínimos.

Error posibles

  • 4000  Invalid request.

  • 40  Invalid subscription id.

  • 40  Invalid subscription type.

  • 40  Invalid subscription status

  • 4004  Invalid collector.

  • 4005  Invalid payment method.

  • 4006  Invalid currency.

  • 4007  Invalid url return.

  • 4008  Invalid back url.

  • 4009  Invalid url notification.

  • 4010  Invalid media payment.

  • 4011  Invalid expiration year.

  • 4012  Invalid expiration month.

  • 4013  Invalid identification type.

  • 4014  Invalid identification type.

  • 40  Invalid due day.

  • 40  Invalid last due day.

  • 4017  Invalid security code.

  • 4018  Invalid transaction amount.

  • 4019  Invalid action.

  • 4020  Invalid authorization transaction id.

  • 40  Details of subscription can't be null.

  • 4031  External reference can not be null.

  • 4032  Concept id can not be null.

  • 4033  Concept description can not be null.

  • 4034  Amount can not be null.

  • 4036  Card holder can not be null.

  • 4037  Card holder name can not be null.

  • 4038  Card holder identification can not be null.

  • 4039  Identification number can not be null.

  • 4050  Parameter not allowed.

  • 4051  Unrelated collector.

  • 4053  Rate out of range.

  • 4054  Charge delay out of range.

  • 4057  Payment number not allowed.

  • 4058  Security code not allowed.

  • 4059  Holder not allowed.

  • 4060  Parameter not found.

  • 4100  Access denied.

  • 5001  Internal service error.

:

  • No labels