feat(router): add endpoint for listing connector features (#6612)

Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com> Co-authored-by: Pa1NarK <[email protected]>
juspay · Dec 24, 2024 · a423ff5 · a423ff5
1 parent 5e4eded
commit a423ff5
Show file tree

Hide file tree

Showing 124 changed files with 1,490 additions and 252 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/api-reference-v2/openapi_spec.json b/api-reference-v2/openapi_spec.json
@@ -6700,6 +6700,43 @@
           "zsl"
         ]
       },
+      "ConnectorFeatureMatrixResponse": {
+        "type": "object",
+        "required": [
+          "name",
+          "supported_payment_methods"
+        ],
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "description": {
+            "type": "string",
+            "nullable": true
+          },
+          "category": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/PaymentConnectorCategory"
+              }
+            ],
+            "nullable": true
+          },
+          "supported_payment_methods": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/SupportedPaymentMethod"
+            }
+          },
+          "supported_webhook_flows": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/EventClass"
+            },
+            "nullable": true
+          }
+        }
+      },
       "ConnectorMetadata": {
         "type": "object",
         "description": "Some connectors like Apple Pay, Airwallex and Noon might require some additional information, find specific details in the child attributes below.",
@@ -8672,6 +8709,38 @@
           }
         }
       },
+      "FeatureMatrixListResponse": {
+        "type": "object",
+        "required": [
+          "connector_count",
+          "connectors"
+        ],
+        "properties": {
+          "connector_count": {
+            "type": "integer",
+            "description": "The number of connectors included in the response",
+            "minimum": 0
+          },
+          "connectors": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ConnectorFeatureMatrixResponse"
+            }
+          }
+        }
+      },
+      "FeatureMatrixRequest": {
+        "type": "object",
+        "properties": {
+          "connectors": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Connector"
+            },
+            "nullable": true
+          }
+        }
+      },
       "FeatureMetadata": {
         "type": "object",
         "description": "additional data that might be required by hyperswitch",
@@ -8702,6 +8771,14 @@
           }
         }
       },
+      "FeatureStatus": {
+        "type": "string",
+        "description": "The status of the feature",
+        "enum": [
+          "not_supported",
+          "supported"
+        ]
+      },
       "FieldType": {
         "oneOf": [
           {
@@ -12746,6 +12823,15 @@
           }
         ]
       },
+      "PaymentConnectorCategory": {
+        "type": "string",
+        "description": "Connector Access Method",
+        "enum": [
+          "payment_gateway",
+          "alternative_payment_method",
+          "bank_acquirer"
+        ]
+      },
       "PaymentCreatePaymentLinkConfig": {
         "allOf": [
           {
@@ -20591,6 +20677,52 @@
         },
         "additionalProperties": false
       },
+      "SupportedPaymentMethod": {
+        "type": "object",
+        "required": [
+          "payment_method",
+          "payment_method_type",
+          "mandates",
+          "refunds",
+          "supported_capture_methods"
+        ],
+        "properties": {
+          "payment_method": {
+            "$ref": "#/components/schemas/PaymentMethod"
+          },
+          "payment_method_type": {
+            "$ref": "#/components/schemas/PaymentMethodType"
+          },
+          "mandates": {
+            "$ref": "#/components/schemas/FeatureStatus"
+          },
+          "refunds": {
+            "$ref": "#/components/schemas/FeatureStatus"
+          },
+          "supported_capture_methods": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/CaptureMethod"
+            }
+          },
+          "supported_countries": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/CountryAlpha2"
+            },
+            "uniqueItems": true,
+            "nullable": true
+          },
+          "supported_currencies": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Currency"
+            },
+            "uniqueItems": true,
+            "nullable": true
+          }
+        }
+      },
       "SurchargeCalculationOverride": {
         "type": "string",
         "enum": [

diff --git a/api-reference/openapi_spec.json b/api-reference/openapi_spec.json
@@ -9319,6 +9319,43 @@
           "zsl"
         ]
       },
+      "ConnectorFeatureMatrixResponse": {
+        "type": "object",
+        "required": [
+          "name",
+          "supported_payment_methods"
+        ],
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "description": {
+            "type": "string",
+            "nullable": true
+          },
+          "category": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/PaymentConnectorCategory"
+              }
+            ],
+            "nullable": true
+          },
+          "supported_payment_methods": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/SupportedPaymentMethod"
+            }
+          },
+          "supported_webhook_flows": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/EventClass"
+            },
+            "nullable": true
+          }
+        }
+      },
       "ConnectorMetadata": {
         "type": "object",
         "description": "Some connectors like Apple Pay, Airwallex and Noon might require some additional information, find specific details in the child attributes below.",
@@ -11269,6 +11306,38 @@
           }
         }
       },
+      "FeatureMatrixListResponse": {
+        "type": "object",
+        "required": [
+          "connector_count",
+          "connectors"
+        ],
+        "properties": {
+          "connector_count": {
+            "type": "integer",
+            "description": "The number of connectors included in the response",
+            "minimum": 0
+          },
+          "connectors": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ConnectorFeatureMatrixResponse"
+            }
+          }
+        }
+      },
+      "FeatureMatrixRequest": {
+        "type": "object",
+        "properties": {
+          "connectors": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Connector"
+            },
+            "nullable": true
+          }
+        }
+      },
       "FeatureMetadata": {
         "type": "object",
         "description": "additional data that might be required by hyperswitch",
@@ -11299,6 +11368,14 @@
           }
         }
       },
+      "FeatureStatus": {
+        "type": "string",
+        "description": "The status of the feature",
+        "enum": [
+          "not_supported",
+          "supported"
+        ]
+      },
       "FieldType": {
         "oneOf": [
           {
@@ -15782,6 +15859,15 @@
           }
         ]
       },
+      "PaymentConnectorCategory": {
+        "type": "string",
+        "description": "Connector Access Method",
+        "enum": [
+          "payment_gateway",
+          "alternative_payment_method",
+          "bank_acquirer"
+        ]
+      },
       "PaymentCreatePaymentLinkConfig": {
         "allOf": [
           {
@@ -25077,6 +25163,52 @@
           }
         }
       },
+      "SupportedPaymentMethod": {
+        "type": "object",
+        "required": [
+          "payment_method",
+          "payment_method_type",
+          "mandates",
+          "refunds",
+          "supported_capture_methods"
+        ],
+        "properties": {
+          "payment_method": {
+            "$ref": "#/components/schemas/PaymentMethod"
+          },
+          "payment_method_type": {
+            "$ref": "#/components/schemas/PaymentMethodType"
+          },
+          "mandates": {
+            "$ref": "#/components/schemas/FeatureStatus"
+          },
+          "refunds": {
+            "$ref": "#/components/schemas/FeatureStatus"
+          },
+          "supported_capture_methods": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/CaptureMethod"
+            }
+          },
+          "supported_countries": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/CountryAlpha2"
+            },
+            "uniqueItems": true,
+            "nullable": true
+          },
+          "supported_currencies": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Currency"
+            },
+            "uniqueItems": true,
+            "nullable": true
+          }
+        }
+      },
       "SurchargeDetailsResponse": {
         "type": "object",
         "required": [

diff --git a/config/config.example.toml b/config/config.example.toml
@@ -516,6 +516,10 @@ seicomart = { country = "JP", currency = "JPY" }
 pay_easy = { country = "JP", currency = "JPY" }
 boleto = { country = "BR", currency = "BRL" }
 
+[pm_filters.bambora]
+credit = { country = "US,CA", currency = "USD" }
+debit = { country = "US,CA", currency = "USD" }
+
 [pm_filters.volt]
 open_banking_uk = { country = "DE,GB,AT,BE,CY,EE,ES,FI,FR,GR,HR,IE,IT,LT,LU,LV,MT,NL,PT,SI,SK,BG,CZ,DK,HU,NO,PL,RO,SE,AU,BR", currency = "EUR,GBP,DKK,NOK,PLN,SEK,AUD,BRL" }
 

diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml
@@ -278,6 +278,10 @@ we_chat_pay = { country = "AU,NZ,CN,JP,HK,SG,ES,GB,SE,NO,AT,NL,DE,CY,CH,BE,FR,DK
 google_pay.currency = "CHF,DKK,EUR,GBP,NOK,PLN,SEK,USD,AUD,NZD,CAD"
 paypal.currency = "CHF,DKK,EUR,GBP,NOK,PLN,SEK,USD,AUD,NZD,CAD"
 
+[pm_filters.bambora]
+credit = { country = "US,CA", currency = "USD" }
+debit = { country = "US,CA", currency = "USD" }
+
 [pm_filters.bankofamerica]
 credit = { currency = "USD" }
 debit = { currency = "USD" }

diff --git a/config/deployments/production.toml b/config/deployments/production.toml
@@ -292,6 +292,10 @@ we_chat_pay = { country = "AU,NZ,CN,JP,HK,SG,ES,GB,SE,NO,AT,NL,DE,CY,CH,BE,FR,DK
 google_pay.currency = "CHF,DKK,EUR,GBP,NOK,PLN,SEK,USD,AUD,NZD,CAD"
 paypal.currency = "CHF,DKK,EUR,GBP,NOK,PLN,SEK,USD,AUD,NZD,CAD"
 
+[pm_filters.bambora]
+credit = { country = "US,CA", currency = "USD" }
+debit = { country = "US,CA", currency = "USD" }
+
 [pm_filters.bankofamerica]
 credit = { currency = "USD" }
 debit = { currency = "USD" }

diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml
@@ -294,6 +294,10 @@ pix = { country = "BR", currency = "BRL" }
 google_pay.currency = "CHF,DKK,EUR,GBP,NOK,PLN,SEK,USD,AUD,NZD,CAD"
 paypal.currency = "CHF,DKK,EUR,GBP,NOK,PLN,SEK,USD,AUD,NZD,CAD"
 
+[pm_filters.bambora]
+credit = { country = "US,CA", currency = "USD" }
+debit = { country = "US,CA", currency = "USD" }
+
 [pm_filters.bankofamerica]
 credit = { currency = "USD" }
 debit = { currency = "USD" }

diff --git a/config/development.toml b/config/development.toml
@@ -459,6 +459,10 @@ pay_easy = { country = "JP", currency = "JPY" }
 pix = { country = "BR", currency = "BRL" }
 boleto = { country = "BR", currency = "BRL" }
 
+[pm_filters.bambora]
+credit = { country = "US,CA", currency = "USD" }
+debit = { country = "US,CA", currency = "USD" }
+
 [pm_filters.bankofamerica]
 credit = { currency = "USD" }
 debit = { currency = "USD" }