Network.Payments.PayPal.Payments

Documentation

type URL = String

type PaymentID = String

data Intent

Payment intent.

Constructors

SaleIntent

AuthoriseIntent

OrderIntent

Instances

Eq Intent

Methods

(==) :: Intent -> Intent -> Bool

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

Read Intent

Methods

readsPrec :: Int -> ReadS Intent

readList :: ReadS [Intent]

readPrec :: ReadPrec Intent

readListPrec :: ReadPrec [Intent]

Show Intent

Methods

showsPrec :: Int -> Intent -> ShowS

show :: Intent -> String

showList :: [Intent] -> ShowS

ToJSON Intent

Methods

toJSON :: Intent -> Value

toEncoding :: Intent -> Encoding

toJSONList :: [Intent] -> Value

toEncodingList :: [Intent] -> Encoding

FromJSON Intent

Methods

parseJSON :: Value -> Parser Intent

parseJSONList :: Value -> Parser [Intent]

data RedirectUrls

Constructors

RedirectUrls

Fields

• redirUrlReturn :: URL
• redirUrlCancel :: URL

Instances

Eq RedirectUrls

Methods

(==) :: RedirectUrls -> RedirectUrls -> Bool

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

Show RedirectUrls

Methods

showsPrec :: Int -> RedirectUrls -> ShowS

show :: RedirectUrls -> String

showList :: [RedirectUrls] -> ShowS

ToJSON RedirectUrls

Methods

toJSON :: RedirectUrls -> Value

toEncoding :: RedirectUrls -> Encoding

toJSONList :: [RedirectUrls] -> Value

toEncodingList :: [RedirectUrls] -> Encoding

FromJSON RedirectUrls

Methods

parseJSON :: Value -> Parser RedirectUrls

parseJSONList :: Value -> Parser [RedirectUrls]

data ReturnLinkParams

Constructors

ReturnLinkParams

Fields

• retLinkParamPayId :: PaymentID
• retLinkParamToken :: String
• retLinkParamPayerId :: String

Instances

Eq ReturnLinkParams

Methods

(==) :: ReturnLinkParams -> ReturnLinkParams -> Bool

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

Show ReturnLinkParams

Methods

showsPrec :: Int -> ReturnLinkParams -> ShowS

show :: ReturnLinkParams -> String

showList :: [ReturnLinkParams] -> ShowS

data CreateRequest

Contains data sent to PayPal to create a payment.

Constructors

CreateRequest

Fields

• createReqIntent :: Intent
• createReqPayer :: Payer
• createReqTransactions :: [Transaction]
• createReqRedirectUrls :: Maybe RedirectUrls

Instances

Eq CreateRequest

Methods

(==) :: CreateRequest -> CreateRequest -> Bool

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

Show CreateRequest

Methods

showsPrec :: Int -> CreateRequest -> ShowS

show :: CreateRequest -> String

showList :: [CreateRequest] -> ShowS

ToJSON CreateRequest

Methods

toJSON :: CreateRequest -> Value

toEncoding :: CreateRequest -> Encoding

toJSONList :: [CreateRequest] -> Value

toEncodingList :: [CreateRequest] -> Encoding

data CreateResponse

Contains a parsed response from PayPal after making a create payment request.

Constructors

CreateResponse

Fields

• createResIntent :: Intent
• createResPayer :: Payer
• createResTransactions :: [Transaction]
• createResRedirectUrls :: Maybe RedirectUrls
• createResPayId :: PaymentID
• createResCreateTime :: UTCTime
• createResPayState :: PaymentState
• createResUpdateTime :: Maybe UTCTime
• createResHateoasLinks :: [HateoasLink]

Instances

Eq CreateResponse

Methods

(==) :: CreateResponse -> CreateResponse -> Bool

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

Show CreateResponse

Methods

showsPrec :: Int -> CreateResponse -> ShowS

show :: CreateResponse -> String

showList :: [CreateResponse] -> ShowS

FromJSON CreateResponse

Methods

parseJSON :: Value -> Parser CreateResponse

parseJSONList :: Value -> Parser [CreateResponse]

data ExecuteRequest

Request to execute a payment.

Constructors

ExecuteRequest

Fields

• executeReqPayerId :: String
• executeReqTransactions :: [ExecuteTransaction]

Instances

Eq ExecuteRequest

Methods

(==) :: ExecuteRequest -> ExecuteRequest -> Bool

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

Show ExecuteRequest

Methods

showsPrec :: Int -> ExecuteRequest -> ShowS

show :: ExecuteRequest -> String

showList :: [ExecuteRequest] -> ShowS

ToJSON ExecuteRequest

Methods

toJSON :: ExecuteRequest -> Value

toEncoding :: ExecuteRequest -> Encoding

toJSONList :: [ExecuteRequest] -> Value

toEncodingList :: [ExecuteRequest] -> Encoding

data ExecuteResponse

Response from an execute payment request.

Constructors

ExecuteResponse

Fields

• executeResIntent :: Intent
• executeResPayer :: Payer
• executeResTransactions :: [Transaction]
• executeResHateoasLinks :: [HateoasLink]

Instances

Eq ExecuteResponse

Methods

(==) :: ExecuteResponse -> ExecuteResponse -> Bool

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

Show ExecuteResponse

Methods

showsPrec :: Int -> ExecuteResponse -> ShowS

show :: ExecuteResponse -> String

showList :: [ExecuteResponse] -> ShowS

FromJSON ExecuteResponse

Methods

parseJSON :: Value -> Parser ExecuteResponse

parseJSONList :: Value -> Parser [ExecuteResponse]

data FindResponse

Contains a parsed response from a find payment request.

Constructors

FindResponse

Fields

• findResIntent :: Intent
• findResPayer :: Payer
• findResTransactions :: [Transaction]
• findResRedirectUrls :: Maybe RedirectUrls
• findResPayId :: PaymentID
• findResCreateTime :: UTCTime
• findResPayState :: PaymentState
• findResUpdateTime :: Maybe UTCTime

Instances

Eq FindResponse

Methods

(==) :: FindResponse -> FindResponse -> Bool

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

Show FindResponse

Methods

showsPrec :: Int -> FindResponse -> ShowS

show :: FindResponse -> String

showList :: [FindResponse] -> ShowS

FromJSON FindResponse

Methods

parseJSON :: Value -> Parser FindResponse

parseJSONList :: Value -> Parser [FindResponse]

data ListResponse

Constructors

ListResponse

Fields

• listResPayments :: [CreateResponse]
• listResCount :: Integer
• listResNextId :: Maybe PaymentID

Instances

Eq ListResponse

Methods

(==) :: ListResponse -> ListResponse -> Bool

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

Show ListResponse

Methods

showsPrec :: Int -> ListResponse -> ShowS

show :: ListResponse -> String

showList :: [ListResponse] -> ShowS

FromJSON ListResponse

Methods

parseJSON :: Value -> Parser ListResponse

parseJSONList :: Value -> Parser [ListResponse]

createPayment :: CreateRequest -> PayPalOperations CreateResponse

Creates a new payment using payment data.

approvalUrlFromCreate :: CreateResponse -> Maybe URL

Extracts an approval URL, if there is one, from a create response

executePayment :: PaymentID -> ExecuteRequest -> PayPalOperations ExecuteResponse

Execute (or complete) a payment that has been approved by the payer.

findPaymentById :: PaymentID -> PayPalOperations FindResponse

Looks up a payment by ID.

listPayments :: Maybe PagingRequest -> PayPalOperations ListResponse

Lists payments, possibly with paging.

returnLinkParams :: Map ByteString ByteString -> Maybe ReturnLinkParams

Use this function to parse GET parameters passed from PayPal to the return URL. Takes a map of query parameters (name to value) and returns a structure containing these parameters if possible. Otherwise PayPal didn't give you required data.