Pular para o conteúdo principal
Versão: 2.1.1

TransactionParams

Visão geral

Classe de dados que representa os parâmetros para solicitação de uma transação.

@Parcelize
data class TransactionParams(
val amount: BigDecimal,
val paymentType: PaymentType,
val installmentType: InstallmentType = InstallmentType.ONE_TIME,
val installmentNumber: Int = 1,

// Refund only
val nsuHost: String? = null,
val refund: Boolean = false,
val transactionTimestamp: Long? = null
) : Parcelable

Parâmetros

ParâmetroTipoDescrição
amountBigDecimalValor da transação em centavos. Ex: 1234 (R$12,34).
paymentTypePaymentTypeTipo de pagamento.
installmentTypeInstallmentTypeTipo de parcelamento.
installmentNumberIntNúmero de parcelas.
nsuHostString?Identificador da transação no provedor de pagamentos.
refundBooleanIndica se a transação é um reembolso.
transactionTimestampLong?Horário de efetuação da operação (em milisegundos desde a época).

Regras e validações

  • Se refund == true, então nsuHost e transactionTimestamp são obrigatórios.
  • Se installmentType == ONE_TIME, installmentNumber deve ser 1.
  • Se installmentType == INSTALLMENTS, installmentNumber deve ser maior que 1.

Se essas regras não forem seguidas, a classe lançará uma IllegalArgumentException.