Informes Pix¶

Consultar Informes¶

Warning

Funcionalidad disponible desde App Pix v1.3.0.1 y PhastPay-SDK v1.0.0.0.

`getReports`¶

Se utiliza la función getReports para consultar el informe de transacciones en un período determinado.

`Request`¶

{
  "start_date": "2024-06-01T00:40:01.444Z",
  "end_date": "2024-06-05T00:40:01.444Z",
  "report_type": "SUMMARY"
}

Parámetros

Nombre	Tipo	Requerido	Descripción
`request`	`String`	Si	Objeto que contiene la información de la solicitud.
`callback`	`GetReportsCallback`	Si	Interfaz que se ejecutará para notificaciones de éxito o error.

Detalle de los Parámetros

request (getReports)

Nombre	Tipo	Requerido	Descripción	Por defecto
`start_date`	`String`	No	Fecha de inicio en formato UTC	-
`end_date`	`String`	No	Fecha de fin en formato UTC	-
`report_type`	`SUMMARY, DETAILED`	No	Indica el tipo de informe a generar: resumido o detallado.	`SUMMARY`

Detalle de los Parámetros

callback (GetReportsCallback)

Nombre	Tipo	Requerido	Descripción
`onSuccess`	`String`	Si	Método llamado en caso de éxito.
`onError`	`String`	Si	Método llamado en caso de error. La respuesta será una `String`, en formato JSON, que contiene los campos definidos en la clase `IpcResponseError`.

fun getReportsService(
    pixClient: PixClient,
    startDate: String,
    endDate: String,
    reportType: ReportType
) {
    val gson: Gson = Gson()

    if (pixClient.isBound()) {
        val getReportsRequest = GetReportsRequest(startDate, endDate, reportType)
        val callback = object : PixClient.ICallbackService {
            override fun onError(response: String?) {
                val responseError = gson.fromJson(response, IpcResponseError::class.java)
                println("Erro $responseError")
            }

            override fun onSuccess(response: String?) {
               println("consultado $response")
            }
        }
          pixClient.getReports(
            gson.toJson(getReportsRequest),
            callback
        )
    }
}

Solicitudes y Respuestas¶

GetReportsRequest¶

data class GetReportsRequest(
    @SerializedName("start_date")
    val startDate: String,

    @SerializedName("end_date")
    val endDate: String,

    @SerializedName("report_type")
    val reportType: ReportType
)

IpcResponseError¶

class IpcResponseError (
    @SerializedName("error_message")
    val errorMessage: String
)