mangopay-1.6.0: Bindings to the MangoPay API

Safe HaskellNone

Web.MangoPay

Description

API entry point

Synopsis

Documentation

data MangoPayT m a Source

the mangopay monad transformer this encapsulates the data necessary to pass the app credentials, etc

Instances

runMangoPayTSource

Arguments

:: Credentials

Your app's credentials.

-> Manager

Connection manager (see withManager).

-> AccessPoint 
-> MangoPayT m a

the action to run

-> m a

the result

Run a computation in the MangoPayT monad transformer with your credentials.

runResourceInMp :: MPUsableMonad m => MangoPayT (ResourceT m) a -> MangoPayT m aSource

Run a ResourceT inside a MangoPayT.

data MpException Source

an exception that a call to MangoPay may throw

Instances

Show MpException 
Typeable MpException 
Exception MpException

make our exception type a normal exception

getAll :: (MPUsableMonad m, FromJSON v) => (Maybe Pagination -> AccessToken -> MangoPayT m (PagedList v)) -> AccessToken -> MangoPayT m [v]Source

get all items, hiding the pagination system

data Credentials Source

the app credentials

Constructors

Credentials 

Fields

cClientID :: Text

client id

cName :: Text

the name

cEmail :: Text

the email

cClientSecret :: Maybe Text

client secret, maybe be Nothing if we haven't generated it

Instances

Eq Credentials 
Ord Credentials 
Read Credentials 
Show Credentials 
Typeable Credentials 
ToJSON Credentials

to json as per MangoPay format

FromJSON Credentials

from json as per MangoPay format

data AccessPoint Source

the MangoPay access point

Constructors

Sandbox 
Production 
Custom ByteString 

Instances

newtype AccessToken Source

the access token is simply a Text

Constructors

AccessToken ByteString 

Instances

data OAuthToken Source

the oauth token returned after authentication

Constructors

OAuthToken 

Fields

oaAccessToken :: Text

the access token

oaTokenType :: Text

the token type

oaExpires :: Int

expiration

Instances

Eq OAuthToken 
Ord OAuthToken 
Read OAuthToken 
Show OAuthToken 
Typeable OAuthToken 
ToJSON OAuthToken

to json as per MangoPay format

FromJSON OAuthToken

from json as per MangoPay format

data Pagination Source

Pagination info for searches http://docs.mangopay.com/api-references/pagination/

Constructors

Pagination 

Fields

pPage :: Integer
 
pPerPage :: Integer
 

Instances

data PagedList a Source

A partial list with pagination information.

Constructors

PagedList 

Fields

plData :: [a]
 
plItemCount :: Integer
 
plPageCount :: Integer
 

Instances

Typeable1 PagedList 
Eq a => Eq (PagedList a) 
Ord a => Ord (PagedList a) 
Read a => Read (PagedList a) 
Show a => Show (PagedList a) 

type MPUsableMonad m = (MonadBaseControl IO m, MonadResource m, MonadLogger m)Source

put our constraints in one synonym

class ToHtQuery a whereSource

simple class used to hide the serialization of parameters and simplify the calling code

Methods

(?+) :: ByteString -> a -> (ByteString, Maybe ByteString)Source

Instances

data CardExpiration Source

the expiration date of a card

Constructors

CardExpiration 

Fields

ceMonth :: Int
 
ceYear :: Int
 

Instances

readCardExpiration :: Reader CardExpirationSource

read Card Expiration from text representation (MMYY)

writeCardExpiration :: CardExpiration -> TextSource

write card expiration

data KindOfAuthentication Source

the kind of authentication data the user has provided

Constructors

Light 
Regular 
Strong 

Instances

createCredentialsSecret :: MPUsableMonad m => MangoPayT m CredentialsSource

populate the passphrase for our clientId IFF we don't have one

oauthLogin :: MPUsableMonad m => Text -> Text -> MangoPayT m OAuthTokenSource

login with given user name and password returns the OAuth token that can be used to generate the opaque AccessToken and carries the expiration delay

toAccessToken :: OAuthToken -> AccessTokenSource

build the access token from the OAuthToken

data NaturalUser Source

a natural user http://docs.mangopay.com/api-references/users/natural-users/

Constructors

NaturalUser 

Fields

uId :: Maybe NaturalUserID

The Id of the object

uCreationDate :: Maybe POSIXTime

The creation date of the user object

uEmail :: Text

User’s e-mail

uFirstName :: Text

User’s firstname

uLastName :: Text

User’s lastname

uAddress :: Maybe Text

User’s address

uBirthday :: POSIXTime

User’s birthdate

uNationality :: CountryCode

User’s Nationality

uCountryOfResidence :: CountryCode

User’s country of residence

uOccupation :: Maybe Text

User’s occupation (ie. Work)

uIncomeRange :: Maybe IncomeRange

User’s income range

uTag :: Maybe Text

Custom data

uProofOfIdentity :: Maybe Text
 
uProofOfAddress :: Maybe Text
 

Instances

data IncomeRange Source

supported income ranges

Constructors

IncomeRange1 
IncomeRange2 
IncomeRange3 
IncomeRange4 
IncomeRange5 
IncomeRange6 

Instances

Bounded IncomeRange 
Enum IncomeRange 
Eq IncomeRange 
Ord IncomeRange 
Read IncomeRange 
Show IncomeRange 
Typeable IncomeRange 
ToJSON IncomeRange

to json as per MangoPay format the samples do show string format when writing, integer format when reading...

FromJSON IncomeRange

from json as per MangoPay format the samples do show string format when writing, integer format when reading...

incomeBounds :: IncomeRange -> (Amount, Amount)Source

bounds in euros for income range

incomeRange :: Amount -> IncomeRangeSource

get Income Range for given Euro amount

type NaturalUserID = TextSource

User ID

data LegalUser Source

a legal user http://docs.mangopay.com/api-references/users/legal-users/

Constructors

LegalUser 

Fields

lId :: Maybe Text

The Id of the object

lCreationDate :: Maybe POSIXTime

The creation date of the user object

lEmail :: Text

The email of the company or the organization

lName :: Text

The name of the company or the organization

lLegalPersonType :: LegalUserType

The type of the legal user (‘BUSINESS’ or ’ORGANIZATION’)

lHeadquartersAddress :: Maybe Text

The address of the company’s headquarters

lLegalRepresentativeFirstName :: Text

The firstname of the company’s Legal representative person

lLegalRepresentativeLastName :: Text

The lastname of the company’s Legal representative person

lLegalRepresentativeAddress :: Maybe Text

The address of the company’s Legal representative person

lLegalRepresentativeEmail :: Maybe Text

The email of the company’s Legal representative person

lLegalRepresentativeBirthday :: POSIXTime

The birthdate of the company’s Legal representative person

lLegalRepresentativeNationality :: CountryCode

the nationality of the company’s Legal representative person

lLegalRepresentativeCountryOfResidence :: CountryCode

The country of residence of the company’s Legal representative person

lStatute :: Maybe Text

The business statute of the company

lTag :: Maybe Text

Custom data

lProofOfRegistration :: Maybe Text

The proof of registration of the company

lShareholderDeclaration :: Maybe Text

The shareholder declaration of the company

Instances

Eq LegalUser 
Ord LegalUser 
Show LegalUser 
Typeable LegalUser 
ToJSON LegalUser

to json as per MangoPay format

FromJSON LegalUser

from json as per MangoPay format

FromJSON (Either NaturalUser LegalUser) 

data LegalUserType Source

the type of legal user

Constructors

Business 
Organization 

Instances

type LegalUserID = TextSource

User ID

data UserRef Source

a short user reference

Constructors

UserRef 

Fields

urId :: AnyUserID
 
urCreationDate :: POSIXTime
 
urPersonType :: PersonType
 
urEmail :: Text
 
urTag :: Maybe Text
 

Instances

Eq UserRef 
Ord UserRef 
Show UserRef 
Typeable UserRef 
ToJSON UserRef

to json as per MangoPay format

FromJSON UserRef

from json as per MangoPay format

data PersonType Source

Type of user.

Constructors

Natural 
Legal 

Instances

type AnyUserID = TextSource

ID for any kind of user

storeNaturalUser :: MPUsableMonad m => NaturalUser -> AccessToken -> MangoPayT m NaturalUserSource

create or edit a natural user

fetchNaturalUser :: MPUsableMonad m => NaturalUserID -> AccessToken -> MangoPayT m NaturalUserSource

fetch a natural user from her ID

storeLegalUser :: MPUsableMonad m => LegalUser -> AccessToken -> MangoPayT m LegalUserSource

create or edit a natural user

fetchLegalUser :: MPUsableMonad m => LegalUserID -> AccessToken -> MangoPayT m LegalUserSource

fetch a natural user from her ID

getUser :: MPUsableMonad m => AnyUserID -> AccessToken -> MangoPayT m (Either NaturalUser LegalUser)Source

get a user, natural or legal

listUsers :: MPUsableMonad m => Maybe Pagination -> AccessToken -> MangoPayT m (PagedList UserRef)Source

list all user references

data Wallet Source

a wallet

Constructors

Wallet 

Fields

wId :: Maybe WalletID

The Id of the wallet

wCreationDate :: Maybe POSIXTime

The creation date of the object

wTag :: Maybe Text

Custom data

wOwners :: [Text]

The owner of the wallet

wDescription :: Text

A description of the wallet

wCurrency :: Currency

Currency of the wallet

wBalance :: Maybe Amount

The amount held on the wallet

Instances

Eq Wallet 
Ord Wallet 
Show Wallet 
Typeable Wallet 
ToJSON Wallet

to json as per MangoPay format

FromJSON Wallet

from json as per MangoPay format

data Amount Source

currency amount

Constructors

Amount 

Fields

aCurrency :: Currency
 
aAmount :: Integer

all amounts should be in cents!

Instances

Eq Amount 
Ord Amount 
Read Amount 
Show Amount 
Typeable Amount 
ToJSON Amount

to json as per MangoPay format

FromJSON Amount

from json as per MangoPay format

type WalletID = TextSource

ID of a wallet

type Currency = TextSource

alias for Currency

storeWallet :: MPUsableMonad m => Wallet -> AccessToken -> MangoPayT m WalletSource

create or edit a wallet

fetchWallet :: MPUsableMonad m => WalletID -> AccessToken -> MangoPayT m WalletSource

fetch a wallet from its ID

listWallets :: MPUsableMonad m => AnyUserID -> Maybe Pagination -> AccessToken -> MangoPayT m (PagedList Wallet)Source

list all wallets for a given user

data Transfer Source

transfer between wallets

Constructors

Transfer 

Fields

tId :: Maybe TransferID

Id of the transfer

tCreationDate :: Maybe POSIXTime

The creation date of the object

tTag :: Maybe Text

Custom data

tAuthorId :: AnyUserID

The Id of the author

tCreditedUserId :: Maybe AnyUserID

The Id of the user owner of the credited wallet

tDebitedFunds :: Amount

The funds debited from the « debited wallet »DebitedFunds – Fees = CreditedFunds (amount received on wallet

tFees :: Amount

The fees taken on the transfer.DebitedFunds – Fees = CreditedFunds (amount received on wallet)

tDebitedWalletID :: WalletID

The debited wallet (where the funds are held before the transfer)

tCreditedWalletID :: WalletID

The credited wallet (where the funds will be held after the transfer)

tCreditedFunds :: Maybe Amount

The funds credited on the « credited wallet »DebitedFunds – Fees = CreditedFunds (amount received on wallet

tStatus :: Maybe TransferStatus

The status of the transfer:

tResultCode :: Maybe Text

The transaction result code

tResultMessage :: Maybe Text

The transaction result message

tExecutionDate :: Maybe POSIXTime

The execution date of the transfer

Instances

Eq Transfer 
Ord Transfer 
Show Transfer 
Typeable Transfer 
ToJSON Transfer

to json as per MangoPay format

FromJSON Transfer

from json as per MangoPay format

type TransferID = TextSource

ID of a transfer

data TransferStatus Source

status of a transfer

Constructors

Created 
Succeeded 
Failed 

Instances

data Transaction Source

any transaction

Constructors

Transaction 

Fields

txId :: Maybe TransactionID

Id of the transfer

txCreationDate :: Maybe POSIXTime

The creation date of the object

txTag :: Maybe Text

Custom data

txAuthorId :: AnyUserID

The Id of the author

txCreditedUserId :: Maybe AnyUserID

The Id of the user owner of the credited wallet

txDebitedFunds :: Amount

The funds debited from the « debited wallet »DebitedFunds – Fees = CreditedFunds (amount received on wallet

txFees :: Amount

The fees taken on the transfer.DebitedFunds – Fees = CreditedFunds (amount received on wallet)

txDebitedWalletID :: Maybe WalletID

The debited wallet (where the funds are held before the transfer)

txCreditedWalletID :: Maybe WalletID

The credited wallet (where the funds will be held after the transfer)

txCreditedFunds :: Maybe Amount

The funds credited on the « credited wallet »DebitedFunds – Fees = CreditedFunds (amount received on wallet

txStatus :: Maybe TransferStatus

The status of the transfer:

txResultCode :: Maybe Text

The transaction result code

txResultMessage :: Maybe Text

The transaction result message

txExecutionDate :: Maybe POSIXTime

The execution date of the transfer

txType :: TransactionType

The type of the transaction

txNature :: TransactionNature

The nature of the transaction:

Instances

Eq Transaction 
Ord Transaction 
Show Transaction 
Typeable Transaction 
ToJSON Transaction

to json as per MangoPay format

FromJSON Transaction

from json as per MangoPay format

type TransactionID = TextSource

data TransactionType Source

type of transaction

Constructors

PAYIN 
PAYOUT 
TRANSFER 

Instances

data TransactionNature Source

Constructors

REGULAR

just as you created the object

REFUND

the transaction has been refunded

REPUDIATION

the transaction has been repudiated

Instances

createTransfer :: MPUsableMonad m => Transfer -> AccessToken -> MangoPayT m TransferSource

create a new fund transfer

fetchTransfer :: MPUsableMonad m => TransferID -> AccessToken -> MangoPayT m TransferSource

fetch a transfer from its ID

listTransactions :: MPUsableMonad m => WalletID -> Maybe Pagination -> AccessToken -> MangoPayT m (PagedList Transaction)Source

list transfers for a given wallet

listTransactionsForUser :: MPUsableMonad m => AnyUserID -> Maybe Pagination -> AccessToken -> MangoPayT m (PagedList Transaction)Source

list transfer for a given user

data Event Source

a event

Constructors

Event 

Fields

eResourceId :: Text
 
eEventType :: EventType
 
eDate :: POSIXTime
 

Instances

Eq Event 
Ord Event 
Show Event 
Typeable Event 
ToJSON Event

to json as per MangoPay format

FromJSON Event

from json as per MangoPay format

data EventType Source

Event type

Constructors

PAYIN_NORMAL_CREATED 
PAYIN_NORMAL_SUCCEEDED 
PAYIN_NORMAL_FAILED 
PAYOUT_NORMAL_CREATED 
PAYOUT_NORMAL_SUCCEEDED 
PAYOUT_NORMAL_FAILED 
TRANSFER_NORMAL_CREATED 
TRANSFER_NORMAL_SUCCEEDED 
TRANSFER_NORMAL_FAILED 
PAYIN_REFUND_CREATED 
PAYIN_REFUND_SUCCEEDED 
PAYIN_REFUND_FAILED 
PAYOUT_REFUND_CREATED 
PAYOUT_REFUND_SUCCEEDED 
PAYOUT_REFUND_FAILED 
TRANSFER_REFUND_CREATED 
TRANSFER_REFUND_SUCCEEDED 
TRANSFER_REFUND_FAILED 
KYC_CREATED 
KYC_VALIDATION_ASKED 
KYC_SUCCEEDED 
KYC_FAILED 

Instances

data EventSearchParams Source

search parameters for events

Constructors

EventSearchParams 

Fields

espEventType :: Maybe EventType
 
espBeforeDate :: Maybe POSIXTime
 
espAfterDate :: Maybe POSIXTime
 
espPagination :: Maybe Pagination
 

Instances

searchEvents :: MPUsableMonad m => EventSearchParams -> AccessToken -> MangoPayT m (PagedList Event)Source

search events, returns a paginated list

searchAllEvents :: MPUsableMonad m => EventSearchParams -> AccessToken -> MangoPayT m [Event]Source

search events, returns the full result

checkEvent :: MPUsableMonad m => Event -> AccessToken -> MangoPayT m BoolSource

Check if an event came from MangoPay. Since notifications are not authenticated, you're advised to always check if the event really comes from MangoPay (cf. https://mangopay.desk.com/customer/portal/questions/6493147).

data HookStatus Source

status of notification hook

Constructors

Enabled 
Disabled 

Instances

data HookValidity Source

validity of notification hook

Constructors

Valid 
Invalid 

Instances

type HookID = TextSource

id for hook

data Hook Source

a notification hook

Constructors

Hook 

Fields

hId :: Maybe HookID

The Id of the hook details

hCreationDate :: Maybe POSIXTime
 
hTag :: Maybe Text

Custom data

hUrl :: Text

This is the URL where you receive notification for each EventType

hStatus :: HookStatus
 
hValidity :: Maybe HookValidity
 
hEventType :: EventType
 

Instances

Eq Hook 
Ord Hook 
Show Hook 
Typeable Hook 
ToJSON Hook

to json as per MangoPay format

FromJSON Hook

from json as per MangoPay format

storeHook :: MPUsableMonad m => Hook -> AccessToken -> MangoPayT m HookSource

create or edit a hook

fetchHook :: MPUsableMonad m => HookID -> AccessToken -> MangoPayT m HookSource

fetch a wallet from its ID

listHooks :: MPUsableMonad m => Maybe Pagination -> AccessToken -> MangoPayT m (PagedList Hook)Source

list all wallets for a given user

eventFromQueryString :: Query -> Maybe EventSource

parse an event from the query string the MangoPay is not very clear on notifications, but see v1 http://docs.mangopay.com/v1-api-references/notifications/ v2 works the same, the event is passed via parameters of the query string

eventFromQueryStringT :: [(Text, Text)] -> Maybe EventSource

parse an event from the query string represented as Text the MangoPay is not very clear on notifications, but see v1 http://docs.mangopay.com/v1-api-references/notifications/ v2 works the same, the event is passed via parameters of the query string

data Document Source

a document

Constructors

Document 

Fields

dId :: Maybe DocumentID
 
dCreationDate :: Maybe POSIXTime
 
dTag :: Maybe Text

custom data for client

dType :: DocumentType
 
dStatus :: Maybe DocumentStatus
 
dRefusedReasonType :: Maybe Text
 
dRefusedReasonMessage :: Maybe Text
 

Instances

Eq Document 
Ord Document 
Show Document 
Typeable Document 
ToJSON Document

to json as per MangoPay format

FromJSON Document

from json as per MangoPay format

type DocumentID = TextSource

ID of a document

data DocumentType Source

type of the document

Constructors

IDENTITY_PROOF

For legal and natural users

REGISTRATION_PROOF

Only for legal users

ARTICLES_OF_ASSOCIATION

Only for legal users

SHAREHOLDER_DECLARATION

Only for legal users

ADDRESS_PROOF

For legal and natural users

Instances

data DocumentStatus Source

status of a document

Constructors

CREATED 
VALIDATION_ASKED 
VALIDATED 
REFUSED 

Instances

storeDocument :: MPUsableMonad m => AnyUserID -> Document -> AccessToken -> MangoPayT m DocumentSource

create or edit a document

fetchDocument :: MPUsableMonad m => AnyUserID -> DocumentID -> AccessToken -> MangoPayT m DocumentSource

fetch a document from its ID

storePage :: MPUsableMonad m => AnyUserID -> DocumentID -> ByteString -> AccessToken -> MangoPayT m ()Source

create a page note that per the MangoPay API the document HAS to be in CREATED status should we check it here? Since MangoPay returns a 500 Internal Server Error if the document is in another status...

getKindOfAuthentication :: Either NaturalUser LegalUser -> [Document] -> KindOfAuthenticationSource

Calculate the MangoPay authentication level. http://docs.mangopay.com/api-references/kyc-rules/

data BankAccount Source

bank account details

Constructors

BankAccount 

Fields

baId :: Maybe BankAccountID
 
baCreationDate :: Maybe POSIXTime
 
baUserId :: Maybe AnyUserID
 
baTag :: Maybe Text
 
baDetails :: BankAccountDetails
 
baOwnerName :: Text
 
baOwnerAddress :: Maybe Text
 

Instances

Eq BankAccount 
Ord BankAccount 
Show BankAccount 
Typeable BankAccount 
ToJSON BankAccount

to json as per MangoPay format

FromJSON BankAccount

from json as per MangoPay format

type BankAccountID = TextSource

ID of a bank account

data BankAccountDetails Source

account details, depending on the type

Constructors

IBAN 

Fields

atIBAN :: Text
 
atBIC :: Text
 
GB 

Fields

atAccountNumber :: Text
 
atSortCode :: Text
 
US 

Fields

atAccountNumber :: Text
 
atABA :: Text
 
CA 

Fields

atAccountNumber :: Text
 
atBankName :: Text
 
atInstitutionNumber :: Text
 
atBranchCode :: Text
 
Other 

Fields

atAccountNumber :: Text
 
atBIC :: Text
 
atCountry :: CountryCode
 

Instances

data PaymentType Source

type of payment

Constructors

CARD 
BANK_WIRE 
AUTOMATIC_DEBIT 
DIRECT_DEBIT 

Instances

storeAccount :: MPUsableMonad m => BankAccount -> AccessToken -> MangoPayT m BankAccountSource

create an account

fetchAccount :: MPUsableMonad m => AnyUserID -> BankAccountID -> AccessToken -> MangoPayT m BankAccountSource

fetch an account from its ID

listAccounts :: MPUsableMonad m => AnyUserID -> Maybe Pagination -> AccessToken -> MangoPayT m (PagedList BankAccount)Source

list all accounts for a given user

data PaymentExecution Source

Constructors

WEB

through a web interface

DIRECT

with a tokenized card

Instances

type BankWireID = TextSource

id of a bankwire

data BankWire Source

a bank wire there are a lot of common fields between all kinds of payments so this could probably become a Payment type

Constructors

BankWire 

Fields

bwId :: Maybe BankWireID
 
bwCreationDate :: Maybe POSIXTime
 
bwTag :: Maybe Text

custom data

bwAuthorId :: AnyUserID

The user ID of the author

bwCreditedUserId :: AnyUserID

It represents the amount credited on the targeted e-wallet.

bwFees :: Maybe Amount

It represents your fees taken on the DebitedFundsDebitedFunds – Fees = CreditedFunds (amount received on wallet)

bwCreditedWalletId :: WalletID

The ID of the credited wallet

bwDebitedWalletId :: Maybe WalletID

The ID of the debited wallet

bwDebitedFunds :: Maybe Amount

It represents the amount debited from the bank account.

bwCreditedFunds :: Maybe Amount

It represents the amount credited on the targeted e-wallet.

bwDeclaredDebitedFunds :: Amount

It represents the expected amount by the platform before that the user makes the payment.

bwDeclaredFees :: Amount

It represents the expected fees amount by the platform before that the user makes the payment.

bwWireReference :: Maybe Text

It is a reference generated by MANGOPAY and displayed to the user by the platform. The user have to indicate it into the bank wire.

bwBankAccount :: Maybe BankAccount

The bank account is generated by MANGOPAY and displayed to the user.

bwStatus :: Maybe TransferStatus

The status of the payment

bwResultCode :: Maybe Text

The transaction result code

bwResultMessage :: Maybe Text

The transaction result Message

bwExecutionDate :: Maybe POSIXTime

The date when the payment is processed

bwType :: Maybe TransactionType

The type of the transaction

bwNature :: Maybe TransactionNature

The nature of the transaction:

bwPaymentType :: Maybe PaymentType

The type of the payment (which type of mean of payment is used).

bwExecutionType :: Maybe PaymentExecution

How the payment has been executed:

Instances

Eq BankWire 
Ord BankWire 
Show BankWire 
Typeable BankWire 
ToJSON BankWire

to json as per MangoPay format

FromJSON BankWire

from json as per MangoPay format

storeBankWire :: MPUsableMonad m => BankWire -> AccessToken -> MangoPayT m BankWireSource

create or edit a bankwire

fetchBankWire :: MPUsableMonad m => BankWireID -> AccessToken -> MangoPayT m BankWireSource

fetch a bank wire from its ID

mkBankWire :: AnyUserID -> AnyUserID -> WalletID -> Amount -> Amount -> BankWireSource

helper function to create a new bank wire with the needed information

type CardPayinID = TextSource

ID of a direct pay in

data CardPayin Source

direct pay in via registered card

Constructors

CardPayin 

Fields

cpId :: Maybe CardPayinID
 
cpCreationDate :: Maybe POSIXTime
 
cpTag :: Maybe Text

custom data

cpAuthorId :: AnyUserID

The user ID of the author

cpCreditedUserId :: AnyUserID

The user ID of the owner of the credited wallet

cpFees :: Amount

It represents your fees taken on the DebitedFundsDebitedFunds – Fees = CreditedFunds (amount received on wallet)

cpCreditedWalletId :: WalletID

The ID of the credited wallet

cpDebitedWalletId :: Maybe WalletID

The ID of the debited wallet

cpDebitedFunds :: Amount

It represents the amount debited from the bank account.

cpCreditedFunds :: Maybe Amount

It represents the amount credited on the targeted e-wallet.

cpSecureModeReturnURL :: Maybe Text

This URL will be used in case the SecureMode is activated.

cpSecureMode :: Maybe Text

The SecureMode correspond to « 3D secure » for CB Visa and MasterCard or « Amex Safe Key » for American Express. This field lets you activate it manual

cpSecureModeRedirectURL :: Maybe Text

This URL will be used in case the SecureMode is activated.

cpCardId :: CardID

The ID of the registered card (Got through CardRegistration object)

cpStatus :: Maybe TransferStatus

The status of the payment

cpResultCode :: Maybe Text

The transaction result code

cpResultMessage :: Maybe Text

The transaction result Message

cpExecutionDate :: Maybe POSIXTime
 
cpType :: Maybe TransactionType

The type of the transaction

cpNature :: Maybe TransactionNature

The nature of the transaction:

cpPaymentType :: Maybe Text

The type of the payment (which type of mean of payment is used).

cpExecutionType :: Maybe PaymentExecution

How the payment has been executed:

Instances

Eq CardPayin 
Ord CardPayin 
Show CardPayin 
Typeable CardPayin 
ToJSON CardPayin

to json as per MangoPay format

FromJSON CardPayin

from json as per MangoPay format

storeCardPayin :: MPUsableMonad m => CardPayin -> AccessToken -> MangoPayT m CardPayinSource

create or edit a direct card pay in

fetchCardPayin :: MPUsableMonad m => CardPayinID -> AccessToken -> MangoPayT m CardPayinSource

fetch a direct pay in from its ID

mkCardPayin :: AnyUserID -> AnyUserID -> WalletID -> Amount -> Amount -> Text -> CardID -> CardPayinSource

helper function to create a new direct payin with the needed information | the url is only used in secure mode but is REQUIRED by MangoPay

type PayoutID = TextSource

id of payout

data Payout Source

payout

Constructors

Payout 

Fields

ptId :: Maybe PayoutID
 
ptCreationDate :: Maybe POSIXTime
 
ptTag :: Maybe Text

custom data for client

ptAuthorId :: AnyUserID

The user ID of the author

ptDebitedWalletId :: WalletID
 
ptDebitedFunds :: Amount
 
ptFees :: Amount
 
ptBankAccountId :: BankAccountID
 
ptCreditedUserId :: Maybe AnyUserID
 
ptCreditedFunds :: Maybe Amount
 
ptStatus :: Maybe TransferStatus
 
ptResultCode :: Maybe Text

The transaction result code

ptResultMessage :: Maybe Text

The transaction result code

ptExecutionDate :: Maybe POSIXTime
 
ptType :: Maybe TransactionType
 
ptNature :: Maybe TransactionNature
 
ptPaymentType :: Maybe PaymentType
 
ptMeanOfPaymentType :: Maybe PaymentType

« BANK_WIRE »

Instances

Eq Payout 
Ord Payout 
Show Payout 
Typeable Payout 
ToJSON Payout

to json as per MangoPay format

FromJSON Payout

from json as per MangoPay format

mkPayout :: AnyUserID -> WalletID -> Amount -> Amount -> BankAccountID -> PayoutSource

make a simplep payout for creation

storePayout :: MPUsableMonad m => Payout -> AccessToken -> MangoPayT m PayoutSource

create a payout

fetchPayout :: MPUsableMonad m => PayoutID -> AccessToken -> MangoPayT m PayoutSource

fetch an payout from its ID

data CardRegistration Source

a card registration

Constructors

CardRegistration 

Fields

crId :: Maybe CardRegistrationID

The Id of the object

crCreationDate :: Maybe POSIXTime

The creation date of the object

crTag :: Maybe Text

Custom data

crUserId :: AnyUserID

The ID of the author

crCurrency :: Currency

The currency of the card registrated

crAccessKey :: Maybe Text

This key has to be sent with the card details and the PreregistrationData

crPreregistrationData :: Maybe Text

This passphrase has to be sent with the card details and the AccessKey

crCardRegistrationURL :: Maybe Text

The URL where to POST the card details, the AccessKey and PreregistrationData

crRegistrationData :: Maybe Text

You get the CardRegistrationData once you posted the card details, the AccessKey and PreregistrationData

crCardType :: Maybe Text

« CB_VISA_MASTERCARD » is the only value available ye

crCardId :: Maybe CardID

You get the CardId (to process payments) once you edited the CardRegistration Object with the RegistrationData

crResultCode :: Maybe Text

The result code of the object

crResultMessage :: Maybe Text

The message explaining the result code

crStatus :: Maybe DocumentStatus

The status of the object.

Instances

type CardRegistrationID = TextSource

card registration ID

type CardID = TextSource

ID of a card

data CardInfo Source

credit card information

Constructors

CardInfo 

Fields

ciNumber :: Text
 
ciExpire :: CardExpiration
 
ciCSC :: Text
 

Instances

data Card Source

a registered card

Constructors

Card 

Fields

cId :: CardID
 
cCreationDate :: POSIXTime
 
cTag :: Maybe Text
 
cExpirationDate :: CardExpiration

MMYY

cAlias :: Text

Example: 497010XXXXXX4414

cCardProvider :: Text

The card provider, it could be « CB », « VISA », « MASTERCARD »,

cCardType :: Text

« CB_VISA_MASTERCARD » is the only value available ye

cProduct :: Maybe Text
 
cBankCode :: Maybe Text
 
cActive :: Bool
 
cCurrency :: Currency
 
cValidity :: CardValidity

Once we proceed (or attempted to process) a payment with the card we are able to indicate if it is « valid » or « invalid ». If we didn’t process a payment yet the « Validity » stay at « unk

cCountry :: Text
 
cUserId :: AnyUserID
 

Instances

Eq Card 
Ord Card 
Show Card 
Typeable Card 
FromJSON Card

from json as per MangoPay format

data CardValidity Source

validity of a card

Constructors

UNKNOWN 
VALID 
INVALID 

Instances

mkCardRegistration :: AnyUserID -> Currency -> CardRegistrationSource

helper function to create a new card registration

storeCardRegistration :: MPUsableMonad m => CardRegistration -> AccessToken -> MangoPayT m CardRegistrationSource

create or edit a card registration

fetchCard :: MPUsableMonad m => CardID -> AccessToken -> MangoPayT m CardSource

fetch a card from its ID

listCards :: MPUsableMonad m => AnyUserID -> Maybe Pagination -> AccessToken -> MangoPayT m (PagedList Card)Source

list all cards for a given user

type RefundID = TextSource

id of a refund

data Refund Source

refund of a transfer

Constructors

Refund 

Fields

rId :: RefundID

Id of the refund

rCreationDate :: POSIXTime
 
rTag :: Maybe Text

Custom data

rAuthorId :: AnyUserID

The user ID of the author

rDebitedFunds :: Amount

Strictly positive amount. In cents.

rFees :: Amount

In cents

rCreditedFunds :: Amount

In cents

rStatus :: TransferStatus
 
rResultCode :: Text

The transaction result code

rResultMessage :: Maybe Text

The transaction result Message

rExecutionDate :: POSIXTime
 
rType :: TransactionType
 
rNature :: TransactionNature
 
rCreditedUserId :: Maybe AnyUserID

Id of the user owner of the credited wallet

rInitialTransactionId :: TransactionID

Id of the transaction being refunded

rInitialTransactionType :: TransactionType

The type of the transaction before being refunded (PayIn, Refund)

rDebitedWalletId :: WalletID

The Id of the debited Wallet

rCreditedWalletID :: Maybe WalletID

The Id of the credited Wallet

Instances

Eq Refund 
Ord Refund 
Show Refund 
Typeable Refund 
FromJSON Refund

from json as per MangoPay format

data RefundRequest Source

refund request

Constructors

RefundRequest 

Fields

rrAuthorId :: AnyUserID

The user ID of the author

rrDebitedFunds :: Maybe Amount

Strictly positive amount. In cents.

rrFees :: Maybe Amount

In cents

Instances

refundTransfer :: MPUsableMonad m => TransferID -> AnyUserID -> AccessToken -> MangoPayT m RefundSource

refund a transfer

refundPayin :: MPUsableMonad m => AnyPayinID -> RefundRequest -> AccessToken -> MangoPayT m RefundSource

refund a pay-in

fetchRefund :: MPUsableMonad m => RefundID -> AccessToken -> MangoPayT m RefundSource

fetch a refund from its ID