Network.Payments.PayPal.Auth

Documentation

type ClientID = String

PayPal client ID with which to execute actions.

type Secret = String

PayPal secret of user with which to execute actions.

type Seconds = Integer

Number representing seconds of time.

data AccessToken

Access token returned from OAuth.

Constructors

AccessToken

Fields

• aTokenScope :: [String]
• aToken :: String
• aTokenType :: String
• aTokenAppId :: String
• aTokenExpires :: Seconds

Instances

Eq AccessToken

Methods

(==) :: AccessToken -> AccessToken -> Bool

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

Show AccessToken

Methods

showsPrec :: Int -> AccessToken -> ShowS

show :: AccessToken -> String

showList :: [AccessToken] -> ShowS

FromJSON AccessToken

Methods

parseJSON :: Value -> Parser AccessToken

parseJSONList :: Value -> Parser [AccessToken]

type AccessTokenWithExpiration = (AccessToken, UTCTime)

An access token from OAuth together with its UTC expiration time.

data AccessTokenError

Error while fetching access token.

Constructors

AccessTokenHttpError HttpException

AccessTokenStatusError Int

AccessTokenParseError String ByteString

type AccessTokenResult = Either AccessTokenError AccessToken

Either an access token or the error encountered while fetching it.

fetchAccessToken :: EnvironmentUrl -> ClientID -> Secret -> IO AccessTokenResult

Use a PayPal environment and login credentials to get an OAuth access token.

fetchAccessTokenWithExpiration :: EnvironmentUrl -> ClientID -> Secret -> IO AccessTokenWithExpirationResult

Use a PayPal environment and login credentials to get an OAuth access token with an expiration time.

safeExpirationTime :: UTCTime -> AccessToken -> UTCTime

Time at which the token should be considered expired. This is a few seconds before the time that PayPal gives us. Parameters are the time at which the access token was retrieved and the access token.