Skip to content

Update PaymentRefundResponse.kt #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 23, 2025
Merged

Update PaymentRefundResponse.kt #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions src/main/java/com/example/zarinpal/data/remote/dto/refund/PaymentRefundResponse.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,32 @@ import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable

/**
* Represents the response data returned after initiating a payment refund.
* Top-level response returned after initiating a payment refund.
*
* @property data Contains the details of the refund response.
* @property data Details of the refund operation.
*/
@Serializable
data class PaymentRefundResponseModel(
val data: PaymentRefundDataModel
)

/**
* Contains the data returned from the payment refund process.
* Container for refund resource information.
*
* @property resource The detailed response of the refund transaction.
* @property resource Detailed refund transaction data.
*/
@Serializable
data class PaymentRefundDataModel(
val resource: PaymentRefundResponse
)

/**
* Represents the details of the refund transaction.
* Refund transaction details.
*
* @property terminalId The terminal ID used for the refund.
* @property id The unique identifier of the refund transaction.
* @property amount The total amount refunded in the smallest currency unit (e.g., IRR).
* @property timeline Contains details of the refund process, including the amount, time, and status.
* @property terminalId Terminal ID used for the refund.
* @property id Unique identifier of the refund transaction.
* @property amount Refunded amount in the smallest currency unit (e.g., IRR).
* @property timeline Timeline of the refund process.
*/
@Serializable
data class PaymentRefundResponse(
Expand All @@ -40,15 +40,15 @@ data class PaymentRefundResponse(
)

/**
* Contains the timeline of the refund process, including the amount refunded, time of refund, and status.
* Timeline of the refund process.
*
* @property refundAmount The amount refunded in the smallest currency unit (e.g., IRR).
* @property refundTime The time when the refund was processed.
* @property refundStatus The status of the refund (e.g., "completed", "pending").
* @property refundAmount Refunded amount in the smallest currency unit (e.g., IRR).
* @property refundTime Timestamp of when the refund was processed.
* @property refundStatus Current status of the refund (e.g., "completed", "pending").
*/
@Serializable
data class PaymentRefundTimeline(
@SerialName("refund_amount") val refundAmount: Int,
@SerialName("refund_time") val refundTime: String,
@SerialName("refund_status") val refundStatus: String
)
)