juspay/hyperswitch

[FEATURE]: [Square] Use `connector_request_reference_id` as reference to the connector

Open

#2,318 opened on Sep 22, 2023

View on GitHub
 (15 comments) (0 reactions) (0 assignees)Rust (42,690 stars) (4,676 forks)batch import
A-connector-integrationC-featuregood first issuehacktoberfest

Description

:memo: Feature Description

  • We transmit our reference id from Hyperswitch to the connector, enabling merchants to subsequently locate the payment within the connector dashboard.
  • Presently, there is a lack of uniformity in this process, as some implementations employ payment_id while others utilize attempt_id.
  • This inconsistency arises from the fact that payment_id and attempt_id correspond to two distinct entities within our system.

:hammer: Possible Implementation

  • To mitigate this confusion, we've introduced a new field called connector_request_reference_id in our RouterData.
  • This id should replace them as a reference id to the connector for payment request.
  • One might need to have exposure to api docs of the connector for which it is being implemented.
  • You can check this PR for further reference https://github.com/juspay/hyperswitch/pull/2052

:bookmark: Note : All the changes needed should be contained within hyperswitch/crates/router/src/connector/

:package: Have you spent some time checking if this feature request has been raised before?

  • I checked and didn't find a similar issue

:package: Have you read the Contributing Guidelines?

:sparkles: Are you willing to submit a PR?

Contributor guide

Tech stack
rust
Domain
backendpayments
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Rust basicsfamiliarity with connector architectureunderstanding of Square API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue requires replacing existing reference IDs (payment id or attempt id) with the new connector request reference id in the Square connector. Start by examining the current implementation in hyperswitch/crates/router/src/connector/square/. Reference the linked PR #2052 for a similar implementation pattern. Ensure the change only affects the Square connector and aligns with the connector's API documentation.