juspay/hyperswitch

[FEATURE] Standardize `state` field in billing and shipping address

Open

#2,939 opened on Nov 21, 2023

View on GitHub
 (6 comments) (0 reactions) (1 assignee)Rust (4,676 forks)batch import
C-featuregood first issuehelp wanted

Repository metrics

Stars
 (42,690 stars)
PR merge metrics
 (Avg merge 8d 12h) (212 merged PRs in 30d)

Description

Feature Description

Currently, we accept the state field in both shipping and billing addresses as a string. However, in a few connectors like Cybersource, we have a mapping from state names to state codes. We propose standardizing the state field to accept only ISO 3166-2 codes (https://en.wikipedia.org/wiki/ISO_3166-2)

Possible Implementation

We can use some crate that helps in validating ISO 3166-2 codes and accept these codes in payment request

Contributor guide

Research direction
Review the current handling of state fields in billing/shipping addresses across connectors, especially Cybersource. Look at existing code in hyperswitch for address validation. Evaluate existing Rust crates for ISO 3166-2 validation (e.g., 'iso3166' or 'country' crate). Check if the crate is actively maintained and compatible with the project's dependencies. Then propose a plan to standardize the state field.
Tech stack
rust
Domain
backend
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.
Blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Basic Rust knowledgeUnderstanding of payment connectors
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35