feat(recovery-events): add revenue recovery topic and vector config to push these events to s3

[NISHANTH1221]

Type of Change

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

Description

This new Kafka Event consume the revenue recovery related events which will be constructed from both RecoveryPaymentIntent and RecoveryPaymentAttempt in revenue recovery flow. The events form Kafka will be picked up by vector and this be eventually batched and pushed to s3 based on the set config. They file path will look like this merchant_id/Year/month/timestamp.csv.

The events will be recorded at two places. Webhook Flow(External Payments done by billing processor) and Internal Proxy Flow(Internal Done by Hyperswitch as a part of retrying). The event structure is mentioned in the kafka message in code.

The estimated size of each event is around 1000bytes. We want to keep the config at 1000 batches and one day(86400s) timeout in vector. So that vector collects all the events till the end of the time out or till it hits 1000 events and push them to s3 file in the designated file path in a csv format in the order mentioned in the config. Based on the above config vector needs 10mb size buffer to support this. S3 auth will be done using the IAM Instance profile which will be taken care off at the time of the deployment.

Additional Changes

• [ ] This PR modifies the API contract
• [ ] This PR modifies the database schema
• [x] This PR modifies application configuration/environment variables

Motivation and Context

As for the Revenue Recovery System we needed a pipeline which can move transaction based data to s3 where we store the entire transactional data which can be further used to train models. The transactional data consists of various parameters from both payment intent and payment attempt. So we created a new topic to facilitate this requirement.

How did you test it?

Follow the steps in this pr #7461 and check the kafka topic. The following will be the corresponding event in kafka:

{
	"merchant_id": "cloth_seller_W0fAQDHthn7eTr67bDfX",
	"invoice_id": "in_1RYjqzRpLdtbmMLFdyCVlIzm",
	"invoice_amount": 1000,
	"invoice_currency": "USD",
	"invoice_due_date": "2025-07-18 18:30:00.0",
	"invoice_date": "2025-06-11 08:18:01.944737",
	"billing_state": "Alaska City",
	"billing_country": "US",
	"billing_city": "Alaska",
	"attempt_id": "12345_att_01975e141dd378b3a402d27fca3be911",
	"attempt_amount": 1000,
	"attempt_currency": "USD",
	"attempt_status": "failure",
	"pg_error_code": "card_declined",
	"network_advice_code": null,
	"network_error_code": null,
	"first_pg_error_code": "card_declined",
	"first_network_advice_code": null,
	"first_network_error_code": null,
	"attempt_created_at": "2025-06-11 08:18:01.944737",
	"payment_method_type": "card",
	"payment_method_subtype": "credit",
	"card_network": "Visa",
	"card_issuer": null,
	"retry_count": 4,
	"payment_gateway": "stripe"
}

Here is the S3 File Path:

Here is the AWS File sample

Checklist

• [x] I formatted the code cargo +nightly fmt --all
• [x] I addressed lints thrown by cargo clippy
• [x] I reviewed the submitted code
• [ ] I added unit tests for my changes where possible

[semanticdiff-com[bot]]

Review changes with  

Changed Files

File	Status
crates/openapi/src/openapi_v2.rs	20% smaller
crates/hyperswitch_domain_models/src/revenue_recovery.rs	9% smaller
crates/router/src/core/revenue_recovery/types.rs	8% smaller
crates/router/src/core/webhooks/recovery_incoming.rs	5% smaller
api-reference/v2/openapi_spec_v2.json	4% smaller
config/vector.yaml	2% smaller
crates/router/src/core/payments/transformers.rs	1% smaller
config/config.example.toml	Unsupported file format
config/deployments/env_specific.toml	Unsupported file format
config/development.toml	Unsupported file format
config/docker_compose.toml	Unsupported file format
crates/api_models/src/payments.rs	0% smaller
crates/diesel_models/src/types.rs	0% smaller
crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs	0% smaller
crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs	0% smaller
crates/hyperswitch_domain_models/src/lib.rs	0% smaller
crates/hyperswitch_domain_models/src/payments.rs	0% smaller
crates/hyperswitch_domain_models/src/payments/payment_attempt.rs	0% smaller
crates/router/src/events.rs	0% smaller
crates/router/src/services/kafka.rs	0% smaller
crates/router/src/services/kafka/revenue_recovery.rs	0% smaller
crates/storage_impl/src/errors.rs	0% smaller

[srujanchikke]

@NISHANTH1221 Please make sure s3 bucket is created for sandbox or integ env before deployment.

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[tsdk02]

Pls check the masking of certain fields like billing_city, billing_state and billing_country when sending the events from kafka to S3, to prevent leaking any sensitive data.

cc: @su-shivanshmathur

[NISHANTH1221]

Pls check the masking of certain fields like billing_city, billing_state and billing_country when sending the events from kafka to S3, to prevent leaking any sensitive data.

cc: @su-shivanshmathur

I have been told that its ok to store the billing city, state and country in raw format since we wont have any customer related information. On top of that I have removed the attempt id and invoice id so that there would be no reference between a transaction and kafka message or our record in s3. cc: @bernard-eugine