stripe 22.6.1 → 22.7.0-alpha.2

package/cjs/resources/PaymentRecords.d.ts

@@ -1,8 +1,8 @@
 import { StripeResource } from '../StripeResource.js';
 import { PaymentMethod } from './PaymentMethods.js';
 import { Mandate } from './Mandates.js';
-import { PaginationParams, Emptyable, MetadataParam, AddressParam, OtherString, Metadata, Address } from '../shared.js';
-import { RequestOptions, ApiListPromise, Response } from '../lib.js';
+import { PaginationParams, Emptyable, MetadataParam, OtherString, AddressParam, Metadata, Address } from '../shared.js';
+import { RequestOptions, ApiListPromise, Response, ApiSearchResultPromise } from '../lib.js';
 export declare class PaymentRecordResource extends StripeResource {
     /**
      * List all the Payment Records for a given merchant.
@@ -12,6 +12,18 @@ export declare class PaymentRecordResource extends StripeResource {
      * Retrieves a Payment Record with the given ID
      */
     retrieve(id: string, params?: PaymentRecordRetrieveParams, options?: RequestOptions): Promise<Response<PaymentRecord>>;
+    /**
+     * Search for PaymentRecords you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
+     * Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
+     * conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
+     * to an hour behind during outages. Search functionality is not available to merchants in India.
+     */
+    search(params: PaymentRecordSearchParams, options?: RequestOptions): ApiSearchResultPromise<PaymentRecord>;
+    /**
+     * Report that the most recent payment attempt on the specified Payment Record
+     *  was disputed.
+     */
+    reportDispute(id: string, params: PaymentRecordReportDisputeParams, options?: RequestOptions): Promise<Response<PaymentRecord>>;
     /**
      * Report a new payment attempt on the specified Payment Record. A new payment
      *  attempt can only be specified if all other payment attempts are canceled or failed.
@@ -21,17 +33,17 @@ export declare class PaymentRecordResource extends StripeResource {
      * Report that the most recent payment attempt on the specified Payment Record
      *  was canceled.
      */
-    reportPaymentAttemptCanceled(id: string, params: PaymentRecordReportPaymentAttemptCanceledParams, options?: RequestOptions): Promise<Response<PaymentRecord>>;
+    reportPaymentAttemptCanceled(id: string, params?: PaymentRecordReportPaymentAttemptCanceledParams, options?: RequestOptions): Promise<Response<PaymentRecord>>;
     /**
      * Report that the most recent payment attempt on the specified Payment Record
      *  failed or errored.
      */
-    reportPaymentAttemptFailed(id: string, params: PaymentRecordReportPaymentAttemptFailedParams, options?: RequestOptions): Promise<Response<PaymentRecord>>;
+    reportPaymentAttemptFailed(id: string, params?: PaymentRecordReportPaymentAttemptFailedParams, options?: RequestOptions): Promise<Response<PaymentRecord>>;
     /**
      * Report that the most recent payment attempt on the specified Payment Record
      *  was guaranteed.
      */
-    reportPaymentAttemptGuaranteed(id: string, params: PaymentRecordReportPaymentAttemptGuaranteedParams, options?: RequestOptions): Promise<Response<PaymentRecord>>;
+    reportPaymentAttemptGuaranteed(id: string, params?: PaymentRecordReportPaymentAttemptGuaranteedParams, options?: RequestOptions): Promise<Response<PaymentRecord>>;
     /**
      * Report informational updates on the specified Payment Record.
      */
@@ -260,8 +272,11 @@ export declare namespace PaymentRecord {
         customer_balance?: PaymentMethodDetails.CustomerBalance;
         eps?: PaymentMethodDetails.Eps;
         fpx?: PaymentMethodDetails.Fpx;
+        gift_card?: PaymentMethodDetails.GiftCard;
         giropay?: PaymentMethodDetails.Giropay;
+        gopay?: PaymentMethodDetails.Gopay;
         grabpay?: PaymentMethodDetails.Grabpay;
+        id_bank_transfer?: PaymentMethodDetails.IdBankTransfer;
         ideal?: PaymentMethodDetails.Ideal;
         interac_present?: PaymentMethodDetails.InteracPresent;
         kakao_pay?: PaymentMethodDetails.KakaoPay;
@@ -284,19 +299,26 @@ export declare namespace PaymentRecord {
         payment_method: string | null;
         paynow?: PaymentMethodDetails.Paynow;
         paypal?: PaymentMethodDetails.Paypal;
+        paypay?: PaymentMethodDetails.Paypay;
         payto?: PaymentMethodDetails.Payto;
         pix?: PaymentMethodDetails.Pix;
         promptpay?: PaymentMethodDetails.Promptpay;
+        qris?: PaymentMethodDetails.Qris;
+        rechnung?: PaymentMethodDetails.Rechnung;
         revolut_pay?: PaymentMethodDetails.RevolutPay;
         samsung_pay?: PaymentMethodDetails.SamsungPay;
         satispay?: PaymentMethodDetails.Satispay;
         scalapay?: PaymentMethodDetails.Scalapay;
         sepa_credit_transfer?: PaymentMethodDetails.SepaCreditTransfer;
         sepa_debit?: PaymentMethodDetails.SepaDebit;
+        sequra?: PaymentMethodDetails.Sequra;
+        shopeepay?: PaymentMethodDetails.Shopeepay;
         sofort?: PaymentMethodDetails.Sofort;
         stripe_account?: PaymentMethodDetails.StripeAccount;
+        stripe_balance?: PaymentMethodDetails.StripeBalance;
         sunbit?: PaymentMethodDetails.Sunbit;
         swish?: PaymentMethodDetails.Swish;
+        tamara?: PaymentMethodDetails.Tamara;
         twint?: PaymentMethodDetails.Twint;
         /**
          * The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type) for the full list of possible types.
@@ -317,10 +339,22 @@ export declare namespace PaymentRecord {
          * used for this payment attempt.
          */
         custom?: ProcessorDetails.Custom;
+        /**
+         * Represents the Fiserv ValueLink gift card processor.
+         */
+        fiserv_valuelink?: ProcessorDetails.FiservValuelink;
+        /**
+         * Represents the Givex gift card processor.
+         */
+        givex?: ProcessorDetails.Givex;
+        /**
+         * Represents the SVS gift card processor.
+         */
+        svs?: ProcessorDetails.Svs;
         /**
          * The processor used for this payment attempt.
          */
-        type: 'custom';
+        type: ProcessorDetails.Type;
     }
     type ReportedBy = 'self' | 'stripe' | OtherString;
     interface ShippingDetails {
@@ -755,6 +789,7 @@ export declare namespace PaymentRecord {
              * ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to.
              */
             location?: string;
+            multicapture?: CardPresent.Multicapture;
             /**
              * Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
              */
@@ -783,10 +818,22 @@ export declare namespace PaymentRecord {
              * ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on.
              */
             reader?: string;
+            /**
+             * Whether the PaymentIntent can be reauthorized or not.
+             */
+            reauthorization?: CardPresent.Reauthorization | null;
+            /**
+             * The time at which the associated PaymentIntent will transition to a terminal state if it is not reauthorized.
+             */
+            reauthorize_before?: number | null;
             /**
              * A collection of fields required to be displayed on receipts. Only required for EMV transactions.
              */
             receipt: CardPresent.Receipt | null;
+            /**
+             * The retrieval reference number assigned to this transaction.
+             */
+            retrieval_reference_number?: string;
             wallet?: CardPresent.Wallet;
         }
         interface Cashapp {
@@ -804,6 +851,14 @@ export declare namespace PaymentRecord {
             transaction_id: string | null;
         }
         interface Crypto {
+            /**
+             * The amount received for the crypto payment.
+             */
+            amount_received?: number;
+            /**
+             * The amount requested for the crypto payment.
+             */
+            amount_requested?: number;
             /**
              * The wallet address of the customer.
              */
@@ -857,6 +912,48 @@ export declare namespace PaymentRecord {
              */
             transaction_id: string | null;
         }
+        interface GiftCard {
+            /**
+             * The balance of the gift card after the transaction.
+             */
+            balance: GiftCard.Balance | null;
+            /**
+             * The brand of the gift card.
+             */
+            brand: GiftCard.Brand | null;
+            /**
+             * The expiration month of the gift card.
+             */
+            exp_month: number | null;
+            /**
+             * The expiration year of the gift card.
+             */
+            exp_year: number | null;
+            /**
+             * Uniquely identifies this particular gift card number. You can use this attribute to check whether two transactions were made using the same gift card.
+             */
+            fingerprint: string | null;
+            /**
+             * The first six digits of the gift card number.
+             */
+            first6: string | null;
+            /**
+             * The last four digits of the gift card number.
+             */
+            last4: string | null;
+            /**
+             * ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to.
+             */
+            location?: string;
+            /**
+             * ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on.
+             */
+            reader?: string;
+            /**
+             * The transaction ID from the gift card processor.
+             */
+            transaction_id: string | null;
+        }
         interface Giropay {
             /**
              * Bank code of bank associated with the bank account.
@@ -875,12 +972,36 @@ export declare namespace PaymentRecord {
              */
             verified_name: string | null;
         }
+        interface Gopay {
+        }
         interface Grabpay {
             /**
              * Unique transaction id generated by GrabPay
              */
             transaction_id: string | null;
         }
+        interface IdBankTransfer {
+            /**
+             * Account number of the bank account to transfer funds to.
+             */
+            account_number: string;
+            /**
+             * Bank where the account is located.
+             */
+            bank: IdBankTransfer.Bank;
+            /**
+             * Local bank code of the bank.
+             */
+            bank_code?: string;
+            /**
+             * Name of the bank associated with the bank account.
+             */
+            bank_name?: string;
+            /**
+             * Merchant name and billing details name, for the customer to check for the correct merchant when performing the bank transfer.
+             */
+            display_name?: string;
+        }
         interface Ideal {
             /**
              * The customer's bank. Can be one of `abn_amro`, `adyen`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
@@ -1184,10 +1305,34 @@ export declare namespace PaymentRecord {
              * The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction.
              */
             seller_protection: Paypal.SellerProtection | null;
+            /**
+             * The shipping address for the customer, as supplied by the merchant at the point of payment
+             * execution. This shipping address will not be updated if the merchant updates the shipping
+             * address on the PaymentIntent after the PaymentIntent was successfully confirmed.
+             */
+            shipping?: Address | null;
             /**
              * A unique ID generated by PayPal for this transaction.
              */
             transaction_id: string | null;
+            /**
+             * The shipping address for the customer, as supplied by the merchant at the point of payment
+             * execution. This shipping address will not be updated if the merchant updates the shipping
+             * address on the PaymentIntent after the PaymentIntent was successfully confirmed.
+             */
+            verified_address?: Address | null;
+            /**
+             * Owner's verified email. Values are verified or provided by PayPal directly
+             * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
+             */
+            verified_email?: string | null;
+            /**
+             * Owner's verified full name. Values are verified or provided by PayPal directly
+             * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
+             */
+            verified_name?: string | null;
+        }
+        interface Paypay {
         }
         interface Payto {
             /**
@@ -1223,6 +1368,14 @@ export declare namespace PaymentRecord {
              */
             reference: string | null;
         }
+        interface Qris {
+        }
+        interface Rechnung {
+            /**
+             * Payment portal URL.
+             */
+            payment_portal_url: string | null;
+        }
         interface RevolutPay {
             funding?: RevolutPay.Funding;
             /**
@@ -1296,6 +1449,14 @@ export declare namespace PaymentRecord {
              */
             mandate: string | null;
         }
+        interface Sequra {
+            /**
+             * The SeQura transaction ID associated with this payment.
+             */
+            transaction_id: string | null;
+        }
+        interface Shopeepay {
+        }
         interface Sofort {
             /**
              * Bank code of bank associated with the bank account.
@@ -1336,6 +1497,12 @@ export declare namespace PaymentRecord {
         }
         interface StripeAccount {
         }
+        interface StripeBalance {
+            /**
+             * The connected account ID whose Stripe balance to use as the source of payment
+             */
+            account?: string | null;
+        }
         interface Sunbit {
             /**
              * The Sunbit transaction ID associated with this payment.
@@ -1356,6 +1523,12 @@ export declare namespace PaymentRecord {
              */
             verified_phone_last4: string | null;
         }
+        interface Tamara {
+            /**
+             * The Tamara transaction ID associated with this payment.
+             */
+            transaction_id: string | null;
+        }
         interface Twint {
             /**
              * ID of the multi use Mandate generated by the PaymentIntent or SetupIntent.
@@ -1445,7 +1618,7 @@ export declare namespace PaymentRecord {
                 /**
                  * funding type of the underlying payment method.
                  */
-                type: 'card' | null;
+                type: Funding.Type | null;
             }
             namespace Funding {
                 interface Card {
@@ -1453,6 +1626,10 @@ export declare namespace PaymentRecord {
                      * Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
                      */
                     brand: string | null;
+                    /**
+                     * The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
+                     */
+                    brand_product?: string | null;
                     /**
                      * Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
                      */
@@ -1474,6 +1651,7 @@ export declare namespace PaymentRecord {
                      */
                     last4: string | null;
                 }
+                type Type = 'card' | OtherString;
             }
         }
         namespace Bancontact {
@@ -1579,7 +1757,7 @@ export declare namespace PaymentRecord {
                 type AuthenticationFlow = 'challenge' | 'frictionless' | OtherString;
                 type ElectronicCommerceIndicator = '01' | '02' | '03' | '04' | '05' | '06' | '07' | OtherString;
                 type ExemptionIndicator = 'low_risk' | 'none' | OtherString;
-                type Result = 'attempt_acknowledged' | 'authenticated' | 'data_share_only' | 'exempted' | 'failed' | 'not_supported' | 'processing_error' | OtherString;
+                type Result = 'attempt_acknowledged' | 'authenticated' | 'exempted' | 'failed' | 'not_supported' | 'processing_error' | OtherString;
                 type ResultReason = 'abandoned' | 'bypassed' | 'canceled' | 'card_not_enrolled' | 'network_not_supported' | 'protocol_error' | 'rejected' | OtherString;
                 type Version = '1.0.2' | '2.1.0' | '2.2.0' | OtherString;
             }
@@ -1595,6 +1773,12 @@ export declare namespace PaymentRecord {
             }
         }
         namespace CardPresent {
+            interface Multicapture {
+                /**
+                 * Indicates whether or not multiple captures are supported.
+                 */
+                status: Multicapture.Status;
+            }
             interface Offline {
                 /**
                  * Time at which the payment was collected while offline
@@ -1606,6 +1790,12 @@ export declare namespace PaymentRecord {
                 type: 'deferred' | null;
             }
             type ReadMethod = 'contact_emv' | 'contactless_emv' | 'contactless_magstripe_mode' | 'magnetic_stripe_fallback' | 'magnetic_stripe_track2' | OtherString;
+            interface Reauthorization {
+                /**
+                 * Indicates whether or not the reauthorization feature is supported.
+                 */
+                status: Reauthorization.Status;
+            }
             interface Receipt {
                 /**
                  * The type of account being debited or credited
@@ -1650,6 +1840,12 @@ export declare namespace PaymentRecord {
                  */
                 type: Wallet.Type;
             }
+            namespace Multicapture {
+                type Status = 'available' | 'unavailable';
+            }
+            namespace Reauthorization {
+                type Status = 'available' | 'unavailable' | OtherString;
+            }
             namespace Receipt {
                 type AccountType = 'checking' | 'credit' | 'prepaid' | 'unknown' | OtherString;
             }
@@ -1668,6 +1864,22 @@ export declare namespace PaymentRecord {
             type AccountHolderType = 'company' | 'individual' | OtherString;
             type Bank = 'affin_bank' | 'agrobank' | 'alliance_bank' | 'ambank' | 'bank_islam' | 'bank_muamalat' | 'bank_of_china' | 'bank_rakyat' | 'bnp_paribas' | 'bsn' | 'cimb' | 'citibank' | 'deutsche_bank' | 'hong_leong_bank' | 'hsbc' | 'kfh' | 'maybank2e' | 'maybank2u' | 'mbsb_bank' | 'ocbc' | 'pb_enterprise' | 'public_bank' | 'rhb' | 'standard_chartered' | 'uob' | OtherString;
         }
+        namespace GiftCard {
+            interface Balance {
+                /**
+                 * The balance amount in the smallest currency unit.
+                 */
+                amount: number | null;
+                /**
+                 * The currency of the balance.
+                 */
+                currency: string | null;
+            }
+            type Brand = 'fiserv_valuelink' | 'givex' | 'svs' | OtherString;
+        }
+        namespace IdBankTransfer {
+            type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata' | OtherString;
+        }
         namespace Ideal {
             type Bank = 'abn_amro' | 'adyen' | 'asn_bank' | 'bunq' | 'buut' | 'finom' | 'handelsbanken' | 'ing' | 'knab' | 'mollie' | 'moneyou' | 'n26' | 'nn' | 'rabobank' | 'regiobank' | 'revolut' | 'sns_bank' | 'triodos_bank' | 'van_lanschot' | 'yoursafe' | OtherString;
             type Bic = 'ABNANL2A' | 'ADYBNL2A' | 'ASNBNL21' | 'BITSNL2A' | 'BUNQNL2A' | 'BUUTNL2A' | 'FNOMNL22' | 'FVLBNL22' | 'HANDNL2A' | 'INGBNL2A' | 'KNABNL2H' | 'MLLENL2A' | 'MOYONL21' | 'NNBANL2G' | 'NTSBDEB1' | 'RABONL2U' | 'RBRBNL21' | 'REVOIE23' | 'REVOLT21' | 'SNSBNL2A' | 'TRIONL2U' | OtherString;
@@ -1795,7 +2007,7 @@ export declare namespace PaymentRecord {
                 /**
                  * Funding type of the underlying payment method.
                  */
-                type: 'card' | null;
+                type: Funding.Type | null;
             }
             namespace Funding {
                 interface Card {
@@ -1803,6 +2015,10 @@ export declare namespace PaymentRecord {
                      * Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
                      */
                     brand: string | null;
+                    /**
+                     * The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
+                     */
+                    brand_product?: string | null;
                     /**
                      * Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
                      */
@@ -1824,6 +2040,7 @@ export declare namespace PaymentRecord {
                      */
                     last4: string | null;
                 }
+                type Type = 'card' | OtherString;
             }
         }
         namespace Sofort {
@@ -1841,6 +2058,25 @@ export declare namespace PaymentRecord {
              */
             payment_reference: string | null;
         }
+        interface FiservValuelink {
+            /**
+             * An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
+             */
+            payment_reference: string;
+        }
+        interface Givex {
+            /**
+             * An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
+             */
+            payment_reference: string;
+        }
+        interface Svs {
+            /**
+             * An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
+             */
+            payment_reference: string;
+        }
+        type Type = 'custom' | 'fiserv_valuelink' | 'givex' | 'svs' | OtherString;
     }
 }
 export interface PaymentRecordRetrieveParams {
@@ -1863,6 +2099,103 @@ export interface PaymentRecordListParams extends PaginationParams {
      */
     expand?: Array<string>;
 }
+export interface PaymentRecordReportDisputeParams {
+    /**
+     * The amount that has been lost to the customer due to disputes on this payment.
+     */
+    amount: PaymentRecordReportDisputeParams.Amount;
+    /**
+     * Processor information for this payment.
+     */
+    processor_details: PaymentRecordReportDisputeParams.ProcessorDetails;
+    /**
+     * Information about the dispute closing.
+     */
+    closed?: PaymentRecordReportDisputeParams.Closed;
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+    /**
+     * Information about the dispute funding event.
+     */
+    funded?: PaymentRecordReportDisputeParams.Funded;
+    /**
+     * When the reported payment was initiated. Measured in seconds since the Unix epoch.
+     */
+    initiated_at?: number;
+    /**
+     * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+     */
+    metadata?: Emptyable<MetadataParam>;
+    /**
+     * The reason the payment was disputed.
+     */
+    reason?: PaymentRecordReportDisputeParams.Reason;
+}
+export declare namespace PaymentRecordReportDisputeParams {
+    interface Amount {
+        /**
+         * 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).
+         */
+        currency: string;
+        /**
+         * A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
+         */
+        value: number;
+    }
+    interface ProcessorDetails {
+        /**
+         * Information about the custom processor used to make this payment.
+         */
+        custom?: ProcessorDetails.Custom;
+        /**
+         * The type of the processor details. An additional hash is included on processor_details with a name matching this value. It contains additional information specific to the processor.
+         */
+        type: 'custom';
+    }
+    interface Closed {
+        /**
+         * When the dispute was closed. Measured in seconds since the Unix epoch.
+         */
+        closed_at: number;
+    }
+    interface Funded {
+        /**
+         * The amount that has been lost to the customer due to disputes on this payment.
+         */
+        amount: Funded.Amount;
+        /**
+         * When the dispute funding event occurred. Measured in seconds since the Unix epoch.
+         */
+        funded_at: number;
+        /**
+         * The type of dispute funding event.
+         */
+        type: 'withdrawn';
+    }
+    type Reason = 'bank_cannot_process' | 'check_returned' | 'credit_not_processed' | 'customer_initiated' | 'debit_not_authorized' | 'duplicate' | 'fraudulent' | 'general' | 'incorrect_account_details' | 'insufficient_funds' | 'noncompliant' | 'product_not_received' | 'product_unacceptable' | 'subscription_canceled' | 'unrecognized' | OtherString;
+    namespace Funded {
+        interface Amount {
+            /**
+             * 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).
+             */
+            currency: string;
+            /**
+             * A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
+             */
+            value: number;
+        }
+    }
+    namespace ProcessorDetails {
+        interface Custom {
+            /**
+             * A reference to the external dispute. This field must be unique across all disputes.
+             */
+            dispute_reference: string;
+        }
+    }
+}
 export interface PaymentRecordReportPaymentParams {
     /**
      * The amount you initially requested for this payment.
@@ -1876,6 +2209,10 @@ export interface PaymentRecordReportPaymentParams {
      * Information about the Payment Method debited for this payment.
      */
     payment_method_details: PaymentRecordReportPaymentParams.PaymentMethodDetails;
+    /**
+     * Information about the payment attempt cancelation.
+     */
+    canceled?: PaymentRecordReportPaymentParams.Canceled;
     /**
      * Customer information for this payment.
      */
@@ -1933,6 +2270,10 @@ export declare namespace PaymentRecordReportPaymentParams {
          * The billing details associated with the method of payment.
          */
         billing_details?: PaymentMethodDetails.BillingDetails;
+        /**
+         * Information about the card payment method used to make this payment.
+         */
+        card?: PaymentMethodDetails.Card;
         /**
          * Information about the custom (user-defined) payment method used to make this payment.
          */
@@ -1944,7 +2285,21 @@ export declare namespace PaymentRecordReportPaymentParams {
         /**
          * The type of the payment method details. An additional hash is included on the payment_method_details with a name matching this value. It contains additional information specific to the type.
          */
-        type?: 'custom';
+        type?: PaymentMethodDetails.Type;
+    }
+    interface Canceled {
+        /**
+         * When the reported payment was canceled. Measured in seconds since the Unix epoch.
+         */
+        canceled_at: number;
+        /**
+         * Payment evaluations associated with this reported payment.
+         */
+        payment_evaluations?: Array<string>;
+        /**
+         * The reason the payment attempt was canceled.
+         */
+        reason?: Canceled.Reason;
     }
     interface CustomerDetails {
         /**
@@ -1970,12 +2325,32 @@ export declare namespace PaymentRecordReportPaymentParams {
          * When the reported payment failed. Measured in seconds since the Unix epoch.
          */
         failed_at: number;
+        /**
+         * The failure code for this payment attempt. Must be one of `payment_method_customer_decline`, `payment_method_provider_unknown_outcome`, `authentication_failure`, `expired_payment_method`, `incorrect_cvc`, `incorrect_number`, `incorrect_postal_code`, `insufficient_funds`, `processing_error`, or `payment_method_restricted`.
+         */
+        failure_code?: Failed.FailureCode;
+        /**
+         * Payment evaluations associated with this reported payment.
+         */
+        payment_evaluations?: Array<string>;
+        /**
+         * Processor information for this payment.
+         */
+        processor_details?: Failed.ProcessorDetails;
     }
     interface Guaranteed {
         /**
          * When the reported payment was guaranteed. Measured in seconds since the Unix epoch.
          */
         guaranteed_at: number;
+        /**
+         * Payment evaluations associated with this reported payment.
+         */
+        payment_evaluations?: Array<string>;
+        /**
+         * Processor information for this payment.
+         */
+        processor_details?: Guaranteed.ProcessorDetails;
     }
     type Outcome = 'failed' | 'guaranteed' | OtherString;
     interface ProcessorDetails {
@@ -2002,6 +2377,50 @@ export declare namespace PaymentRecordReportPaymentParams {
          */
         phone?: string;
     }
+    namespace Canceled {
+        type Reason = 'blocked_for_fraud' | 'merchant_canceled' | OtherString;
+    }
+    namespace Failed {
+        type FailureCode = 'authentication_failure' | 'expired_payment_method' | 'incorrect_cvc' | 'incorrect_number' | 'incorrect_postal_code' | 'insufficient_funds' | 'payment_method_customer_decline' | 'payment_method_provider_unknown_outcome' | 'payment_method_restricted' | 'processing_error' | OtherString;
+        interface ProcessorDetails {
+            /**
+             * Information about the custom processor used to make this payment.
+             */
+            custom?: ProcessorDetails.Custom;
+            /**
+             * The type of the processor details. An additional hash is included on processor_details with a name matching this value. It contains additional information specific to the processor.
+             */
+            type: 'custom';
+        }
+        namespace ProcessorDetails {
+            interface Custom {
+                /**
+                 * An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
+                 */
+                payment_reference: string;
+            }
+        }
+    }
+    namespace Guaranteed {
+        interface ProcessorDetails {
+            /**
+             * Information about the custom processor used to make this payment.
+             */
+            custom?: ProcessorDetails.Custom;
+            /**
+             * The type of the processor details. An additional hash is included on processor_details with a name matching this value. It contains additional information specific to the processor.
+             */
+            type: 'custom';
+        }
+        namespace ProcessorDetails {
+            interface Custom {
+                /**
+                 * An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
+                 */
+                payment_reference: string;
+            }
+        }
+    }
     namespace PaymentMethodDetails {
         interface BillingDetails {
             /**
@@ -2021,6 +2440,12 @@ export declare namespace PaymentRecordReportPaymentParams {
              */
             phone?: string;
         }
+        interface Card {
+            /**
+             * Verification checks performed on the card.
+             */
+            checks?: Card.Checks;
+        }
         interface Custom {
             /**
              * Display name for the custom (user-defined) payment method type used to make this payment.
@@ -2031,6 +2456,28 @@ export declare namespace PaymentRecordReportPaymentParams {
              */
             type?: string;
         }
+        type Type = 'card' | 'custom' | OtherString;
+        namespace Card {
+            interface Checks {
+                /**
+                 * The result of the check on the cardholder's address line 1.
+                 */
+                address_line1_check?: Checks.AddressLine1Check;
+                /**
+                 * The result of the check on the cardholder's postal code.
+                 */
+                address_postal_code_check?: Checks.AddressPostalCodeCheck;
+                /**
+                 * The result of the check on the card's CVC.
+                 */
+                cvc_check?: Checks.CvcCheck;
+            }
+            namespace Checks {
+                type AddressLine1Check = 'fail' | 'pass' | 'unavailable' | 'unchecked' | OtherString;
+                type AddressPostalCodeCheck = 'fail' | 'pass' | 'unavailable' | 'unchecked' | OtherString;
+                type CvcCheck = 'fail' | 'pass' | 'unavailable' | 'unchecked' | OtherString;
+            }
+        }
     }
     namespace ProcessorDetails {
         interface Custom {
@@ -2046,6 +2493,10 @@ export interface PaymentRecordReportPaymentAttemptParams {
      * When the reported payment was initiated. Measured in seconds since the Unix epoch.
      */
     initiated_at: number;
+    /**
+     * Information about the payment attempt cancelation.
+     */
+    canceled?: PaymentRecordReportPaymentAttemptParams.Canceled;
     /**
      * An arbitrary string attached to the object. Often useful for displaying to users.
      */
@@ -2080,17 +2531,51 @@ export interface PaymentRecordReportPaymentAttemptParams {
     shipping_details?: PaymentRecordReportPaymentAttemptParams.ShippingDetails;
 }
 export declare namespace PaymentRecordReportPaymentAttemptParams {
+    interface Canceled {
+        /**
+         * When the reported payment was canceled. Measured in seconds since the Unix epoch.
+         */
+        canceled_at: number;
+        /**
+         * Payment evaluations associated with this reported payment.
+         */
+        payment_evaluations?: Array<string>;
+        /**
+         * The reason the payment attempt was canceled.
+         */
+        reason?: Canceled.Reason;
+    }
     interface Failed {
         /**
          * When the reported payment failed. Measured in seconds since the Unix epoch.
          */
         failed_at: number;
+        /**
+         * The failure code for this payment attempt. Must be one of `payment_method_customer_decline`, `payment_method_provider_unknown_outcome`, `authentication_failure`, `expired_payment_method`, `incorrect_cvc`, `incorrect_number`, `incorrect_postal_code`, `insufficient_funds`, `processing_error`, or `payment_method_restricted`.
+         */
+        failure_code?: Failed.FailureCode;
+        /**
+         * Payment evaluations associated with this reported payment.
+         */
+        payment_evaluations?: Array<string>;
+        /**
+         * Processor information for this payment.
+         */
+        processor_details?: Failed.ProcessorDetails;
     }
     interface Guaranteed {
         /**
          * When the reported payment was guaranteed. Measured in seconds since the Unix epoch.
          */
         guaranteed_at: number;
+        /**
+         * Payment evaluations associated with this reported payment.
+         */
+        payment_evaluations?: Array<string>;
+        /**
+         * Processor information for this payment.
+         */
+        processor_details?: Guaranteed.ProcessorDetails;
     }
     type Outcome = 'failed' | 'guaranteed' | OtherString;
     interface PaymentMethodDetails {
@@ -2098,6 +2583,10 @@ export declare namespace PaymentRecordReportPaymentAttemptParams {
          * The billing details associated with the method of payment.
          */
         billing_details?: PaymentMethodDetails.BillingDetails;
+        /**
+         * Information about the card payment method used to make this payment.
+         */
+        card?: PaymentMethodDetails.Card;
         /**
          * Information about the custom (user-defined) payment method used to make this payment.
          */
@@ -2109,7 +2598,7 @@ export declare namespace PaymentRecordReportPaymentAttemptParams {
         /**
          * The type of the payment method details. An additional hash is included on the payment_method_details with a name matching this value. It contains additional information specific to the type.
          */
-        type?: 'custom';
+        type?: PaymentMethodDetails.Type;
     }
     interface ShippingDetails {
         /**
@@ -2125,6 +2614,50 @@ export declare namespace PaymentRecordReportPaymentAttemptParams {
          */
         phone?: string;
     }
+    namespace Canceled {
+        type Reason = 'blocked_for_fraud' | 'merchant_canceled' | OtherString;
+    }
+    namespace Failed {
+        type FailureCode = 'authentication_failure' | 'expired_payment_method' | 'incorrect_cvc' | 'incorrect_number' | 'incorrect_postal_code' | 'insufficient_funds' | 'payment_method_customer_decline' | 'payment_method_provider_unknown_outcome' | 'payment_method_restricted' | 'processing_error' | OtherString;
+        interface ProcessorDetails {
+            /**
+             * Information about the custom processor used to make this payment.
+             */
+            custom?: ProcessorDetails.Custom;
+            /**
+             * The type of the processor details. An additional hash is included on processor_details with a name matching this value. It contains additional information specific to the processor.
+             */
+            type: 'custom';
+        }
+        namespace ProcessorDetails {
+            interface Custom {
+                /**
+                 * An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
+                 */
+                payment_reference: string;
+            }
+        }
+    }
+    namespace Guaranteed {
+        interface ProcessorDetails {
+            /**
+             * Information about the custom processor used to make this payment.
+             */
+            custom?: ProcessorDetails.Custom;
+            /**
+             * The type of the processor details. An additional hash is included on processor_details with a name matching this value. It contains additional information specific to the processor.
+             */
+            type: 'custom';
+        }
+        namespace ProcessorDetails {
+            interface Custom {
+                /**
+                 * An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
+                 */
+                payment_reference: string;
+            }
+        }
+    }
     namespace PaymentMethodDetails {
         interface BillingDetails {
             /**
@@ -2144,6 +2677,12 @@ export declare namespace PaymentRecordReportPaymentAttemptParams {
              */
             phone?: string;
         }
+        interface Card {
+            /**
+             * Verification checks performed on the card.
+             */
+            checks?: Card.Checks;
+        }
         interface Custom {
             /**
              * Display name for the custom (user-defined) payment method type used to make this payment.
@@ -2154,13 +2693,35 @@ export declare namespace PaymentRecordReportPaymentAttemptParams {
              */
             type?: string;
         }
+        type Type = 'card' | 'custom' | OtherString;
+        namespace Card {
+            interface Checks {
+                /**
+                 * The result of the check on the cardholder's address line 1.
+                 */
+                address_line1_check?: Checks.AddressLine1Check;
+                /**
+                 * The result of the check on the cardholder's postal code.
+                 */
+                address_postal_code_check?: Checks.AddressPostalCodeCheck;
+                /**
+                 * The result of the check on the card's CVC.
+                 */
+                cvc_check?: Checks.CvcCheck;
+            }
+            namespace Checks {
+                type AddressLine1Check = 'fail' | 'pass' | 'unavailable' | 'unchecked' | OtherString;
+                type AddressPostalCodeCheck = 'fail' | 'pass' | 'unavailable' | 'unchecked' | OtherString;
+                type CvcCheck = 'fail' | 'pass' | 'unavailable' | 'unchecked' | OtherString;
+            }
+        }
     }
 }
 export interface PaymentRecordReportPaymentAttemptCanceledParams {
     /**
      * When the reported payment was canceled. Measured in seconds since the Unix epoch.
      */
-    canceled_at: number;
+    canceled_at?: number;
     /**
      * Specifies which fields in the response should be expanded.
      */
@@ -2169,34 +2730,196 @@ export interface PaymentRecordReportPaymentAttemptCanceledParams {
      * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
      */
     metadata?: Emptyable<MetadataParam>;
+    /**
+     * Payment evaluations associated with this reported payment.
+     */
+    payment_evaluations?: Array<string>;
+    /**
+     * The reason the payment attempt was canceled.
+     */
+    reason?: PaymentRecordReportPaymentAttemptCanceledParams.Reason;
+}
+export declare namespace PaymentRecordReportPaymentAttemptCanceledParams {
+    type Reason = 'blocked_for_fraud' | 'merchant_canceled' | OtherString;
 }
 export interface PaymentRecordReportPaymentAttemptFailedParams {
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
     /**
      * When the reported payment failed. Measured in seconds since the Unix epoch.
      */
-    failed_at: number;
+    failed_at?: number;
     /**
-     * Specifies which fields in the response should be expanded.
+     * The failure code for this payment attempt. Must be one of `payment_method_customer_decline`, `payment_method_provider_unknown_outcome`, `authentication_failure`, `expired_payment_method`, `incorrect_cvc`, `incorrect_number`, `incorrect_postal_code`, `insufficient_funds`, `processing_error`, or `payment_method_restricted`.
      */
-    expand?: Array<string>;
+    failure_code?: PaymentRecordReportPaymentAttemptFailedParams.FailureCode;
     /**
      * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
      */
     metadata?: Emptyable<MetadataParam>;
-}
-export interface PaymentRecordReportPaymentAttemptGuaranteedParams {
     /**
-     * When the reported payment was guaranteed. Measured in seconds since the Unix epoch.
+     * Payment evaluations associated with this reported payment.
+     */
+    payment_evaluations?: Array<string>;
+    /**
+     * Information about the Payment Method debited for this payment.
+     */
+    payment_method_details?: PaymentRecordReportPaymentAttemptFailedParams.PaymentMethodDetails;
+    /**
+     * Processor information for this payment.
      */
-    guaranteed_at: number;
+    processor_details?: PaymentRecordReportPaymentAttemptFailedParams.ProcessorDetails;
+}
+export declare namespace PaymentRecordReportPaymentAttemptFailedParams {
+    type FailureCode = 'authentication_failure' | 'expired_payment_method' | 'incorrect_cvc' | 'incorrect_number' | 'incorrect_postal_code' | 'insufficient_funds' | 'payment_method_customer_decline' | 'payment_method_provider_unknown_outcome' | 'payment_method_restricted' | 'processing_error' | OtherString;
+    interface PaymentMethodDetails {
+        /**
+         * Information about the card payment method used to make this payment.
+         */
+        card?: PaymentMethodDetails.Card;
+        /**
+         * The type of the payment method details. An additional hash is included on the payment_method_details with a name matching this value. It contains additional information specific to the type.
+         */
+        type: 'card';
+    }
+    interface ProcessorDetails {
+        /**
+         * Information about the custom processor used to make this payment.
+         */
+        custom?: ProcessorDetails.Custom;
+        /**
+         * The type of the processor details. An additional hash is included on processor_details with a name matching this value. It contains additional information specific to the processor.
+         */
+        type: 'custom';
+    }
+    namespace PaymentMethodDetails {
+        interface Card {
+            /**
+             * Verification checks performed on the card.
+             */
+            checks?: Card.Checks;
+            /**
+             * Decline code from the card network for the failed payment.
+             */
+            network_decline_code?: string;
+        }
+        namespace Card {
+            interface Checks {
+                /**
+                 * The result of the check on the cardholder's address line 1.
+                 */
+                address_line1_check?: Checks.AddressLine1Check;
+                /**
+                 * The result of the check on the cardholder's postal code.
+                 */
+                address_postal_code_check?: Checks.AddressPostalCodeCheck;
+                /**
+                 * The result of the check on the card's CVC.
+                 */
+                cvc_check?: Checks.CvcCheck;
+            }
+            namespace Checks {
+                type AddressLine1Check = 'fail' | 'pass' | 'unavailable' | 'unchecked' | OtherString;
+                type AddressPostalCodeCheck = 'fail' | 'pass' | 'unavailable' | 'unchecked' | OtherString;
+                type CvcCheck = 'fail' | 'pass' | 'unavailable' | 'unchecked' | OtherString;
+            }
+        }
+    }
+    namespace ProcessorDetails {
+        interface Custom {
+            /**
+             * An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
+             */
+            payment_reference: string;
+        }
+    }
+}
+export interface PaymentRecordReportPaymentAttemptGuaranteedParams {
     /**
      * Specifies which fields in the response should be expanded.
      */
     expand?: Array<string>;
+    /**
+     * When the reported payment was guaranteed. Measured in seconds since the Unix epoch.
+     */
+    guaranteed_at?: number;
     /**
      * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
      */
     metadata?: Emptyable<MetadataParam>;
+    /**
+     * Payment evaluations associated with this reported payment.
+     */
+    payment_evaluations?: Array<string>;
+    /**
+     * Information about the Payment Method debited for this payment.
+     */
+    payment_method_details?: PaymentRecordReportPaymentAttemptGuaranteedParams.PaymentMethodDetails;
+    /**
+     * Processor information for this payment.
+     */
+    processor_details?: PaymentRecordReportPaymentAttemptGuaranteedParams.ProcessorDetails;
+}
+export declare namespace PaymentRecordReportPaymentAttemptGuaranteedParams {
+    interface PaymentMethodDetails {
+        /**
+         * Information about the card payment method used to make this payment.
+         */
+        card?: PaymentMethodDetails.Card;
+        /**
+         * The type of the payment method details. An additional hash is included on the payment_method_details with a name matching this value. It contains additional information specific to the type.
+         */
+        type: 'card';
+    }
+    interface ProcessorDetails {
+        /**
+         * Information about the custom processor used to make this payment.
+         */
+        custom?: ProcessorDetails.Custom;
+        /**
+         * The type of the processor details. An additional hash is included on processor_details with a name matching this value. It contains additional information specific to the processor.
+         */
+        type: 'custom';
+    }
+    namespace PaymentMethodDetails {
+        interface Card {
+            /**
+             * Verification checks performed on the card.
+             */
+            checks?: Card.Checks;
+        }
+        namespace Card {
+            interface Checks {
+                /**
+                 * The result of the check on the cardholder's address line 1.
+                 */
+                address_line1_check?: Checks.AddressLine1Check;
+                /**
+                 * The result of the check on the cardholder's postal code.
+                 */
+                address_postal_code_check?: Checks.AddressPostalCodeCheck;
+                /**
+                 * The result of the check on the card's CVC.
+                 */
+                cvc_check?: Checks.CvcCheck;
+            }
+            namespace Checks {
+                type AddressLine1Check = 'fail' | 'pass' | 'unavailable' | 'unchecked' | OtherString;
+                type AddressPostalCodeCheck = 'fail' | 'pass' | 'unavailable' | 'unchecked' | OtherString;
+                type CvcCheck = 'fail' | 'pass' | 'unavailable' | 'unchecked' | OtherString;
+            }
+        }
+    }
+    namespace ProcessorDetails {
+        interface Custom {
+            /**
+             * An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
+             */
+            payment_reference: string;
+        }
+    }
 }
 export interface PaymentRecordReportPaymentAttemptInformationalParams {
     /**
@@ -2255,10 +2978,6 @@ export declare namespace PaymentRecordReportPaymentAttemptInformationalParams {
     }
 }
 export interface PaymentRecordReportRefundParams {
-    /**
-     * The outcome of the reported refund.
-     */
-    outcome: 'refunded';
     /**
      * Processor information for this refund.
      */
@@ -2271,6 +2990,10 @@ export interface PaymentRecordReportRefundParams {
      * Specifies which fields in the response should be expanded.
      */
     expand?: Array<string>;
+    /**
+     * Information about the refund failure.
+     */
+    failed?: PaymentRecordReportRefundParams.Failed;
     /**
      * When the reported refund was initiated. Measured in seconds since the Unix epoch.
      */
@@ -2279,6 +3002,18 @@ export interface PaymentRecordReportRefundParams {
      * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
      */
     metadata?: Emptyable<MetadataParam>;
+    /**
+     * The outcome of the reported refund.
+     */
+    outcome?: PaymentRecordReportRefundParams.Outcome;
+    /**
+     * The reason for the refund. One of `duplicate`, `fraudulent`, or `requested_by_customer`.
+     */
+    reason?: PaymentRecordReportRefundParams.Reason;
+    /**
+     * A key to group refunds together.
+     */
+    refund_group?: string;
     /**
      * Information about the payment attempt refund.
      */
@@ -2305,12 +3040,27 @@ export declare namespace PaymentRecordReportRefundParams {
          */
         value: number;
     }
+    interface Failed {
+        /**
+         * When the reported refund failed. Measured in seconds since the Unix epoch.
+         */
+        failed_at?: number;
+        /**
+         * Provides the reason for the refund failure. Possible values are: `lost_or_stolen_card`, `expired_or_canceled_card`, `charge_for_pending_refund_disputed`, `insufficient_funds`, `declined`, `merchant_request`, or `unknown`.
+         */
+        failure_reason?: Failed.FailureReason;
+    }
+    type Outcome = 'failed' | 'refunded' | OtherString;
+    type Reason = 'duplicate' | 'fraudulent' | 'requested_by_customer' | OtherString;
     interface Refunded {
         /**
          * When the reported refund completed. Measured in seconds since the Unix epoch.
          */
         refunded_at: number;
     }
+    namespace Failed {
+        type FailureReason = 'charge_for_pending_refund_disputed' | 'declined' | 'expired_or_canceled_card' | 'insufficient_funds' | 'lost_or_stolen_card' | 'merchant_request' | 'unknown' | OtherString;
+    }
     namespace ProcessorDetails {
         interface Custom {
             /**
@@ -2320,3 +3070,21 @@ export declare namespace PaymentRecordReportRefundParams {
         }
     }
 }
+export interface PaymentRecordSearchParams {
+    /**
+     * The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for payment records](https://docs.stripe.com/search#query-fields-for-paymentrecords).
+     */
+    query: string;
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+    /**
+     * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+     */
+    limit?: number;
+    /**
+     * A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
+     */
+    page?: string;
+}