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:

  • getTransactionHistory(by: TransactionHistoryQuery): permite realizar una búsqueda de transacciones del mismo día y aplicar distintos filtros.
do {
    try TransactionHistory.shared.getTransactionHistory(by:.date(Date()) { (result) in
                switch result {
                case .success(let transactions):
                case .failure(let error):
                }

    catch {
        print(error)
}

Elemento

Tipo de Dato

Descripción

TransactionHistoryQuery

 Enum

Tipo de búsqueda

.card(last4: String)

Últimos 4 dígitos de la tarjeta.

Se valida que el parámetro tenga el siguiente formato: "^\\d{0,4}$"

De no cumplir con el formato se regresa un error de tipo: InvalidParameterFormat

.date(Foundation.Date)

Fecha en que se realizó el pago.

.receipt(receiptNum: String)

Número de evoucher generado por Clip.

Se valida que el parámetro tenga el siguiente formato: "^[a-zA-Z0-9-_]{0,}$"

De no cumplir con el formato se regresa un error de tipo: InvalidParameterFormat

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

Decimal

tip

Cantidad de la propina

Decimal

totalAmount

Cantidad total del pago incluyendo propina

Decimal

cardType

Tipo de tarjeta utilizada para el pago:

CardType  

  • .amex
  • .discover
  • .jcb
  • .mastercard
  • .visa
  • .sivale
  • .edenred
  • .carnet
  • .privateCard
  • .electron
  • .sodexo
  • .unknown

Enum

last4

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

String

installment

Indica si el pago se difiere en mensualidades:

Installment

  • .ThreeMonth
  • .SixMonth
  • .NineMonth
  • .TwelveMonth
  • .PayInFull

Enum

merchantInvoiceId

Referencia alfanumérica proporcionada por el vendedor

String

status

Estado de la transacción.

Lista de posibles estados de la transacción:

TransactionStatus

  • .Paid
  • .Refunded
  • .Cancelled
  • .Declined
  • .Error

Enum

currency

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

String

paymentDate

Fecha de creación del pago

Date

latitude

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

String

longitude

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

String