Skip to content
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.

Sign up for GitHub

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

Jump to bottom

feat(payments_v2): implement payments capture v2 #6722

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
+1,888 −284
Draft

feat(payments_v2): implement payments capture v2 #6722

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b9ff053
feat(payments_v2): implement payments capture v2
Narayanbhat166 Dec 2, 2024
8874a1d
Merge branch 'main' into payments_capture_v2
Narayanbhat166 Dec 2, 2024
ff28a6c
docs(openapi): re-generate OpenAPI specification
hyperswitch-bot[bot] Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
202 changes: 86 additions & 116 deletions api-reference-v2/openapi_spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6121,88 +6121,6 @@
"greater_than_equal"
]
},
"ConfirmIntentAmountDetailsResponse": {
"type": "object",
"required": [
"currency",
"skip_external_tax_calculation",
"skip_surcharge_calculation",
"net_amount",
"amount_capturable"
],
"properties": {
"order_amount": {
"type": "integer",
"format": "int64",
"description": "The payment amount. Amount for the payment in the lowest denomination of the currency, (i.e) in cents for USD denomination, in yen for JPY denomination etc. E.g., Pass 100 to charge $1.00 and 1 for 1¥ since ¥ is a zero-decimal currency. Read more about [the Decimal and Non-Decimal Currencies](https://github.com/juspay/hyperswitch/wiki/Decimal-and-Non%E2%80%90Decimal-Currencies)",
"example": 6540,
"minimum": 0
},
"currency": {
"$ref": "#/components/schemas/Currency"
},
"shipping_cost": {
"allOf": [
{
"$ref": "#/components/schemas/MinorUnit"
}
],
"nullable": true
},
"order_tax_amount": {
"allOf": [
{
"$ref": "#/components/schemas/MinorUnit"
}
],
"nullable": true
},
"skip_external_tax_calculation": {
"$ref": "#/components/schemas/TaxCalculationOverride"
},
"skip_surcharge_calculation": {
"$ref": "#/components/schemas/SurchargeCalculationOverride"
},
"surcharge_amount": {
"allOf": [
{
"$ref": "#/components/schemas/MinorUnit"
}
],
"nullable": true
},
"tax_on_surcharge": {
"allOf": [
{
"$ref": "#/components/schemas/MinorUnit"
}
],
"nullable": true
},
"net_amount": {
"$ref": "#/components/schemas/MinorUnit"
},
"amount_to_capture": {
"allOf": [
{
"$ref": "#/components/schemas/MinorUnit"
}
],
"nullable": true
},
"amount_capturable": {
"$ref": "#/components/schemas/MinorUnit"
},
"amount_captured": {
"allOf": [
{
"$ref": "#/components/schemas/MinorUnit"
}
],
"nullable": true
}
}
},
"Connector": {
"type": "string",
"description": "A connector is an integration to fulfill payments",
Expand Down Expand Up @@ -12044,6 +11962,88 @@
}
}
},
"PaymentAmountDetailsResponse": {
"type": "object",
"required": [
"currency",
"skip_external_tax_calculation",
"skip_surcharge_calculation",
"net_amount",
"amount_capturable"
],
"properties": {
"order_amount": {
"type": "integer",
"format": "int64",
"description": "The payment amount. Amount for the payment in the lowest denomination of the currency, (i.e) in cents for USD denomination, in yen for JPY denomination etc. E.g., Pass 100 to charge $1.00 and 1 for 1¥ since ¥ is a zero-decimal currency. Read more about [the Decimal and Non-Decimal Currencies](https://github.com/juspay/hyperswitch/wiki/Decimal-and-Non%E2%80%90Decimal-Currencies)",
"example": 6540,
"minimum": 0
},
"currency": {
"$ref": "#/components/schemas/Currency"
},
"shipping_cost": {
"allOf": [
{
"$ref": "#/components/schemas/MinorUnit"
}
],
"nullable": true
},
"order_tax_amount": {
"allOf": [
{
"$ref": "#/components/schemas/MinorUnit"
}
],
"nullable": true
},
"skip_external_tax_calculation": {
"$ref": "#/components/schemas/TaxCalculationOverride"
},
"skip_surcharge_calculation": {
"$ref": "#/components/schemas/SurchargeCalculationOverride"
},
"surcharge_amount": {
"allOf": [
{
"$ref": "#/components/schemas/MinorUnit"
}
],
"nullable": true
},
"tax_on_surcharge": {
"allOf": [
{
"$ref": "#/components/schemas/MinorUnit"
}
],
"nullable": true
},
"net_amount": {
"$ref": "#/components/schemas/MinorUnit"
},
"amount_to_capture": {
"allOf": [
{
"$ref": "#/components/schemas/MinorUnit"
}
],
"nullable": true
},
"amount_capturable": {
"$ref": "#/components/schemas/MinorUnit"
},
"amount_captured": {
"allOf": [
{
"$ref": "#/components/schemas/MinorUnit"
}
],
"nullable": true
}
}
},
"PaymentAttemptResponse": {
"type": "object",
"required": [
Expand Down Expand Up @@ -13869,42 +13869,12 @@
},
"PaymentsCaptureRequest": {
"type": "object",
"required": [
"amount_to_capture"
],
"properties": {
"merchant_id": {
"type": "string",
"description": "The unique identifier for the merchant",
"nullable": true
},
"amount_to_capture": {
"type": "integer",
"format": "int64",
"description": "The Amount to be captured/ debited from the user's payment method.",
"example": 6540
},
"refund_uncaptured_amount": {
"type": "boolean",
"description": "Decider to refund the uncaptured amount",
"nullable": true
},
"statement_descriptor_suffix": {
"type": "string",
"description": "Provides information about a card payment that customers see on their statements.",
"nullable": true
},
"statement_descriptor_prefix": {
"type": "string",
"description": "Concatenated with the statement descriptor suffix that’s set on the account to form the complete statement descriptor.",
"nullable": true
},
"merchant_connector_details": {
"allOf": [
{
"$ref": "#/components/schemas/MerchantConnectorDetailsWrap"
}
],
"description": "The Amount to be captured/ debited from the user's payment method. If not passed the full amount will be captured.",
"example": 6540,
"nullable": true
}
}
Expand Down Expand Up @@ -14006,7 +13976,7 @@
"$ref": "#/components/schemas/IntentStatus"
},
"amount": {
"$ref": "#/components/schemas/ConfirmIntentAmountDetailsResponse"
"$ref": "#/components/schemas/PaymentAmountDetailsResponse"
},
"connector": {
"type": "string",
Expand Down Expand Up @@ -15742,7 +15712,7 @@
"$ref": "#/components/schemas/IntentStatus"
},
"amount": {
"$ref": "#/components/schemas/ConfirmIntentAmountDetailsResponse"
"$ref": "#/components/schemas/PaymentAmountDetailsResponse"
},
"connector": {
"type": "string",
Expand Down
2 changes: 1 addition & 1 deletion api-reference/openapi_spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16643,7 +16643,7 @@
"amount_to_capture": {
"type": "integer",
"format": "int64",
"description": "The Amount to be captured/ debited from the user's payment method.",
"description": "The Amount to be captured/ debited from the user's payment method. If not passed the full amount will be captured.",
"example": 6540
},
"refund_uncaptured_amount": {
Expand Down
10 changes: 10 additions & 0 deletions crates/api_models/src/events/payment.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ use crate::payment_methods::CustomerPaymentMethodsListResponse;
#[cfg(all(feature = "v2", feature = "payment_methods_v2"))]
use crate::payment_methods::CustomerPaymentMethodsListResponse;
use crate::{
events,
payment_methods::{
CustomerDefaultPaymentMethodResponse, DefaultPaymentMethod, ListCountriesCurrenciesRequest,
ListCountriesCurrenciesResponse, PaymentMethodCollectLinkRenderRequest,
Expand Down Expand Up @@ -418,3 +419,12 @@ impl ApiEventMetric for PaymentStartRedirectionRequest {
})
}
}

#[cfg(feature = "v2")]
impl ApiEventMetric for events::PaymentsCaptureResponse {
fn get_api_event_type(&self) -> Option<ApiEventsType> {
Some(ApiEventsType::Payment {
payment_id: self.id.clone(),
})
}
}
31 changes: 27 additions & 4 deletions crates/api_models/src/payments.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -488,7 +488,7 @@ pub struct AmountDetailsResponse {

#[cfg(feature = "v2")]
#[derive(Clone, Debug, PartialEq, serde::Serialize, ToSchema)]
pub struct ConfirmIntentAmountDetailsResponse {
pub struct PaymentAmountDetailsResponse {
/// The payment amount. Amount for the payment in the lowest denomination of the currency, (i.e) in cents for USD denomination, in yen for JPY denomination etc. E.g., Pass 100 to charge $1.00 and 1 for 1¥ since ¥ is a zero-decimal currency. Read more about [the Decimal and Non-Decimal Currencies](https://github.com/juspay/hyperswitch/wiki/Decimal-and-Non%E2%80%90Decimal-Currencies)
#[schema(value_type = u64, example = 6540)]
#[serde(default, deserialize_with = "amount::deserialize")]
Expand Down Expand Up @@ -3891,6 +3891,7 @@ pub struct PhoneDetails {
pub country_code: Option<String>,
}

#[cfg(feature = "v1")]
#[derive(Debug, Clone, Default, Eq, PartialEq, serde::Deserialize, serde::Serialize, ToSchema)]
pub struct PaymentsCaptureRequest {
/// The unique identifier for the payment
Expand All @@ -3899,7 +3900,7 @@ pub struct PaymentsCaptureRequest {
/// The unique identifier for the merchant
#[schema(value_type = Option<String>)]
pub merchant_id: Option<id_type::MerchantId>,
/// The Amount to be captured/ debited from the user's payment method.
/// The Amount to be captured/ debited from the user's payment method. If not passed the full amount will be captured.
#[schema(value_type = i64, example = 6540)]
pub amount_to_capture: Option<MinorUnit>,
/// Decider to refund the uncaptured amount
Expand All @@ -3913,6 +3914,28 @@ pub struct PaymentsCaptureRequest {
pub merchant_connector_details: Option<admin::MerchantConnectorDetailsWrap>,
}

#[cfg(feature = "v2")]
#[derive(Debug, Clone, Default, Eq, PartialEq, serde::Deserialize, serde::Serialize, ToSchema)]
pub struct PaymentsCaptureRequest {
/// The Amount to be captured/ debited from the user's payment method. If not passed the full amount will be captured.
#[schema(value_type = Option<i64>, example = 6540)]
pub amount_to_capture: Option<MinorUnit>,
}

#[cfg(feature = "v2")]
#[derive(Debug, Clone, serde::Serialize, ToSchema)]
pub struct PaymentsCaptureResponse {
/// The unique identifier for the payment
pub id: id_type::GlobalPaymentId,

/// Amount details related to the payment
pub amount: PaymentAmountDetailsResponse,

/// Status of the payment
#[schema(value_type = IntentStatus, example = "succeeded")]
pub status: common_enums::IntentStatus,
}

#[derive(Default, Clone, Debug, Eq, PartialEq, serde::Serialize)]
pub struct UrlDetails {
pub url: String,
Expand Down Expand Up @@ -4615,7 +4638,7 @@ pub struct PaymentsConfirmIntentResponse {
pub status: api_enums::IntentStatus,

/// Amount related information for this payment and attempt
pub amount: ConfirmIntentAmountDetailsResponse,
pub amount: PaymentAmountDetailsResponse,

/// The connector used for the payment
#[schema(example = "stripe")]
Expand Down Expand Up @@ -4684,7 +4707,7 @@ pub struct PaymentsRetrieveResponse {
pub status: api_enums::IntentStatus,

/// Amount related information for this payment and attempt
pub amount: ConfirmIntentAmountDetailsResponse,
pub amount: PaymentAmountDetailsResponse,

/// The connector used for the payment
#[schema(example = "stripe")]
Expand Down
4 changes: 2 additions & 2 deletions crates/diesel_models/src/payment_attempt.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -754,7 +754,6 @@ pub enum PaymentAttemptUpdate {
#[derive(Clone, Debug, AsChangeset, router_derive::DebugAsDisplay)]
#[diesel(table_name = payment_attempt)]
pub struct PaymentAttemptUpdateInternal {
// net_amount: Option<MinorUnit>,
pub status: Option<storage_enums::AttemptStatus>,
// authentication_type: Option<storage_enums::AuthenticationType>,
pub error_message: Option<String>,
Expand All @@ -774,7 +773,8 @@ pub struct PaymentAttemptUpdateInternal {
// multiple_capture_count: Option<i16>,
// pub surcharge_amount: Option<MinorUnit>,
// tax_on_surcharge: Option<MinorUnit>,
// amount_capturable: Option<MinorUnit>,
pub amount_capturable: Option<MinorUnit>,
pub amount_to_capture: Option<MinorUnit>,
pub updated_by: String,
pub merchant_connector_id: Option<id_type::MerchantConnectorAccountId>,
pub connector: Option<String>,
Expand Down
Loading
Loading