Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(connector): [NMI] Implement webhook for Payments and Refunds #3164

Merged
merged 5 commits into from
Dec 19, 2023
Merged

feat(connector): [NMI] Implement webhook for Payments and Refunds #3164

merged 5 commits into from
Dec 19, 2023

Conversation

Sakilmostak
Copy link
Contributor

@Sakilmostak Sakilmostak commented Dec 18, 2023 •
edited
Loading

Type of Change

  • Bugfix
  • New feature
  • Enhancement
  • Refactoring
  • Dependency updates
  • Documentation
  • CI/CD

Description

  • Includes webhook for payment as well as refund
  • Includes refactoring of sync using reference id

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 a merchant account:
{ "merchant_id": "merchant_{{$timestamp}}", "locker_id": "m0010", "merchant_name": "NewAge Retailer", "merchant_details": { "primary_contact_person": "John Test", "primary_email": "JohnTest@test.com", "primary_phone": "sunt laborum", "secondary_contact_person": "John Test2", "secondary_email": "JohnTest2@test.com", "secondary_phone": "cillum do dolor id", "website": "www.example.com", "about_business": "Online Retail with a wide selection of organic products for North America", "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US" } }, "return_url": "https://google.com/success", "webhook_details": { "webhook_version": "1.0.1", "webhook_username": "ekart_retail", "webhook_password": "password_ekart@123", "payment_created_enabled": true, "payment_succeeded_enabled": true, "payment_failed_enabled": true }, "routing_algorithm": { "type": "single", "data": "nmi" }, "sub_merchants_enabled": false, "metadata": { "city": "NY", "unit": "245" }, "primary_business_details": [ { "country": "US", "business": "default" } ] }

Update the merchant account:
{ "merchant_id": "{{merchant_id}}", "webhook_details": { "webhook_version": "1.0.1", "webhook_username": "ekart_retail", "webhook_password": "password_ekart@123", "payment_created_enabled": true, "payment_succeeded_enabled": true, "payment_failed_enabled": true, "webhook_url": "{{webhook_url}}" } }

Create a Payment Connector(NMI):
{ "connector_type": "fiz_operations", "connector_name": "nmi", "connector_account_details": { "auth_type": "BodyKey", "api_key": "{{api_Key}}", "key1": "{{public_key}}" }, "test_mode": false, "disabled": false, "payment_methods_enabled": [ { "payment_method": "card", "payment_method_types": [ { "payment_method_type": "credit", "card_networks": [ "Visa", "Mastercard" ], "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true }, { "payment_method_type": "debit", "card_networks": [ "Visa", "Mastercard" ], "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true } ] }, { "payment_method": "pay_later", "payment_method_types": [ { "payment_method_type": "klarna", "payment_experience": "redirect_to_url", "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true }, { "payment_method_type": "affirm", "payment_experience": "redirect_to_url", "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true }, { "payment_method_type": "afterpay_clearpay", "payment_experience": "redirect_to_url", "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true } ] } ], "metadata": { "city": "NY", "unit": "245" }, "business_country": "US", "business_label": "default" }

Update the payment connector:
{ "connector_type": "fiz_operations", "connector_webhook_details": { "merchant_secret": "{{webhook_secret_key}}" } }

Create a non 3ds payment with NMI:
{ "amount": 18000, "currency": "USD", "confirm": true, "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "customer_id": "StripeCustomer", "email": "abcdef123@gmail.com", "name": "John Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "authentication_type": "no_three_ds", "return_url": "https://google.com", "setup_future_usage": "off_session", "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "127.0.0.1" }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "John", "last_name": "Doe" } }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" }, "payment_method": "card", "payment_method_type": "credit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "10", "card_exp_year": "25", "card_holder_name": "joseph Doe", "card_cvc": "999" } } }

  • You should recieve the webhook in your endpoint
  • Both payment and refund is supported

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

@Sakilmostak Sakilmostak added A-connector-integration Area: Connector integration C-feature Category: Feature request or enhancement P-high Priority: High S-waiting-on-review Status: This PR has been implemented and needs to be reviewed A-webhooks Area: Webhook flows labels Dec 18, 2023
@Sakilmostak Sakilmostak requested a review from a team as a code owner December 18, 2023 17:08
@Sakilmostak Sakilmostak self-assigned this Dec 18, 2023
ArjunKarthik
ArjunKarthik requested changes Dec 19, 2023
View reviewed changes
crates/router/src/connector/nmi.rs
) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> {
Err(errors::ConnectorError::WebhooksNotImplemented).into_report()
let webhook_body: nmi::NmiWebhookBody = request
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since, this object will be consumed by PSync handle_response, let's have try_from webhook response object to PSync response object for payments and in case of refund return the object as it is. This will ensure that any changes in PSync will not break the incoming webhook flow

crates/router/src/connector/nmi/transformers.rs Outdated
| NmiWebhookEventType::AuthSuccess
| NmiWebhookEventType::AuthFailure
| NmiWebhookEventType::AuthProcessing
| NmiWebhookEventType::VoidSuccess
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

VoidSuccess can be mapped to PaymentIntentCancelled

crates/router/src/connector/nmi/transformers.rs Outdated
#[serde(rename = "transaction.auth.failure")]
AuthFailure,
#[serde(rename = "transaction.auth.unknown")]
AuthProcessing,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is unknown status, Let's use AuthUnknown.

crates/router/src/connector/nmi/transformers.rs Outdated
#[serde(rename = "transaction.sale.failure")]
PaymentIntentFailure,
#[serde(rename = "transaction.sale.unknown")]
PaymentIntentProcessing,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is unknown status, Let's use SaleUnknown.

crates/router/src/connector/nmi/transformers.rs Outdated
#[derive(Debug, Deserialize, Serialize)]
pub enum NmiWebhookEventType {
#[serde(rename = "transaction.sale.success")]
PaymentIntentSuccess,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of PaymentIntent in the enum naming, let's use SaleSuccess, SaleFailure, SaleUnknown

crates/router/src/connector/nmi/transformers.rs Outdated
#[serde(rename = "transaction.capture.failure")]
CaptureFailure,
#[serde(rename = "transaction.capture.unknown")]
CaptureProcessing,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is unknown status, Let's use CaptureUnknown.

crates/router/src/connector/nmi/transformers.rs Outdated
#[serde(rename = "transaction.void.failure")]
VoidFailure,
#[serde(rename = "transaction.void.unknown")]
VoidProcessing,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is unknown status, Let's use VoidUnknown.

ArjunKarthik
ArjunKarthik reviewed Dec 19, 2023
View reviewed changes
crates/router/src/connector/nmi.rs Outdated
.parse_struct("nmi NmiWebhookBody")
.change_context(errors::ConnectorError::WebhookResourceObjectNotFound)?;

if let nmi::NmiActionType::Sale = webhook_body.event_body.action.action_type {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add all payment events

@likhinbopanna likhinbopanna added this pull request to the merge queue Dec 19, 2023
Merged via the queue into main with commit 30c1401 Dec 19, 2023
12 of 14 checks passed
@likhinbopanna likhinbopanna deleted the nmi_webhooks branch December 19, 2023 14:55
@pixincreate
Copy link
Member

https://github.com/juspay/hyperswitch/tree/feat_nmi_webhooks

I had previously implemented webhooks for this connector when we did not had proper access to their dashboard.
I'll delete the branch.

@pixincreate pixincreate removed the S-waiting-on-review Status: This PR has been implemented and needs to be reviewed label Dec 21, 2023
@SanchithHegde SanchithHegde removed the P-high Priority: High label Dec 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@deepanshu-iiitu deepanshu-iiitu deepanshu-iiitu approved these changes

@ArjunKarthik ArjunKarthik ArjunKarthik approved these changes

Assignees

@Sakilmostak Sakilmostak

Labels
A-connector-integration Area: Connector integration A-webhooks Area: Webhook flows C-feature Category: Feature request or enhancement
Projects
No open projects
hyperswitch - Public Roadmap
Status: Merged
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@Sakilmostak @pixincreate @ArjunKarthik @deepanshu-iiitu @SanchithHegde @likhinbopanna