API Doc
Space shortcuts
Page tree

Versions Compared

Old Version 8

changes.mady.by.user Kevin Forgaral

Saved on

compared with

New Version Current

changes.mady.by.user Lucas Mout

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Acción

Status
colourBlue
titlePOST
    https://api/v2.paypertic.com/suscripciones


Parámetros del mensaje


Dias
Advanced Tables - Table Plus
heading0
multiplefalse
enableHeadingAttributesfalse
enableSortingfalse
enableHighlightingfalse
NombreTipoFormatoDescripción
typeString

Tipo de suscripción. Valores:

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

Status
colourRed
titleREQUERIDO

collector_idString

Identificador del comercio.

Status
colourRed
titleREQUERIDO

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
botón regresar.
notification_urlString
URL a la cual se
estaran
estarán enviado las notificaciones del pago.
detailObject

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.

Status
colourRed
titleREQUERIDO

    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

Descripción 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
interés 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
  • Brasileros
  • COP: Pesos Colombianos

Status
colourRed
titleREQUERIDO

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
security_codeString
Codigo

Código 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
expedición.
payerObject

Datos del pagador.

Status
colourRed
titleREQUERIDO

    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
expedición.
    phonesArray (Object)
Lisado

Listado de números telefónicos.
        descriptionString
Descipción

Descripció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


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
DateTime

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_dateDateTime

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_periodBooleanTrue / False

True: La suscripción activa comienza a generar cobros en el periodo actual.

False: La suscripción comienza en el siguiente periodo.

metadataObject
Objeto JSON para adjuntar datos a la suscripción.
recurrenceString

Tipos de recurrencia (por defecto monthly):

  • daily: Diaramente.
  • weekly: Semanalmente.
    • biweekly:
    • fortnight: Quincenalmente.
    • monthly: Mensual.
    bymonthly
    • bimonthly: 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).



    Code Block
    languagejs
    firstline0
    titleSuscripción con campos mínimos.
    linenumberstrue
    collapsetrue
    {
    "type": "subscription",
    "collector_id": "999",
    "currency_id": "ARS",
    "recurrence":"monthly",
    "detail":
		{
            "external_reference": "344999",
            "concept_id":"4499",
            "concept_description":"Concepto Prueba",
            "amount":44 999.499
        },
    "payer": {
    	"id":"999",
        "name": "GustavoPagador SimonePrueba",
        "email": "kevinf@payperticprueba@paypertic.com",
        "identification": {
            "type":"ARG_DNI",
            "number":"1658070799999999",
            "country":"ARG"
        }
    }
}

    Error posibles

    • 4000  Invalid request.

    • 40  4022  Invalid subscription id.

    • 40  4021  Invalid subscription type.

    • 40  4023  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  4024  Invalid due day.40 

    • 4016  Invalid last due daydate.

    • 4017  Invalid security code.

    • 4018  Invalid transaction amount.

    • 4019  Invalid action.

    • 4020  Invalid authorization transaction id.

    • 40  4112  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.

    ...