stripe 22.2.0 → 22.3.0-alpha.2

package/esm/resources/Issuing/Authorizations.d.ts

@@ -57,6 +57,7 @@ export interface Authorization {
      * How the card details were provided.
      */
     authorization_method: Issuing.Authorization.AuthorizationMethod;
+    balance_response?: Issuing.Authorization.BalanceResponse;
     /**
      * List of balance transactions associated with this authorization.
      */
@@ -77,6 +78,10 @@ export interface Authorization {
      * Time at which the object was created. Measured in seconds since the Unix epoch.
      */
     created: number;
+    /**
+     * Array of onchain crypto transactions linked to this resource.
+     */
+    crypto_transactions?: Array<Issuing.Authorization.CryptoTransaction> | null;
     /**
      * 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).
      */
@@ -130,6 +135,7 @@ export interface Authorization {
      * [Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null.
      */
     token?: string | Token | null;
+    token_details?: Issuing.Authorization.TokenDetails;
     /**
      * List of [transactions](https://docs.stripe.com/api/issuing/transactions) associated with this authorization.
      */
@@ -161,7 +167,35 @@ export declare namespace Issuing {
             cashback_amount: number | null;
         }
         type AuthorizationMethod = 'chip' | 'contactless' | 'keyed_in' | 'online' | 'swipe';
+        interface BalanceResponse {
+            /**
+             * The cardholder account type affected by this authorization.
+             */
+            account_type: BalanceResponse.AccountType;
+            /**
+             * The remaining balance in the cardholder's account after the authorization, in the smallest currency unit.
+             */
+            amount: number;
+            /**
+             * The currency of the remaining balance in the cardholder's account after the authorization.
+             */
+            currency: string;
+        }
         type CardPresence = 'not_present' | 'present';
+        interface CryptoTransaction {
+            /**
+             * The confirmed crypto transaction details when `type` is `crypto_transaction_confirmed`; otherwise null.
+             */
+            crypto_transaction_confirmed: CryptoTransaction.CryptoTransactionConfirmed | null;
+            /**
+             * The failed crypto transaction details when `type` is `crypto_transaction_failed`; otherwise null.
+             */
+            crypto_transaction_failed: CryptoTransaction.CryptoTransactionFailed | null;
+            /**
+             * The crypto transaction variant for this array entry.
+             */
+            type: string;
+        }
         interface Fleet {
             /**
              * Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.
@@ -241,6 +275,10 @@ export declare namespace Issuing {
              * Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.
              */
             network_id: string;
+            /**
+             * The identifier of the payment facilitator (PayFac) that processed this authorization, as assigned by the card network. Null when the transaction was not processed through a PayFac.
+             */
+            payment_facilitator_id?: string | null;
             /**
              * Postal code where the seller is located
              */
@@ -249,6 +287,10 @@ export declare namespace Issuing {
              * State where the seller is located
              */
             state: string | null;
+            /**
+             * The identifier of the sub-merchant involved in this authorization, as assigned by the payment facilitator. Null when the transaction was not processed through a PayFac or when no sub-merchant ID was provided.
+             */
+            sub_merchant_id?: string | null;
             /**
              * The seller's tax identification number. Currently populated for French merchants only.
              */
@@ -357,6 +399,29 @@ export declare namespace Issuing {
             requested_at: number | null;
         }
         type Status = 'closed' | 'expired' | 'pending' | 'reversed';
+        interface TokenDetails {
+            /**
+             * The card associated with this token.
+             */
+            card: string;
+            /**
+             * Time at which the object was created. Measured in seconds since the Unix epoch.
+             */
+            created: number;
+            /**
+             * The hashed ID derived from the device ID from the card network associated with the token.
+             */
+            device_fingerprint?: string;
+            network_data?: TokenDetails.NetworkData;
+            /**
+             * The decision made during token provisioning.
+             */
+            provisioning_decision?: TokenDetails.ProvisioningDecision | null;
+            /**
+             * The type of the token, indicating how it is used.
+             */
+            token_type?: TokenDetails.TokenType | null;
+        }
         interface Treasury {
             /**
              * The array of [ReceivedCredits](https://docs.stripe.com/api/treasury/received_credits) associated with this authorization
@@ -401,6 +466,131 @@ export declare namespace Issuing {
              */
             three_d_secure: VerificationData.ThreeDSecure | null;
         }
+        namespace BalanceResponse {
+            type AccountType = 'checking' | 'credit' | 'default' | 'other' | 'savings' | 'universal';
+        }
+        namespace CryptoTransaction {
+            interface CryptoTransactionConfirmed {
+                /**
+                 * The crypto amount for the confirmed transaction.
+                 */
+                amount: string;
+                /**
+                 * The upcharged MCC amount, if one was applied.
+                 */
+                amount_mcc_upcharged: string | null;
+                /**
+                 * The blockchain network for the confirmed transaction.
+                 */
+                chain: string;
+                /**
+                 * When the transaction was confirmed onchain.
+                 */
+                confirmed_at: number;
+                /**
+                 * The currency of the crypto transaction amount.
+                 */
+                currency: string;
+                /**
+                 * Fees associated with the transaction.
+                 */
+                fees: Array<CryptoTransactionConfirmed.Fee>;
+                /**
+                 * The source wallet address for the transaction.
+                 */
+                from_address: string;
+                /**
+                 * Memo metadata attached to the transaction, if present.
+                 */
+                memo: string | null;
+                /**
+                 * The destination wallet address for the transaction.
+                 */
+                to_address: string;
+                /**
+                 * The blockchain transaction hash.
+                 */
+                transaction_hash: string;
+            }
+            interface CryptoTransactionFailed {
+                /**
+                 * The crypto amount for the failed transaction.
+                 */
+                amount: string;
+                /**
+                 * The upcharged MCC amount, if one was applied.
+                 */
+                amount_mcc_upcharged: string | null;
+                /**
+                 * The blockchain network for the failed transaction.
+                 */
+                chain: string;
+                /**
+                 * The currency of the crypto transaction amount.
+                 */
+                currency: string;
+                /**
+                 * When the transaction failed.
+                 */
+                failed_at: number;
+                /**
+                 * The reason the transaction failed.
+                 */
+                failure_reason: string;
+                /**
+                 * Fees associated with the transaction.
+                 */
+                fees: Array<CryptoTransactionFailed.Fee>;
+                /**
+                 * The source wallet address for the attempted transaction.
+                 */
+                from_address: string;
+                /**
+                 * Memo metadata attached to the transaction, if present.
+                 */
+                memo: string | null;
+                /**
+                 * The destination wallet address for the attempted transaction when one exists.
+                 */
+                to_address: string | null;
+                /**
+                 * The blockchain transaction hash when one exists.
+                 */
+                transaction_hash: string | null;
+            }
+            namespace CryptoTransactionConfirmed {
+                interface Fee {
+                    /**
+                     * The fee amount.
+                     */
+                    amount: string;
+                    /**
+                     * The fee currency.
+                     */
+                    currency: string;
+                    /**
+                     * The fee type.
+                     */
+                    type: string;
+                }
+            }
+            namespace CryptoTransactionFailed {
+                interface Fee {
+                    /**
+                     * The fee amount.
+                     */
+                    amount: string;
+                    /**
+                     * The fee currency.
+                     */
+                    currency: string;
+                    /**
+                     * The fee type.
+                     */
+                    type: string;
+                }
+            }
+        }
         namespace Fleet {
             interface CardholderPromptData {
                 /**
@@ -503,6 +693,106 @@ export declare namespace Issuing {
             }
             type Reason = 'account_disabled' | 'card_active' | 'card_canceled' | 'card_expired' | 'card_inactive' | 'cardholder_blocked' | 'cardholder_inactive' | 'cardholder_verification_required' | 'insecure_authorization_method' | 'insufficient_funds' | 'network_fallback' | 'not_allowed' | 'pin_blocked' | 'spending_controls' | 'suspected_fraud' | 'verification_failed' | 'webhook_approved' | 'webhook_declined' | 'webhook_error' | 'webhook_timeout';
         }
+        namespace TokenDetails {
+            interface NetworkData {
+                device?: NetworkData.Device;
+                mastercard?: NetworkData.Mastercard;
+                /**
+                 * The card network for this token.
+                 */
+                type: NetworkData.Type;
+                visa?: NetworkData.Visa;
+                wallet_provider?: NetworkData.WalletProvider;
+            }
+            type ProvisioningDecision = 'approve' | 'approve_pending_id_and_v' | 'decline';
+            type TokenType = 'card_on_file' | 'cloud_based' | 'commerce_platform' | 'commercial_virtual_account' | 'secure_element' | 'static_credential';
+            namespace NetworkData {
+                interface Device {
+                    /**
+                     * The IP address of the device at provisioning time.
+                     */
+                    ip_address?: string;
+                    /**
+                     * The ISO 639-1 language code of the device associated with the tokenization request.
+                     */
+                    language?: Device.Language;
+                    /**
+                     * The phone number of the device used for tokenization.
+                     */
+                    phone_number?: string;
+                }
+                interface Mastercard {
+                    /**
+                     * A unique reference ID from the network to represent the card account number.
+                     */
+                    card_reference_id?: string;
+                    /**
+                     * The network-unique identifier for the token.
+                     */
+                    token_reference_id: string;
+                    /**
+                     * The ID of the entity requesting tokenization.
+                     */
+                    token_requestor_id: string;
+                }
+                type Type = 'mastercard' | 'visa';
+                interface Visa {
+                    /**
+                     * A unique reference ID from the network to represent the card account number.
+                     */
+                    card_reference_id?: string;
+                    /**
+                     * Stripe's recommendation to the network for this token activation request, derived from the same risk signals used for the activation decision.
+                     */
+                    token_decision_recommendation?: Visa.TokenDecisionRecommendation | null;
+                    /**
+                     * The network-unique identifier for the token.
+                     */
+                    token_reference_id: string;
+                    /**
+                     * The ID of the entity requesting tokenization.
+                     */
+                    token_requestor_id: string;
+                    /**
+                     * Degree of risk associated with the token between `01` and `99`, with higher number indicating higher risk. A `00` value indicates the token was not scored by Visa.
+                     */
+                    token_risk_score?: string;
+                }
+                interface WalletProvider {
+                    /**
+                     * An evaluation on the trustworthiness of the wallet account between 1 and 5. A higher score indicates more trustworthy.
+                     */
+                    account_trust_score?: number;
+                    /**
+                     * The method used for tokenizing a card.
+                     */
+                    card_number_source?: WalletProvider.CardNumberSource;
+                    /**
+                     * An evaluation on the trustworthiness of the device. A higher score indicates more trustworthy.
+                     */
+                    device_trust_score?: number;
+                    /**
+                     * The reasons for suggested tokenization given by the card network.
+                     */
+                    reason_codes?: Array<WalletProvider.ReasonCode>;
+                    /**
+                     * The recommendation on responding to the tokenization request.
+                     */
+                    suggested_decision?: WalletProvider.SuggestedDecision;
+                }
+                namespace Device {
+                    type Language = 'aa' | 'ab' | 'ae' | 'af' | 'ak' | 'am' | 'an' | 'ar' | 'as' | 'av' | 'ay' | 'az' | 'ba' | 'be' | 'bg' | 'bi' | 'bm' | 'bn' | 'bo' | 'br' | 'bs' | 'ca' | 'ce' | 'ch' | 'co' | 'cr' | 'cs' | 'cu' | 'cv' | 'cy' | 'da' | 'de' | 'dv' | 'dz' | 'ee' | 'el' | 'en' | 'eo' | 'es' | 'et' | 'eu' | 'fa' | 'ff' | 'fi' | 'fj' | 'fo' | 'fr' | 'fy' | 'ga' | 'gd' | 'gl' | 'gn' | 'gu' | 'gv' | 'ha' | 'he' | 'hi' | 'ho' | 'hr' | 'ht' | 'hu' | 'hy' | 'hz' | 'ia' | 'id' | 'ie' | 'ig' | 'ii' | 'ik' | 'io' | 'is' | 'it' | 'iu' | 'ja' | 'jv' | 'ka' | 'kg' | 'ki' | 'kj' | 'kk' | 'kl' | 'km' | 'kn' | 'ko' | 'kr' | 'ks' | 'ku' | 'kv' | 'kw' | 'ky' | 'la' | 'lb' | 'lg' | 'li' | 'ln' | 'lo' | 'lt' | 'lu' | 'lv' | 'mg' | 'mh' | 'mi' | 'mk' | 'ml' | 'mn' | 'mr' | 'ms' | 'mt' | 'my' | 'na' | 'nb' | 'nd' | 'ne' | 'ng' | 'nl' | 'nn' | 'no' | 'nr' | 'nv' | 'ny' | 'oc' | 'oj' | 'om' | 'or' | 'os' | 'pa' | 'pi' | 'pl' | 'ps' | 'pt' | 'qu' | 'rm' | 'rn' | 'ro' | 'ru' | 'rw' | 'sa' | 'sc' | 'sd' | 'se' | 'sg' | 'si' | 'sk' | 'sl' | 'sm' | 'sn' | 'so' | 'sq' | 'sr' | 'ss' | 'st' | 'su' | 'sv' | 'sw' | 'ta' | 'te' | 'tg' | 'th' | 'ti' | 'tk' | 'tl' | 'tn' | 'to' | 'tr' | 'ts' | 'tt' | 'tw' | 'ty' | 'ug' | 'uk' | 'ur' | 'uz' | 've' | 'vi' | 'vo' | 'wa' | 'wo' | 'xh' | 'yi' | 'yo' | 'za' | 'zh' | 'zu';
+                }
+                namespace Visa {
+                    type TokenDecisionRecommendation = 'approve' | 'decline' | 'recommend_id_and_v';
+                }
+                namespace WalletProvider {
+                    type CardNumberSource = 'app' | 'manual' | 'on_file' | 'other';
+                    type ReasonCode = 'account_card_too_new' | 'account_recently_changed' | 'account_too_new' | 'account_too_new_since_launch' | 'additional_device' | 'data_expired' | 'defer_id_v_decision' | 'device_recently_lost' | 'good_activity_history' | 'has_suspended_tokens' | 'high_risk' | 'inactive_account' | 'long_account_tenure' | 'low_account_score' | 'low_device_score' | 'low_phone_number_score' | 'network_service_error' | 'outside_home_territory' | 'provisioning_cardholder_mismatch' | 'provisioning_device_and_cardholder_mismatch' | 'provisioning_device_mismatch' | 'same_device_no_prior_authentication' | 'same_device_successful_prior_authentication' | 'software_update' | 'suspicious_activity' | 'too_many_different_cardholders' | 'too_many_recent_attempts' | 'too_many_recent_tokens';
+                    type SuggestedDecision = 'approve' | 'decline' | 'require_auth';
+                }
+            }
+        }
         namespace VerificationData {
             type AddressLine1Check = 'match' | 'mismatch' | 'not_provided';
             type AddressPostalCodeCheck = 'match' | 'mismatch' | 'not_provided';

package/esm/resources/Issuing/Cardholders.d.ts

@@ -114,7 +114,7 @@ export declare namespace Issuing {
              */
             verification: Individual.Verification | null;
         }
-        type PreferredLocale = 'de' | 'en' | 'es' | 'fr' | 'it';
+        type PreferredLocale = 'da' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'pl' | 'sv';
         interface Requirements {
             /**
              * If `disabled_reason` is present, all cards will decline authorizations with `cardholder_verification_required` reason.
@@ -278,7 +278,8 @@ export declare namespace Issuing {
          */
         metadata?: MetadataParam;
         /**
-         * The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://docs.stripe.com/issuing/3d-secure#when-is-3d-secure-applied) for more details.
+         * The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. This is required for all cardholders who will be creating EU cards.
+         *  While phone number is optional if the cardholder will not be creating EU cards, note that this cardholder will not be eligible for 3DS without a phone number. See the [3D Secure documentation](https://docs.stripe.com/issuing/3d-secure#when-is-3d-secure-applied) for more details.
          */
         phone_number?: string;
         /**
@@ -334,7 +335,7 @@ export declare namespace Issuing {
              */
             verification?: Individual.Verification;
         }
-        type PreferredLocale = 'de' | 'en' | 'es' | 'fr' | 'it';
+        type PreferredLocale = 'da' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'pl' | 'sv';
         interface SpendingControls {
             /**
              * Array of card presence statuses from which authorizations will be allowed. Possible options are `present`, `not_present`. All other statuses will be blocked. Cannot be set with `blocked_card_presences`. Provide an empty value to unset this control.
@@ -568,7 +569,7 @@ export declare namespace Issuing {
              */
             verification?: Individual.Verification;
         }
-        type PreferredLocale = 'de' | 'en' | 'es' | 'fr' | 'it';
+        type PreferredLocale = 'da' | 'de' | 'en' | 'es' | 'fr' | 'it' | 'pl' | 'sv';
         interface SpendingControls {
             /**
              * Array of card presence statuses from which authorizations will be allowed. Possible options are `present`, `not_present`. All other statuses will be blocked. Cannot be set with `blocked_card_presences`. Provide an empty value to unset this control.

package/esm/resources/Issuing/Cards.d.ts

@@ -317,6 +317,10 @@ export declare namespace Issuing {
                  * Reason the card is ineligible for Apple Pay
                  */
                 ineligible_reason: ApplePay.IneligibleReason | null;
+                /**
+                 * Unique identifier for the card in Apple Pay
+                 */
+                primary_account_identifier?: string | null;
             }
             interface GooglePay {
                 /**
@@ -327,6 +331,10 @@ export declare namespace Issuing {
                  * Reason the card is ineligible for Google Pay
                  */
                 ineligible_reason: GooglePay.IneligibleReason | null;
+                /**
+                 * Unique identifier for the card in Google Pay
+                 */
+                primary_account_identifier?: string | null;
             }
             namespace ApplePay {
                 type IneligibleReason = 'missing_agreement' | 'missing_cardholder_contact' | 'unsupported_region';
@@ -786,9 +794,37 @@ export declare namespace Issuing {
          * Only return cards that have the given type. One of `virtual` or `physical`.
          */
         type?: CardListParams.Type;
+        /**
+         * Filter cards by wallet settings.
+         */
+        wallets?: CardListParams.Wallets;
     }
     namespace CardListParams {
         type Status = 'active' | 'canceled' | 'inactive';
         type Type = 'physical' | 'virtual';
+        interface Wallets {
+            /**
+             * Filter cards by Apple Pay wallet details.
+             */
+            apple_pay?: Wallets.ApplePay;
+            /**
+             * Filter cards by Google Pay wallet details.
+             */
+            google_pay?: Wallets.GooglePay;
+        }
+        namespace Wallets {
+            interface ApplePay {
+                /**
+                 * Query by Apple Pay primary account identifier.
+                 */
+                primary_account_identifier?: string;
+            }
+            interface GooglePay {
+                /**
+                 * Query by Google Pay primary account identifier.
+                 */
+                primary_account_identifier?: string;
+            }
+        }
     }
 }