id
stringlengths
20
153
type
stringclasses
1 value
granularity
stringclasses
14 values
content
stringlengths
16
84.3k
metadata
dict
hyperswitch_struct_api_models_3933660723864617778
clm
struct
// hyperswitch/crates/api_models/src/payment_methods.rs pub struct TokenizedBankTransferValue2 { pub customer_id: Option<id_type::CustomerId>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "TokenizedBankTransferValue2", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-4525604996330542690
clm
struct
// hyperswitch/crates/api_models/src/payment_methods.rs pub struct TokenizedBankRedirectValue1 { pub data: payments::BankRedirectData, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "TokenizedBankRedirectValue1", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-1767448482607497552
clm
struct
// hyperswitch/crates/api_models/src/payment_methods.rs pub struct TokenizedBankRedirectValue2 { pub customer_id: Option<id_type::CustomerId>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "TokenizedBankRedirectValue2", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_2560553604774550588
clm
struct
// hyperswitch/crates/api_models/src/payment_methods.rs pub struct PaymentMethodRecord { pub customer_id: id_type::CustomerId, pub name: Option<masking::Secret<String>>, pub email: Option<pii::Email>, pub phone: Option<masking::Secret<String>>, pub phone_country_code: Option<String>, pub merchant_id: Option<id_type::MerchantId>, pub payment_method: Option<api_enums::PaymentMethod>, pub payment_method_type: Option<api_enums::PaymentMethodType>, pub nick_name: Option<masking::Secret<String>>, pub payment_instrument_id: Option<masking::Secret<String>>, pub connector_customer_id: Option<String>, pub card_number_masked: masking::Secret<String>, pub card_expiry_month: masking::Secret<String>, pub card_expiry_year: masking::Secret<String>, pub card_scheme: Option<String>, pub original_transaction_id: Option<String>, pub billing_address_zip: Option<masking::Secret<String>>, pub billing_address_state: Option<masking::Secret<String>>, pub billing_address_first_name: Option<masking::Secret<String>>, pub billing_address_last_name: Option<masking::Secret<String>>, pub billing_address_city: Option<String>, pub billing_address_country: Option<api_enums::CountryAlpha2>, pub billing_address_line1: Option<masking::Secret<String>>, pub billing_address_line2: Option<masking::Secret<String>>, pub billing_address_line3: Option<masking::Secret<String>>, pub raw_card_number: Option<masking::Secret<String>>, pub merchant_connector_id: Option<id_type::MerchantConnectorAccountId>, pub merchant_connector_ids: Option<String>, pub original_transaction_amount: Option<i64>, pub original_transaction_currency: Option<common_enums::Currency>, pub line_number: Option<i64>, pub network_token_number: Option<CardNumber>, pub network_token_expiry_month: Option<masking::Secret<String>>, pub network_token_expiry_year: Option<masking::Secret<String>>, pub network_token_requestor_ref_id: Option<String>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PaymentMethodRecord", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-1273139774098399740
clm
struct
// hyperswitch/crates/api_models/src/payment_methods.rs pub struct UpdatePaymentMethodRecord { pub payment_method_id: String, pub status: Option<common_enums::PaymentMethodStatus>, pub network_transaction_id: Option<String>, pub line_number: Option<i64>, pub payment_instrument_id: Option<masking::Secret<String>>, pub connector_customer_id: Option<String>, pub merchant_connector_ids: Option<String>, pub card_expiry_month: Option<masking::Secret<String>>, pub card_expiry_year: Option<masking::Secret<String>>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "UpdatePaymentMethodRecord", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_7254734744391788388
clm
struct
// hyperswitch/crates/api_models/src/payment_methods.rs pub struct PaymentMethodUpdateResponse { pub payment_method_id: String, pub status: Option<common_enums::PaymentMethodStatus>, pub network_transaction_id: Option<String>, pub connector_mandate_details: Option<pii::SecretSerdeValue>, pub update_status: UpdateStatus, #[serde(skip_serializing_if = "Option::is_none")] pub update_error: Option<String>, pub updated_payment_method_data: Option<bool>, pub connector_customer: Option<pii::SecretSerdeValue>, pub line_number: Option<i64>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PaymentMethodUpdateResponse", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_5730921168451436745
clm
struct
// hyperswitch/crates/api_models/src/payment_methods.rs pub struct PaymentMethodMigrationResponse { pub line_number: Option<i64>, #[serde(skip_serializing_if = "Option::is_none")] pub payment_method_id: Option<String>, #[serde(skip_serializing_if = "Option::is_none")] pub payment_method: Option<api_enums::PaymentMethod>, #[serde(skip_serializing_if = "Option::is_none")] pub payment_method_type: Option<api_enums::PaymentMethodType>, pub customer_id: Option<id_type::CustomerId>, pub migration_status: MigrationStatus, #[serde(skip_serializing_if = "Option::is_none")] pub migration_error: Option<String>, pub card_number_masked: Option<masking::Secret<String>>, pub card_migrated: Option<bool>, pub network_token_migrated: Option<bool>, pub connector_mandate_details_migrated: Option<bool>, pub network_transaction_id_migrated: Option<bool>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PaymentMethodMigrationResponse", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_8629375156376823887
clm
struct
// hyperswitch/crates/api_models/src/payment_methods.rs pub struct CardNetworkTokenizeRequest { /// Merchant ID associated with the tokenization request #[schema(example = "merchant_1671528864", value_type = String)] pub merchant_id: id_type::MerchantId, /// Details of the card or payment method to be tokenized #[serde(flatten)] pub data: TokenizeDataRequest, /// Customer details #[schema(value_type = CustomerDetails)] pub customer: payments::CustomerDetails, /// The billing details of the payment method #[schema(value_type = Option<Address>)] pub billing: Option<payments::Address>, /// You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object. #[schema(value_type = Option<Object>, example = json!({ "city": "NY", "unit": "245" }))] pub metadata: Option<pii::SecretSerdeValue>, /// The name of the bank/ provider issuing the payment method to the end user pub payment_method_issuer: Option<String>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "CardNetworkTokenizeRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_5318930640728483715
clm
struct
// hyperswitch/crates/api_models/src/payment_methods.rs pub struct TokenizeCardRequest { /// Card Number #[schema(value_type = String, example = "4111111145551142")] pub raw_card_number: CardNumber, /// Card Expiry Month #[schema(value_type = String, example = "10")] pub card_expiry_month: masking::Secret<String>, /// Card Expiry Year #[schema(value_type = String, example = "25")] pub card_expiry_year: masking::Secret<String>, /// The CVC number for the card #[schema(value_type = Option<String>, example = "242")] pub card_cvc: Option<masking::Secret<String>>, /// Card Holder Name #[schema(value_type = Option<String>, example = "John Doe")] pub card_holder_name: Option<masking::Secret<String>>, /// Card Holder's Nick Name #[schema(value_type = Option<String>, example = "John Doe")] pub nick_name: Option<masking::Secret<String>>, /// Card Issuing Country pub card_issuing_country: Option<String>, /// Card's Network #[schema(value_type = Option<CardNetwork>)] pub card_network: Option<api_enums::CardNetwork>, /// Issuer Bank for Card pub card_issuer: Option<String>, /// Card Type pub card_type: Option<CardType>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "TokenizeCardRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_8927482229518797433
clm
struct
// hyperswitch/crates/api_models/src/payment_methods.rs pub struct TokenizePaymentMethodRequest { /// Payment method's ID #[serde(skip_deserializing)] pub payment_method_id: String, /// The CVC number for the card #[schema(value_type = Option<String>, example = "242")] pub card_cvc: Option<masking::Secret<String>>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "TokenizePaymentMethodRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_2673344081584444710
clm
struct
// hyperswitch/crates/api_models/src/payment_methods.rs pub struct CardNetworkTokenizeResponse { /// Response for payment method entry in DB pub payment_method_response: Option<PaymentMethodResponse>, /// Customer details #[schema(value_type = CustomerDetails)] pub customer: Option<payments::CustomerDetails>, /// Card network tokenization status pub card_tokenized: bool, /// Error code #[serde(skip_serializing_if = "Option::is_none")] pub error_code: Option<String>, /// Error message #[serde(skip_serializing_if = "Option::is_none")] pub error_message: Option<String>, /// Details that were sent for tokenization #[serde(skip_serializing_if = "Option::is_none")] pub tokenization_data: Option<TokenizeDataRequest>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "CardNetworkTokenizeResponse", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-6582028547181279795
clm
struct
// hyperswitch/crates/api_models/src/payment_methods.rs pub struct PaymentMethodSessionRequest { /// The customer id for which the payment methods session is to be created #[schema(value_type = String, example = "cus_y3oqhf46pyzuxjbcn2giaqnb44")] pub customer_id: id_type::GlobalCustomerId, /// The billing address details of the customer. This will also be used for any new payment methods added during the session #[schema(value_type = Option<Address>)] pub billing: Option<payments::Address>, /// The return url to which the customer should be redirected to after adding the payment method #[schema(value_type = Option<String>)] pub return_url: Option<common_utils::types::Url>, /// The tokenization type to be applied #[schema(value_type = Option<PspTokenization>)] pub psp_tokenization: Option<common_types::payment_methods::PspTokenization>, /// The network tokenization configuration if applicable #[schema(value_type = Option<NetworkTokenization>)] pub network_tokenization: Option<common_types::payment_methods::NetworkTokenization>, /// The time (seconds ) when the session will expire /// If not provided, the session will expire in 15 minutes #[schema(example = 900, default = 900)] pub expires_in: Option<u32>, /// Contains data to be passed on to tokenization service ( if present ) to create token_id for given JSON data #[schema(value_type = Option<serde_json::Value>)] pub tokenization_data: Option<pii::SecretSerdeValue>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PaymentMethodSessionRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_8152827986334369376
clm
struct
// hyperswitch/crates/api_models/src/payment_methods.rs pub struct PaymentMethodsSessionUpdateRequest { /// The billing address details of the customer. This will also be used for any new payment methods added during the session #[schema(value_type = Option<Address>)] pub billing: Option<payments::Address>, /// The tokenization type to be applied #[schema(value_type = Option<PspTokenization>)] pub psp_tokenization: Option<common_types::payment_methods::PspTokenization>, /// The network tokenization configuration if applicable #[schema(value_type = Option<NetworkTokenization>)] pub network_tokenization: Option<common_types::payment_methods::NetworkTokenization>, /// Contains data to be passed on to tokenization service ( if present ) to create token_id for given JSON data #[schema(value_type = Option<serde_json::Value>)] pub tokenization_data: Option<pii::SecretSerdeValue>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PaymentMethodsSessionUpdateRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_1659534104833881270
clm
struct
// hyperswitch/crates/api_models/src/payment_methods.rs pub struct PaymentMethodSessionUpdateSavedPaymentMethod { /// The payment method id of the payment method to be updated #[schema(value_type = String, example = "12345_pm_01926c58bc6e77c09e809964e72af8c8")] pub payment_method_id: id_type::GlobalPaymentMethodId, /// The update request for the payment method update #[serde(flatten)] pub payment_method_update_request: PaymentMethodUpdate, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PaymentMethodSessionUpdateSavedPaymentMethod", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_369654948472836390
clm
struct
// hyperswitch/crates/api_models/src/payment_methods.rs pub struct PaymentMethodSessionDeleteSavedPaymentMethod { /// The payment method id of the payment method to be updated #[schema(value_type = String, example = "12345_pm_01926c58bc6e77c09e809964e72af8c8")] pub payment_method_id: id_type::GlobalPaymentMethodId, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PaymentMethodSessionDeleteSavedPaymentMethod", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-706339609138254381
clm
struct
// hyperswitch/crates/api_models/src/payment_methods.rs pub struct PaymentMethodSessionConfirmRequest { /// The payment method type #[schema(value_type = PaymentMethod, example = "card")] pub payment_method_type: common_enums::PaymentMethod, /// The payment method subtype #[schema(value_type = PaymentMethodType, example = "google_pay")] pub payment_method_subtype: common_enums::PaymentMethodType, /// The payment instrument data to be used for the payment #[schema(value_type = PaymentMethodDataRequest)] pub payment_method_data: payments::PaymentMethodDataRequest, /// The return url to which the customer should be redirected to after adding the payment method #[schema(value_type = Option<String>)] pub return_url: Option<common_utils::types::Url>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PaymentMethodSessionConfirmRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_5804043685645084519
clm
struct
// hyperswitch/crates/api_models/src/payment_methods.rs pub struct PaymentMethodSessionResponse { #[schema(value_type = String, example = "12345_pms_01926c58bc6e77c09e809964e72af8c8")] pub id: id_type::GlobalPaymentMethodSessionId, /// The customer id for which the payment methods session is to be created #[schema(value_type = String, example = "12345_cus_01926c58bc6e77c09e809964e72af8c8")] pub customer_id: id_type::GlobalCustomerId, /// The billing address details of the customer. This will also be used for any new payment methods added during the session #[schema(value_type = Option<Address>)] pub billing: Option<payments::Address>, /// The tokenization type to be applied #[schema(value_type = Option<PspTokenization>)] pub psp_tokenization: Option<common_types::payment_methods::PspTokenization>, /// The network tokenization configuration if applicable #[schema(value_type = Option<NetworkTokenization>)] pub network_tokenization: Option<common_types::payment_methods::NetworkTokenization>, /// Contains data to be passed on to tokenization service ( if present ) to create token_id for given JSON data #[schema(value_type = Option<serde_json::Value>)] pub tokenization_data: Option<pii::SecretSerdeValue>, /// The iso timestamp when the session will expire /// Trying to retrieve the session or any operations on the session after this time will result in an error #[schema(value_type = PrimitiveDateTime, example = "2023-01-18T11:04:09.922Z")] #[serde(with = "common_utils::custom_serde::iso8601")] pub expires_at: time::PrimitiveDateTime, /// Client Secret #[schema(value_type = String)] pub client_secret: masking::Secret<String>, /// The return url to which the user should be redirected to #[schema(value_type = Option<String>)] pub return_url: Option<common_utils::types::Url>, /// The next action details for the payment method session #[schema(value_type = Option<NextActionData>)] pub next_action: Option<payments::NextActionData>, /// The customer authentication details for the payment method /// This refers to either the payment / external authentication details pub authentication_details: Option<AuthenticationDetails>, /// The payment method that was created using this payment method session #[schema(value_type = Option<Vec<String>>)] pub associated_payment_methods: Option<Vec<String>>, /// The token-id created if there is tokenization_data present #[schema(value_type = Option<String>, example = "12345_tok_01926c58bc6e77c09e809964e72af8c8")] pub associated_token_id: Option<id_type::GlobalTokenId>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PaymentMethodSessionResponse", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_6902015792949180456
clm
struct
// hyperswitch/crates/api_models/src/payment_methods.rs pub struct AuthenticationDetails { /// The status of authentication for the payment method #[schema(value_type = IntentStatus)] pub status: common_enums::IntentStatus, /// Error details of the authentication #[schema(value_type = Option<ErrorDetails>)] pub error: Option<payments::ErrorDetails>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "AuthenticationDetails", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_6584619392766216718
clm
struct
// hyperswitch/crates/api_models/src/payment_methods.rs pub struct NetworkTokenStatusCheckSuccessResponse { /// The status of the network token #[schema(value_type = TokenStatus)] pub status: api_enums::TokenStatus, /// The expiry month of the network token if active #[schema(value_type = String)] pub token_expiry_month: masking::Secret<String>, /// The expiry year of the network token if active #[schema(value_type = String)] pub token_expiry_year: masking::Secret<String>, /// The last four digits of the card pub card_last_four: String, /// The last four digits of the network token pub token_last_four: String, /// The expiry date of the card in MM/YY format pub card_expiry: String, /// The payment method ID that was checked #[schema(value_type = String, example = "12345_pm_019959146f92737389eb6927ce1eb7dc")] pub payment_method_id: id_type::GlobalPaymentMethodId, /// The customer ID associated with the payment method #[schema(value_type = String, example = "12345_cus_0195dc62bb8e7312a44484536da76aef")] pub customer_id: id_type::GlobalCustomerId, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "NetworkTokenStatusCheckSuccessResponse", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-9220061145911462440
clm
struct
// hyperswitch/crates/api_models/src/payment_methods.rs pub struct NetworkTokenStatusCheckFailureResponse { /// Error message describing what went wrong pub error_message: String, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "NetworkTokenStatusCheckFailureResponse", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_4119182444680586233
clm
struct
// hyperswitch/crates/api_models/src/verifications.rs pub struct ApplepayMerchantVerificationConfigs { pub domain_names: Vec<String>, pub encrypt_to: String, pub partner_internal_merchant_identifier: String, pub partner_merchant_name: String, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "ApplepayMerchantVerificationConfigs", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-5073172557889752525
clm
struct
// hyperswitch/crates/api_models/src/verifications.rs pub struct ApplepayMerchantVerificationRequest { pub domain_names: Vec<String>, pub merchant_connector_account_id: id_type::MerchantConnectorAccountId, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "ApplepayMerchantVerificationRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-1310893919301008454
clm
struct
// hyperswitch/crates/api_models/src/verifications.rs pub struct ApplepayMerchantResponse { pub status_message: String, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "ApplepayMerchantResponse", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_6570396276546691560
clm
struct
// hyperswitch/crates/api_models/src/verifications.rs pub struct ApplepayGetVerifiedDomainsParam { pub merchant_id: id_type::MerchantId, pub merchant_connector_account_id: id_type::MerchantConnectorAccountId, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "ApplepayGetVerifiedDomainsParam", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_1894894544756312623
clm
struct
// hyperswitch/crates/api_models/src/verifications.rs pub struct ApplepayVerifiedDomainsResponse { pub verified_domains: Vec<String>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "ApplepayVerifiedDomainsResponse", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-6802640311240056286
clm
struct
// hyperswitch/crates/api_models/src/proxy.rs pub struct Headers(pub HashMap<String, String>);
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "Headers", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_2229391322016800463
clm
struct
// hyperswitch/crates/api_models/src/proxy.rs pub struct ProxyRequest { /// The request body that needs to be forwarded pub request_body: Value, /// The destination URL where the request needs to be forwarded #[schema(value_type = String, example = "https://api.example.com/endpoint")] pub destination_url: url::Url, /// The headers that need to be forwarded #[schema(value_type = Object, example = r#"{ "key1": "value-1", "key2": "value-2" }"#)] pub headers: Headers, /// The method that needs to be used for the request #[schema(value_type = Method, example = "Post")] pub method: Method, /// The vault token that is used to fetch sensitive data from the vault pub token: String, /// The type of token that is used to fetch sensitive data from the vault #[schema(value_type = TokenType, example = "payment_method_id")] pub token_type: TokenType, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "ProxyRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_8071512233313912485
clm
struct
// hyperswitch/crates/api_models/src/proxy.rs pub struct ProxyResponse { /// The response received from the destination pub response: Value, /// The status code of the response pub status_code: u16, /// The headers of the response #[schema(value_type = Object, example = r#"{ "key1": "value-1", "key2": "value-2" }"#)] pub response_headers: Headers, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "ProxyResponse", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-3415340941548150403
clm
struct
// hyperswitch/crates/api_models/src/open_router.rs pub struct OpenRouterDecideGatewayRequest { pub payment_info: PaymentInfo, #[schema(value_type = String)] pub merchant_id: id_type::ProfileId, pub eligible_gateway_list: Option<Vec<String>>, pub ranking_algorithm: Option<RankingAlgorithm>, pub elimination_enabled: Option<bool>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "OpenRouterDecideGatewayRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_1100906880199043439
clm
struct
// hyperswitch/crates/api_models/src/open_router.rs pub struct DecideGatewayResponse { pub decided_gateway: Option<String>, pub gateway_priority_map: Option<serde_json::Value>, pub filter_wise_gateways: Option<serde_json::Value>, pub priority_logic_tag: Option<String>, pub routing_approach: Option<String>, pub gateway_before_evaluation: Option<String>, pub priority_logic_output: Option<PriorityLogicOutput>, pub reset_approach: Option<String>, pub routing_dimension: Option<String>, pub routing_dimension_level: Option<String>, pub is_scheduled_outage: Option<bool>, pub is_dynamic_mga_enabled: Option<bool>, pub gateway_mga_id_map: Option<serde_json::Value>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "DecideGatewayResponse", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-4264418977589482097
clm
struct
// hyperswitch/crates/api_models/src/open_router.rs pub struct PriorityLogicOutput { pub is_enforcement: Option<bool>, pub gws: Option<Vec<String>>, pub priority_logic_tag: Option<String>, pub gateway_reference_ids: Option<HashMap<String, String>>, pub primary_logic: Option<PriorityLogicData>, pub fallback_logic: Option<PriorityLogicData>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PriorityLogicOutput", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_4578385120488858811
clm
struct
// hyperswitch/crates/api_models/src/open_router.rs pub struct PriorityLogicData { pub name: Option<String>, pub status: Option<String>, pub failure_reason: Option<String>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PriorityLogicData", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_1971478549586785746
clm
struct
// hyperswitch/crates/api_models/src/open_router.rs pub struct PaymentInfo { #[schema(value_type = String)] pub payment_id: id_type::PaymentId, pub amount: MinorUnit, pub currency: Currency, // customerId: Option<ETCu::CustomerId>, // preferredGateway: Option<ETG::Gateway>, pub payment_type: String, pub metadata: Option<String>, // internalMetadata: Option<String>, // isEmi: Option<bool>, // emiBank: Option<String>, // emiTenure: Option<i32>, pub payment_method_type: String, pub payment_method: PaymentMethod, // paymentSource: Option<String>, // authType: Option<ETCa::txn_card_info::AuthType>, // cardIssuerBankName: Option<String>, pub card_isin: Option<String>, // cardType: Option<ETCa::card_type::CardType>, // cardSwitchProvider: Option<Secret<String>>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PaymentInfo", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-4159779380151693937
clm
struct
// hyperswitch/crates/api_models/src/open_router.rs pub struct DecidedGateway { pub gateway_priority_map: Option<HashMap<String, f64>>, pub debit_routing_output: Option<DebitRoutingOutput>, pub routing_approach: String, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "DecidedGateway", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_7968222162392261117
clm
struct
// hyperswitch/crates/api_models/src/open_router.rs pub struct DebitRoutingOutput { pub co_badged_card_networks_info: CoBadgedCardNetworks, pub issuer_country: common_enums::CountryAlpha2, pub is_regulated: bool, pub regulated_name: Option<common_enums::RegulatedName>, pub card_type: common_enums::CardType, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "DebitRoutingOutput", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-404524939421426788
clm
struct
// hyperswitch/crates/api_models/src/open_router.rs pub struct CoBadgedCardNetworksInfo { pub network: common_enums::CardNetwork, pub saving_percentage: f64, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "CoBadgedCardNetworksInfo", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-8342723594208659204
clm
struct
// hyperswitch/crates/api_models/src/open_router.rs pub struct CoBadgedCardNetworks(pub Vec<CoBadgedCardNetworksInfo>);
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "CoBadgedCardNetworks", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_4256423809531604907
clm
struct
// hyperswitch/crates/api_models/src/open_router.rs pub struct CoBadgedCardRequest { pub merchant_category_code: common_enums::DecisionEngineMerchantCategoryCode, pub acquirer_country: common_enums::CountryAlpha2, pub co_badged_card_data: Option<DebitRoutingRequestData>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "CoBadgedCardRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_7423804414938764492
clm
struct
// hyperswitch/crates/api_models/src/open_router.rs pub struct DebitRoutingRequestData { pub co_badged_card_networks_info: Vec<common_enums::CardNetwork>, pub issuer_country: common_enums::CountryAlpha2, pub is_regulated: bool, pub regulated_name: Option<common_enums::RegulatedName>, pub card_type: common_enums::CardType, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "DebitRoutingRequestData", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-4334158833734480404
clm
struct
// hyperswitch/crates/api_models/src/open_router.rs pub struct ErrorResponse { pub status: String, pub error_code: String, pub error_message: String, pub priority_logic_tag: Option<String>, pub filter_wise_gateways: Option<serde_json::Value>, pub error_info: UnifiedError, pub is_dynamic_mga_enabled: bool, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "ErrorResponse", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-8208378230424675702
clm
struct
// hyperswitch/crates/api_models/src/open_router.rs pub struct UnifiedError { pub code: String, pub user_message: String, pub developer_message: String, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "UnifiedError", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_8158937984918092882
clm
struct
// hyperswitch/crates/api_models/src/open_router.rs pub struct UpdateScorePayload { #[schema(value_type = String)] pub merchant_id: id_type::ProfileId, pub gateway: String, pub status: TxnStatus, #[schema(value_type = String)] pub payment_id: id_type::PaymentId, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "UpdateScorePayload", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_5260290746781674876
clm
struct
// hyperswitch/crates/api_models/src/open_router.rs pub struct UpdateScoreResponse { pub message: String, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "UpdateScoreResponse", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_381005030542277611
clm
struct
// hyperswitch/crates/api_models/src/open_router.rs pub struct DecisionEngineConfigSetupRequest { pub merchant_id: String, pub config: DecisionEngineConfigVariant, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "DecisionEngineConfigSetupRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_2314383577149751211
clm
struct
// hyperswitch/crates/api_models/src/open_router.rs pub struct GetDecisionEngineConfigRequest { pub merchant_id: String, pub algorithm: DecisionEngineDynamicAlgorithmType, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "GetDecisionEngineConfigRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_7911387117852043799
clm
struct
// hyperswitch/crates/api_models/src/open_router.rs pub struct DecisionEngineSuccessRateData { pub default_latency_threshold: Option<f64>, pub default_bucket_size: Option<i32>, pub default_hedging_percent: Option<f64>, pub default_lower_reset_factor: Option<f64>, pub default_upper_reset_factor: Option<f64>, pub default_gateway_extra_score: Option<Vec<DecisionEngineGatewayWiseExtraScore>>, pub sub_level_input_config: Option<Vec<DecisionEngineSRSubLevelInputConfig>>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "DecisionEngineSuccessRateData", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_8494698854969635920
clm
struct
// hyperswitch/crates/api_models/src/open_router.rs pub struct DecisionEngineSRSubLevelInputConfig { pub payment_method_type: Option<String>, pub payment_method: Option<String>, pub latency_threshold: Option<f64>, pub bucket_size: Option<i32>, pub hedging_percent: Option<f64>, pub lower_reset_factor: Option<f64>, pub upper_reset_factor: Option<f64>, pub gateway_extra_score: Option<Vec<DecisionEngineGatewayWiseExtraScore>>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "DecisionEngineSRSubLevelInputConfig", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-4909217723610306961
clm
struct
// hyperswitch/crates/api_models/src/open_router.rs pub struct DecisionEngineGatewayWiseExtraScore { pub gateway_name: String, pub gateway_sigma_factor: f64, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "DecisionEngineGatewayWiseExtraScore", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_1971683831892342403
clm
struct
// hyperswitch/crates/api_models/src/open_router.rs pub struct DecisionEngineEliminationData { pub threshold: f64, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "DecisionEngineEliminationData", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-5595553966164802780
clm
struct
// hyperswitch/crates/api_models/src/open_router.rs pub struct MerchantAccount { pub merchant_id: String, pub gateway_success_rate_based_decider_input: Option<String>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "MerchantAccount", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_4187985631207352589
clm
struct
// hyperswitch/crates/api_models/src/open_router.rs pub struct FetchRoutingConfig { pub merchant_id: String, pub algorithm: AlgorithmType, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "FetchRoutingConfig", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-3908783485025093644
clm
struct
// hyperswitch/crates/api_models/src/refunds.rs pub struct RefundRequest { /// The payment id against which refund is to be initiated #[schema( max_length = 30, min_length = 30, example = "pay_mbabizu24mvu3mela5njyhpit4", value_type = String, )] pub payment_id: common_utils::id_type::PaymentId, /// Unique Identifier for the Refund. This is to ensure idempotency for multiple partial refunds initiated against the same payment. If this is not passed by the merchant, this field shall be auto generated and provided in the API response. It is recommended to generate uuid(v4) as the refund_id. #[schema( max_length = 30, min_length = 30, example = "ref_mbabizu24mvu3mela5njyhpit4" )] pub refund_id: Option<String>, /// The identifier for the Merchant Account #[schema(max_length = 255, example = "y3oqhf46pyzuxjbcn2giaqnb44", value_type = Option<String>)] pub merchant_id: Option<common_utils::id_type::MerchantId>, /// Total amount for which the refund is to be initiated. Amount for the payment in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc., If not provided, this will default to the full payment amount #[schema(value_type = Option<i64> , minimum = 100, example = 6540)] pub amount: Option<MinorUnit>, /// Reason for the refund. Often useful for displaying to users and your customer support executive. In case the payment went through Stripe, this field needs to be passed with one of these enums: `duplicate`, `fraudulent`, or `requested_by_customer` #[schema(max_length = 255, example = "Customer returned the product")] pub reason: Option<String>, /// To indicate whether to refund needs to be instant or scheduled. Default value is instant #[schema(default = "Instant", example = "Instant")] pub refund_type: Option<RefundType>, /// You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object. #[schema(value_type = Option<Object>, example = r#"{ "city": "NY", "unit": "245" }"#)] pub metadata: Option<pii::SecretSerdeValue>, /// Merchant connector details used to make payments. #[schema(value_type = Option<MerchantConnectorDetailsWrap>)] pub merchant_connector_details: Option<admin::MerchantConnectorDetailsWrap>, /// Charge specific fields for controlling the revert of funds from either platform or connected account #[schema(value_type = Option<SplitRefund>)] pub split_refunds: Option<common_types::refunds::SplitRefund>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "RefundRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_9051525280972897060
clm
struct
// hyperswitch/crates/api_models/src/refunds.rs pub struct RefundsCreateRequest { /// The payment id against which refund is initiated #[schema( max_length = 30, min_length = 30, example = "pay_mbabizu24mvu3mela5njyhpit4", value_type = String, )] pub payment_id: common_utils::id_type::GlobalPaymentId, /// Unique Identifier for the Refund given by the Merchant. #[schema( max_length = 64, min_length = 1, example = "ref_mbabizu24mvu3mela5njyhpit4", value_type = String, )] pub merchant_reference_id: common_utils::id_type::RefundReferenceId, /// The identifier for the Merchant Account #[schema(max_length = 255, example = "y3oqhf46pyzuxjbcn2giaqnb44", value_type = Option<String>)] pub merchant_id: Option<common_utils::id_type::MerchantId>, /// Total amount for which the refund is to be initiated. Amount for the payment in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc., If not provided, this will default to the amount_captured of the payment #[schema(value_type = Option<i64> , minimum = 100, example = 6540)] pub amount: Option<MinorUnit>, /// Reason for the refund. Often useful for displaying to users and your customer support executive. #[schema(max_length = 255, example = "Customer returned the product")] pub reason: Option<String>, /// To indicate whether to refund needs to be instant or scheduled. Default value is instant #[schema(default = "Instant", example = "Instant")] pub refund_type: Option<RefundType>, /// Metadata is useful for storing additional, unstructured information on an object. #[schema(value_type = Option<Object>, example = r#"{ "city": "NY", "unit": "245" }"#)] pub metadata: Option<pii::SecretSerdeValue>, /// Merchant connector details used to make payments. #[schema(value_type = Option<MerchantConnectorAuthDetails>)] pub merchant_connector_details: Option<common_types::domain::MerchantConnectorAuthDetails>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "RefundsCreateRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_368104078198841913
clm
struct
// hyperswitch/crates/api_models/src/refunds.rs pub struct RefundsRetrieveBody { pub force_sync: Option<bool>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "RefundsRetrieveBody", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_368104078198841913
clm
struct
// hyperswitch/crates/api_models/src/refunds.rs pub struct RefundsRetrieveBody { pub force_sync: Option<bool>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "RefundsRetrieveBody", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-6900421602655544019
clm
struct
// hyperswitch/crates/api_models/src/refunds.rs pub struct RefundsRetrievePayload { /// `force_sync` with the connector to get refund details pub force_sync: Option<bool>, /// Merchant connector details used to make payments. pub merchant_connector_details: Option<common_types::domain::MerchantConnectorAuthDetails>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "RefundsRetrievePayload", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-6557473858150480881
clm
struct
// hyperswitch/crates/api_models/src/refunds.rs pub struct RefundsRetrieveRequest { /// Unique Identifier for the Refund. This is to ensure idempotency for multiple partial refund initiated against the same payment. If the identifiers is not defined by the merchant, this filed shall be auto generated and provide in the API response. It is recommended to generate uuid(v4) as the refund_id. #[schema( max_length = 30, min_length = 30, example = "ref_mbabizu24mvu3mela5njyhpit4" )] pub refund_id: String, /// `force_sync` with the connector to get refund details /// (defaults to false) pub force_sync: Option<bool>, /// Merchant connector details used to make payments. pub merchant_connector_details: Option<admin::MerchantConnectorDetailsWrap>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "RefundsRetrieveRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-6557473858150480881
clm
struct
// hyperswitch/crates/api_models/src/refunds.rs pub struct RefundsRetrieveRequest { /// Unique Identifier for the Refund. This is to ensure idempotency for multiple partial refund initiated against the same payment. If the identifiers is not defined by the merchant, this filed shall be auto generated and provide in the API response. It is recommended to generate uuid(v4) as the refund_id. #[schema( max_length = 30, min_length = 30, example = "ref_mbabizu24mvu3mela5njyhpit4" )] pub refund_id: common_utils::id_type::GlobalRefundId, /// `force_sync` with the connector to get refund details /// (defaults to false) pub force_sync: Option<bool>, /// Merchant connector details used to make payments. #[schema(value_type = Option<MerchantConnectorAuthDetails>)] pub merchant_connector_details: Option<common_types::domain::MerchantConnectorAuthDetails>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "RefundsRetrieveRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-4913837128509251838
clm
struct
// hyperswitch/crates/api_models/src/refunds.rs pub struct RefundUpdateRequest { #[serde(skip)] pub refund_id: String, /// An arbitrary string attached to the object. Often useful for displaying to users and your customer support executive #[schema(max_length = 255, example = "Customer returned the product")] pub reason: Option<String>, /// You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object. #[schema(value_type = Option<Object>, example = r#"{ "city": "NY", "unit": "245" }"#)] pub metadata: Option<pii::SecretSerdeValue>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "RefundUpdateRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-6450409717757774162
clm
struct
// hyperswitch/crates/api_models/src/refunds.rs pub struct RefundMetadataUpdateRequest { /// An arbitrary string attached to the object. Often useful for displaying to users and your customer support executive #[schema(max_length = 255, example = "Customer returned the product")] pub reason: Option<String>, /// You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object. #[schema(value_type = Option<Object>, example = r#"{ "city": "NY", "unit": "245" }"#)] pub metadata: Option<pii::SecretSerdeValue>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "RefundMetadataUpdateRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-2893817872558968631
clm
struct
// hyperswitch/crates/api_models/src/refunds.rs pub struct RefundManualUpdateRequest { #[serde(skip)] pub refund_id: String, /// Merchant ID #[schema(value_type = String)] pub merchant_id: common_utils::id_type::MerchantId, /// The status for refund pub status: Option<RefundStatus>, /// The code for the error pub error_code: Option<String>, /// The error message pub error_message: Option<String>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "RefundManualUpdateRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-4662012483449392107
clm
struct
// hyperswitch/crates/api_models/src/refunds.rs pub struct RefundResponse { /// Unique Identifier for the refund pub refund_id: String, /// The payment id against which refund is initiated #[schema(value_type = String)] pub payment_id: common_utils::id_type::PaymentId, /// The refund amount, which should be less than or equal to the total payment amount. Amount for the payment in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc #[schema(value_type = i64 , minimum = 100, example = 6540)] pub amount: MinorUnit, /// The three-letter ISO currency code pub currency: String, /// The status for refund pub status: RefundStatus, /// An arbitrary string attached to the object. Often useful for displaying to users and your customer support executive pub reason: Option<String>, /// You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object #[schema(value_type = Option<Object>)] pub metadata: Option<pii::SecretSerdeValue>, /// The error message pub error_message: Option<String>, /// The code for the error pub error_code: Option<String>, /// Error code unified across the connectors is received here if there was an error while calling connector pub unified_code: Option<String>, /// Error message unified across the connectors is received here if there was an error while calling connector pub unified_message: Option<String>, /// The timestamp at which refund is created #[serde(with = "common_utils::custom_serde::iso8601::option")] pub created_at: Option<PrimitiveDateTime>, /// The timestamp at which refund is updated #[serde(with = "common_utils::custom_serde::iso8601::option")] pub updated_at: Option<PrimitiveDateTime>, /// The connector used for the refund and the corresponding payment #[schema(example = "stripe")] pub connector: String, /// The id of business profile for this refund #[schema(value_type = Option<String>)] pub profile_id: Option<common_utils::id_type::ProfileId>, /// The merchant_connector_id of the processor through which this payment went through #[schema(value_type = Option<String>)] pub merchant_connector_id: Option<common_utils::id_type::MerchantConnectorAccountId>, /// Charge specific fields for controlling the revert of funds from either platform or connected account #[schema(value_type = Option<SplitRefund>,)] pub split_refunds: Option<common_types::refunds::SplitRefund>, /// Error code received from the issuer in case of failed refunds pub issuer_error_code: Option<String>, /// Error message received from the issuer in case of failed refunds pub issuer_error_message: Option<String>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "RefundResponse", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-4662012483449392107
clm
struct
// hyperswitch/crates/api_models/src/refunds.rs pub struct RefundResponse { /// Global Refund Id for the refund #[schema(value_type = String)] pub id: common_utils::id_type::GlobalRefundId, /// The payment id against which refund is initiated #[schema(value_type = String)] pub payment_id: common_utils::id_type::GlobalPaymentId, /// Unique Identifier for the Refund. This is to ensure idempotency for multiple partial refunds initiated against the same payment. #[schema( max_length = 30, min_length = 30, example = "ref_mbabizu24mvu3mela5njyhpit4", value_type = Option<String>, )] pub merchant_reference_id: Option<common_utils::id_type::RefundReferenceId>, /// The refund amount #[schema(value_type = i64 , minimum = 100, example = 6540)] pub amount: MinorUnit, /// The three-letter ISO currency code #[schema(value_type = Currency)] pub currency: common_enums::Currency, /// The status for refund pub status: RefundStatus, /// An arbitrary string attached to the object pub reason: Option<String>, /// Metadata is useful for storing additional, unstructured information on an object #[schema(value_type = Option<Object>)] pub metadata: Option<pii::SecretSerdeValue>, /// The error details for the refund pub error_details: Option<RefundErrorDetails>, /// The timestamp at which refund is created #[serde(with = "common_utils::custom_serde::iso8601")] pub created_at: PrimitiveDateTime, /// The timestamp at which refund is updated #[serde(with = "common_utils::custom_serde::iso8601")] pub updated_at: PrimitiveDateTime, /// The connector used for the refund and the corresponding payment #[schema(example = "stripe", value_type = Connector)] pub connector: enums::Connector, /// The id of business profile for this refund #[schema(value_type = String)] pub profile_id: common_utils::id_type::ProfileId, /// The merchant_connector_id of the processor through which this payment went through #[schema(value_type = String)] pub merchant_connector_id: Option<common_utils::id_type::MerchantConnectorAccountId>, /// The reference id of the connector for the refund pub connector_refund_reference_id: Option<String>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "RefundResponse", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_3423059810890182043
clm
struct
// hyperswitch/crates/api_models/src/refunds.rs pub struct RefundErrorDetails { pub code: String, pub message: String, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "RefundErrorDetails", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_82820707305730178
clm
struct
// hyperswitch/crates/api_models/src/refunds.rs pub struct RefundListRequest { /// The identifier for the payment #[schema(value_type = Option<String>)] pub payment_id: Option<common_utils::id_type::PaymentId>, /// The identifier for the refund pub refund_id: Option<String>, /// The identifier for business profile #[schema(value_type = Option<String>)] pub profile_id: Option<common_utils::id_type::ProfileId>, /// Limit on the number of objects to return pub limit: Option<i64>, /// The starting point within a list of objects pub offset: Option<i64>, /// The time range for which objects are needed. TimeRange has two fields start_time and end_time from which objects can be filtered as per required scenarios (created_at, time less than, greater than etc) #[serde(flatten)] pub time_range: Option<TimeRange>, /// The amount to filter reufnds list. Amount takes two option fields start_amount and end_amount from which objects can be filtered as per required scenarios (less_than, greater_than, equal_to and range) pub amount_filter: Option<AmountFilter>, /// The list of connectors to filter refunds list pub connector: Option<Vec<String>>, /// The list of merchant connector ids to filter the refunds list for selected label #[schema(value_type = Option<Vec<String>>)] pub merchant_connector_id: Option<Vec<common_utils::id_type::MerchantConnectorAccountId>>, /// The list of currencies to filter refunds list #[schema(value_type = Option<Vec<Currency>>)] pub currency: Option<Vec<enums::Currency>>, /// The list of refund statuses to filter refunds list #[schema(value_type = Option<Vec<RefundStatus>>)] pub refund_status: Option<Vec<enums::RefundStatus>>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "RefundListRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_82820707305730178
clm
struct
// hyperswitch/crates/api_models/src/refunds.rs pub struct RefundListRequest { /// The identifier for the payment #[schema(value_type = Option<String>)] pub payment_id: Option<common_utils::id_type::GlobalPaymentId>, /// The identifier for the refund #[schema(value_type = String)] pub refund_id: Option<common_utils::id_type::GlobalRefundId>, /// Limit on the number of objects to return pub limit: Option<i64>, /// The starting point within a list of objects pub offset: Option<i64>, /// The time range for which objects are needed. TimeRange has two fields start_time and end_time from which objects can be filtered as per required scenarios (created_at, time less than, greater than etc) #[serde(flatten)] pub time_range: Option<TimeRange>, /// The amount to filter reufnds list. Amount takes two option fields start_amount and end_amount from which objects can be filtered as per required scenarios (less_than, greater_than, equal_to and range) pub amount_filter: Option<AmountFilter>, /// The list of connectors to filter refunds list pub connector: Option<Vec<String>>, /// The list of merchant connector ids to filter the refunds list for selected label #[schema(value_type = Option<Vec<String>>)] pub connector_id_list: Option<Vec<common_utils::id_type::MerchantConnectorAccountId>>, /// The list of currencies to filter refunds list #[schema(value_type = Option<Vec<Currency>>)] pub currency: Option<Vec<enums::Currency>>, /// The list of refund statuses to filter refunds list #[schema(value_type = Option<Vec<RefundStatus>>)] pub refund_status: Option<Vec<enums::RefundStatus>>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "RefundListRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_5528411098079384806
clm
struct
// hyperswitch/crates/api_models/src/refunds.rs pub struct RefundListResponse { /// The number of refunds included in the list pub count: usize, /// The total number of refunds in the list pub total_count: i64, /// The List of refund response object pub data: Vec<RefundResponse>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "RefundListResponse", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-4845368866845182280
clm
struct
// hyperswitch/crates/api_models/src/refunds.rs pub struct RefundListMetaData { /// The list of available connector filters pub connector: Vec<String>, /// The list of available currency filters #[schema(value_type = Vec<Currency>)] pub currency: Vec<enums::Currency>, /// The list of available refund status filters #[schema(value_type = Vec<RefundStatus>)] pub refund_status: Vec<enums::RefundStatus>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "RefundListMetaData", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_6201759262355412824
clm
struct
// hyperswitch/crates/api_models/src/refunds.rs pub struct RefundListFilters { /// The map of available connector filters, where the key is the connector name and the value is a list of MerchantConnectorInfo instances pub connector: HashMap<String, Vec<MerchantConnectorInfo>>, /// The list of available currency filters #[schema(value_type = Vec<Currency>)] pub currency: Vec<enums::Currency>, /// The list of available refund status filters #[schema(value_type = Vec<RefundStatus>)] pub refund_status: Vec<enums::RefundStatus>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "RefundListFilters", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-5400074380631141412
clm
struct
// hyperswitch/crates/api_models/src/refunds.rs pub struct RefundAggregateResponse { /// The list of refund status with their count pub status_with_count: HashMap<enums::RefundStatus, i64>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "RefundAggregateResponse", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-1864256866783933043
clm
struct
// hyperswitch/crates/api_models/src/organization.rs pub struct OrganizationId { pub organization_id: id_type::OrganizationId, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "OrganizationId", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_3559280046434342550
clm
struct
// hyperswitch/crates/api_models/src/organization.rs pub struct OrganizationCreateRequest { /// Name of the organization pub organization_name: String, /// Details about the organization #[schema(value_type = Option<Object>)] pub organization_details: Option<pii::SecretSerdeValue>, /// Metadata is useful for storing additional, unstructured information on an object. #[schema(value_type = Option<Object>)] pub metadata: Option<pii::SecretSerdeValue>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "OrganizationCreateRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-8477230656652034753
clm
struct
// hyperswitch/crates/api_models/src/organization.rs pub struct OrganizationUpdateRequest { /// Name of the organization pub organization_name: Option<String>, /// Details about the organization #[schema(value_type = Option<Object>)] pub organization_details: Option<pii::SecretSerdeValue>, /// Metadata is useful for storing additional, unstructured information on an object. #[schema(value_type = Option<Object>)] pub metadata: Option<pii::SecretSerdeValue>, /// Platform merchant id is unique distiguisher for special merchant in the platform org #[schema(value_type = String)] pub platform_merchant_id: Option<id_type::MerchantId>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "OrganizationUpdateRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-5771298193950384529
clm
struct
// hyperswitch/crates/api_models/src/organization.rs pub struct OrganizationResponse { /// The unique identifier for the Organization #[schema(value_type = String, max_length = 64, min_length = 1, example = "org_q98uSGAYbjEwqs0mJwnz")] pub organization_id: id_type::OrganizationId, /// Name of the Organization pub organization_name: Option<String>, /// Details about the organization #[schema(value_type = Option<Object>)] pub organization_details: Option<pii::SecretSerdeValue>, /// Metadata is useful for storing additional, unstructured information on an object. #[schema(value_type = Option<Object>)] pub metadata: Option<pii::SecretSerdeValue>, pub modified_at: time::PrimitiveDateTime, pub created_at: time::PrimitiveDateTime, /// Organization Type of the organization #[schema(value_type = Option<OrganizationType>, example = "standard")] pub organization_type: Option<OrganizationType>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "OrganizationResponse", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-5771298193950384529
clm
struct
// hyperswitch/crates/api_models/src/organization.rs pub struct OrganizationResponse { /// The unique identifier for the Organization #[schema(value_type = String, max_length = 64, min_length = 1, example = "org_q98uSGAYbjEwqs0mJwnz")] pub id: id_type::OrganizationId, /// Name of the Organization pub organization_name: Option<String>, /// Details about the organization #[schema(value_type = Option<Object>)] pub organization_details: Option<pii::SecretSerdeValue>, /// Metadata is useful for storing additional, unstructured information on an object. #[schema(value_type = Option<Object>)] pub metadata: Option<pii::SecretSerdeValue>, pub modified_at: time::PrimitiveDateTime, pub created_at: time::PrimitiveDateTime, /// Organization Type of the organization #[schema(value_type = Option<OrganizationType>, example = "standard")] pub organization_type: Option<OrganizationType>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "OrganizationResponse", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_4943941659347226092
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct PayoutCreateRequest { /// Unique identifier for the payout. This ensures idempotency for multiple payouts that have been done by a single merchant. This field is auto generated and is returned in the API response, **not required to be included in the Payout Create/Update Request.** #[schema( value_type = Option<String>, min_length = 30, max_length = 30, example = "187282ab-40ef-47a9-9206-5099ba31e432" )] #[remove_in(PayoutsCreateRequest, PayoutUpdateRequest, PayoutConfirmRequest)] pub payout_id: Option<id_type::PayoutId>, /// This is an identifier for the merchant account. This is inferred from the API key provided during the request, **not required to be included in the Payout Create/Update Request.** #[schema(max_length = 255, value_type = Option<String>, example = "merchant_1668273825")] #[remove_in(PayoutsCreateRequest, PayoutUpdateRequest, PayoutConfirmRequest)] pub merchant_id: Option<id_type::MerchantId>, /// Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported. #[schema(value_type = Option<String>, max_length = 255, example = "merchant_order_ref_123")] pub merchant_order_reference_id: Option<String>, /// The payout amount. Amount for the payout in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc., #[schema(value_type = Option<u64>, example = 1000)] #[mandatory_in(PayoutsCreateRequest = u64)] #[remove_in(PayoutsConfirmRequest)] #[serde(default, deserialize_with = "payments::amount::deserialize_option")] pub amount: Option<payments::Amount>, /// The currency of the payout request can be specified here #[schema(value_type = Option<Currency>, example = "USD")] #[mandatory_in(PayoutsCreateRequest = Currency)] #[remove_in(PayoutsConfirmRequest)] pub currency: Option<api_enums::Currency>, /// Specifies routing algorithm for selecting a connector #[schema(value_type = Option<StaticRoutingAlgorithm>, example = json!({ "type": "single", "data": "adyen" }))] pub routing: Option<serde_json::Value>, /// This field allows the merchant to manually select a connector with which the payout can go through. #[schema(value_type = Option<Vec<PayoutConnectors>>, max_length = 255, example = json!(["wise", "adyen"]))] pub connector: Option<Vec<api_enums::PayoutConnectors>>, /// This field is used when merchant wants to confirm the payout, thus useful for the payout _Confirm_ request. Ideally merchants should _Create_ a payout, _Update_ it (if required), then _Confirm_ it. #[schema(value_type = Option<bool>, example = true, default = false)] #[remove_in(PayoutConfirmRequest)] pub confirm: Option<bool>, /// The payout_type of the payout request can be specified here, this is a mandatory field to _Confirm_ the payout, i.e., should be passed in _Create_ request, if not then should be updated in the payout _Update_ request, then only it can be confirmed. #[schema(value_type = Option<PayoutType>, example = "card")] pub payout_type: Option<api_enums::PayoutType>, /// The payout method information required for carrying out a payout #[schema(value_type = Option<PayoutMethodData>)] pub payout_method_data: Option<PayoutMethodData>, /// The billing address for the payout #[schema(value_type = Option<Address>, example = json!(r#"{ "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Francisco", "state": "CA", "zip": "94122", "country": "US", "first_name": "John", "last_name": "Doe" }, "phone": { "number": "9123456789", "country_code": "+1" } }"#))] pub billing: Option<payments::Address>, /// Set to true to confirm the payout without review, no further action required #[schema(value_type = Option<bool>, example = true, default = false)] pub auto_fulfill: Option<bool>, /// The identifier for the customer object. If not provided the customer ID will be autogenerated. _Deprecated: Use customer_id instead._ #[schema(deprecated, value_type = Option<String>, max_length = 255, example = "cus_y3oqhf46pyzuxjbcn2giaqnb44")] pub customer_id: Option<id_type::CustomerId>, /// Passing this object creates a new customer or attaches an existing customer to the payout #[schema(value_type = Option<CustomerDetails>)] pub customer: Option<payments::CustomerDetails>, /// It's a token used for client side verification. #[schema(value_type = Option<String>, example = "pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo")] #[remove_in(PayoutsCreateRequest)] #[mandatory_in(PayoutConfirmRequest = String)] pub client_secret: Option<String>, /// The URL to redirect after the completion of the operation #[schema(value_type = Option<String>, example = "https://hyperswitch.io")] pub return_url: Option<String>, /// Business country of the merchant for this payout. _Deprecated: Use profile_id instead._ #[schema(deprecated, example = "US", value_type = Option<CountryAlpha2>)] pub business_country: Option<api_enums::CountryAlpha2>, /// Business label of the merchant for this payout. _Deprecated: Use profile_id instead._ #[schema(deprecated, example = "food", value_type = Option<String>)] pub business_label: Option<String>, /// A description of the payout #[schema(example = "It's my first payout request", value_type = Option<String>)] pub description: Option<String>, /// Type of entity to whom the payout is being carried out to, select from the given list of options #[schema(value_type = Option<PayoutEntityType>, example = "Individual")] pub entity_type: Option<api_enums::PayoutEntityType>, /// Specifies whether or not the payout request is recurring #[schema(value_type = Option<bool>, default = false)] pub recurring: Option<bool>, /// You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object. #[schema(value_type = Option<Object>, example = r#"{ "udf1": "some-value", "udf2": "some-value" }"#)] pub metadata: Option<pii::SecretSerdeValue>, /// Provide a reference to a stored payout method, used to process the payout. #[schema(example = "187282ab-40ef-47a9-9206-5099ba31e432", value_type = Option<String>)] pub payout_token: Option<String>, /// The business profile to use for this payout, especially if there are multiple business profiles associated with the account, otherwise default business profile associated with the merchant account will be used. #[schema(value_type = Option<String>)] pub profile_id: Option<id_type::ProfileId>, /// The send method which will be required for processing payouts, check options for better understanding. #[schema(value_type = Option<PayoutSendPriority>, example = "instant")] pub priority: Option<api_enums::PayoutSendPriority>, /// Whether to get the payout link (if applicable). Merchant need to specify this during the Payout _Create_, this field can not be updated during Payout _Update_. #[schema(default = false, example = true, value_type = Option<bool>)] pub payout_link: Option<bool>, /// Custom payout link config for the particular payout, if payout link is to be generated. #[schema(value_type = Option<PayoutCreatePayoutLinkConfig>)] pub payout_link_config: Option<PayoutCreatePayoutLinkConfig>, /// Will be used to expire client secret after certain amount of time to be supplied in seconds /// (900) for 15 mins #[schema(value_type = Option<u32>, example = 900)] pub session_expiry: Option<u32>, /// Customer's email. _Deprecated: Use customer object instead._ #[schema(deprecated, max_length = 255, value_type = Option<String>, example = "johntest@test.com")] pub email: Option<Email>, /// Customer's name. _Deprecated: Use customer object instead._ #[schema(deprecated, value_type = Option<String>, max_length = 255, example = "John Test")] pub name: Option<Secret<String>>, /// Customer's phone. _Deprecated: Use customer object instead._ #[schema(deprecated, value_type = Option<String>, max_length = 255, example = "9123456789")] pub phone: Option<Secret<String>>, /// Customer's phone country code. _Deprecated: Use customer object instead._ #[schema(deprecated, max_length = 255, example = "+1")] pub phone_country_code: Option<String>, /// Identifier for payout method pub payout_method_id: Option<String>, /// Additional details required by 3DS 2.0 #[schema(value_type = Option<BrowserInformation>)] pub browser_info: Option<BrowserInformation>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PayoutCreateRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_7203511897075112764
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct PayoutCreatePayoutLinkConfig { /// The unique identifier for the collect link. #[schema(value_type = Option<String>, example = "pm_collect_link_2bdacf398vwzq5n422S1")] pub payout_link_id: Option<String>, #[serde(flatten)] #[schema(value_type = Option<GenericLinkUiConfig>)] pub ui_config: Option<link_utils::GenericLinkUiConfig>, /// List of payout methods shown on collect UI #[schema(value_type = Option<Vec<EnabledPaymentMethod>>, example = r#"[{"payment_method": "bank_transfer", "payment_method_types": ["ach", "bacs"]}]"#)] pub enabled_payment_methods: Option<Vec<link_utils::EnabledPaymentMethod>>, /// Form layout of the payout link #[schema(value_type = Option<UIWidgetFormLayout>, max_length = 255, example = "tabs")] pub form_layout: Option<api_enums::UIWidgetFormLayout>, /// `test_mode` allows for opening payout links without any restrictions. This removes /// - domain name validations /// - check for making sure link is accessed within an iframe #[schema(value_type = Option<bool>, example = false)] pub test_mode: Option<bool>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PayoutCreatePayoutLinkConfig", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-8567540680987272458
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct CardPayout { /// The card number #[schema(value_type = String, example = "4242424242424242")] pub card_number: CardNumber, /// The card's expiry month #[schema(value_type = String)] pub expiry_month: Secret<String>, /// The card's expiry year #[schema(value_type = String)] pub expiry_year: Secret<String>, /// The card holder's name #[schema(value_type = String, example = "John Doe")] pub card_holder_name: Option<Secret<String>>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "CardPayout", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-3400081497393724320
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct AchBankTransfer { /// Bank name #[schema(value_type = Option<String>, example = "Deutsche Bank")] pub bank_name: Option<String>, /// Bank country code #[schema(value_type = Option<CountryAlpha2>, example = "US")] pub bank_country_code: Option<api_enums::CountryAlpha2>, /// Bank city #[schema(value_type = Option<String>, example = "California")] pub bank_city: Option<String>, /// Bank account number is an unique identifier assigned by a bank to a customer. #[schema(value_type = String, example = "000123456")] pub bank_account_number: Secret<String>, /// [9 digits] Routing number - used in USA for identifying a specific bank. #[schema(value_type = String, example = "110000000")] pub bank_routing_number: Secret<String>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "AchBankTransfer", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_3259208398232291421
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct BacsBankTransfer { /// Bank name #[schema(value_type = Option<String>, example = "Deutsche Bank")] pub bank_name: Option<String>, /// Bank country code #[schema(value_type = Option<CountryAlpha2>, example = "US")] pub bank_country_code: Option<api_enums::CountryAlpha2>, /// Bank city #[schema(value_type = Option<String>, example = "California")] pub bank_city: Option<String>, /// Bank account number is an unique identifier assigned by a bank to a customer. #[schema(value_type = String, example = "000123456")] pub bank_account_number: Secret<String>, /// [6 digits] Sort Code - used in UK and Ireland for identifying a bank and it's branches. #[schema(value_type = String, example = "98-76-54")] pub bank_sort_code: Secret<String>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "BacsBankTransfer", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_9106331717626260042
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct PixBankTransfer { /// Bank name #[schema(value_type = Option<String>, example = "Deutsche Bank")] pub bank_name: Option<String>, /// Bank branch #[schema(value_type = Option<String>, example = "3707")] pub bank_branch: Option<String>, /// Bank account number is an unique identifier assigned by a bank to a customer. #[schema(value_type = String, example = "000123456")] pub bank_account_number: Secret<String>, /// Unique key for pix customer #[schema(value_type = String, example = "000123456")] pub pix_key: Secret<String>, /// Individual taxpayer identification number #[schema(value_type = Option<String>, example = "000123456")] pub tax_id: Option<Secret<String>>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PixBankTransfer", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-587445544332152902
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct Interac { /// Customer email linked with interac account #[schema(value_type = String, example = "john.doe@example.com")] pub email: Email, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "Interac", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-5681740426624276503
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct Paypal { /// Email linked with paypal account #[schema(value_type = String, example = "john.doe@example.com")] pub email: Option<Email>, /// mobile number linked to paypal account #[schema(value_type = String, example = "16608213349")] pub telephone_number: Option<Secret<String>>, /// id of the paypal account #[schema(value_type = String, example = "G83KXTJ5EHCQ2")] pub paypal_id: Option<Secret<String>>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "Paypal", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-3645208117586073164
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct Venmo { /// mobile number linked to venmo account #[schema(value_type = String, example = "16608213349")] pub telephone_number: Option<Secret<String>>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "Venmo", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_3446419506735132748
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct ApplePayDecrypt { /// The dpan number associated with card number #[schema(value_type = String, example = "4242424242424242")] pub dpan: CardNumber, /// The card's expiry month #[schema(value_type = String)] pub expiry_month: Secret<String>, /// The card's expiry year #[schema(value_type = String)] pub expiry_year: Secret<String>, /// The card holder's name #[schema(value_type = String, example = "John Doe")] pub card_holder_name: Option<Secret<String>>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "ApplePayDecrypt", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-648322744192563716
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct PayoutCreateResponse { /// Unique identifier for the payout. This ensures idempotency for multiple payouts /// that have been done by a single merchant. This field is auto generated and is returned in the API response. #[schema( value_type = String, min_length = 30, max_length = 30, example = "187282ab-40ef-47a9-9206-5099ba31e432" )] pub payout_id: id_type::PayoutId, /// This is an identifier for the merchant account. This is inferred from the API key /// provided during the request #[schema(max_length = 255, value_type = String, example = "merchant_1668273825")] pub merchant_id: id_type::MerchantId, /// Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported. #[schema(value_type = Option<String>, max_length = 255, example = "merchant_order_ref_123")] pub merchant_order_reference_id: Option<String>, /// The payout amount. Amount for the payout in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc., #[schema(value_type = i64, example = 1000)] pub amount: common_utils::types::MinorUnit, /// Recipient's currency for the payout request #[schema(value_type = Currency, example = "USD")] pub currency: api_enums::Currency, /// The connector used for the payout #[schema(example = "wise")] pub connector: Option<String>, /// The payout method that is to be used #[schema(value_type = Option<PayoutType>, example = "bank")] pub payout_type: Option<api_enums::PayoutType>, /// The payout method details for the payout #[schema(value_type = Option<PayoutMethodDataResponse>, example = json!(r#"{ "card": { "last4": "2503", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "400000", "card_extended_bin": null, "card_exp_month": "08", "card_exp_year": "25", "card_holder_name": null, "payment_checks": null, "authentication_data": null } }"#))] pub payout_method_data: Option<PayoutMethodDataResponse>, /// The billing address for the payout #[schema(value_type = Option<Address>, example = json!(r#"{ "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Francisco", "state": "CA", "zip": "94122", "country": "US", "first_name": "John", "last_name": "Doe" }, "phone": { "number": "9123456789", "country_code": "+1" } }"#))] pub billing: Option<payments::Address>, /// Set to true to confirm the payout without review, no further action required #[schema(value_type = bool, example = true, default = false)] pub auto_fulfill: bool, /// The identifier for the customer object. If not provided the customer ID will be autogenerated. #[schema(value_type = String, max_length = 255, example = "cus_y3oqhf46pyzuxjbcn2giaqnb44")] pub customer_id: Option<id_type::CustomerId>, /// Passing this object creates a new customer or attaches an existing customer to the payout #[schema(value_type = Option<CustomerDetailsResponse>)] pub customer: Option<payments::CustomerDetailsResponse>, /// It's a token used for client side verification. #[schema(value_type = String, example = "pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo")] pub client_secret: Option<String>, /// The URL to redirect after the completion of the operation #[schema(value_type = String, example = "https://hyperswitch.io")] pub return_url: Option<String>, /// Business country of the merchant for this payout #[schema(example = "US", value_type = CountryAlpha2)] pub business_country: Option<api_enums::CountryAlpha2>, /// Business label of the merchant for this payout #[schema(example = "food", value_type = Option<String>)] pub business_label: Option<String>, /// A description of the payout #[schema(example = "It's my first payout request", value_type = Option<String>)] pub description: Option<String>, /// Type of entity to whom the payout is being carried out to #[schema(value_type = PayoutEntityType, example = "Individual")] pub entity_type: api_enums::PayoutEntityType, /// Specifies whether or not the payout request is recurring #[schema(value_type = bool, default = false)] pub recurring: bool, /// You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object. #[schema(value_type = Option<Object>, example = r#"{ "udf1": "some-value", "udf2": "some-value" }"#)] pub metadata: Option<pii::SecretSerdeValue>, /// Unique identifier of the merchant connector account #[schema(value_type = Option<String>, example = "mca_sAD3OZLATetvjLOYhUSy")] pub merchant_connector_id: Option<id_type::MerchantConnectorAccountId>, /// Current status of the Payout #[schema(value_type = PayoutStatus, example = RequiresConfirmation)] pub status: api_enums::PayoutStatus, /// If there was an error while calling the connector the error message is received here #[schema(value_type = Option<String>, example = "Failed while verifying the card")] pub error_message: Option<String>, /// If there was an error while calling the connectors the code is received here #[schema(value_type = Option<String>, example = "E0001")] pub error_code: Option<String>, /// The business profile that is associated with this payout #[schema(value_type = String)] pub profile_id: id_type::ProfileId, /// Time when the payout was created #[schema(example = "2022-09-10T10:11:12Z")] #[serde(with = "common_utils::custom_serde::iso8601::option")] pub created: Option<PrimitiveDateTime>, /// Underlying processor's payout resource ID #[schema(value_type = Option<String>, example = "S3FC9G9M2MVFDXT5")] pub connector_transaction_id: Option<String>, /// Payout's send priority (if applicable) #[schema(value_type = Option<PayoutSendPriority>, example = "instant")] pub priority: Option<api_enums::PayoutSendPriority>, /// List of attempts #[schema(value_type = Option<Vec<PayoutAttemptResponse>>)] #[serde(skip_serializing_if = "Option::is_none")] pub attempts: Option<Vec<PayoutAttemptResponse>>, /// If payout link was requested, this contains the link's ID and the URL to render the payout widget #[schema(value_type = Option<PayoutLinkResponse>)] pub payout_link: Option<PayoutLinkResponse>, /// Customer's email. _Deprecated: Use customer object instead._ #[schema(deprecated, max_length = 255, value_type = Option<String>, example = "johntest@test.com")] pub email: crypto::OptionalEncryptableEmail, /// Customer's name. _Deprecated: Use customer object instead._ #[schema(deprecated, value_type = Option<String>, max_length = 255, example = "John Test")] pub name: crypto::OptionalEncryptableName, /// Customer's phone. _Deprecated: Use customer object instead._ #[schema(deprecated, value_type = Option<String>, max_length = 255, example = "9123456789")] pub phone: crypto::OptionalEncryptablePhone, /// Customer's phone country code. _Deprecated: Use customer object instead._ #[schema(deprecated, max_length = 255, example = "+1")] pub phone_country_code: Option<String>, /// (This field is not live yet) /// Error code unified across the connectors is received here in case of errors while calling the underlying connector #[remove_in(PayoutCreateResponse)] #[schema(value_type = Option<String>, max_length = 255, example = "UE_000")] pub unified_code: Option<UnifiedCode>, /// (This field is not live yet) /// Error message unified across the connectors is received here in case of errors while calling the underlying connector #[remove_in(PayoutCreateResponse)] #[schema(value_type = Option<String>, max_length = 1024, example = "Invalid card details")] pub unified_message: Option<UnifiedMessage>, /// Identifier for payout method pub payout_method_id: Option<String>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PayoutCreateResponse", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-7826719686033056446
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct PayoutAttemptResponse { /// Unique identifier for the attempt pub attempt_id: String, /// The status of the attempt #[schema(value_type = PayoutStatus, example = "failed")] pub status: api_enums::PayoutStatus, /// The payout attempt amount. Amount for the payout in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc., #[schema(value_type = i64, example = 6583)] pub amount: common_utils::types::MinorUnit, /// The currency of the amount of the payout attempt #[schema(value_type = Option<Currency>, example = "USD")] pub currency: Option<api_enums::Currency>, /// The connector used for the payout pub connector: Option<String>, /// Connector's error code in case of failures pub error_code: Option<String>, /// Connector's error message in case of failures pub error_message: Option<String>, /// The payout method that was used #[schema(value_type = Option<PayoutType>, example = "bank")] pub payment_method: Option<api_enums::PayoutType>, /// Payment Method Type #[schema(value_type = Option<PaymentMethodType>, example = "bacs")] pub payout_method_type: Option<api_enums::PaymentMethodType>, /// A unique identifier for a payout provided by the connector pub connector_transaction_id: Option<String>, /// If the payout was cancelled the reason provided here pub cancellation_reason: Option<String>, /// (This field is not live yet) /// Error code unified across the connectors is received here in case of errors while calling the underlying connector #[remove_in(PayoutAttemptResponse)] #[schema(value_type = Option<String>, max_length = 255, example = "UE_000")] pub unified_code: Option<UnifiedCode>, /// (This field is not live yet) /// Error message unified across the connectors is received here in case of errors while calling the underlying connector #[remove_in(PayoutAttemptResponse)] #[schema(value_type = Option<String>, max_length = 1024, example = "Invalid card details")] pub unified_message: Option<UnifiedMessage>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PayoutAttemptResponse", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-340671339397172803
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct PayoutRetrieveBody { pub force_sync: Option<bool>, #[schema(value_type = Option<String>)] pub merchant_id: Option<id_type::MerchantId>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PayoutRetrieveBody", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-6902317105597642413
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct PayoutRetrieveRequest { /// Unique identifier for the payout. This ensures idempotency for multiple payouts /// that have been done by a single merchant. This field is auto generated and is returned in the API response. #[schema( value_type = String, min_length = 30, max_length = 30, example = "187282ab-40ef-47a9-9206-5099ba31e432" )] pub payout_id: id_type::PayoutId, /// `force_sync` with the connector to get payout details /// (defaults to false) #[schema(value_type = Option<bool>, default = false, example = true)] pub force_sync: Option<bool>, /// The identifier for the Merchant Account. #[schema(value_type = Option<String>)] pub merchant_id: Option<id_type::MerchantId>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PayoutRetrieveRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-99437718186323329
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct PayoutActionRequest { /// Unique identifier for the payout. This ensures idempotency for multiple payouts /// that have been done by a single merchant. This field is auto generated and is returned in the API response. #[schema( value_type = String, min_length = 30, max_length = 30, example = "187282ab-40ef-47a9-9206-5099ba31e432" )] pub payout_id: id_type::PayoutId, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PayoutActionRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_3445450278742178979
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct PayoutVendorAccountDetails { pub vendor_details: PayoutVendorDetails, pub individual_details: PayoutIndividualDetails, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PayoutVendorAccountDetails", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-254766789320472541
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct PayoutVendorDetails { pub account_type: String, pub business_type: String, pub business_profile_mcc: Option<i32>, pub business_profile_url: Option<String>, pub business_profile_name: Option<Secret<String>>, pub company_address_line1: Option<Secret<String>>, pub company_address_line2: Option<Secret<String>>, pub company_address_postal_code: Option<Secret<String>>, pub company_address_city: Option<Secret<String>>, pub company_address_state: Option<Secret<String>>, pub company_phone: Option<Secret<String>>, pub company_tax_id: Option<Secret<String>>, pub company_owners_provided: Option<bool>, pub capabilities_card_payments: Option<bool>, pub capabilities_transfers: Option<bool>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PayoutVendorDetails", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-6091403217831522498
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct PayoutIndividualDetails { pub tos_acceptance_date: Option<i64>, pub tos_acceptance_ip: Option<Secret<String>>, pub individual_dob_day: Option<Secret<String>>, pub individual_dob_month: Option<Secret<String>>, pub individual_dob_year: Option<Secret<String>>, pub individual_id_number: Option<Secret<String>>, pub individual_ssn_last_4: Option<Secret<String>>, pub external_account_account_holder_type: Option<String>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PayoutIndividualDetails", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_343987090026291986
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct PayoutListConstraints { /// The identifier for customer #[schema(value_type = Option<String>, example = "cus_y3oqhf46pyzuxjbcn2giaqnb44")] pub customer_id: Option<id_type::CustomerId>, /// A cursor for use in pagination, fetch the next list after some object #[schema(example = "payout_fafa124123", value_type = Option<String>,)] pub starting_after: Option<id_type::PayoutId>, /// A cursor for use in pagination, fetch the previous list before some object #[schema(example = "payout_fafa124123", value_type = Option<String>,)] pub ending_before: Option<id_type::PayoutId>, /// limit on the number of objects to return #[schema(default = 10, maximum = 100)] #[serde(default = "default_payouts_list_limit")] pub limit: u32, /// The time at which payout is created #[schema(example = "2022-09-10T10:11:12Z")] #[serde(default, with = "common_utils::custom_serde::iso8601::option")] pub created: Option<PrimitiveDateTime>, /// The time range for which objects are needed. TimeRange has two fields start_time and end_time from which objects can be filtered as per required scenarios (created_at, time less than, greater than etc). #[serde(flatten)] #[schema(value_type = Option<TimeRange>)] pub time_range: Option<common_utils::types::TimeRange>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PayoutListConstraints", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-6825985324942763561
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct PayoutListFilterConstraints { /// The identifier for payout #[schema( value_type = Option<String>, min_length = 30, max_length = 30, example = "187282ab-40ef-47a9-9206-5099ba31e432" )] pub payout_id: Option<id_type::PayoutId>, /// The merchant order reference ID for payout #[schema(value_type = Option<String>, max_length = 255, example = "merchant_order_ref_123")] pub merchant_order_reference_id: Option<String>, /// The identifier for business profile #[schema(value_type = Option<String>)] pub profile_id: Option<id_type::ProfileId>, /// The identifier for customer #[schema(value_type = Option<String>,example = "cus_y3oqhf46pyzuxjbcn2giaqnb44")] pub customer_id: Option<id_type::CustomerId>, /// The limit on the number of objects. The default limit is 10 and max limit is 20 #[serde(default = "default_payouts_list_limit")] pub limit: u32, /// The starting point within a list of objects pub offset: Option<u32>, /// The time range for which objects are needed. TimeRange has two fields start_time and end_time from which objects can be filtered as per required scenarios (created_at, time less than, greater than etc). #[serde(flatten)] #[schema(value_type = Option<TimeRange>)] pub time_range: Option<common_utils::types::TimeRange>, /// The list of connectors to filter payouts list #[schema(value_type = Option<Vec<PayoutConnectors>>, max_length = 255, example = json!(["wise", "adyen"]))] pub connector: Option<Vec<api_enums::PayoutConnectors>>, /// The list of currencies to filter payouts list #[schema(value_type = Currency, example = "USD")] pub currency: Option<Vec<api_enums::Currency>>, /// The list of payout status to filter payouts list #[schema(value_type = Option<Vec<PayoutStatus>>, example = json!(["pending", "failed"]))] pub status: Option<Vec<api_enums::PayoutStatus>>, /// The list of payout methods to filter payouts list #[schema(value_type = Option<Vec<PayoutType>>, example = json!(["bank", "card"]))] pub payout_method: Option<Vec<common_enums::PayoutType>>, /// Type of recipient #[schema(value_type = PayoutEntityType, example = "Individual")] pub entity_type: Option<common_enums::PayoutEntityType>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PayoutListFilterConstraints", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-7706072540937606316
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct PayoutListResponse { /// The number of payouts included in the list pub size: usize, /// The list of payouts response objects pub data: Vec<PayoutCreateResponse>, /// The total number of available payouts for given constraints #[serde(skip_serializing_if = "Option::is_none")] pub total_count: Option<i64>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PayoutListResponse", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_3320320718802091020
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct PayoutListFilters { /// The list of available connector filters #[schema(value_type = Vec<PayoutConnectors>)] pub connector: Vec<api_enums::PayoutConnectors>, /// The list of available currency filters #[schema(value_type = Vec<Currency>)] pub currency: Vec<common_enums::Currency>, /// The list of available payout status filters #[schema(value_type = Vec<PayoutStatus>)] pub status: Vec<common_enums::PayoutStatus>, /// The list of available payout method filters #[schema(value_type = Vec<PayoutType>)] pub payout_method: Vec<common_enums::PayoutType>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PayoutListFilters", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-2946490496546825961
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct PayoutLinkResponse { pub payout_link_id: String, #[schema(value_type = String)] pub link: Secret<url::Url>, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PayoutLinkResponse", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-43991810737667996
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct PayoutLinkInitiateRequest { #[schema(value_type = String)] pub merchant_id: id_type::MerchantId, #[schema(value_type = String)] pub payout_id: id_type::PayoutId, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PayoutLinkInitiateRequest", "total_crates": null, "trait_name": null }
hyperswitch_struct_api_models_-8667793107342019881
clm
struct
// hyperswitch/crates/api_models/src/payouts.rs pub struct PayoutLinkDetails { pub publishable_key: Secret<String>, pub client_secret: Secret<String>, pub payout_link_id: String, pub payout_id: id_type::PayoutId, pub customer_id: id_type::CustomerId, #[serde(with = "common_utils::custom_serde::iso8601")] pub session_expiry: PrimitiveDateTime, pub return_url: Option<url::Url>, #[serde(flatten)] pub ui_config: link_utils::GenericLinkUiConfigFormData, pub enabled_payment_methods: Vec<link_utils::EnabledPaymentMethod>, pub enabled_payment_methods_with_required_fields: Vec<PayoutEnabledPaymentMethodsInfo>, pub amount: common_utils::types::StringMajorUnit, pub currency: common_enums::Currency, pub locale: String, pub form_layout: Option<common_enums::UIWidgetFormLayout>, pub test_mode: bool, }
{ "chunk": null, "crate": "api_models", "enum_name": null, "file_size": null, "for_type": null, "function_name": null, "is_async": null, "is_pub": null, "lines": null, "method_name": null, "num_enums": null, "num_items": null, "num_structs": null, "repo": "hyperswitch", "start_line": null, "struct_name": "PayoutLinkDetails", "total_crates": null, "trait_name": null }