Strapi plugin strapi-plugin-payments-aggregator

General payment providers aggregator for Strapi 3.

Configuration

Plugin configuration is stored in the ./config/plugins.js file of the application. Here is example of the configuration file

1module.exports = ({ env }) => ({
2  'payments-aggregator': {
3    enabled: true,
4    providers: {
5      <some-provider>: {...}
6    },
7    callback: async (payment) => {....}
8  }
9});

Integration

The plugin configures the following routes

POST /payments-aggreagor/initiate
POST /payments-aggreagor/:provider/:paymentId/callback
 GET /payments-aggreagor/:provider/:paymentId/callback
 GET /payments-aggreagor/providers

Besides configured routes the plugin functionality is accessible through strapi.plugins['payments-aggregator'].services.payments service with functions:

1function initiatePayment(payment:PaymentRequest):PaymentInitiation
2function validatePayment(data:PaymentValidationRequest):void
3function listProviders():ProviderPaymentMethod[]

Besides these callable functions there is option to configure a callback function that will be called any time a status change is recorded from communication with service provider. This callback function is defined in the plugin configuration.

Providers

This plugins uses providers. Each provider needs to have name like strapi-provider-payments-<name> and must implement the following interfaces. The exported default function must accept object that contains configuration options for the provider. This function must return an object that conforms to the following interface:

1interface Provider {
2  name: string
3  initiate(data:PaymentRequest&&{webhookUrl:string, amount:float}):PaymentInitiation
4  validate(data:Object):PaymentDetails
5  getPaymentMethods():CountryPaymentMethods
6}

Types

1enum PaymentStatusType {
2  CREATED = 'created'
3  FAILED = 'failed'
4  COMPLETED = 'completed'
5  CANCELLED = 'cancelled'
6}
7
8interface PaymentDetails {
9  status:PaymentStatusType
10  externalId:string
11  clientIBAN:string
12  metadata:Object
13  reference:string
14}
15
16interface PaymentRequest {
17  provider:string
18  amount:number // Amount in cents
19  currencyCode:string
20  locale:string
21  reference:string
22  description:string
23  bank:string
24  returnUrl:string
25  email:string
26}
27
28interface PaymentValidationRequest {
29  provider:string
30  paymentId:string
31  // provider specific data
32}
33
34interface Header {
35  name:string
36  value:string
37}
38
39interface Payment {
40  provider:string
41  status:PaymentStatusType
42  amount:number
43  currency:string
44  referenceId:string
45  externalId:string
46}
47
48interface PaymentInitiation {
49  payment?: Payment
50  url: string
51  headers:Header[]
52}
53interface PaymentMethod {
54  bic:string
55  name:string
56  logo_url:string
57}
58
59interface CountryPaymentMethods {
60  <countryCode>:PaymentMethod[]
61  <countryCode>:PaymentMethod[]
62  ...
63}
64
65interface ProviderPaymentMethod {
66  <providerName>:CountryPaymentMethods
67}