Ir para o conteúdo

listado

Listado de pix

listPixPayment()

Otro método que se puede utilizar para consultar transacciones es la lista de pagos. Este listado se puede realizar mediante filtros como fecha, estado o valores específicos. Todos estos filtros se pueden combinar, permitiendo una consulta más precisa y personalizada de las transacciones realizadas en el periodo especificado.

// solicitud de consulta
{
  "end_date": "Jul 12, 2024 11:01:35",
  "start_date": "Feb 1, 2024 11:01:35",
  "status": [
    "DEVOLVIDO"
  ]
}

Parámetros

Nombre Tipo Obligatorio Descripción
request listPixPayment Sí Objeto de transferencia de datos que contendrá la información de solicitud de foto. Tenga en cuenta que no todos los parámetros son obligatorios.
callback ListPixPaymentCallback Sí Interfaz que se ejecutará para notificaciones de éxito o error en el proceso de pix.

Detalles de los parámetros

request (listPixPayment)

Nombre Tipo Obligatorio Descripción
start_date String Sí Fecha de inicio del filtrado.
end_date String Sí Fecha de finalización del filtrado.
status List<String> No Lista de estados de transacciones para filtrar.
value String No Filtrado de valor de transacción.

Detalles de los parámetros

callback (ListPixPaymentCallback)

Nombre Tipo Obligatorio Descripción
onSuccess String Sí Método de notificación en caso de éxito.
onError String Sí Método de notificación en caso de error. 
fun listPixService(
    pixClient: PixClient,
    startDateTime: Date,
    endDateTime: Date,
    listStatus: List<ChargeStatus>?,
    value: String?,
    listPix: (Array<ListPixResponse>) -> Unit
) {
    val gson: Gson = Gson()

    CoroutineScope(Dispatchers.Main).launch {
        val listPixRequest = ListPixRequest(startDateTime, endDateTime, listStatus, value)
        val callback = object : PixClient.ListPixPaymentCallback {
            override fun onError(response: String?) {
                println("Response $response")
            }

            override fun onSuccess(response: String?) {
                println("Response $response")
                val list = gson.fromJson(response, Array<ListPixResponse>::class.java)
                listPix(list)
            }
        }

        pixClient.listPixPayment(
            gson.toJson(listPixRequest),
            callback
        )
    }
}

Ejemplo de clase ListPixRequest:

data class ListPixRequest(
    @SerializedName("start_date")
    val startDate: Date,
    @SerializedName("end_date")
    val endDate: Date,
    @SerializedName("status")
    val status: List<ChargeStatus>?,
    @SerializedName("value")
    val value: String?,
)

Ejemplo de la clase ListPixResponse:

data class ListPixResponse(
    @SerializedName("cob_value")
    val cobValue: String,
    @SerializedName("pix_client_id")
    val clientId: String,
    @SerializedName("status")
    val status: String,
    @SerializedName("tx_id")
    val txId: String,
    @SerializedName("date_time")
    val pixDateTime: String,
)

En el caso del listado se devolverá un array con la siguiente estructura:

{
  "pix": [
    {
      "cob_value": "0.01",
      "date_time": "2024-06-11T10:59:20Z",
      "status": "REMOVIDA_PELO_USUARIO_RECEBEDOR",
      "tx_id": "bb87b47af1664bda988fe8c82a73a3b3"
    },
    {
      "cob_value": "0.01",
      "date_time": "2024-06-11T11:13:46Z",
      "status": "DEVOLVIDO",
      "tx_id": "827af752d7b04b61952871f43ced22c0"
    },
    {
      "cob_value": "0.01",
      "date_time": "2024-06-11T11:00:52Z",
      "status": "CONCLUIDA",
      "tx_id": "827af752d7b04b61952871f43ced22c0"
    },
    {
      "cob_value": "0.01",
      "date_time": "2024-06-11T11:13:00Z",
      "status": "REMOVIDA_PELO_USUARIO_RECEBEDOR",
      "tx_id": "f0cc13d80f7347de905512918d059ecd"
    },
    {
      "cob_value": "0.01",
      "date_time": "2024-06-12T12:28:50Z",
      "pix_client_id": "81abf3dc-7ab7-4645-99cc-3c23ab26fadb",
      "status": "DEVOLVIDO",
      "tx_id": "1997bd293a7245cdabb60db68effd4a5"
    },
    {
      "cob_value": "0.01",
      "date_time": "2024-06-12T12:27:36Z",
      "pix_client_id": "81abf3dc-7ab7-4645-99cc-3c23ab26fadb",
      "status": "CONCLUIDA",
      "tx_id": "1997bd293a7245cdabb60db68effd4a5"
    },
    {
      "cob_value": "0.01",
      "date_time": "2024-06-12T12:40:31Z",
      "pix_client_id": "abb87037-ff2e-4849-9767-dcab82c6c27a",
      "status": "EXPIRADA",
      "tx_id": "889b7815ec894d5aacd20cd88a077b12"
    },
    {
      "cob_value": "0.01",
      "date_time": "2024-06-13T11:54:26Z",
      "pix_client_id": "918976aa-bebc-4049-b9bf-3d7435f703da",
      "status": "REMOVIDA_PELO_USUARIO_RECEBEDOR",
      "tx_id": "aba04b6ad6494e7ea36916ce0f199349"
    },
    {
      "cob_value": "0.01",
      "date_time": "2024-06-18T08:45:22Z",
      "pix_client_id": "fdfe3199-a2e4-4459-9ce3-af5861790d09",
      "status": "REMOVIDA_PELO_USUARIO_RECEBEDOR",
      "tx_id": "f6324dab076c4b99aee9134c3bc96615"
    },
    {
      "cob_value": "0.02",
      "date_time": "2024-06-18T09:21:39Z",
      "pix_client_id": "853a6129-d5b9-4148-9597-fab003465c27",
      "status": "DEVOLVIDO",
      "tx_id": "36080b620fe2437984e66600e5f8ccf9"
    },
    {
      "cob_value": "0.02",
      "date_time": "2024-06-18T09:16:48Z",
      "pix_client_id": "853a6129-d5b9-4148-9597-fab003465c27",
      "status": "CONCLUIDA",
      "tx_id": "36080b620fe2437984e66600e5f8ccf9"
    },
    {
      "cob_value": "0.01",
      "date_time": "2024-06-18T09:58:42Z",
      "pix_client_id": "b068f3cd-440b-4c34-9608-5fe9847bedd5",
      "status": "CONCLUIDA",
      "tx_id": "82eea34e971441e8abd0f7ccaae0d3cc"
    }
  ]
}