Getnet DocsGetnet Docs

Referencia de API

Esta página proporciona una referencia técnica para los repositorios redsys-tpv-business-lib. Incluye los métodos disponibles, parámetros y tipos de retorno para cada funcionalidad.

Tipos Comunes

RepositoryResult<T>

Una clase sellada genérica que envuelve todas las respuestas asíncronas de los repositorios.

  • Success<T>: Contiene los datos del resultado (val data: T).
  • ConnectionError: Indica un fallo de red o de conexión con el servicio.
  • Cancelled: Indica que la operación fue cancelada por el usuario (val message: String).
  • ProtocolError: Indica un error de integración o de mapeo de datos (val type: ProtocolErrorType, val description: String?).

1. InitializationRepository

Propósito: Gestionar la inicialización y configuración del TPV.

Métodos

MétodoDescripciónParámetrosTipo de retorno
initTpvInicializa el TPV con el host.NingunoRepositoryResult<TpvInfo>
getTpvInfoRepositoryResultRecupera la información en caché del TPV.NingunoRepositoryResult<TpvInfo>
saveTerminalInformationActualiza la información local del terminal.tpvInfo: TpvInfoUnit (Suspend)

2. PaymentRepository

Propósito: Procesar pagos con tarjeta.

Métodos

MétodoDescripciónParámetrosTipo de retorno
makePaymentRealiza un pago estándar.amount: Money
tip: Money?
shiftInfo: ShiftInfo?
financialConditions: FinancialConditions?
proprietaryExtraData: ProprietaryExtraData?
language: LanguageIso6391?
RepositoryResult<PaymentResult>

PaymentResult (Interfaz Sellada)

  • Accepted(val data: Transaction)
  • Denied(val data: Transaction)
  • CardNotFound

3. RefundRepository

Propósito: Procesar devoluciones.

Métodos

MétodoDescripciónParámetrosTipo de retorno
makeRefundDevolución por ID de operación original.operationId: String
amount: Money
proprietaryExtraData: ProprietaryExtraData?
language: LanguageIso6391?
RepositoryResult<RefundResult>
makeRefundReadingCardDevolución por ID, forzando la lectura de tarjeta.operationId: String
amount: Money
proprietaryExtraData: ProprietaryExtraData?
language: LanguageIso6391?
RepositoryResult<RefundResult>
makeRefundWithoutOriginalDevolución sin ID previo.amount: Money
proprietaryExtraData: ProprietaryExtraData?
language: LanguageIso6391?
RepositoryResult<RefundResult>

RefundResult (Interfaz Sellada)

  • Accepted(val data: Transaction)
  • Denied(val data: Transaction)
  • ExceededAmount

4. PreauthorizationRepository

Propósito: Gestionar reservas de fondos.

Métodos

MétodoDescripciónParámetrosTipo de retorno
makePreauthorizationCrear una nueva preautorización.amount: Money
shiftInfo: ShiftInfo?
proprietaryExtraData: ProprietaryExtraData?
language: LanguageIso6391?
RepositoryResult<PreauthorizationResult>
confirmPreauthorizationConfirmar/Cobrar una preautorización.amount: Money
operationId: String
shiftInfo: ShiftInfo?
proprietaryExtraData: ProprietaryExtraData?
language: LanguageIso6391?
RepositoryResult<PreauthorizationResult>
replacePreauthorizationActualizar el importe.amount: Money
operationId: String
shiftInfo: ShiftInfo?
proprietaryExtraData: ProprietaryExtraData?
language: LanguageIso6391?
RepositoryResult<PreauthorizationResult>
annulPreauthorizationCancelar la reserva.operationId: String
language: LanguageIso6391?
RepositoryResult<PreauthorizationResult>

PreauthorizationResult (Interfaz Sellada)

  • Accepted(val data: Transaction)
  • Denied(val data: Transaction)

5. TransactionRepository

Propósito: Consultar transacciones históricas.

Métodos

MétodoDescripciónParámetrosTipo de retorno
getTransactionsBuscar transacciones por rango de fechas.initDate: Date
endDate: Date
filter: TransactionFilter?
resultsFilter: TransactionResultsFilter?
RepositoryResult<GetTransactionsResult>
getTransactionsBySessionBuscar por sesión.initDate: Date
endDate: Date
sessionDate: Date
sessionId: Int?
filter: TransactionFilter?
resultsFilter: TransactionResultsFilter?
RepositoryResult<GetTransactionsResult>

6. TotalsRepository

Propósito: Consultar totales acumulados.

Métodos

MétodoDescripciónParámetrosTipo de retorno
getSessionsTotales de todas las sesiones en una fecha.date: Date
wantBrandDetails: Boolean
RepositoryResult<TotalsResult>
getSessionTotales de una sesión específica por ID.date: Date
sessionId: Int
wantBrandDetails: Boolean
RepositoryResult<TotalsResult>
getSessionsBetweenDatesTotales de sesiones en un rango.initDate: Date
endDate: Date
wantBrandDetails: Boolean
RepositoryResult<TotalsResult>
getLastSessionTotales de la última sesión cerrada.NingunoRepositoryResult<GetLastSessionResult>
getShiftsTotales de todos los turnos en una fecha.date: Date
wantBrandDetails: Boolean
RepositoryResult<TotalsResult>
getShiftTotales de un turno específico por ID.date: Date
shiftId: String
wantBrandDetails: Boolean
RepositoryResult<TotalsResult>
getShiftBetweenDatesTotales de turnos en un rango.initDate: Date
endDate: Date
wantBrandDetails: Boolean
RepositoryResult<TotalsResult>

TotalsResult (Interfaz Sellada)

  • IncomingData(val data: TotalsModel)
  • EmptyData
  • WrongIdentifierError

7. ShiftRepository y SessionRepository

Propósito: Gestionar períodos operacionales.

Métodos

RepositorioMétodoParámetrosTipo de retorno
ShiftRepositoryopenShiftnumber: Int
date: Date
RepositoryResult<Boolean>
SessionRepositorycloseSessionwantBrandDetails: BooleanRepositoryResult<CloseSessionResult>

8. PrinterRepository

Propósito: Controlar la impresora del dispositivo.

Métodos

MétodoDescripciónParámetrosTipo de retorno
checkPaperVerificar el estado del papel.NingunoRepositoryResult<Boolean>
printBitmapImprimir un bitmap personalizado.bitmap: BitmapRepositoryResult<Boolean>
printDefaultTicketImprimir recibo estándar.context: Context
headerIcon: Bitmap
transaction: Transaction
RepositoryResult<Boolean>

9. TicketDigitalRepository

Propósito: Gestionar recibos digitales.

Métodos

MétodoDescripciónParámetrosTipo de retorno
sendTicketDigitalEnviar recibo por correo electrónico.operId: String
email: String
RepositoryResult<TicketDigitalResult>
getTicketDigitalURLObtener URL del recibo (para QR).operId: StringRepositoryResult<TicketDigitalUrlResult>

10. SettingsRepository y AuthRepository

Propósito: Configuración y Autenticación.

Métodos

RepositorioMétodoParámetrosTipo de retorno
SettingsRepositoryupdateShowTransactionResultshowTransactionResult: BooleanRepositoryResult<Boolean>
SettingsRepositoryupdateLanguagelanguage: LanguageIso6391RepositoryResult<Boolean>
AuthRepositorygetTokenNingunoRepositoryResult<AuthResult>

11. Repositorios APM (Bizum, Alipay, WeChat)

Propósito: Métodos de Pago Alternativos.

Métodos

RepositorioMétodoParámetrosTipo de retorno
BizumRepositorysendBizumamount: Money
phoneNumber: String
shiftInfo: ShiftInfo?
language: LanguageIso6391?
RepositoryResult<SendBizumResult>
AlipayRepositorymakePaymentamount: Money
tip: Money
qrId: String
transactionName: String
qrIdType: QrIdType
languageIso6391: LanguageIso6391
RepositoryResult<AlipayResult>
AlipayRepositorymakeRefundamount: Money
originalOperationId: String
languageIso6391: LanguageIso6391
RepositoryResult<AlipayResult>
WeChatRepositorymakePaymentamount: Money
tip: Money
qrId: String
transactionName: String?
languageIso6391: LanguageIso6391
RepositoryResult<WeChatResult>
WeChatRepositorymakeRefundamount: Money
originalOperationId: String
languageIso6391: LanguageIso6391
RepositoryResult<WeChatResult>