feat(mca): Added recipient connector call for open banking connectors #3758

Sarthak1799 · 2024-02-21T14:45:22Z

Type of Change

Description

Added connector call in payment connector create to facilitate merchant recipient creation at connector end.
Added alternative locker call for creation of recipient at Hyperswitch's end in case the connector does not support it.
Added validation for merchant bank account data

Additional Changes

This PR modifies the API contract
This PR modifies the database schema
This PR modifies application configuration/environment variables

Motivation and Context

How did you test it?

Create an MCA account with connector_type as payment_processor and an open banking connector

curl --location --request POST 'http://localhost:8080/account/merchant_1720607250/connectors' \
--header 'api-key: test_admin' \
--header 'Content-Type: application/json' \
--data-raw '{
    "connector_type": "payment_processor",
    "connector_name": "plaid",
    "connector_label": "plaid3",
    "connector_account_details": {
        "auth_type": "BodyKey",
        "api_key": "Some_key",
        "key1": "Some_key"
    },
    "test_mode": false,
    "disabled": false,
    "payment_methods_enabled": [
        {
            "payment_method": "bank_redirect",
            "payment_method_types": [
                {
                    "payment_method_type": "eps",
                    "recurring_enabled": true,
                    "installment_payment_enabled": true,
                    "accepted_currencies": {
                        "type": "enable_only",
                        "list": [
                            "EUR"
                        ]
                    }
                },
                {
                    "payment_method_type": "giropay",
                    "recurring_enabled": true,
                    "installment_payment_enabled": true,
                    "accepted_currencies": {
                        "type": "enable_only",
                        "list": [
                            "EUR"
                        ]
                    }
                },
                {
                    "payment_method_type": "ideal",
                    "recurring_enabled": true,
                    "installment_payment_enabled": true,
                    "accepted_currencies": {
                        "type": "enable_only",
                        "list": [
                            "EUR"
                        ]
                    }
                }
            ]
        },
        {
            "payment_method": "bank_debit",
            "payment_method_types": [
                {
                    "payment_method_type": "ach",
                    "recurring_enabled": true,
                    "installment_payment_enabled": true,
                    "minimum_amount": 0,
                    "maximum_amount": 10000
                }
            ]
        },
        {
            "payment_method": "wallet",
            "payment_method_types": [
                {
                    "payment_method_type": "apple_pay",
                    "payment_experience": "invoke_sdk_client",
                    "card_networks": null,
                    "accepted_countries": null,
                    "minimum_amount": 1,
                    "maximum_amount": 68607706,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true,
                    "accepted_currencies": {
                        "type": "enable_only",
                        "list": [
                            "USD",
                            "GBP",
                            "CAD",
                            "AUD",
                            "EUR"
                        ]
                    }
                }
            ]
        }
    ],
    "additional_merchant_data": {
         "open_banking_recipient_data": {
            "account_data": {
                "bacs": {
                    "sort_code": "200000",
                    "account_number": "55779911",
                    "name": "merchant_name"
                }
            }
        }
    },
    "metadata": {
        "city": "NY",
        "unit": "246"
    }
}'

Successful Response should look like this -

{
    "connector_type": "payment_processor",
    "connector_name": "plaid",
    "connector_label": "plaid3",
    "merchant_connector_id": "mca_c0iTEayEJMViYwEhTCOG",
    "profile_id": "pro_UgP3FfqWGhfPLuUqYtJF",
    "connector_account_details": {
        "auth_type": "BodyKey",
      "api_key": "Some_key",
        "key1": "Some_key"
    },
    "payment_methods_enabled": [
        {
            "payment_method": "bank_redirect",
            "payment_method_types": [
                {
                    "payment_method_type": "eps",
                    "payment_experience": null,
                    "card_networks": null,
                    "accepted_currencies": {
                        "type": "enable_only",
                        "list": [
                            "EUR"
                        ]
                    },
                    "accepted_countries": null,
                    "minimum_amount": null,
                    "maximum_amount": null,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                },
                {
                    "payment_method_type": "giropay",
                    "payment_experience": null,
                    "card_networks": null,
                    "accepted_currencies": {
                        "type": "enable_only",
                        "list": [
                            "EUR"
                        ]
                    },
                    "accepted_countries": null,
                    "minimum_amount": null,
                    "maximum_amount": null,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                },
                {
                    "payment_method_type": "ideal",
                    "payment_experience": null,
                    "card_networks": null,
                    "accepted_currencies": {
                        "type": "enable_only",
                        "list": [
                            "EUR"
                        ]
                    },
                    "accepted_countries": null,
                    "minimum_amount": null,
                    "maximum_amount": null,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                }
            ]
        },
        {
            "payment_method": "bank_debit",
            "payment_method_types": [
                {
                    "payment_method_type": "ach",
                    "payment_experience": null,
                    "card_networks": null,
                    "accepted_currencies": null,
                    "accepted_countries": null,
                    "minimum_amount": 0,
                    "maximum_amount": 10000,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                }
            ]
        },
        {
            "payment_method": "wallet",
            "payment_method_types": [
                {
                    "payment_method_type": "apple_pay",
                    "payment_experience": "invoke_sdk_client",
                    "card_networks": null,
                    "accepted_currencies": {
                        "type": "enable_only",
                        "list": [
                            "USD",
                            "GBP",
                            "CAD",
                            "AUD",
                            "EUR"
                        ]
                    },
                    "accepted_countries": null,
                    "minimum_amount": 1,
                    "maximum_amount": 68607706,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                }
            ]
        }
    ],
    "connector_webhook_details": null,
    "metadata": {
        "city": "NY",
        "unit": "246"
    },
    "test_mode": false,
    "disabled": false,
    "frm_configs": null,
    "business_country": null,
    "business_label": null,
    "business_sub_label": null,
    "applepay_verified_domains": null,
    "pm_auth_config": null,
    "status": "active",
    "additional_merchant_data": {
        "open_banking_recipient_data": {
            "account_data": {
                "bacs": {
                    "account_number": "55779911",
                    "sort_code": "200000",
                    "name": "merchant_name",
                    "connector_recipient_id": "recipient-id-sandbox-45beb880-9e3d-4ae3-927b-052f5610fd74"
                }
            }
        }
    }
}

Response when the connector does not support recipient creation (locker call to be made in this)

{
    "connector_type": "payment_processor",
    "connector_name": "plaid",
    "connector_label": "plaid3",
    "merchant_connector_id": "mca_6bIUIrWNSbqssRO89Zxx",
    "profile_id": "pro_UgP3FfqWGhfPLuUqYtJF",
    "connector_account_details": {
        "auth_type": "BodyKey",
       "api_key": "Some_key",
        "key1": "Some_key"
    },
    "payment_methods_enabled": [
        {
            "payment_method": "bank_redirect",
            "payment_method_types": [
                {
                    "payment_method_type": "eps",
                    "payment_experience": null,
                    "card_networks": null,
                    "accepted_currencies": {
                        "type": "enable_only",
                        "list": [
                            "EUR"
                        ]
                    },
                    "accepted_countries": null,
                    "minimum_amount": null,
                    "maximum_amount": null,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                },
                {
                    "payment_method_type": "giropay",
                    "payment_experience": null,
                    "card_networks": null,
                    "accepted_currencies": {
                        "type": "enable_only",
                        "list": [
                            "EUR"
                        ]
                    },
                    "accepted_countries": null,
                    "minimum_amount": null,
                    "maximum_amount": null,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                },
                {
                    "payment_method_type": "ideal",
                    "payment_experience": null,
                    "card_networks": null,
                    "accepted_currencies": {
                        "type": "enable_only",
                        "list": [
                            "EUR"
                        ]
                    },
                    "accepted_countries": null,
                    "minimum_amount": null,
                    "maximum_amount": null,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                }
            ]
        },
        {
            "payment_method": "bank_debit",
            "payment_method_types": [
                {
                    "payment_method_type": "ach",
                    "payment_experience": null,
                    "card_networks": null,
                    "accepted_currencies": null,
                    "accepted_countries": null,
                    "minimum_amount": 0,
                    "maximum_amount": 10000,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                }
            ]
        },
        {
            "payment_method": "wallet",
            "payment_method_types": [
                {
                    "payment_method_type": "apple_pay",
                    "payment_experience": "invoke_sdk_client",
                    "card_networks": null,
                    "accepted_currencies": {
                        "type": "enable_only",
                        "list": [
                            "USD",
                            "GBP",
                            "CAD",
                            "AUD",
                            "EUR"
                        ]
                    },
                    "accepted_countries": null,
                    "minimum_amount": 1,
                    "maximum_amount": 68607706,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                }
            ]
        }
    ],
    "connector_webhook_details": null,
    "metadata": {
        "city": "NY",
        "unit": "246"
    },
    "test_mode": false,
    "disabled": false,
    "frm_configs": null,
    "business_country": null,
    "business_label": null,
    "business_sub_label": null,
    "applepay_verified_domains": null,
    "pm_auth_config": null,
    "status": "active",
    "additional_merchant_data": {
        "open_banking_recipient_data": {
            "account_data": {
                "bacs": {
                    "account_number": "55779911",
                    "sort_code": "200000",
                    "name": "merchant_name"
                }
            }
        }
    }
}

Checklist

I formatted the code cargo +nightly fmt --all
I addressed lints thrown by cargo clippy
I reviewed the submitted code
I added unit tests for my changes where possible
I added a CHANGELOG entry if applicable

…t-recipient

crates/api_models/src/admin.rs

crates/pm_auth/src/connector/plaid.rs

config/development.toml

Narayanbhat166 · 2024-03-15T10:37:26Z

Few points to be resolved:

If we receive an error from the processor, the error should be propogated in the response, status code should be the same as sent by the processor. ( or we can throw 4xx for any failed error, and 5xx for any internal error as usual )
Is receipient_id used as a key for authentication with the api? If not it does not make sense to store it in auth type. We can have a separate column for these processors ( or store it in metadata, I would not prefer this option ). Only keys that are used for authentication should go in auth type ( both in api and database ).
The previous point also applies for bank_account_number, if not required for authentication, we can move it out and collect it in metadata. The metadata can be type validated.

Sarthak1799 · 2024-03-15T10:47:14Z

For the first point, made the changes to throw a 4xx from the connector instead of 5xx @Narayanbhat166

…t-recipient

crates/router/src/core/admin.rs

…t-recipient

* 'main' of github.com:juspay/hyperswitch: (25 commits) fix(logs): ignore request headers while logging (#5273) feat(webhooks): add support for custom outgoing webhook http headers (#5275) fix(payment_methods): set `requires_cvv` to false when either `connector_mandate_details` or `network_transaction_id` is present during MITs (#5331) chore: create justfile for running commands for v1 and v2 migrations (#5325) fix(routing): do not update `perform_session_flow_routing` output if the `SessionRoutingChoice` is none (#5336) fix(database): modified_at updated for every state change for Payment Attempts (#5312) feat(mca): Added recipient connector call for open banking connectors (#3758) chore(version): 2024.07.16.0 refactor(connector): [Mifinity] add a field language_preference in payment request for mifinity payment method data (#5326) fix(router): store `customer_acceptance` in payment_attempt, use it in confirm flow for delayed authorizations like external 3ds flow (#5308) feat(proxy): add support to pass proxy bypass urls from configs (#5322) Docs: Updating Error codes in API-ref (#5296) feat(core): [Payouts] Add retrieve flow for payouts (#4936) fix(connector): [AUTHORIZEDOTNET] Populate error reason for failure transactions (#5319) chore(version): 2024.07.15.0 feat(logging): Emit a setup error when a restricted keys are used for logging default keys (#5185) feat(payment_methods): add support to migrate existing customer PMs from processor to hyperswitch (#5306) feat(connector): [DATATRANS] Implement card payments (#5028) chore: making of function create_encrypted_data (#5251) fix(payments): populate merchant order ref id in list (#5310) ...

feat(mca): Added recipient connector call for open banking connectors

f9848a0

Sarthak1799 added A-core Area: Core flows C-feature Category: Feature request or enhancement labels Feb 21, 2024

Sarthak1799 requested a review from vspecky February 21, 2024 14:45

Sarthak1799 self-assigned this Feb 21, 2024

Sarthak1799 requested review from a team as code owners February 21, 2024 14:45

hyperswitch-bot bot added 2 commits February 21, 2024 14:45

chore: run formatter

708774f

docs(openapi): re-generate OpenAPI specification

5315345

Sarthak1799 linked an issue Feb 27, 2024 that may be closed by this pull request

[FEATURE] Update Payment Connector Create to incorporate recipient creation #3610

Closed

2 tasks

Sarthak1799 added 3 commits March 4, 2024 18:27

Merge branch 'main' of github.com:juspay/hyperswitch into mca-merchan…

1886c11

…t-recipient

fix(mca): Some fixes

41666a0

fix(mca): Use merchant_id for customer in lcoker call

e6a8754

This was referenced Mar 6, 2024

feat(connector): Plaid connector Integration #3952

Merged

feat(core): Payments core modification for open banking connectors #3947

Merged

Sarthak1799 and others added 4 commits March 11, 2024 15:51

fix(mca) :Fixed clippy errors

8b78b91

fix(mca): Fixed mca response

6ae507e

Merge branch 'main' of github.com:juspay/hyperswitch into mca-merchan…

d7839fe

…t-recipient

chore: run formatter

1bbd8c3

Narayanbhat166 reviewed Mar 13, 2024

View reviewed changes

crates/api_models/src/admin.rs Outdated Show resolved Hide resolved

Narayanbhat166 reviewed Mar 13, 2024

View reviewed changes

crates/pm_auth/src/connector/plaid.rs Outdated Show resolved Hide resolved

Narayanbhat166 reviewed Mar 13, 2024

View reviewed changes

config/development.toml Outdated Show resolved Hide resolved

fix(mca): Resolved comments

7ba1295

fix(mca): Resolved comments

516e1f8

hyperswitch-bot bot and others added 3 commits March 15, 2024 10:48

chore: run formatter

6df183d

Merge branch 'main' of github.com:juspay/hyperswitch into mca-merchan…

aba43fb

…t-recipient

refactor(mca): Additional merchant data in mca

0265a1f

Sarthak1799 and others added 2 commits July 10, 2024 16:02

Merge branch 'main' of github.com:juspay/hyperswitch into mca-merchan…

0a2e266

…t-recipient

docs(openapi): re-generate OpenAPI specification

4cff58f

Chethan-rao reviewed Jul 10, 2024

View reviewed changes

crates/router/src/core/admin.rs Outdated Show resolved Hide resolved

Sarthak1799 added 2 commits July 10, 2024 17:08

fix(mca): Resolved comments

bc6ec0b

fix(mca): Fixed errors

2cf744a

Chethan-rao reviewed Jul 10, 2024

View reviewed changes

crates/router/src/core/admin.rs Outdated Show resolved Hide resolved

fix(mca): Fixed errors

f1affe5

Chethan-rao previously approved these changes Jul 11, 2024

View reviewed changes

Narayanbhat166 reviewed Jul 11, 2024

View reviewed changes

crates/router/src/core/admin.rs Outdated Show resolved Hide resolved

Narayanbhat166 previously approved these changes Jul 11, 2024

View reviewed changes

fix(mca): Resolved comments

d177e87

Sarthak1799 dismissed stale reviews from Narayanbhat166 and Chethan-rao via d177e87 July 11, 2024 11:12

Sarthak1799 and others added 5 commits July 11, 2024 18:42

fix(mca): Resolved errors

791ba58

Merge branch 'main' of github.com:juspay/hyperswitch into mca-merchan…

f41a4c4

…t-recipient

fix(mca): Resolved errors

1adb8d2

Merge branch 'main' into mca-merchant-recipient

72dc3f9

fix(mca): Fixed errors

cc1fba3

Sakilmostak previously approved these changes Jul 12, 2024

View reviewed changes

Narayanbhat166 previously approved these changes Jul 12, 2024

View reviewed changes

fix(mca): Fixed some errors

6d50f73

Sarthak1799 dismissed stale reviews from Narayanbhat166 and Sakilmostak via 6d50f73 July 15, 2024 13:44

Sakilmostak approved these changes Jul 15, 2024

View reviewed changes

vspecky approved these changes Jul 16, 2024

View reviewed changes

Gnanasundari24 added this pull request to the merge queue Jul 16, 2024

Merged via the queue into main with commit 3951ac6 Jul 16, 2024

Gnanasundari24 deleted the mca-merchant-recipient branch July 16, 2024 08:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(mca): Added recipient connector call for open banking connectors #3758

feat(mca): Added recipient connector call for open banking connectors #3758

Uh oh!

Sarthak1799 commented Feb 21, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Narayanbhat166 commented Mar 15, 2024

Uh oh!

Sarthak1799 commented Mar 15, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

feat(mca): Added recipient connector call for open banking connectors #3758

feat(mca): Added recipient connector call for open banking connectors #3758

Uh oh!

Conversation

Sarthak1799 commented Feb 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Narayanbhat166 commented Mar 15, 2024

Uh oh!

Sarthak1799 commented Mar 15, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Sarthak1799 commented Feb 21, 2024 •

edited

Loading