modulepackage
0.0.0-20200120170118-794a79bd7e52
Repository: https://github.com/bregydoc/plutus.git
Documentation: pkg.go.dev
# README
Plutus
Plutus is a modern tool to manage your payments, charges and invoices of your products. This tool is payment gateway agnostic and works like a new layer on your traditional payment stack.
Important
Currently, plutus only works with Culqi bridge, culqi is a peruvian payment gateway. My focus is implement a Strip bridge and with this continue work on the dashboard client of plutus (see client dir).
# Packages
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
AvailableCurrencies is a map with available currencies.
Charge represents a money flow from your customer to you.
Created is when the transaction eas early created.
Done is a done sale.
Draft is the earliest state of sale.
No description provided by the author
No description provided by the author
Null is a null sale, only for debug porpuses.
OneUseToken is a one use token from your charger.
PaidOut is a charged sale.
PEN represents a Peruvian Currency.
PercentDiscount is a static discount (e.g.
RecurrentToken is a saved card to recurrent use in your charger service.
Signed is a signed and final modeling sale.
StaticDiscount is a static discount (e.g.
USD represents an American Dollar.
# Structs
BridgeDescription is used to describe a bridge, it's a fast overview the capabilities of this bridge.
CardDetails represents a minimal details to encode your card sensible deatils.
CardToken represents a basic token generated by the charger service.
ChargeParams represents a minimal params to make a charge with your bridge.
ChargeToken is the reponse from your payment bridge.
Company serves to describe your company.
Cost represents a economic cost.
Currency is struct to describe a currency.
Customer represents a customer minimal information.
Date is a simple wrap for year and month date.
Discount is a discount value.
DiscountCode represents a discount promotional code.
DiscountUseRecord is a record of discount code use.
EncodedCardDetails represents a encoded card details (hidden complete number and expiration year too).
Location is a set of fields to localize to customer.
NewDiscountCode is a wrapper to create a new discount code.
Product is a product description.
RefundParams represents a minimal params to make a refund with your bridge.
RefundToken is the reponse from your payment bridge.
Sale is a bidirectional transaction.
SaleRepresentation is a representation of one sale.
SalesEngine is the core engine of plutus.
SupportContact wraps the support contact of your company.
Transaction represents a transaction of money.
TransactionSnapshot is a snapshot of one time transaction.
# Interfaces
DeliveryChannel a delivery channel is a way to represent and send a voucher of yourtransaction.
PaymentBridge is an abstraction layer for your charger ends.
Repository represents a bag where you can to put your basic objects.
# Type aliases
CardTokenType represents a type of token from your charger service.
DiscountType is a type of discount, actually plutus support static or percentual types.
FlowType is how the flow of resources (money in this case) is propagated.
ID represents an id managed and generated by plutus.
ProductList is a quantized list of products.
No description provided by the author
Quantity is an int representing a quantity.
SaleState represents the state of any sale.
TransactionState is the state of a transaction.