From 8a7061cddd9c04defd2c79430901a9090efbe072 Mon Sep 17 00:00:00 2001
From: Jean-Paul Calderone <exarkun@twistedmatrix.com>
Date: Wed, 6 Nov 2019 10:05:17 -0500
Subject: [PATCH] haddocks about fields of Charges
---
src/PaymentServer/Processors/Stripe.hs | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/src/PaymentServer/Processors/Stripe.hs b/src/PaymentServer/Processors/Stripe.hs
index ec03171..36cc535 100644
--- a/src/PaymentServer/Processors/Stripe.hs
+++ b/src/PaymentServer/Processors/Stripe.hs
@@ -131,10 +131,12 @@ webhook d _ =
type ChargesAPI = "charge" :> ReqBody '[JSON] Charges :> Post '[JSON] Acknowledgement
data Charges = Charges
- { token :: Text
- , voucher :: Voucher
- , amount :: Int
- , currency :: Text
+ { token :: Text -- ^ The text of a Stripe tokenized payment method.
+ , voucher :: Voucher -- ^ The voucher for which this charge will pay.
+ , amount :: Int -- ^ The amount of the charge in the minimum
+ -- currency unit of the target currency (eg for
+ -- USD, cents).
+ , currency :: Text -- ^ The currency in which the charge will be made.
} deriving (Show, Eq)
instance FromJSON Charges where
--
GitLab