Obtener el historial de transacciones

El SDK de Clip permite obtener el historial de transacciones que se han realizado.

Las funciones disponibles para trabajar con el historial son las siguientes:

  • search(): permite realizar una búsqueda de transacciones del mismo día y aplicar distintos filtros.
  • detail(): muestra detalles para una transacción individual.
  • refund(): realiza el reembolso de una transacción.

La siguiente tabla muestra los elementos en el objeto de respuesta ClipTransaction que regresan las funciones anteriores:

Elemento

Descripción

Tipo de dato

receiptNumber

Identificador único de la transacción

String

amount

Cantidad del pago

BigDecimal

tip

Cantidad de la propina

BigDecimal

totalAmount

Cantidad total del pago incluyendo propina

BigDecimal

cardType

Tipo de tarjeta utilizada para el pago:  

  • VISA
  • MASTERCARD
  • DISCOVER
  • AMEX
  • JCB
  • CARNET
  • SIVALE
  • UNKNOWN

Object, string

last4

Últimos cuatro dígitos de la tarjeta utilizada para el pago

String

installment

Indica si el pago se difiere en mensualidades

String

walletAmount

Cantidad a pagar con monedero electrónico

BigDecimal

walletType

Tipo de monedero

  • Points
  • Card

Object

walletSubType

Clasificación de la tarjeta de puntos.

Posibles tipos de tarjetas:

  • Visa Tasa Clásica
  • Visa Tradicional Clásica
  • Visa Básica
  • Visa Tasa Baja Oro
  • Visa Tradicional Oro
  • Mc Scotia Travel Platinum
  • MC Scotia Travel Oro - SRP
  • MC Tasa Baja Oro
  • MC Tradicional Oro
  • MC Scotia Travel Clásica
  • MC Tasa Baja Clásica
  • MC Tradicional Clásica
  • MC Scotia Travel World Elite
  • Platinum Infinite Visa
  • Scotia MX Ideal
  • Scotia Rewards Gold

String

merchantInvoiceId

Referencia alfanumérica proporcionada por el vendedor

String

status

Estado de la transacción.

Lista de posibles estados de la transacción:

  • Paid
  • Refunded
  • Cancelled
  • Declined
  • Error

Object, string

currency

Código de divisa para la transacción del pago conforme a ISO 4217

String

paymentDate

Fecha de creación del pago

Date

location

Objeto que contiene la información de ubicación

Object

longitude

Coordenada de longitud para la ubicación de la transacción

Double

latitude

Coordenada de latitud para la ubicación de la transacción

Double

Buscar transacciones en el historial

Implementa la siguiente función para buscar transacciones en el historial:

ClipHistory.search(SearchParamsRequest.byDate(date: Date, page: Int), object : ClipHistoryListener.OnSearchSuccessListener {
                override fun onSearchSuccess(response: List<ClipTransaction>?) {
                }
            }, , object : ClipHistoryListener.OnErrorListener {
                override fun onError(error: StatusCode.ClipError) {
                }
            })
ClipHistory.search(SearchParamsRequest.byDate(Date date, int page), new ClipHistoryListener.OnSearchSuccessListener() {
            @Override
            public void onSearchSuccess(@Nullable List<ClipTransaction> list) {
            }
        }, new ClipHistoryListener.OnErrorListener() {
            @Override
            public void onError(@NotNull StatusCode.ClipError clipError) {
            }
        });

La siguiente tabla incluye una descripción para los parámetros de la función:

Elemento

Descripción

SearchParamsRequest

Función de búsqueda

.byCardNumber

Realiza la búsqueda por el número de tarjeta utilizada para el pago

.byDate

Realiza la búsqueda por la fecha del pago

.byDateRange

Realiza la búsqueda por un rango de fechas definido

.byReceiptNumber

Realiza la búsqueda por el número de recibo que identifica al pago

CardNumber: El objeto CardNumber está compuesto por los últimos 4 dígitos que aparecen en la tarjeta.

Elemento

Descripción

Tipo de dato

value

L os últimos 4 dígitos que aparecen en la tarjeta.

El regex que se valida es: ^\d{0,4}$

De no cumplir con el formato especificado, se regresará una excepción de tipo:  InvalidParameterFormat.

String

ReceiptNumber: El objeto ReceiptNumber representa el número de recibo generado por Clip al concluir una transacción de manera exitosa.

Elemento

Descripción

Tipo de dato

value

Número de recibo generado por Clip.

El regex que se valida es: ^[a-zA-Z0-9-_]{0,}$

De no cumplir con el formato especificado, se regresará una excepción de tipo:  InvalidParameterFormat.

String

Mostrar los detalles de una transacción

Implementa la siguiente función para mostrar los detalles de una transacción en específico:

ClipHistory.detail(receiptNumber: ReceiptNumber, object : ClipListener<ClipTransaction?> {
     override fun onCompleteListener(response: ClipTransaction?, error: StatusCode.ClipError?) {}
})
ClipHistory.detail(ReceiptNumber receiptNumber, new ClipListener<ClipTransaction?>() {
            @Override
            public void onCompleteListener(@Nullable ClipTransaction clipTransaction, @Nullable StatusCode.ClipError error) {
            }
        });

La siguiente tabla incluye una descripción para los parámetros de la función:

Elemento

Descripción

receiptNumber

Realiza la búsqueda por el número de recibo que identifica al pago

timeZone

Representación de la zona horaria.