API Doc
Page tree

Versions Compared

Old Version 4

changes.mady.by.user Federico Satelier

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.

...

Status
colourGreen
titleGET
https://api/v2.paypertic.com/pagos/:id


Parámetros de la respuesta


Identificador del pago.
Advanced Tables - Table Plus
heading0
multiplefalse
enableHeadingAttributesfalse
enableSortingfalse
enableHighlightingfalse


NombreTipo
Acceso
FormatoDescripción
idString
readable

Identificador de la transacción.
external_transaction_idString
Identificador unívoco de la transacción para la entidad
typeString
writable

Tipo de pago. Valores:

  • debit:
Debito
  • Débito en cuenta o tarjeta.
  • online: Transacción online con tarjeta.
  • transfer: Transferencia en cuenta.
  • debin: Transacción debin.
  • coupon:
Cupon
  • Cupón de pago.
collector_idString
writable

Identificador del comercio.
return_urlString
writable

URL a la cual redirige el formulario de ingreso de datos de
metodos
métodos de pago una vez finalizado el pago.
back_urlString
writable

URL a la cual redirige el formulario de pago al realizar clic en el
boton
botón regresar.
notification_urlString
writable

URL a la cual se
estaran
estarán enviado las notificaciones del pago.
form_urlString
readable

URL del formulario de pago.
detailsArray (Object)
readable | writable

Listado de pagos que conforman la transacción. Puede tener mas de un pago dentro de una transacción o referenciar a pagos pendientes ya registrados realizados.

También se puede enviar pagos a diferentes comercios los cuales deben declarar y registrar la relación de los mismos.

    payment_idString
Identificador del pago. Se puede enviar el identificador para obtener los datos de un pago pendiente ya registrado en la plataforma, de esta forma la transacción actual realizara el pago del mismo.
    external_referenceString
Referencia o id externo a la plataforma para uso del comercio.
    concept_idString
Identificador del concepto del pago definido por el comercio.
    concept_descriptionString
Descripcion

Descripción del concepto del pago definido por el comercio.
    amountFloat##.00Monto del pago.
    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
writable
##.00Tasa de
interes
interés anual a cobrar pasada la fecha de vencimiento.
charge_delayFloat
writable
##.00Monto fijo a cobrar pasada la fecha de vencimiento.
currency_idString
readable | writable

Identificador de moneda. Valores

:

  • USD: Dolar estadounidense

  • EUR: Euro
  • ARS: Pesos Argentinos
  • BRL: Reales Brazileros
  • COP: Pesos Colombianos
    authorization_transactionIdStringID de transacción de autorización.

disponibles.

payment_methodsArray (Object)
readable | writable


    amountFloat
Monto a pagar con el medio de pago.
    media_payment_idInteger
Identificador del medio de pago.
    first_six_digitsString
Primeros seis dígitos del medio de pago.
   
number
last_four_digitsString
Número del

Últimos cuatro dígitos del medio de pago.
    installmentsInteger
Cuotas.
    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.
    authorization_code
Integer
String
Código de autorización.
   
token
ticket_numberString
Token de ingreso de datos de tarjeta

Numero de ticket generado por el medio de pago.
   
cardholder
holderObject
Titular del medio de
la tarjeta
pago.
        nameString
Nombre.
        identificationObject
Documento del titular
de la tarjeta
.
            typeString
Tipo de documento.
            numberString
Número.
            countryStringISO 3166-1 alfa-3País de
expedicion
expedición.
payer   
gatewayObject
readable | writableDatos del pagador.

Gateway del pago.
        establishment_numberString
Número del establecimiento.
        merchant_idString
Identificador del
pagador. Se obtiene del servicio de CUSTOMERS    nameStringNombre.
usuario en el gateway.

        transaction_id

String
Identificador de la transacción.
        batch_numberString
Número de lote.
        ticket_numberString
Número de ticket.
payerObject

    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.
fee_detailsArray (Object)
readable

Detalle de las comisión.
Estan
Están expresadas en la misma moneda que la transacción.
    typeString

Tipo de

cardo

cargo. Valores:

  • fee: Comisión por transacción.
  • carrier_fee: Arancel del carrier.
  • media_payment_cost: Costo del medio de pago.
  • carrier_cost: Costo del carrier.
  • refund_cost: Costo por reembolso.
  • deferred_cost: Costo por diferir el pago.
  • discount: Descuentos.
  • rebilling_cost: Costo de refacturación
  • tariff : Arancel
  • financial_cost: Costo de financiamiento
  • overdue_payment: Costo de vencimiento
  • others: Otros
    fee_payerString

Quien paga. Valores:

  • collector: El comercio absorbe.
  • payer: El pagador lo absorbe.
    descriptionString
Razón de la comisión.
    amountFloat##.00Monto de la comisión.
final_amountFloat
readable
##.00Monto final de la transacción. Es la suma de los montos de los detalles mas las comisión aplicadas al pagador.
refundsArray (Object)
readable

Listado de reembolsos.
Estan
Están expresadas en la misma moneda que la transacción.
    idString
Identificador del reembolso.
    amountFloat##.00Monto de reembolso.
    sourceObject
Origen del reembolso.
        idString
Identificador del origen.
        nameString
Nombre.
        typeString

Origen de la transacción. Valores:

  • collector: Comercio.
  • system: Sistema interno.
  • backoffice: Operador de backoffice.
  • customer: Pagador.
  • carrier: Carrier.
    metadataObject
Objeto JSON para adjuntar datos al reembolso.
retriesReintentos de pagos.
relatedsArray (Object)
readable

Pagos relacionados.
    typeString

Tipo de relación. Valores:


    payment_idString
Identificador del pago
de reintento
relacionado.
statusString
readable

Estado de la transacción. Valores:

  • pending: El usuario aún no completó el proceso de pago.

approved
  • issued: El pago
fue aprobado y acreditado
  • esta listo para ser enviado a cobrar.
authorized

  • approved: El pago

ha sido autorizado pero aún no fue capturado

  • fue aprobado y acreditado.

  • in_process: El pago fue enviado al medio de pago para el proceso.

  • rejected: El pago fue rechazado. El usuario puede intentar pagar nuevamente.

  • cancelled: El pago fue cancelado por una de las partes, o porque el tiempo expiró.

  • refunded: El pago fue devuelto al usuario.

  • deferred: El pago se encuentra diferido por el pagador.
dismissed
  • objected: El pago se encuentra objetado por el pagador.
  • review: El pago esta pendiente de
aprovacion
  • aprobación por parte de la entidad.
  • validate: El pago esta pendiente de
aprocacion
  • aprobación por parte del pagador.
status_detailString
readable

Detalle del estado (Ej: En un pago rechazado puede venir la leyenda del rechazo "Sin Fondo")
validationBoolean
readable

Si necesita validación por parte del pagador.
reviewBoolean
readable

Si requiere revisión por parte de la entidad.
upgradeableBoolean
readable

Si se puede
actualiar
actualizar el pago.
request_dateDate
readable

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

RFC 822 time zone		Fecha de
envio
envío de la transacción.
due_dateDate
readable | writable

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

RFC 822 time zone		Fecha de vencimiento.
last_due_dateDate
readable | writable

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

RFC 822 time zone		Fecha de último
vencieminto
vencimiento.
process_dateDate
readable

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

RFC 822 time zone

Fecha en la que se proceso el pago.
paid_dateDate
readable

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

RFC 822 time zone

Fecha de pago.
rejected_dateDate
readable

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

RFC 822 time zone

Fecha de rechazo.
cancel_dateDate
readable

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

RFC 822 time zone

Fecha de cancelación.
accreditation_dateDate
readable

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

RFC 822 time zone

Fecha de acreditación.
review_validation_dateDate
readable

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

RFC 822 time zone

Fecha de validación del pago por parte de la entidad.
payer_validation_dateDate
readable

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

RFC 822 time zone

Fecha de validación del pago por parte del pagador.
payer_deferred_dateDate
readable

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

RFC 822 time zone

Fecha de diferimiento del pago.
last_updated_dateDate
readable

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

RFC 822 time zone

Última fecha de actualización.
metadataObject
writable

Objeto JSON para adjuntar datos al pago.
carrierString
writable

Carrier
sourceString
readable

Origen del ultimo cambio del pago.
    idString
Identificador del origen.
    nameString
Nombre.
    typeString

Origen de la transacción. Valores:

  • collector: Comercio.
  • system: Sistema interno.
  • backoffice: Operador de backoffice.
  • customer: Pagador.
  • carrier: Carrier.



Errores posibles

  • 4000  Invalid request.

  • 4001  Invalid payment id.

  • 4100  Access denied.
  • 5001  Internal service error.