feat(router): blocklist #3056

prajjwalkumar17 · 2023-12-05T11:57:03Z

Type of Change

Description

This feature will allow the merchants to block the following according to their needs:

  1. card_numbers
  2. card_isins
  3. extended_bins

Additional Changes

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

Motivation and Context

Requested by Merchant.

How did you test it?

Refer to the attached postman collection for the API contracts for the blocklist APIs. Currently we support blocking three types of resources i.e. card numbers (payment intrument), card bin, and extended card bin.

For Card Bin and Extended Card Bin :-

Setup a Merchant Account and any Connector account
Make a payment with a certain card (ensure it succeeds)
Block the card's card bin or extended card bin
Try the payment again (should fail this time with an API response saying that the payment was blocked)

For Payment Instrument :-

Repeat steps 1 and 2 of previous section
In the payment confirm response, there will be an additional field called "fingerprint". This is the fingerprint id that can be used to block a particular payment method. Use this to block the card.
Try the payment again (should fail)

blocklist_api_postman.zip

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

…hyperswitch into feat/block_paymentmethod

…ate tracker

…umn fingerprint_id in payment attempt

… pm_fingerprint, pm_hash

…hyperswitch into feat/block_paymentmethod

crates/router/src/core/payments/operations/payment_confirm.rs

crates/router/src/routes/app.rs

… improvements and succinction

Narayanbhat166 · 2024-01-11T11:36:06Z

migrations/2023-12-11-075542_create_pm_fingerprint_table/up.sql

+CREATE TYPE "BlocklistDataKind" AS ENUM (
+    'payment_method',
+    'card_bin',
+    'extended_card_bin'
+);


do we need to have this as a database enum. can be a string.

We won't be having much changes around this enum, so it being enum in DB should be fine.

cc: @vspecky

Narayanbhat166 · 2024-01-11T12:15:38Z

If status is being changed to failed, then return a 200 with appropriate error_message and error_code. These fields should be populated in PaymentAttempt. You can take these up in the next immediate PR

Narayanbhat166 · 2024-01-11T11:41:40Z

crates/router/src/db/blocklist_lookup.rs

+        merchant_id: &str,
+        fingerprint: &str,
+    ) -> CustomResult<storage::BlocklistLookup, errors::StorageError> {
+        let conn = connection::pg_connection_write(self).await?;


pg_connection_read

Narayanbhat166 · 2024-01-11T11:55:09Z

crates/router/src/core/payments/operations/payment_confirm.rs

+        let merchant_id = payment_data.payment_attempt.merchant_id;
+        let merchant_fingerprint_secret =
+            blocklist_utils::get_merchant_fingerprint_secret(state, &merchant_id).await?;


Move all of the blocklist logic to a separate function.

Narayanbhat166 · 2024-01-11T11:59:17Z

crates/router/src/core/payments/operations/payment_confirm.rs

+                &merchant_id,
+                card_number_fingerprint,
+            ));
+        }
+


Combine all of these queries in a single query. You can use the WHERE IN sql clause.

…-router * 'main' of github.com:juspay/hyperswitch: (84 commits) chore(config): add merchant_secret config for webhooks for cashtocode and volt in wasm dashboard (#3333) chore(version): 2024.01.12.0 fix: update amount_capturable based on intent_status and payment flow (#3278) feat: add support for card extended bin in payment attempt (#3312) feat(connector): [cybersource] Implement 3DS flow for cards (#3290) chore: remove connector auth TOML files from `.gitignore` and `.dockerignore` (#3330) fix(refund): add merchant_connector_id in refund (#3303) feat(connector): [BOA/CYB] Store AVS response in connector_metadata (#3271) feat(outgoingwebhookevent): adding api for query to fetch outgoing webhook events log (#3310) feat(router): payment_method block (#3056) feat(connector): [Volt] Add support for refund webhooks (#3326) feat(users): invite user without email (#3328) feat(euclid_wasm): config changes for NMI (#3329) refactor(router): restricted list payment method Customer to api-key based (#3100) feat(connector): [BOA/Cyb] Include merchant metadata in capture and void requests (#3308) fix(router): add config to avoid connector tokenization for `apple pay` `simplified flow` (#3234) refactor(router): flagged order_details validation to skip validation (#3116) fix(core): surcharge with saved card failure (#3318) feat(payment_link): Added sdk layout option payment link (#3207) chore(version): 2024.01.11.0 ...

* 'main' of github.com:juspay/hyperswitch: (22 commits) chore(version): 2024.01.12.1 chore: add api reference for blocklist (#3336) chore(config): add merchant_secret config for webhooks for cashtocode and volt in wasm dashboard (#3333) chore(version): 2024.01.12.0 fix: update amount_capturable based on intent_status and payment flow (#3278) feat: add support for card extended bin in payment attempt (#3312) feat(connector): [cybersource] Implement 3DS flow for cards (#3290) chore: remove connector auth TOML files from `.gitignore` and `.dockerignore` (#3330) fix(refund): add merchant_connector_id in refund (#3303) feat(connector): [BOA/CYB] Store AVS response in connector_metadata (#3271) feat(outgoingwebhookevent): adding api for query to fetch outgoing webhook events log (#3310) feat(router): payment_method block (#3056) feat(connector): [Volt] Add support for refund webhooks (#3326) feat(users): invite user without email (#3328) feat(euclid_wasm): config changes for NMI (#3329) refactor(router): restricted list payment method Customer to api-key based (#3100) feat(connector): [BOA/Cyb] Include merchant metadata in capture and void requests (#3308) fix(router): add config to avoid connector tokenization for `apple pay` `simplified flow` (#3234) refactor(router): flagged order_details validation to skip validation (#3116) fix(core): surcharge with saved card failure (#3318) ...

prajjwalkumar17 · 2024-01-19T06:23:47Z

If status is being changed to failed, then return a 200 with appropriate error_message and error_code. These fields should be populated in PaymentAttempt. You can take these up in the next immediate PR

All the comments are addressed in this PR :)

chore: updated main

779b1b0

prajjwalkumar17 self-assigned this Dec 5, 2023

prajjwalkumar17 requested a review from a team as a code owner December 5, 2023 11:57

prajjwalkumar17 marked this pull request as draft December 5, 2023 11:57

prajjwalkumar17 and others added 9 commits December 5, 2023 17:27

Merge branch 'main' into feat/block_paymentmethod

896c755

feat(router): block card block route init

248f39d

Merge branch 'feat/block_paymentmethod' of https://github.com/juspay/…

b3665d7

…hyperswitch into feat/block_paymentmethod

chore: run formatter

d434bf2

chore: pull schema.rs from main

0348d18

Merge branch 'feat/block_paymentmethod' of https://github.com/juspay/…

ee32675

…hyperswitch into feat/block_paymentmethod

chore: added the card fingerprint generation in payment confirm's upd…

bdbb6b5

…ate tracker

Merge branch 'main' into feat/block_paymentmethod

bc0a0d2

chore: run formatter

797a538

SanchithHegde changed the title ~~feat(router): pament_method block~~ feat(router): payment_method block Dec 11, 2023

prajjwalkumar17 and others added 15 commits December 12, 2023 17:13

chore: add new tables pm_blocklist and pm_fingerprints and a new colo…

ac19744

…umn fingerprint_id in payment attempt

chore: run formatter

8715fbf

chore: block, unblock & blocklist api working with 2 tables up namely…

ddcdc74

… pm_fingerprint, pm_hash

Merge branch 'feat/block_paymentmethod' of https://github.com/juspay/…

7dee9c9

…hyperswitch into feat/block_paymentmethod

Merge branch 'main' into feat/block_paymentmethod

4558f4d

chore: run formatter

3133fc8

chore: complete interfacing of blocklist_lookup table

e6bd5c6

chore: run formatter

84014ef

chore: complete flow working without kms encryptions

ee8386d

chore: merge main

3b6af11

chore: run formatter

560a8eb

docs(openapi): re-generate OpenAPI specification

0c76254

chore: refactored the response

077f88f

chore: merge main

ec5368a

chore: run formatter

d177c09

prajjwalkumar17 commented Dec 28, 2023

View reviewed changes

crates/router/src/core/payments/operations/payment_confirm.rs Outdated Show resolved Hide resolved

crates/router/src/routes/app.rs Outdated Show resolved Hide resolved

vspecky added 2 commits January 11, 2024 01:40

refactor(router): refactor the blocklist feature with quality of life…

ed791f6

… improvements and succinction

fix(router): remove redundant feature flag

767cce6

prajjwalkumar17 requested a review from vspecky January 10, 2024 22:59

refactor(router): remove redundant code for blocklist

91a5711

vspecky previously approved these changes Jan 11, 2024

View reviewed changes

refactor(router): update flow name and permissions for blocklist APIs

947d197

vspecky dismissed their stale review via 947d197 January 11, 2024 07:11

vspecky previously approved these changes Jan 11, 2024

View reviewed changes

Merge branch 'main' into feat/block_paymentmethod

18e5d31

prajjwalkumar17 dismissed vspecky’s stale review via 18e5d31 January 11, 2024 08:04

refactor(router): changed the read permissions

5864ae1

prajjwalkumar17 requested a review from vspecky January 11, 2024 10:48

vspecky approved these changes Jan 11, 2024

View reviewed changes

racnan approved these changes Jan 11, 2024

View reviewed changes

Narayanbhat166 reviewed Jan 11, 2024

View reviewed changes

Narayanbhat166 approved these changes Jan 11, 2024

View reviewed changes

Gnanasundari24 added this pull request to the merge queue Jan 11, 2024

Merged via the queue into main with commit bb09613 Jan 11, 2024
9 of 11 checks passed

Gnanasundari24 deleted the feat/block_paymentmethod branch January 11, 2024 12:42

prajjwalkumar17 removed S-waiting-on-review Status: This PR has been implemented and needs to be reviewed R-waiting-on-L1 Review: Waiting on L1 reviewer R-waiting-on-L2 Review: Waiting on L2 reviewer labels Jan 11, 2024

prajjwalkumar17 mentioned this pull request Jan 12, 2024

chore: add api reference for blocklist #3336

Merged

15 tasks

prajjwalkumar17 changed the title ~~feat(router): payment_method block~~ feat(router): blocklist Jan 24, 2024

prajjwalkumar17 linked an issue Jan 24, 2024 that may be closed by this pull request

[FEATURE] Blocklist initial implementation #3439

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(router): blocklist #3056

feat(router): blocklist #3056

prajjwalkumar17 commented Dec 5, 2023 •

edited by vspecky

Loading

Narayanbhat166 Jan 11, 2024

prajjwalkumar17 Jan 18, 2024

Narayanbhat166 commented Jan 11, 2024

Narayanbhat166 Jan 11, 2024

Narayanbhat166 Jan 11, 2024

Narayanbhat166 Jan 11, 2024

prajjwalkumar17 commented Jan 19, 2024

feat(router): blocklist #3056

feat(router): blocklist #3056

Conversation

prajjwalkumar17 commented Dec 5, 2023 • edited by vspecky Loading

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

Narayanbhat166 Jan 11, 2024

Choose a reason for hiding this comment

prajjwalkumar17 Jan 18, 2024

Choose a reason for hiding this comment

Narayanbhat166 commented Jan 11, 2024

Narayanbhat166 Jan 11, 2024

Choose a reason for hiding this comment

Narayanbhat166 Jan 11, 2024

Choose a reason for hiding this comment

Narayanbhat166 Jan 11, 2024

Choose a reason for hiding this comment

prajjwalkumar17 commented Jan 19, 2024

prajjwalkumar17 commented Dec 5, 2023 •

edited by vspecky

Loading