PaymentService.WeChatPay

(opens new window) (opens new window) (opens new window) (opens new window) (opens new window)

WeChatPay implementation of the EasyAbp.PaymentService module.

Online Demo

We have launched an online demo for this module: https://pay.samples.easyabp.io (opens new window)

Installation

Should also install the PaymentService module since this module depends on it.

1. Install the following NuGet packages. (see how (opens new window))

   • EasyAbp.PaymentService.WeChatPay.Application
   • EasyAbp.PaymentService.WeChatPay.Application.Contracts
   • EasyAbp.PaymentService.WeChatPay.Domain
   • EasyAbp.PaymentService.WeChatPay.Domain.Shared
   • EasyAbp.PaymentService.WeChatPay.EntityFrameworkCore
   • EasyAbp.PaymentService.WeChatPay.HttpApi
   • EasyAbp.PaymentService.WeChatPay.HttpApi.Client
   • (Optional) EasyAbp.PaymentService.WeChatPay.MongoDB
   • (Optional) EasyAbp.PaymentService.WeChatPay.Web

2. Add DependsOn(typeof(PaymentServiceWeChatPayXxxModule)) attribute to configure the module dependencies. (see how (opens new window))

3. Add builder.ConfigurePaymentServiceWeChatPay(); to the OnModelCreating() method in MyProjectMigrationsDbContext.cs.

4. Add EF Core migrations and update your database. See: ABP document (opens new window).

Usage

1. Register the WeChatPay payment method:

   Configure<PaymentServiceOptions>(options =>
   {
       options.Providers.Configure<WeChatPayPaymentServiceProvider>(WeChatPayPaymentServiceProvider.PaymentMethod);
   });
   

2. Configure the WeChatPay settings (opens new window), you can try to use SettingUI (opens new window) to finish this work.

   See the demo (opens new window), it is also according to the document (opens new window) of the EasyAbp.Abp.WeChat module.

3. Pay with WeChatPay.

   1. Users can use the API /api/paymentService/payment/{id}/pay to finish the payment, please put the necessary params in the ExtraProperties:

      {
          "extraProperties": {
              "trade_type": "JSAPI",
              "appid": "wx81a2956875268fk8"   // You can specify an appid or get it from the input from the client.
          }
      }
      

   Skip the following steps if you are using the EasyAbp.EShop (opens new window).

   See more steps

   2. Create a payment with the payment method WeChatPay.

      Other modules or apps that depend on PaymentService module should create payments via distributed events.

      See sample code

      await _distributedEventBus.PublishAsync(new CreatePaymentEto
      {
          TenantId = CurrentTenant.Id,
          UserId = CurrentUser.GetId(),
          PaymentMethod = "WeChatPay",   // Should specify the payment method as "WeChatPay"
          Currency = "CNY",   // Should always be "CNY"
          PaymentItems = orders.Select(order => new CreatePaymentItemEto
          {
              ItemType = "MyCustomKeyword", // It is just a sample and you can customize it yourself
              ItemKey = order.Id,
              OriginalPaymentAmount = order.Price
          }).ToList()
      });
      

      please refer to the usage in EShop (opens new window)

   3. Handle the payment created distributed event to get and remember the PaymentId.

      See sample code

      public class MyCustomPaymentCreatedEventHandler : IDistributedEventHandler<EntityCreatedEto<PaymentEto>>, ITransientDependency
      {
          [UnitOfWork(isTransactional: true)]
          public virtual async Task HandleEventAsync(EntityCreatedEto<PaymentEto> eventData)
          {
              foreach (var item in eventData.Entity.PaymentItems.Where(item => item.ItemType == "MyCustomKeyword"))
              {
                  // Persistence the PaymentId of the ongoing payment, so user can get it in some way.
              }
          }
      }
      

      please refer to the usage in EShop (opens new window)

   4. Handle the payment canceled distributed event to clear the remembered the PaymentId.

      See sample code

      public class MyCustomPaymentCanceledEventHandler : IDistributedEventHandler<PaymentCanceledEto>, ITransientDependency
      {
          [UnitOfWork(isTransactional: true)]
          public virtual async Task HandleEventAsync(PaymentCanceledEto payment)
          {
              foreach (var item in payment.PaymentItems.Where(item => item.ItemType == "MyCustomKeyword"))
              {
                  // Remove the remembered PaymentId.
              }
          }
      }
      

      please refer to the usage in EShop (opens new window)

   5. Handle the payment completed distributed event:

      See sample code

      public class MyCustomPaymentCompletedEventHandler : IDistributedEventHandler<PaymentCompletedEto>, ITransientDependency
      {
          [UnitOfWork(isTransactional: true)]
          public virtual async Task HandleEventAsync(PaymentCompletedEto payment)
          {
              foreach (var item in payment.PaymentItems.Where(item => item.ItemType == "MyCustomKeyword"))
              {
                  // Maybe you can automatically send out the goods to the customer here.
              }
          }
      }
      

      please refer to the usage in EShop (opens new window)

Roadmap

• [ ] Unit tests.