-
Notifications
You must be signed in to change notification settings - Fork 1.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: Api reference docs update for Payments - Create #4955
Merged
Gnanasundari24
merged 25 commits into
main
from
Api-reference-docs-update-payment-create
Jun 28, 2024
Merged
Changes from all commits
Commits
Show all changes
25 commits
Select commit
Hold shift + click to select a range
2c791f5
docs: openapi changes for Payments-Create
aedffd7
Payment-create-api-reference changes
13354fa
docs(openapi): re-generate OpenAPI specification
hyperswitch-bot[bot] c7aa077
Corrections based on first review
gorakhnathy7 2458c46
Payments-create and Payments-Response- Final
gorakhnathy7 e6a72dc
chore: run formatter
hyperswitch-bot[bot] e186350
docs(openapi): re-generate OpenAPI specification
hyperswitch-bot[bot] 24fcc3d
Final Changes for Payments Module
gorakhnathy7 0a673ad
docs(openapi): re-generate OpenAPI specification
hyperswitch-bot[bot] 7562637
Removing duplicate the Openapi/spec.json file
gorakhnathy7 c4f9626
few removals of the outdated fields
gorakhnathy7 bfcfabc
Updated schema to get custom response
gorakhnathy7 d6c026a
Updated schema to get custom response
gorakhnathy7 5a5937d
chore: run formatter
hyperswitch-bot[bot] 8258a70
Update crates/api_models/src/payments.rs
gorakhnathy7 542fa52
Update crates/api_models/src/payments.rs
gorakhnathy7 34d623d
Update crates/api_models/src/payments.rs
gorakhnathy7 9f33045
Update crates/api_models/src/payments.rs
gorakhnathy7 9d8dec8
Update crates/common_enums/src/enums.rs
gorakhnathy7 1178905
Update crates/api_models/src/payments.rs
gorakhnathy7 245913d
docs(openapi): re-generate OpenAPI specification
hyperswitch-bot[bot] ff2ab6b
Merge branch 'main' into Api-reference-docs-update-payment-create
gorakhnathy7 5da110d
docs(openapi): re-generate OpenAPI specification
hyperswitch-bot[bot] 0cfe34c
Merge branch 'main' into Api-reference-docs-update-payment-create
gorakhnathy7 151a1f9
Resolved conflicts.
gorakhnathy7 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -572,6 +572,7 @@ mod test { | |
} | ||
} | ||
|
||
/// Denotes the retry action | ||
#[derive( | ||
Debug, | ||
serde::Deserialize, | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,6 +19,7 @@ pub mod diesel_exports { | |
}; | ||
} | ||
|
||
/// The status of the attempt | ||
#[derive( | ||
Clone, | ||
Copy, | ||
|
@@ -205,6 +206,7 @@ impl AttemptStatus { | |
} | ||
} | ||
|
||
/// Pass this parameter to force 3DS or non 3DS auth for this payment. Some connectors will still force 3DS auth even in case of passing 'no_three_ds' here and vice versa. Default value is 'no_three_ds' if not set | ||
#[derive( | ||
Clone, | ||
Copy, | ||
|
@@ -232,6 +234,7 @@ pub enum AuthenticationType { | |
NoThreeDs, | ||
} | ||
|
||
/// The status of the capture | ||
#[derive( | ||
Clone, | ||
Copy, | ||
|
@@ -308,6 +311,7 @@ pub enum BlocklistDataKind { | |
ExtendedCardBin, | ||
} | ||
|
||
/// Default value if not passed is set to 'automatic' which results in Auth and Capture in one single API request. Pass 'manual' or 'manual_multiple' in case you want do a separate Auth and Capture by first authorizing and placing a hold on your customer's funds so that you can use the Payments/Capture endpoint later to capture the authorized amount. Pass 'manual' if you want to only capture the amount later once or 'manual_multiple' if you want to capture the funds multiple times later. Both 'manual' and 'manual_multiple' are only supported by a specific list of processors | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We can have a macro do this for us. If you want to do this manually then can you create this as a list so that the statuses are much more readable |
||
#[derive( | ||
Clone, | ||
Copy, | ||
|
@@ -1164,6 +1168,7 @@ pub enum MerchantStorageScheme { | |
RedisKv, | ||
} | ||
|
||
/// The status of the current payment that was made | ||
#[derive( | ||
Clone, | ||
Copy, | ||
|
@@ -1197,6 +1202,7 @@ pub enum IntentStatus { | |
PartiallyCapturedAndCapturable, | ||
} | ||
|
||
/// Indicates that you intend to make future payments with this Payment’s payment method. Providing this parameter will attach the payment method to the Customer, if present, after the Payment is confirmed and any required actions from the user are complete. | ||
#[derive( | ||
Clone, | ||
Copy, | ||
|
@@ -1251,6 +1257,7 @@ pub enum PaymentMethodIssuerCode { | |
JpBacs, | ||
} | ||
|
||
/// Payment Method Status | ||
#[derive( | ||
Clone, | ||
Copy, | ||
|
@@ -1603,6 +1610,7 @@ pub enum CardNetwork { | |
Maestro, | ||
} | ||
|
||
/// Stage of the dispute | ||
#[derive( | ||
Clone, | ||
Copy, | ||
|
@@ -1627,6 +1635,7 @@ pub enum DisputeStage { | |
PreArbitration, | ||
} | ||
|
||
/// Status of the dispute | ||
#[derive( | ||
Clone, | ||
Debug, | ||
|
@@ -2499,6 +2508,7 @@ pub enum RoleScope { | |
Organization, | ||
} | ||
|
||
/// Indicates the transaction status | ||
#[derive( | ||
Clone, | ||
Default, | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This field can be removed in all the three requests from the api ref