feat(payments): Add audit events for PaymentUpdate update

[Rutam21]

Type of Change

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

Description

This PR adds an Audit event for the PaymentUpdate operation.

Additional Changes

• This PR modifies the files below

• crates/router/src/core/payments/operations/payment_update.rs

• crates/router/src/events/audit_events.rs

Motivation and Context

This PR fixes #4682

How did you test it

• Hit the Payments - Create endpoint.
  Make a payment with "confirm": false

curl --location 'http://localhost:8080/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: dev_LZcIA7XeMpnK5satp4CDvjcnHCaeKTBcosyuBBJaknZu1odhFo96cwS0nSdfzuJF' \
--data-raw '{
    "amount": 6540,
    "currency": "USD",
    "confirm": false,
    "capture_method": "automatic",
    "capture_on": "2022-09-10T10:11:12Z",
    "amount_to_capture": 6540,
    "customer_id": "StripeCustomer",
    "email": "[email protected]",
    "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",
    "payment_method": "card",
    "payment_method_type": "credit",
    "payment_method_data": {
        "card": {
            "card_number": "4242424242424242",
            "card_exp_month": "10",
            "card_exp_year": "25",
            "card_holder_name": "joseph Doe",
            "card_cvc": "123"
        }
    },
    "billing": {
        "address": {
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "city": "San Fransico",
            "state": "California",
            "zip": "94122",
            "country": "US",
            "first_name": "joseph",
            "last_name": "Doe"
        },
        "phone": {
            "number": "8056594427",
            "country_code": "+91"
        }
    },
    "shipping": {
        "address": {
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "city": "San Fransico",
            "state": "California",
            "zip": "94122",
            "country": "US",
            "first_name": "joseph",
            "last_name": "Doe"
        },
        "phone": {
            "number": "8056594427",
            "country_code": "+91"
        }
    },
    "statement_descriptor_name": "joseph",
    "statement_descriptor_suffix": "JS",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    },
    "profile_id": "pro_v5sFoHe80OeiUlIonocM"
}'

• Now hit the Payments - Update endpoint.

{
  "amount": 20000,
  "currency": "SGD",
  "confirm": false,
  "capture_method": "automatic",
  "capture_on": "2022-09-10T10:11:12Z",
  "amount_to_capture": 20000,
  "email": "[email protected]",
  "name": "joseph Doe",
  "phone": "8888888888",
  "phone_country_code": "+65",
  "description": "Its my first payment request",
  "authentication_type": "no_three_ds",
  "payment_method": "card",
  "return_url": "https://google.com",
  "payment_method_data": {
    "card": {
      "card_number": "4242424242424242",
      "card_exp_month": "10",
      "card_exp_year": "25",
      "card_holder_name": "joseph Doe",
      "card_cvc": "123"
    }
  },
   "billing": {
        "address": {
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "city": "San Fransico",
            "state": "California",
            "zip": "94122",
            "country": "US"
        }
    },
    "shipping": {
        "address": {
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "city": "San Fransico",
            "state": "California",
            "zip": "94122",
            "country": "US"
        }
    },
  "statement_descriptor_name": "joseph",
  "statement_descriptor_suffix": "JS",
  "metadata": {
    "udf1": "value1",
    "new_customer": "true",
    "login_date": "2019-09-10T10:11:12Z"
  }
}

Audit log will get generated and can be viewed in hyperswitch-audit-events topic in kafka with PaymentUpdate event-type.
Amount parameter can be verified in the event.

Now payment can be completed by hitting the Payments - Confirm endpoint.

Checklist

• I formatted the code cargo +nightly fmt --all
• I addressed lints thrown by cargo clippy
• I reviewed the submitted code

[semanticdiff-com]

Review changes with  

Changed Files

File	Status
crates/router/src/core/payments/operations/payment_update.rs	0% smaller
crates/router/src/events/audit_events.rs	0% smaller

[Rutam21]

Please review and suggest changes, if any.

cc: @Isampras @ShivanshMathurJuspay @ivor11

[lsampras]

Hey @Rutam21 ,
Can you share the event json or a screenshot of the event,
Can refer to pr #4166 for reference.

[Rutam21]

@lsampras I checked #4166, can you please point me out how I can get a event screenhsot or event json for this update? It seems like you were using something similar to Postman to hit the API endpoint. If you could please let me know the steps, I would follow along and update.

[maverox]

@lsampras I checked #4166, can you please point me out how I can get a event screenhsot or event json for this update? It seems like you were using something similar to Postman to hit the API endpoint. If you could please let me know the steps, I would follow along and update.

For the UI in this screenshot, you can find the docs to set up Kafka, kafka-ui (the interface in the screenshot) and ClickHouse using Docker Compose here: https://github.com/juspay/hyperswitch/tree/main/crates/analytics/docs

and then try generating said events and monitor logs in kafka-ui.

Also the docs are self-explanatory but still if in any doubt ping us in this slack channel

[gorakhnathy7]

Hey @Rutam21 Any updates.

[Rutam21]

@maverox I tried updating the respective toml files and then starting the app using docker-compose. But this errors out while starting the hyperswitch-server-1. Please let me know if there are some additional settings that I am missing here. Thanks.

cc: @gorakhnathy7

[maverox]

@maverox I tried updating the respective toml files and then starting the app using docker-compose. But this errors out while starting the hyperswitch-server-1. Please let me know if there are some additional settings that I am missing here. Thanks.

cc: @gorakhnathy7

hey bro this happens with me as well when i am running the server locally (not containerized)
basically if you do

cargo r

so if your server is running and all these other containers are running as well there shouldn't be any problem try
going to any of the analytics services
kafka-ui or clickhouse playground

make some payments using the api or dashboard and check for new logs there.

[Rutam21]

@tsdk02 I will push another commit to add the amount parameter. Thanks for the suggestion.

[tsdk02]

Hey @Rutam21, a gentle reminder to add the suggested changes to this PR, so it can be merged.

[Rutam21]

@tsdk02 I have added the amount parameter to the audit event. Let me know if this looks good. Thanks.

[Rutam21]

@tsdk02 Please review and suggest changes, if any. Thanks.

[Rutam21]

The merge conflict is resolved and the branch is updated.

Please review, approve and add to the merge queue. Thanks.

cc: @Chethan-rao @tsdk02 @likhinbopanna