Consultar una transacción
En esta sección se proporciona información detallada sobre cómo realizar consultas sobre transacciones, aplicando diferentes filtros.
Requisitos
- Filtros para aplicar en la búsqueda.
Paso a paso
- Instanciar el objeto
TrxData
pasándole el contexto. - Instanciar el objeto
LastTrxRequest
- Invocar el método
getLastTrx
y pasarle el objetoLastTrxRequest
. - Configurar un observer para recibir el listado de transacciones.
Instanciar objeto LastTrxRequest
Campo | Descripción |
---|---|
appVersion | String con la versión de la App. Por default se envía un String EMPTY = “”. |
operationType | String con el tipo de operación que se desea consultar. |
merchantId | Identificador del merchant. Formato UUID. |
customerId | Identificador del customer. Formato UUID. |
start | Fecha de inicio de consulta. Formato UTC+0: YYYY-MM-DDT00:00:00Z |
end | Fecha de fin de consulta. Formato UTC+0: YYYY-MM-DDT00:00:00Z |
page | Número de páginas a recuperar. |
size | Cantidad de registros a recuperar. |
status | Estado de la transacción: APPROVED, REJECTED |
paymentMethod | Método de pago: DEBIT, CREDIT, PREPAID, QR |
cardBrand |
|
minAmount | Monto mínimo para buscar la transacción. En formato ISO, sin punto decimal y los 2 últimos dígitos son los decimales, ejemplo: $10 = 1000 |
maxAmount | Monto máximo para buscar la transacción. En formato ISO, sin punto decimal y los 2 últimos dígitos son los decimales, ejemplo: $10 = 1000 |
ℹ️
Si no se desea aplicar alguno de estos filtros, debe enviarse como null.
Ejemplo de implementación
val trxData = TrxData(this)
val lastTrxRequest = LastTrxRequest(
appVersion = "",
operationType = "",
merchantId = merchantId,
customerId = customerId,
userEmail = null,
start = "2024-07-01T00:00:00Z",
end = "2024-07-09T23:59:00Z",
page = 0, size = 1000
)
trxData.getLastTrx(lastTrxRequest = lastTrxRequest)
trxData.getLastTrx.observe(this) { lisTrx ->
lisTrx?.let {
if (lisTrx.statusResult?.statusType == StatusType.SUCCESS) {
Log.i(TAG, "Listado de transacciones: $lisTrx")
} else {
Log.i(TAG, "Error en la consulta")
}
} ?: run {
Log.i(TAG, "Transacciones no disponibles")
}
}
Códigos de respuesta
La respuesta se recupera del objeto TrxListResponse
.
Objeto TrxListResponse
- statusResult: Campo de tipo StatusResult, contiene el estado de la consulta. En el campo code de este objeto se puede recuperar el estado, los posibles valores son:
Código | Descripción |
---|---|
StatusResult.ERROR | Ocurrió un error en la búsqueda de las transacciones. |
StatusResult.SUCCESS | La consulta se realizó con éxito. |
- content: Campo de tipo
List<Transaction>
, contiene el listado de transacciones devueltos en la consulta. El objeto Transaction contiene los siguientes datos:- id → es el identificador interno de la transacción.
- type → es el tipo de transacción.
- merchant_id → es el identificador del merchant con el que se realizó la transacción.
- customer_id → es el identificador del customer con el que se realizó la transacción.
- terminal → Contiene datos de la terminal.
- currency → Es el código de moneda con el que se realizó la transacción.
- installment → Contiene información de las cuotas, si aplica.
- amount → Es el monto de la transacción.
- card → Contiene datos de la tarjeta.
- qr_id → Es el identificador de QR, aplica para los pagos coo QR.
- refunded_amount → Contiene el monto de la devolución/anulación.