1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
// ======================================
// This file was automatically generated.
// ======================================
use serde::{Deserialize, Serialize};
use crate::ids::IssuingAuthorizationId;
use crate::params::{Expandable, Metadata, Object, Timestamp};
use crate::resources::{
BalanceTransaction, Currency, IssuingAuthorizationAmountDetails, IssuingAuthorizationCheck,
IssuingAuthorizationMethod, IssuingAuthorizationReason, IssuingCard, IssuingCardholder,
IssuingToken, IssuingTransaction, MerchantData,
};
/// The resource representing a Stripe "IssuingAuthorization".
///
/// For more details see <https://stripe.com/docs/api/issuing/authorizations/object>
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct IssuingAuthorization {
/// Unique identifier for the object.
pub id: IssuingAuthorizationId,
/// The total amount that was authorized or rejected.
///
/// This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
/// `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different.
pub amount: i64,
/// Detailed breakdown of amount components.
///
/// These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
pub amount_details: Option<IssuingAuthorizationAmountDetails>,
/// Whether the authorization has been approved.
pub approved: bool,
/// How the card details were provided.
pub authorization_method: IssuingAuthorizationMethod,
/// List of balance transactions associated with this authorization.
pub balance_transactions: Vec<BalanceTransaction>,
pub card: IssuingCard,
/// The cardholder to whom this authorization belongs.
pub cardholder: Option<Expandable<IssuingCardholder>>,
/// Time at which the object was created.
///
/// Measured in seconds since the Unix epoch.
pub created: Timestamp,
/// The currency of the cardholder.
///
/// This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization.
/// Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
/// Must be a [supported currency](https://stripe.com/docs/currencies).
pub currency: Currency,
/// Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
pub livemode: bool,
/// The total amount that was authorized or rejected.
///
/// This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
/// `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different.
pub merchant_amount: i64,
/// The local currency that was presented to the cardholder for the authorization.
///
/// This currency can be different from the cardholder currency and the `currency` field on this authorization.
/// Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
/// Must be a [supported currency](https://stripe.com/docs/currencies).
pub merchant_currency: Currency,
pub merchant_data: MerchantData,
/// Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object.
///
/// This can be useful for storing additional information about the object in a structured format.
pub metadata: Metadata,
/// Details about the authorization, such as identifiers, set by the card network.
pub network_data: Option<IssuingAuthorizationNetworkData>,
/// The pending authorization request.
///
/// This field will only be non-null during an `issuing_authorization.request` webhook.
pub pending_request: Option<IssuingAuthorizationPendingRequest>,
/// History of every time a `pending_request` authorization was approved/declined, either by you directly or by Stripe (e.g.
///
/// based on your spending_controls).
/// If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization.
/// This field can be helpful in determining why a given authorization was approved/declined.
pub request_history: Vec<IssuingAuthorizationRequest>,
/// The current status of the authorization in its lifecycle.
pub status: IssuingAuthorizationStatus,
/// [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this authorization.
///
/// If a network token was not used for this authorization, this field will be null.
#[serde(skip_serializing_if = "Option::is_none")]
pub token: Option<Expandable<IssuingToken>>,
/// List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization.
pub transactions: Vec<IssuingTransaction>,
/// [Treasury](https://stripe.com/docs/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts).
#[serde(skip_serializing_if = "Option::is_none")]
pub treasury: Option<IssuingAuthorizationTreasury>,
pub verification_data: IssuingAuthorizationVerificationData,
/// The digital wallet used for this transaction.
///
/// One of `apple_pay`, `google_pay`, or `samsung_pay`.
/// Will populate as `null` when no digital wallet was utilized.
pub wallet: Option<String>,
}
impl Object for IssuingAuthorization {
type Id = IssuingAuthorizationId;
fn id(&self) -> Self::Id {
self.id.clone()
}
fn object(&self) -> &'static str {
"issuing.authorization"
}
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct IssuingAuthorizationNetworkData {
/// Identifier assigned to the acquirer by the card network.
///
/// Sometimes this value is not provided by the network; in this case, the value will be `null`.
pub acquiring_institution_id: Option<String>,
/// The System Trace Audit Number (STAN) is a 6-digit identifier assigned by the acquirer.
///
/// Prefer `network_data.transaction_id` if present, unless you have special requirements.
pub system_trace_audit_number: Option<String>,
/// Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.
pub transaction_id: Option<String>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct IssuingAuthorizationPendingRequest {
/// The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://stripe.com/docs/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
pub amount: i64,
/// Detailed breakdown of amount components.
///
/// These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
pub amount_details: Option<IssuingAuthorizationAmountDetails>,
/// Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
///
/// Must be a [supported currency](https://stripe.com/docs/currencies).
pub currency: Currency,
/// If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.
pub is_amount_controllable: bool,
/// The amount the merchant is requesting to be authorized in the `merchant_currency`.
///
/// The amount is in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
pub merchant_amount: i64,
/// The local currency the merchant is requesting to authorize.
pub merchant_currency: Currency,
/// The card network's estimate of the likelihood that an authorization is fraudulent.
///
/// Takes on values between 1 and 99.
pub network_risk_score: Option<i64>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct IssuingAuthorizationRequest {
/// The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
///
/// Stripe held this amount from your account to fund the authorization if the request was approved.
pub amount: i64,
/// Detailed breakdown of amount components.
///
/// These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
pub amount_details: Option<IssuingAuthorizationAmountDetails>,
/// Whether this request was approved.
pub approved: bool,
/// A code created by Stripe which is shared with the merchant to validate the authorization.
///
/// This field will be populated if the authorization message was approved.
/// The code typically starts with the letter "S", followed by a six-digit number.
/// For example, "S498162".
/// Please note that the code is not guaranteed to be unique across authorizations.
pub authorization_code: Option<String>,
/// Time at which the object was created.
///
/// Measured in seconds since the Unix epoch.
pub created: Timestamp,
/// Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
///
/// Must be a [supported currency](https://stripe.com/docs/currencies).
pub currency: Currency,
/// The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
pub merchant_amount: i64,
/// The currency that was collected by the merchant and presented to the cardholder for the authorization.
///
/// Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
/// Must be a [supported currency](https://stripe.com/docs/currencies).
pub merchant_currency: Currency,
/// The card network's estimate of the likelihood that an authorization is fraudulent.
///
/// Takes on values between 1 and 99.
pub network_risk_score: Option<i64>,
/// When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome.
pub reason: IssuingAuthorizationReason,
/// If the `request_history.reason` is `webhook_error` because the direct webhook response is invalid (for example, parsing errors or missing parameters), we surface a more detailed error message via this field.
pub reason_message: Option<String>,
/// Time when the card network received an authorization request from the acquirer in UTC.
///
/// Referred to by networks as transmission time.
pub requested_at: Option<Timestamp>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct IssuingAuthorizationTreasury {
/// The array of [ReceivedCredits](https://stripe.com/docs/api/treasury/received_credits) associated with this authorization.
pub received_credits: Vec<String>,
/// The array of [ReceivedDebits](https://stripe.com/docs/api/treasury/received_debits) associated with this authorization.
pub received_debits: Vec<String>,
/// The Treasury [Transaction](https://stripe.com/docs/api/treasury/transactions) associated with this authorization.
pub transaction: Option<String>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct IssuingAuthorizationVerificationData {
/// Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`.
pub address_line1_check: IssuingAuthorizationCheck,
/// Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`.
pub address_postal_code_check: IssuingAuthorizationCheck,
/// The exemption applied to this authorization.
pub authentication_exemption: Option<IssuingAuthorizationAuthenticationExemption>,
/// Whether the cardholder provided a CVC and if it matched Stripe’s record.
pub cvc_check: IssuingAuthorizationCheck,
/// Whether the cardholder provided an expiry date and if it matched Stripe’s record.
pub expiry_check: IssuingAuthorizationCheck,
/// The postal code submitted as part of the authorization used for postal code verification.
pub postal_code: Option<String>,
/// 3D Secure details.
pub three_d_secure: Option<IssuingAuthorizationThreeDSecure>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct IssuingAuthorizationAuthenticationExemption {
/// The entity that requested the exemption, either the acquiring merchant or the Issuing user.
pub claimed_by: IssuingAuthorizationAuthenticationExemptionClaimedBy,
/// The specific exemption claimed for this authorization.
#[serde(rename = "type")]
pub type_: IssuingAuthorizationAuthenticationExemptionType,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct IssuingAuthorizationThreeDSecure {
/// The outcome of the 3D Secure authentication request.
pub result: IssuingAuthorizationThreeDSecureResult,
}
/// An enum representing the possible values of an `IssuingAuthorizationAuthenticationExemption`'s `claimed_by` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum IssuingAuthorizationAuthenticationExemptionClaimedBy {
Acquirer,
Issuer,
}
impl IssuingAuthorizationAuthenticationExemptionClaimedBy {
pub fn as_str(self) -> &'static str {
match self {
IssuingAuthorizationAuthenticationExemptionClaimedBy::Acquirer => "acquirer",
IssuingAuthorizationAuthenticationExemptionClaimedBy::Issuer => "issuer",
}
}
}
impl AsRef<str> for IssuingAuthorizationAuthenticationExemptionClaimedBy {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for IssuingAuthorizationAuthenticationExemptionClaimedBy {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for IssuingAuthorizationAuthenticationExemptionClaimedBy {
fn default() -> Self {
Self::Acquirer
}
}
/// An enum representing the possible values of an `IssuingAuthorizationAuthenticationExemption`'s `type` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum IssuingAuthorizationAuthenticationExemptionType {
LowValueTransaction,
TransactionRiskAnalysis,
Unknown,
}
impl IssuingAuthorizationAuthenticationExemptionType {
pub fn as_str(self) -> &'static str {
match self {
IssuingAuthorizationAuthenticationExemptionType::LowValueTransaction => {
"low_value_transaction"
}
IssuingAuthorizationAuthenticationExemptionType::TransactionRiskAnalysis => {
"transaction_risk_analysis"
}
IssuingAuthorizationAuthenticationExemptionType::Unknown => "unknown",
}
}
}
impl AsRef<str> for IssuingAuthorizationAuthenticationExemptionType {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for IssuingAuthorizationAuthenticationExemptionType {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for IssuingAuthorizationAuthenticationExemptionType {
fn default() -> Self {
Self::LowValueTransaction
}
}
/// An enum representing the possible values of an `IssuingAuthorization`'s `status` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum IssuingAuthorizationStatus {
Closed,
Pending,
Reversed,
}
impl IssuingAuthorizationStatus {
pub fn as_str(self) -> &'static str {
match self {
IssuingAuthorizationStatus::Closed => "closed",
IssuingAuthorizationStatus::Pending => "pending",
IssuingAuthorizationStatus::Reversed => "reversed",
}
}
}
impl AsRef<str> for IssuingAuthorizationStatus {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for IssuingAuthorizationStatus {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for IssuingAuthorizationStatus {
fn default() -> Self {
Self::Closed
}
}
/// An enum representing the possible values of an `IssuingAuthorizationThreeDSecure`'s `result` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum IssuingAuthorizationThreeDSecureResult {
AttemptAcknowledged,
Authenticated,
Failed,
Required,
}
impl IssuingAuthorizationThreeDSecureResult {
pub fn as_str(self) -> &'static str {
match self {
IssuingAuthorizationThreeDSecureResult::AttemptAcknowledged => "attempt_acknowledged",
IssuingAuthorizationThreeDSecureResult::Authenticated => "authenticated",
IssuingAuthorizationThreeDSecureResult::Failed => "failed",
IssuingAuthorizationThreeDSecureResult::Required => "required",
}
}
}
impl AsRef<str> for IssuingAuthorizationThreeDSecureResult {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for IssuingAuthorizationThreeDSecureResult {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for IssuingAuthorizationThreeDSecureResult {
fn default() -> Self {
Self::AttemptAcknowledged
}
}