|
| 1 | +# Common Payment System |
| 2 | + |
| 3 | +ASP.NET Zero provides a payment system to get payments easily. In order to start a payment, just use `CreatePayment` method of `IPaymentManager` and then redirect user to `GatewaySelection` action of `PaymentController` with the created paymentId. For example, a sample URL for the `paymentId=1` should be like this; |
| 4 | + |
| 5 | +```bash |
| 6 | +https://localhost:44302/Payment/GatewaySelection?paymentId=1 |
| 7 | +``` |
| 8 | + |
| 9 | +ASP.NET Zero's common payment system will handle the rest of the payment flow. |
| 10 | + |
| 11 | +- If the payment process is successfull, user will be redirected to `SuccessUrl` provided when creating the payment request. |
| 12 | +- If the payment process is unsuccessfull, user will be redirected to `ErrorUrl` provided when creating the payment request. |
| 13 | +- If `SuccessUrl` or `ErrorUrl` is not provided, user will be redirected to a common page and result of the payment process will be displayed. |
| 14 | + |
| 15 | +## Creating Payment Request |
| 16 | + |
| 17 | +### SubscriptionPayment Entity |
| 18 | + |
| 19 | +`IPaymentManager` is used to create a payment requet. It's `CreatePayment` method requires a `SubscriptionPayment` entity. Here is the detials of `SubscriptionPayment` entity. |
| 20 | + |
| 21 | +* `TenantId`: Represents which Tenant this payment request belongs to. |
| 22 | +* `PaymentPeriodType`: Period type of the payment if this is a payment for a specific period. Currently, Monthly and Annual are supported. |
| 23 | +* `DayCount`: Integer value of `PaymentPeriodType` field. |
| 24 | +* `Gateway`: Name of payment gateway which processed this payment. This is set by ASP.NET Zero when the payment is successfull. |
| 25 | +* `Status`: Status of payment. This is set by ASP.NET Zero. |
| 26 | +* `ExternalPaymentId`: Id of the payment in the external payment gateway system like Stripe or PayPal. This is set by ASP.NET Zero. |
| 27 | +* `InvoiceNo`: Invoice number if an invoice generated in ASP.NET Zero for this payment. |
| 28 | +* `SuccessUrl`: URL to redirect user if payment is successfull. |
| 29 | +* `ErrorUrl`: URL to redirect user if payment is failed. |
| 30 | +* `IsRecurring`: Represents if this is a recurring payment or not. If it is recurring, user's credit card will be charged at the end of every payment cycle. This is only supported by Stripe at the moment. |
| 31 | +* `IsProrationPayment`: This is a special field. If the tenant is on a recurring payment plan and operation is upgrade, then it is a proration payment. |
| 32 | +* `ExtraProperties`: A dictionary to store additional information on the payment object. |
| 33 | +* `SubscriptionPaymentProducts`: List of products to be purchased for this payment. |
| 34 | + |
| 35 | +### SubscriptionPaymentProduct Entity |
| 36 | + |
| 37 | +* `SubscriptionPaymentId`: Id of the related payment record. |
| 38 | +* `Description`: Description of the purchased product. |
| 39 | +* `Amount`: Price of the product. |
| 40 | +* `Count`: Count of products to be purchased. |
| 41 | +* `TotalAmount`: Total price of products to be purchased. |
| 42 | +* `ExtraProperties`: A dictionary to store additional information on the product object. |
0 commit comments