En este apartado le explicaremos qué es una solicitud de pago, qué información contiene, para qué sirve cada uno de sus campos y algunos ejemplos.
Una solicitud de pagos es el conjunto de datos que se envían y reciben cuando se trabaja con nuestra API de pagos. Puede contener los siguientes campos
- external_transaction_id (String): Id único de de la solicitud asignado por el sistema integrador. Este ID debe representar cada una de las solicitudes en vuestro sistema. Se valida la unicidad para evitar informar varias veces el mismo pago.
- details (Array<Object>): Listado de detalles del pago. Conceptos e importes de lo que el pagdor debe abonar. Es un listado ya que permite enviar más de un detalle en la misma solicitud, para mostrar los conceptos de forma desagregada y poder agrupar varios pagos en una sola solicitud. Este campo, con todos los detalles de la solicitud de pago, deben ser enviados por el sistema integrador al momento de crear la solicitud y luego no pueden ser modificados. Campos de los detalles;
- amount (Number): Importe del detalle. Debe estar expresado en números con punto como separador de decimales (.) y sin separador de miles, por ejemplo: 15181.85.
- concept_id (String): Identificador del concepto. Este campo identifica el concepto que se está pagando, por ejemplo una patente, número de inmueble, de tasa o un código de producto. No se realiza ninguna validación sobre este campo. Recomendamos que sea un valor realmente representativo del concepto que se está cobrando, ya que luego podrá ser utilizado como filtro para diferentes consultas.
- concept_description (String): Descripción del concepto. Aquí deberá ingresar un texto descriptivo, breve y conciso, para que el pagador lo reconozca. Por ejemplo: "Cuota social Abril 2010" o "Impuesto patente ABC123 - Junio 2015".
- external_reference (String): Referencia del pago. Aquí deberá enviar un identificador que represente a este detalle en particular, como por ejemplo, un número de factura, cedulon, o simplemente un código. La función es similar al external_transaction_id salvo que aquí no se valida la unicidad del valor, el mismo external_reference puede estar presente en diferentes detalles.
- payment_id (String): Campo de uso interno.
- collector_id (String): Identificador de la entidad a la que pertenece este detalle. En el caso de que no estar presente, toma el valor indicado en el nivel superior de la solicitud de pago.
- currency_id (String con valores acotados): Moneda del pago, representación en el código ISO 4217. Por ejemplo, para Pesos Argentinos: ARS. Consulte el listado de monedas disponibles.
- id (String): Id único asignado por Pay per TIC a cada solicitud de pago en el momento en el que se registra en la plataforma. Este uuid representa la solicitud de pago y recomendamos persistirlo y vincularlo en el sistema integrador con el valor representado en el campo external_transaction_id mencionado anteriormente.
- payment_methods (Array<Object>): Listado de objetos de Medio de Pago.
- payer (Object): Objeto Payer. Pagador, usuario final al que le corresponde el pago.
- fee_details (Array<Object>): Listado de cargos.
- final_amount (Number): Monto final de la transacción, es la sumatoria de todos los details y fee_details con type "payer". Es lo que deberá abonar / abonó el pagador.
- status (String con valores acotados): Estado de la transacción. Ver valores posibles.
- status_detail (String): Detalle del estado de la solicitud. Información adicional al estado, por ejemplo: en un rechazo, se mostrará el motivo del mismo "Falta de fondos". En el caso de un pago objetado o cancelado, también podremos encontrar el motivo de dicha acción.
- status_code (Number): Código de error. Este campo estará disponible en el caso de un rechazo o error durante el procesamiento e indicará el código de error correspondiente.
- collector_id (String): Id de la entidad a la que pertenece el pago. Este id es generado por Pay per TIC y es único por cada entidad registrada en nuestra plataforma. En el caso de contar con una sola entidad registrada en nuestra plataforma no es necesario enviarlo ya que se toma automáticamente de la sesión. En caso de estar integrando varias entidades con el mismo usuario es requerido indicar a cual pertence con este valor.
- collector_detail (Object): Objeto que contiene información pública de la entidad a la que pertenece la solicitud de pago. La información que se muestra en este campo es la que está registrada en la configuración dentro de la plataforma, si desea modificar algún dato, póngase en contacto con nuestro equipo de soporte.
- name (String): Nombre de la entidad.
- source_logo (String): Link al logo de la entidad.
- public_address (String): Dirección de dominio público.
- public_phone (String): Teléfono de contacto para usuarios finales.
- public_email (String): Email de contacto para usuarios finales.
- public_business_hours (String): Horario de atención.
- refunds (Array<Object>): Array de objetos Refund. Contiene una lista con todas las devoluciones de una solicitud de pago.
- validation (Boolean): Indica si el pago requiere validación por parte del pagador.
- review (Boolean): Indica si la solicitud requiere validación por parte de la entidad.
- request_date (String): Fecha en la que se registró la solicitud en la API de Pay per TIC.
- due_date (String): Fecha de vencimiento. Es la fecha predeterminada de cobro para los débitos y cupones de pago. En el caso de pagos online no es relevante ya que la transacción se procesa en el momento.
- last_due_date (String): Última fecha de vencimiento. Una vez pasada esta fecha, ya no se podrá pagar esta solicitud.
- refunded_date (String): Fecha de reintegro. Sólo estará presente en pagos con estado "refunded".
- process_date (String): Fecha de procesamiento. Sólo estará presente en pagos cuyo estado sea "in_process", "approved", "rejected" o "refunded".
- paid_date (String): Fecha en la que el medio de pago aprobó la transacción. Sólo estará presente en pagos con estado "approved" o "refunded".
- rejected_date (String): Fecha de rechazo. Sólo estará presente en pagos con estado "rejected".
- cancel_date (String): Fecha de cancelación. Sólo estará presente en pagos con estado "cancelled".
- objected_date (String): Indica la fecha en la que el pagador objetó esta solicitud.. Sólo estará presente en pagos con estado "objected".
- accreditation_date (String): Fecha de acreditación, indica la fecha en la que se disponibiliza el dinero en las cuentas de Pay per TIC de la entidad. Sólo estará presente en pagos con estado "approved". y sólo es válida para gateways cuyo campo ppt_owner tenga valor true.
- review_validation_date (String): Fecha de aprobación de revisión. Sólo estará presente en pagos que tengan el campo review con valor true y su estado ya no sea "review".
- payer_validation_date (String): Indica la fecha en la que el pagador validó la solicitud. Sólo estará presente en pagos que tengan validate con valor true y su estado ya no sea "validate".
- payer_deferred_date (String): Fecha de diferimiento. Sólo estará presente en pagos con estado "deferred". Indica la fecha de diferimiento seleccionada por el pagador. Más información sobre diferimiento de pagos.
- last_update_date (String): Fecha de última actualización. Representa la fecha en la que se realizó el último cambio sobre esta solicitud de pago.
- metadata (Object): Este campo permite almacenar todo tipo de información adicional que sea necesaria en formato JSON.
- carrier (String): Campo de uso interno.
- source (String): Objeto Source. Usuario que generó el último cambio realizado sobre la solicitud.
- presets (Object): Objeto Presets. Permite determinar ciertas funcionalidades de la solicitud en particular. Ver más información sobre los presets.
- by_subscription (String): En el caso que el pago haya sido generado por una suscripción, en este campo encontraremos el id de la misma.
- collector_notifications (Array<Object>): Listado de objetos Collector notifications. Listado con las notificaciones enviadas a la entidad. Sólo se guarda una notificación por cambio de estado, en caso que alguna falle, la próxima sobreescribe el registro actualizando la fecha de envío y el código de respuesta.
- notifications (Array<Object>): Listado de objetos Notification. Listado con todas las notificaciones enviadas al pagador.
- rate (Number): Tasa Nominal Anual (TNA) a aplicar una vez pasada la fecha de vencimiento (due_date).
- charge_delay (Number): Monto fijo de recargo a aplicar una vez pasada la fecha de vencimiento (due_date).