Recurrente Aditional Classes
A Wrapper to interact with the Payment Gateway Recurrente.
Definition
Namespace: Tipi.Tools.Payments
Assembly: Tipi.Tools.Payments.dll
Package: Tipi.Tools.Recurrente
This class lets you interact with Recurrente's API.
Aditional Classes
Class used as parameter in order to initialize the Recurrente class.
Class used as return value for the CreateCheckoutAsync method.
Class used as return value for the CreateProductAsync method.
Class used a single charge price for a product.
Class used as return value for the CreateSubscriptionAsync method.
Class used a recurring charge price for a product.
Class used as return value for the GetActiveSubscriptionAsync method.
Class used to represent the user's saved Payment method.
Class used to represent a saved debit or credit Card.
RecurrenteOptions
Class used as a parameter to initialize a new instance of the Recurrente Class.
Properties
SecretKey
Property of type String that represents your Secret Key.
PublicKey
Property of type String that represents your Public Key.
Constructors
RecurrenteOptions(String, String)
This constructor takes as arguments two values of type String that represents your Public and Privates keys from Recurrente.
Checkout
Class used as return value for the CreateCheckoutAsync method.
Properties
Id
Property of type String that represents the Checkout Id.
Url
Property of type String that represents your Checkout Url.
Constructors
Checkout(String, String)
This constructor takes as arguments two values of type String that represents the Checkout URL and the Checkout Id.
Product
Class used as return value for the CreateProductAsync method.
Properties
Price
Property of type SinglePrice that represents your price Object.
Id
Property of type String that represents your product Id.
Name
Property of type String that represents your product Name.
Description
Property of type String that represents your product description.
PhoneRequirement
Property of type Requirements that represents if the checkout for this product should include a Phone number field.
AddressRequirement
Property of type Requirements that represents if the checkout for this product should include a Address field.
BillingInfoRequirement
Property of type Requirements that represents if the checkout for this product should include a Billing Info field.
Image
Property of type String that represents your product image.
CancelUrl
Property of type String that represents the Url Callback to return when the checkout for this product is cancelled.
SuccessUrl
Property of type String that represents the Url Callback to return when the checkout for this product is succesful.
StoreUrl
Property of type String that represents the Url to access a Storefront for the product.
Status
Property of type String that represents the status of the product.
Constructors
Product(SinglePrice)
This constructor takes as arguments two values of type SinglePrice that represents your price Object.
Subscription
Class used as return value for the CreateSubscriptionAsync method.
Properties
Price
Property of type RecurringPrice that represents your price Object.
Id
Property of type String that represents your product Id.
Name
Property of type String that represents your product Name.
Description
Property of type String that represents your product description.
PhoneRequirement
Property of type Requirements that represents if the checkout for this product should include a Phone number field.
AddressRequirement
Property of type Requirements that represents if the checkout for this product should include a Address field.
BillingInfoRequirement
Property of type Requirements that represents if the checkout for this product should include a Billing Info field.
Image
Property of type String that represents your product image.
CancelUrl
Property of type String that represents the Url Callback to return when the checkout for this product is cancelled.
SuccessUrl
Property of type String that represents the Url Callback to return when the checkout for this product is succesful.
StoreUrl
Property of type String that represents the Url to access a Storefront for the product.
Status
Property of type String that represents the status of the product.
Constructors
Product(RecurringPrice)
This constructor takes as arguments two values of type RecurringPrice that represents your price Object.
RecurringPrice
Class used a recurring charge price for a product.
Properties
Id
Property of type String that represents your Price Id.
Amount
Property of type double that represents your product amount.
Currency
Property of type Currency that represents your supported Currency.
Interval
Property of type BillingInterval that represents the Supported Billing Interval Measurment Units.
IntervalCount
Property of type int the number of interval to count before billing.
FreeTrialInterval
Property of type BillingInterval that represents the Supported Billing Interval Measurment Units for the free trial.
FreeTrialIntervalCount
Property of type int that represents the number of interval to count before finishing the Free Trial.
CancellationInterval
Property of type int the number of interval before cancelling the subscription when payment fails.
Methods
SetFreeTrial(BillingInterval, int)
This method takes as arguments two values one of type BillingInterval that represents the Supported Billing Interval Measurment Units for the free trial and other of type int that represents the number of interval to count before finishing the Free Trial. It is use to set a Free Trial to the Subscription.
ActiveSubscription
Class used as return value for the GetActiveSubscriptionAsync method.
Properties
Id
Property of type String that represents your Active subscription Id.
Status
Property of type String that represents your Active subscription Status.
Started
Property of type DateTime that represents when your Active subscription was started.
NextBilling
Property of type DateTime that represents when your Active subscription will be charged again.
UserId
Property of type String that represents your Active subscription User.
Property of type String that represents your Active subscription User Email.
ProductId
Property of type String that represents your Active subscription Related Product Id.
PaymentMethod
Class used to represent the user's saved Payment method.
Properties
Id
Property of type String that represents the Id of this particular payment method.
Type
Property of type String that represents the type of the payment method.
Card
Property of type Card that represents the information of the saved credit or debit card.
Card
Class used to represent a saved debit or credit Card.
Properties
Last4Digits
Property of type String that represents the last 4 digits of the saved card.
ExpirationMonth
Property of type String that represents the expiration month of the saved card.
ExpiratioYear
Property of type String that represents the expiration year of the saved card.
Provider
Property of type String that represents the provider of the card.