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

Acción

GET  https://api.paypertic.com/suscripciones/:id

Parámetros del mensaje de respuesta.


Nombre del campoTipoFormatoDescripció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.
collector_idString

Identificador del comercio.

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

Detalle de la suscripción.

    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.
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
payment_methodObject
Objeto que representa al medio de pago (Sólo si la suscripción tiene uno asociado).
    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.

    idString
Identificador del pagador. Se obtiene del servicio de CUSTOMERS
    external_referenceString
Referencia del pagador en la entidad.
    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.
last_due_dayInteger
Dias desde el comienzo del período hasta el último vencimiento.
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 (Sólo si se trata de tipo subscription con duració temporal o tipo plan).
start_dateDate

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

RFC 822 time zone

Fecha a partir de la cual comenzará la suscripción (Sólo si fue informada al momento de la creación).

request_dateDate

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

RFC 822 time zone
Fecha de solicitud.

cancel_date

Date

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

RFC 822 time zone

Fecha de cancelación (Sólo si ya fue cancelada).

cancel_reasonString
Motivo de cancelación.
rejected_dateDate

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

RFC 822 time zone

Fecha de rechazo (Sólo si fue rechazada por el pagador).

review_validation_dateDate

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

RFC 822 time zone
Fecha de validación de la entidad (Sólo si review es true y fue validada por la entidad).
payer_validation_dateDate

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

RFC 822 time zone
Fecha de validación del pagador (Sólo si validate es true y fue validada por el pagador).
last_update_dateDate

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

RFC 822 time zone
Fecha de última actualización.
created_paymentsInteger
Cantidad de pagos creados por la suscripción.


Error posibles

  • 4000  Invalid request.

  • 40  Invalid subscription id.

  • 4100  Access denied.

  • 5001  Internal service error.

:

  • No labels