Safe Haskell	None
Language	Haskell2010

PayPal.Adaptive

Contents

Client
Error
PayResponse
Processing
Money

Synopsis

Client

data Client Source

Constructors

Client
Fields _clAppId :: Text _clUserId :: Text _clEnvironment :: Environment _clPassword :: Text _clSignature :: Text _clAccountEmail :: Text Not needed for authentication, but deposits are sent to here and withdrawals are sent from here. Must be the email associated with your PayPal app.

Instances

Eq Client Source
Show Client Source
ToJSON Client Source
FromJSON Client Source

data Environment Source

Constructors

Sandbox
Production

Instances

Eq Environment Source
Read Environment Source
Show Environment Source
ToJSON Environment Source
FromJSON Environment Source

clUserId :: Lens' Client Text Source

clSignature :: Lens' Client Text Source

clPassword :: Lens' Client Text Source

clEnvironment :: Lens' Client Environment Source

clAppId :: Lens' Client Text Source

clAccountEmail :: Lens' Client Text Source

_Production :: Prism' Environment () Source

_Sandbox :: Prism' Environment () Source

Error

data AdaptiveError Source

Text is an error message in all the below types.

AeShouldNotHappen is meant to cover PayPal responses to API requests that this library doesn't support sending in the first place. TODO: is this actually how we're using it?

Constructors

AeConnectionError SomeException
AeDecodeFailed ByteString Text
AeErrorResponse ByteString ErrorResponse

Instances

Show AdaptiveError Source

data ErrorResponse Source

Constructors

ErrorResponse
Fields _unErrorResponse :: [PayError]

Instances

Eq ErrorResponse Source
Show ErrorResponse Source
FromJSON ErrorResponse Source

data PayError Source

Constructors

PayError
Fields _errorCode :: ErrorCode _errorMessage :: Text

Instances

Eq PayError Source
Show PayError Source
FromJSON PayError Source

newtype ErrorCode Source

Constructors

ErrorCode
Fields _unErrorCode :: Int

Instances

Eq ErrorCode Source
Show ErrorCode Source
FromJSON ErrorCode Source

invalidCredentials :: ErrorCode Source

noSuchEmail :: ErrorCode Source

Raised when the Deposit sender email or the Withdrawal account email doesn't exist.

unErrorCode :: Iso' ErrorCode Int Source

unErrorResponse :: Iso' ErrorResponse [PayError] Source

errorMessage :: Lens' PayError Text Source

errorCode :: Lens' PayError ErrorCode Source

_AeErrorResponse :: Prism' AdaptiveError (ByteString, ErrorResponse) Source

_AeDecodeFailed :: Prism' AdaptiveError (ByteString, Text) Source

_AeConnectionError :: Prism' AdaptiveError SomeException Source

PayResponse

data PayResponse Source

Used for forgiving attempts to parse PayPal responses. For instance, this library never expects more than one PaymentInfo. We still try to parse them as a list here so we can still sucessfully parse a PayResp to use in an AdaptiveError if for some reason more than one PaymentInfo is returned.

https://developer.paypal.com/docs/classic/api/adaptive-payments/Pay_API_Operation/

Constructors

PayResponse
Fields _prPayError :: Maybe Text payErrorList (string) -- Information about why a payment failed. _prPayStatus :: PayStatus _prPayKey :: PayKey _prPaymentInfos :: [PaymentInfo]

Instances

Eq PayResponse Source
Show PayResponse Source
FromJSON PayResponse Source

prPaymentInfos :: Lens' PayResponse [PaymentInfo] Source

prPayStatus :: Lens' PayResponse PayStatus Source

prPayKey :: Lens' PayResponse PayKey Source

prPayError :: Lens' PayResponse (Maybe Text) Source

Processing

data CompletePayResponse Source

A version of PayResponse for completed transactions.

Status fields are omitted since they should be complete.

Has no separate field for a PaymentInfo list since successful transactions will always have exactly one. Instead the pay info fields have been flattened into the top level of this structure.

Constructors

CompletePayResponse
Fields _cpPayKey :: PayKey _cpReceiver :: Receiver _cpTransactionId :: TransactionId _cpSenderTransactionId :: TransactionId

Instances

Eq CompletePayResponse Source
Show CompletePayResponse Source

data NotComplete Source

A high level data type that tries to summarize the status of a payment in simple terms (meant to be used in an Either, e.g. Either NotComplete CompletePayResponse).

Constructors

NcIncomplete Text
NcFailed Text
NcShouldNotHappen Text

Instances

Eq NotComplete Source
Show NotComplete Source

checkComplete :: PayResponse -> Either NotComplete CompletePayResponse Source

getPaymentInfo :: PayResponse -> Either NotComplete PaymentInfo Source

cpTransactionId :: Lens' CompletePayResponse TransactionId Source

cpSenderTransactionId :: Lens' CompletePayResponse TransactionId Source

cpReceiver :: Lens' CompletePayResponse Receiver Source

cpPayKey :: Lens' CompletePayResponse PayKey Source

_NcShouldNotHappen :: Prism' NotComplete Text Source

_NcFailed :: Prism' NotComplete Text Source

_NcIncomplete :: Prism' NotComplete Text Source

Money

data Money Source

Constructors

USD
Fields _usdCents :: Int

Instances

Eq Money Source
Show Money Source
Monoid Money Source

m2Currency :: Money -> Text Source

m2PayPal :: Money -> String Source