Api Rest: Método Sale

El método sale se considera el más importante del api rest ya que es el encargado de solicitar el pago a los clientes y verificar el estado de la transacción. El flujo de ejecución del método es el siguiente:

  1. Llamada POST solicitando el pago: Como vimos en el funcionamiento de PayPhone el cliente confirma sus consumos desde su dispositivo móvil gracias a una solicitud del establecimiento; el método sale nos ayuda a crear esta solicitud. Mediante una llamada POST indicamos al servicio de PayPhone los atributos de la transacción como el número de teléfono del cliente, el valor, los impuestos, entre otros. Todos los valores monetarios a enviar deben ir multiplicados por 100, por ejemplo, $1 dólar = 100; $1.50 dólares = 150. Ingresa al swagger y podrás ver su modelo de consulta y respuesta. Recuerda siempre enviar los campos de acuerdo a tu tipo de facturación; AmountWithTax y Tax en caso de cobrar IVA  o AmountWithoutTax en caso de ser tarifa 0%. Nota: aquí puedes ver como usar el swagger.  
  2. Consultar estado de la transacción: Después de la ejecución de la llamada anterior PayPhone te entregara un identificador de transacción (transactionID) con el que podrás consultar en qué estado se encuentra el cobro realizado (Pendiente, Aceptado o Cancelado). Para esto debes hacer una llamada GET al servicio de PayPhone enviando como parámetro el transactionID. Aquí tienes el modelo de consulta y respuesta.

PayPhone te entregará un código en el campo «statusCode» correspondiente al estado de la transacción: 1-pendiente, 2-cancelada y 3-aprobada.

Puedes crear una rutina para que cada cierto tiempo tu plataforma consulte a PayPhone el estado de la transacción y según la respuesta le muestres al cliente el resultado.

Cabe recalcar que de aquí en adelante tienes dos identificadores para tu transacción, un transactionID entregado por PayPhone y un clientTransactionID que proporcionas tu en la primera llamada POST. Para las llamadas de cancelar, consulta, reverso o anulación puedes usar ya sea el transactionID o tu clientTransactionID.

Nota: El campo StoreID  solo se envía cuando se manejan diferentes tiendas o sucursales, si no se usan diferentes tiendas se puede omitir. Para especificar que tienda hace el cobro el storeID se obtiene desde la página web de PayPhone Developer, en la sección solicitud de compañía, columna Acciones, Listado de tiendas.

Puedes consultar el catálogo de errores haciendo click aquí.

Leave A Comment?