digetpay-sdk/com.digetpay.sdk.model

Package-level declarations

Types

data class Card(val cardNumber: String, val cardHolder: String, val cardExpiryMonth: String, val cardExpiryYear: String, val cardCvv: String) : Serializable

CardPaymentRequest

data class CardPaymentRequest(val orderId: String, val amount: Double, val currency: String = "SAR", val customer: Customer, val card: Card, val auth: Boolean = false, val recurringInit: Boolean = false, val successUrl: String = CheckoutRequest.DEFAULT_SUCCESS_URL, val failureUrl: String = CheckoutRequest.DEFAULT_FAILURE_URL) : Serializable

Input for a server-to-server (S2S) card payment via com.digetpay.sdk.DigetPay.payWithCard.

CheckoutRequest

data class CheckoutRequest(val merchantOrderId: String, val amount: Double, val currency: String = "SAR", val customerName: String, val customerEmail: String, val customerPhone: String, val successUrl: String = DEFAULT_SUCCESS_URL, val failureUrl: String = DEFAULT_FAILURE_URL) : Serializable

The data needed to start a hosted checkout session.

CheckoutResponse

data class CheckoutResponse(val id: String, val redirectUrl: String)

Raw response of POST /v1/payment/checkout/intiate.

Customer

data class Customer(val name: String, val email: String, val phone: String, val idNumber: String = "", val idType: String = "", val taxNumber: String = "") : Serializable

ErrorCode

enum ErrorCode : Enum<ErrorCode>

MerchantTransaction

data class MerchantTransaction(val id: String? = null, val channel: String? = null, val amount: Double? = null, val refundedAmount: Double? = null, val currency: String? = null, val status: String? = null, val createdAt: String? = null, val ledgerSchema: String? = null, val payerUserMasked: String? = null, val chargeUserMasked: String? = null, val failureReason: String? = null, val edfaOrderId: String? = null, val edfaTransId: String? = null, val palmMatchScore: Double? = null, val pinVerified: Boolean? = null, val posReceiptId: String? = null, val tapRail: String? = null, val tapReference: String? = null, val posMerchantId: String? = null, val deviceSerial: String? = null)

MerchantTransactionsPagination

data class MerchantTransactionsPagination(val page: Int? = null, val pageSize: Int? = null, val total: Int? = null, val totalPages: Int? = null)

MerchantTransactionsResult

data class MerchantTransactionsResult(val merchantId: String? = null, val posMerchantIds: List<String> = emptyList(), val items: List<MerchantTransaction> = emptyList(), val pagination: MerchantTransactionsPagination? = null)

Result of GET /v1/palm-pos/merchant/transactions.

PaymentError

data class PaymentError(val code: ErrorCode, val message: String, val details: String? = null)

Delivered to the host app when a payment cannot be completed.

PaymentResult

data class PaymentResult(val sessionId: String, val transactionId: String?, val orderId: String?, val amount: String?, val currency: String?, val status: String?)

Delivered to the host app when a payment finishes successfully.

RecurringRequest

data class RecurringRequest(val paymentId: String, val orderId: String, val recurringToken: String, val amount: Double, val currency: String = "SAR", val orderNumber: String, val orderDescription: String = "") : Serializable

Input for a recurring (token-based) charge. The recurringToken and paymentId come from the original sale that was started with recurringInit = true (delivered via webhook on your backend).

RecurringResult

data class RecurringResult(val transactionId: String?, val status: String?, val orderId: String?, val amount: String?, val message: String?)

Result of a recurring charge.

RecurringTransaction

data class RecurringTransaction(val transactionId: String? = null, val orderId: String? = null, val recurringToken: String? = null, val amount: Double? = null, val currency: String? = null, val order: RecurringTransactionOrder? = null)

RecurringTransactionOrder

data class RecurringTransactionOrder(val number: String? = null, val amount: Double? = null, val currency: String? = null, val description: String? = null)

RecurringTransactionsResult

data class RecurringTransactionsResult(val data: List<RecurringTransaction> = emptyList())

Result of GET /v1/payment/s2s/recurring.

RefundResult

data class RefundResult(val result: String?, val referenceId: String?, val paymentId: String?, val refundId: String?, val amount: String?, val message: String?)

Result of a refund operation.

StatusContent

data class StatusContent(val transactionId: String? = null, val orderId: String? = null, val amount: String? = null, val currencyCode: String? = null, val transactionStatus: String? = null, val paymentStatus: String? = null, val declineReason: String? = null)

StatusData

data class StatusData(val content: List<StatusContent> = emptyList())

StatusResponse

data class StatusResponse(val code: Int? = null, val message: String? = null, val errorCode: String? = null, val data: StatusData? = null)

Raw response of GET /v1/payment/checkout/status.

TransactionResult

data class TransactionResult(val transactionId: String?, val acquirerPaymentId: String?, val status: String?, val orderId: String?, val message: String?)

Result of a capture or void operation. Check status for the outcome.

TransactionStatusResult

data class TransactionStatusResult(val transactionId: String?, val orderId: String?, val amount: String?, val currency: String?, val transactionStatus: String?, val paymentStatus: String?, val declineReason: String?)

Result of GET /payment/checkout/status.