Mollie.API.Refunds

Documentation

refundsPath :: Text

Refund resource's path, relative to API's versioned url or to a Payment resource url.

getRefunds

Arguments

:: Int

offset

-> Int

count

-> Mollie (Either ResponseError (List Refund))

Handler to get a list of refunds. Because the list endpoint is paginated this handler requires an offset and a count. The maximum amount of refunds returned with a single call is 250.

For more information see: https://www.mollie.com/en/docs/reference/refunds/list-all.

data RefundStatus

All possible statusses a refund could be assigned.

For more information see: https://www.mollie.com/en/docs/reference/refunds/get.

Constructors

RefundPending

The payment will be processed soon (usually the next business day). The refund could still be cancelled, see: https://www.mollie.com/en/docs/reference/refunds/delete.

RefundProcessing

The refund is processing, cancellation is no longer possible.

RefundRefunded

The refund has been paid out the the customer.

Instances

Eq RefundStatus

Methods

(==) :: RefundStatus -> RefundStatus -> Bool

(/=) :: RefundStatus -> RefundStatus -> Bool

Read RefundStatus

Methods

readsPrec :: Int -> ReadS RefundStatus

readList :: ReadS [RefundStatus]

readPrec :: ReadPrec RefundStatus

readListPrec :: ReadPrec [RefundStatus]

Show RefundStatus

Methods

showsPrec :: Int -> RefundStatus -> ShowS

show :: RefundStatus -> String

showList :: [RefundStatus] -> ShowS

FromJSON RefundStatus

Methods

parseJSON :: Value -> Parser RefundStatus

ToText RefundStatus

Methods

toText :: RefundStatus -> Text

data Refund

Representation of a refund made with Mollie.

Note that the amount is curently returned as text because Mollie does not return it as a valid json number.

For more information see: https://www.mollie.com/en/docs/reference/refunds/get.

Constructors

Refund

Fields

• refund_id :: Text

  Mollies reference to the refund.

• refund_payment :: Payment

  The payment for which this refund was made.

• refund_amount :: Text

  The amount of EURO which this refund refunded.

• refund_status :: RefundStatus

  The status in which this refund currently is.

• refund_refundedDatetime :: Maybe UTCTime

  The date on which the refund was issued.

Instances

Show Refund

Methods

showsPrec :: Int -> Refund -> ShowS

show :: Refund -> String

showList :: [Refund] -> ShowS

FromJSON Refund

Methods

parseJSON :: Value -> Parser Refund

data ListLinks

Important links associated with List responses.

Constructors

ListLinks

Fields

• listLinks_previous :: Maybe Text

  URL to previous list.

• listLinks_next :: Maybe Text

  URL to next list.

• listLinks_first :: Maybe Text

  URL to first list.

• listLinks_last :: Maybe Text

  URL to last list.

Instances

Show ListLinks

Methods

showsPrec :: Int -> ListLinks -> ShowS

show :: ListLinks -> String

showList :: [ListLinks] -> ShowS

FromJSON ListLinks

Methods

parseJSON :: Value -> Parser ListLinks

data List a

List response for any resource with metadata.

For more information see: https://www.mollie.com/nl/docs/reference/payments/list.

Constructors

List

Fields

• list_totalCount :: Int

  Total number of resources available.

• list_offset :: Int

  The number of skipped resources.

• list_count :: Int

  The number of resources found in `data`.

• list_data :: [a]

  The resources for this request.

• list_links :: Maybe ListLinks

  Important links for this list.

Instances

Show a => Show (List a)

Methods

showsPrec :: Int -> List a -> ShowS

show :: List a -> String

showList :: [List a] -> ShowS

FromJSON a0 => FromJSON (List a0)

Methods

parseJSON :: Value -> Parser (List a0)

data ResponseError

Response errors which could happen when requesting resources from Mollie.

Constructors

ClientError Int Error

ServerError Int

UnexpectedResponse

Instances

Show ResponseError

Methods

showsPrec :: Int -> ResponseError -> ShowS

show :: ResponseError -> String

showList :: [ResponseError] -> ShowS