Class ApiRequestParams

java.lang.Object
com.stripe.net.ApiRequestParams
Direct Known Subclasses:
AccountCapabilitiesParams, AccountCapabilityListParams, AccountCapabilityRetrieveParams, AccountCapabilityUpdateParams, AccountCreateParams, AccountDisconnectParams, AccountExternalAccountCreateParams, AccountExternalAccountListParams, AccountExternalAccountRetrieveParams, AccountExternalAccountUpdateParams, AccountLinkCreateParams, AccountListOwnersParams, AccountListParams, AccountListParams, AccountLoginLinkCreateParams, AccountOwnerListParams, AccountPersonCreateParams, AccountPersonListParams, AccountPersonRetrieveParams, AccountPersonsParams, AccountPersonUpdateParams, AccountRefreshParams, AccountRejectParams, AccountRetrieveCurrentParams, AccountRetrieveParams, AccountRetrieveParams, AccountSessionCreateParams, AccountSubscribeParams, AccountUnsubscribeParams, AccountUpdateParams, ActiveEntitlementListParams, ActiveEntitlementRetrieveParams, ApplePayDomainCreateParams, ApplePayDomainListParams, ApplePayDomainRetrieveParams, ApplicationFeeListParams, ApplicationFeeRefundCreateParams, ApplicationFeeRefundListParams, ApplicationFeeRefundRetrieveParams, ApplicationFeeRefundUpdateParams, ApplicationFeeRetrieveParams, AuthorizationApproveParams, AuthorizationCaptureParams, AuthorizationCreateParams, AuthorizationDeclineParams, AuthorizationExpireParams, AuthorizationIncrementParams, AuthorizationListParams, AuthorizationRetrieveParams, AuthorizationReverseParams, AuthorizationUpdateParams, BalanceRetrieveParams, BalanceTransactionListParams, BalanceTransactionRetrieveParams, BankAccountUpdateOnAccountParams, BankAccountUpdateOnCustomerParams, BankAccountVerifyParams, CalculationCreateParams, CalculationLineItemListParams, CalculationListLineItemsParams, CapabilityCollectionListParams, CapabilityCollectionRetrieveParams, CapabilityUpdateParams, CardCreateParams, CardDeliverCardParams, CardDetailsParams, CardFailCardParams, CardholderCreateParams, CardholderListParams, CardholderRetrieveParams, CardholderUpdateParams, CardListParams, CardRetrieveParams, CardReturnCardParams, CardShipCardParams, CardUpdateOnAccountParams, CardUpdateOnCustomerParams, CardUpdateParams, CashBalanceRetrieveParams, CashBalanceUpdateParams, ChargeCaptureParams, ChargeCreateParams, ChargeListParams, ChargeRetrieveParams, ChargeSearchParams, ChargeUpdateParams, ConfigurationCreateParams, ConfigurationCreateParams, ConfigurationListParams, ConfigurationListParams, ConfigurationRetrieveParams, ConfigurationRetrieveParams, ConfigurationUpdateParams, ConfigurationUpdateParams, ConfirmationTokenCreateParams, ConfirmationTokenRetrieveParams, ConnectionTokenCreateParams, CountrySpecListParams, CountrySpecRetrieveParams, CouponCreateParams, CouponListParams, CouponRetrieveParams, CouponUpdateParams, CreditNoteCreateParams, CreditNoteLineItemCollectionListParams, CreditNoteLineItemListParams, CreditNoteListParams, CreditNotePreviewLinesListParams, CreditNotePreviewParams, CreditNoteRetrieveParams, CreditNoteUpdateParams, CreditNoteVoidCreditNoteParams, CreditReversalCreateParams, CreditReversalListParams, CreditReversalRetrieveParams, CustomerBalanceTransactionCollectionCreateParams, CustomerBalanceTransactionCollectionListParams, CustomerBalanceTransactionCollectionRetrieveParams, CustomerBalanceTransactionCreateParams, CustomerBalanceTransactionListParams, CustomerBalanceTransactionRetrieveParams, CustomerBalanceTransactionsParams, CustomerBalanceTransactionUpdateParams, CustomerCashBalanceRetrieveParams, CustomerCashBalanceTransactionCollectionListParams, CustomerCashBalanceTransactionCollectionRetrieveParams, CustomerCashBalanceTransactionListParams, CustomerCashBalanceTransactionRetrieveParams, CustomerCashBalanceTransactionsParams, CustomerCashBalanceUpdateParams, CustomerCreateFundingInstructionsParams, CustomerCreateParams, CustomerFundCashBalanceParams, CustomerFundingInstructionsCreateParams, CustomerListParams, CustomerListPaymentMethodsParams, CustomerPaymentMethodListParams, CustomerPaymentMethodRetrieveParams, CustomerPaymentSourceCreateParams, CustomerPaymentSourceDeleteParams, CustomerPaymentSourceListParams, CustomerPaymentSourceRetrieveParams, CustomerPaymentSourceUpdateParams, CustomerPaymentSourceVerifyParams, CustomerRetrieveParams, CustomerRetrievePaymentMethodParams, CustomerSearchParams, CustomerSessionCreateParams, CustomerTaxIdCreateParams, CustomerTaxIdListParams, CustomerTaxIdRetrieveParams, CustomerUpdateParams, DebitReversalCreateParams, DebitReversalListParams, DebitReversalRetrieveParams, DisputeCloseParams, DisputeCreateParams, DisputeListParams, DisputeListParams, DisputeRetrieveParams, DisputeRetrieveParams, DisputeSubmitParams, DisputeUpdateParams, DisputeUpdateParams, EarlyFraudWarningListParams, EarlyFraudWarningRetrieveParams, EphemeralKeyCreateParams, EphemeralKeyDeleteParams, EventListParams, EventRetrieveParams, ExchangeRateListParams, ExchangeRateRetrieveParams, ExternalAccountCollectionCreateParams, ExternalAccountCollectionListParams, ExternalAccountCollectionRetrieveParams, FeatureCreateParams, FeatureListParams, FeatureRetrieveParams, FeatureUpdateParams, FeeRefundCollectionCreateParams, FeeRefundCollectionListParams, FeeRefundCollectionRetrieveParams, FeeRefundUpdateParams, FileCreateParams, FileLinkCreateParams, FileLinkListParams, FileLinkRetrieveParams, FileLinkUpdateParams, FileListParams, FileRetrieveParams, FinancialAccountCreateParams, FinancialAccountFeaturesRetrieveParams, FinancialAccountFeaturesUpdateParams, FinancialAccountListParams, FinancialAccountRetrieveFeaturesParams, FinancialAccountRetrieveParams, FinancialAccountUpdateFeaturesParams, FinancialAccountUpdateParams, InboundTransferCancelParams, InboundTransferCreateParams, InboundTransferFailParams, InboundTransferListParams, InboundTransferRetrieveParams, InboundTransferReturnInboundTransferParams, InboundTransferSucceedParams, InvoiceCreateParams, InvoiceCreatePreviewParams, InvoiceFinalizeInvoiceParams, InvoiceItemCreateParams, InvoiceItemListParams, InvoiceItemRetrieveParams, InvoiceItemUpdateParams, InvoiceLineItemCollectionListParams, InvoiceLineItemListParams, InvoiceLineItemUpdateParams, InvoiceListParams, InvoiceMarkUncollectibleParams, InvoicePayParams, InvoiceRetrieveParams, InvoiceSearchParams, InvoiceSendInvoiceParams, InvoiceUpcomingLinesListParams, InvoiceUpcomingLinesParams, InvoiceUpcomingParams, InvoiceUpdateParams, InvoiceVoidInvoiceParams, LocationCreateParams, LocationDeleteParams, LocationListParams, LocationRetrieveParams, LocationUpdateParams, LoginLinkCreateOnAccountParams, MandateRetrieveParams, MeterCreateParams, MeterDeactivateParams, MeterEventAdjustmentCreateParams, MeterEventCreateParams, MeterEventSummaryListParams, MeterListParams, MeterReactivateParams, MeterRetrieveParams, MeterUpdateParams, OrderCancelParams, OrderCreateParams, OrderListParams, OrderRetrieveParams, OrderUpdateParams, OutboundPaymentCancelParams, OutboundPaymentCreateParams, OutboundPaymentFailParams, OutboundPaymentListParams, OutboundPaymentPostParams, OutboundPaymentRetrieveParams, OutboundPaymentReturnOutboundPaymentParams, OutboundPaymentUpdateParams, OutboundTransferCancelParams, OutboundTransferCreateParams, OutboundTransferFailParams, OutboundTransferListParams, OutboundTransferPostParams, OutboundTransferRetrieveParams, OutboundTransferReturnOutboundTransferParams, OutboundTransferUpdateParams, PaymentIntentApplyCustomerBalanceParams, PaymentIntentCancelParams, PaymentIntentCaptureParams, PaymentIntentConfirmParams, PaymentIntentCreateParams, PaymentIntentIncrementAuthorizationParams, PaymentIntentListParams, PaymentIntentRetrieveParams, PaymentIntentSearchParams, PaymentIntentUpdateParams, PaymentIntentVerifyMicrodepositsParams, PaymentLinkCreateParams, PaymentLinkLineItemListParams, PaymentLinkListLineItemsParams, PaymentLinkListParams, PaymentLinkRetrieveParams, PaymentLinkUpdateParams, PaymentMethodAttachParams, PaymentMethodConfigurationCreateParams, PaymentMethodConfigurationListParams, PaymentMethodConfigurationRetrieveParams, PaymentMethodConfigurationUpdateParams, PaymentMethodCreateParams, PaymentMethodDetachParams, PaymentMethodDomainCreateParams, PaymentMethodDomainListParams, PaymentMethodDomainRetrieveParams, PaymentMethodDomainUpdateParams, PaymentMethodDomainValidateParams, PaymentMethodListParams, PaymentMethodRetrieveParams, PaymentMethodUpdateParams, PaymentSourceCollectionCreateParams, PaymentSourceCollectionListParams, PaymentSourceCollectionRetrieveParams, PayoutCancelParams, PayoutCreateParams, PayoutListParams, PayoutRetrieveParams, PayoutReverseParams, PayoutUpdateParams, PersonalizationDesignActivateParams, PersonalizationDesignCreateParams, PersonalizationDesignDeactivateParams, PersonalizationDesignListParams, PersonalizationDesignRejectParams, PersonalizationDesignRetrieveParams, PersonalizationDesignUpdateParams, PersonCollectionCreateParams, PersonCollectionListParams, PersonCollectionRetrieveParams, PersonUpdateParams, PhysicalBundleListParams, PhysicalBundleRetrieveParams, PlanCreateParams, PlanListParams, PlanRetrieveParams, PlanUpdateParams, PriceCreateParams, PriceListParams, PriceRetrieveParams, PriceSearchParams, PriceUpdateParams, ProductCreateParams, ProductFeatureCreateParams, ProductFeatureListParams, ProductFeatureRetrieveParams, ProductListParams, ProductListParams, ProductRetrieveParams, ProductRetrieveParams, ProductSearchParams, ProductUpdateParams, PromotionCodeCreateParams, PromotionCodeListParams, PromotionCodeRetrieveParams, PromotionCodeUpdateParams, QuoteAcceptParams, QuoteCancelParams, QuoteComputedUpfrontLineItemsListParams, QuoteCreateParams, QuoteFinalizeQuoteParams, QuoteLineItemListParams, QuoteListComputedUpfrontLineItemsParams, QuoteListLineItemsParams, QuoteListParams, QuotePdfParams, QuoteRetrieveParams, QuoteUpdateParams, ReaderCancelActionParams, ReaderCreateParams, ReaderDeleteParams, ReaderListParams, ReaderPresentPaymentMethodParams, ReaderProcessPaymentIntentParams, ReaderProcessSetupIntentParams, ReaderRefundPaymentParams, ReaderRetrieveParams, ReaderSetReaderDisplayParams, ReaderUpdateParams, ReceivedCreditCreateParams, ReceivedCreditListParams, ReceivedCreditRetrieveParams, ReceivedDebitCreateParams, ReceivedDebitListParams, ReceivedDebitRetrieveParams, RefundCancelParams, RefundCollectionListParams, RefundCollectionRetrieveParams, RefundCreateParams, RefundExpireParams, RefundListParams, RefundRetrieveParams, RefundUpdateParams, RegistrationCreateParams, RegistrationListParams, RegistrationRetrieveParams, RegistrationUpdateParams, ReportRunCreateParams, ReportRunListParams, ReportRunRetrieveParams, ReportTypeListParams, ReportTypeRetrieveParams, RequestCreateParams, RequestListParams, RequestRetrieveParams, ReviewApproveParams, ReviewListParams, ReviewRetrieveParams, ScheduledQueryRunListParams, ScheduledQueryRunRetrieveParams, SecretCreateParams, SecretDeleteWhereParams, SecretFindParams, SecretListParams, SessionCreateParams, SessionCreateParams, SessionCreateParams, SessionExpireParams, SessionLineItemListParams, SessionListLineItemsParams, SessionListParams, SessionRetrieveParams, SessionRetrieveParams, SettingsRetrieveParams, SettingsUpdateParams, SetupAttemptListParams, SetupIntentCancelParams, SetupIntentConfirmParams, SetupIntentCreateParams, SetupIntentListParams, SetupIntentRetrieveParams, SetupIntentUpdateParams, SetupIntentVerifyMicrodepositsParams, ShippingRateCreateParams, ShippingRateListParams, ShippingRateRetrieveParams, ShippingRateUpdateParams, SourceCreateParams, SourceDetachParams, SourceRetrieveParams, SourceSourceTransactionsParams, SourceTransactionListParams, SourceUpdateParams, SourceVerifyParams, SubscriptionCancelParams, SubscriptionCreateParams, SubscriptionItemCreateParams, SubscriptionItemDeleteParams, SubscriptionItemListParams, SubscriptionItemRetrieveParams, SubscriptionItemUpdateParams, SubscriptionItemUsageRecordCreateParams, SubscriptionItemUsageRecordSummariesParams, SubscriptionItemUsageRecordSummaryListParams, SubscriptionListParams, SubscriptionResumeParams, SubscriptionRetrieveParams, SubscriptionScheduleCancelParams, SubscriptionScheduleCreateParams, SubscriptionScheduleListParams, SubscriptionScheduleReleaseParams, SubscriptionScheduleRetrieveParams, SubscriptionScheduleUpdateParams, SubscriptionSearchParams, SubscriptionUpdateParams, SupplierListParams, SupplierRetrieveParams, TaxCodeListParams, TaxCodeRetrieveParams, TaxIdCollectionCreateParams, TaxIdCollectionListParams, TaxIdCollectionRetrieveParams, TaxIdCreateParams, TaxIdListParams, TaxIdRetrieveParams, TaxRateCreateParams, TaxRateListParams, TaxRateRetrieveParams, TaxRateUpdateParams, TestClockAdvanceParams, TestClockCreateParams, TestClockListParams, TestClockRetrieveParams, TokenCreateParams, TokenListParams, TokenRetrieveParams, TokenRetrieveParams, TokenUpdateParams, TopupCancelParams, TopupCreateParams, TopupListParams, TopupRetrieveParams, TopupUpdateParams, TransactionCreateForceCaptureParams, TransactionCreateFromCalculationParams, TransactionCreateReversalParams, TransactionCreateUnlinkedRefundParams, TransactionEntryListParams, TransactionEntryRetrieveParams, TransactionLineItemListParams, TransactionListLineItemsParams, TransactionListParams, TransactionListParams, TransactionListParams, TransactionRefundParams, TransactionRetrieveParams, TransactionRetrieveParams, TransactionRetrieveParams, TransactionRetrieveParams, TransactionUpdateParams, TransferCreateParams, TransferListParams, TransferRetrieveParams, TransferReversalCollectionCreateParams, TransferReversalCollectionListParams, TransferReversalCollectionRetrieveParams, TransferReversalCreateParams, TransferReversalListParams, TransferReversalRetrieveParams, TransferReversalUpdateParams, TransferUpdateParams, UsageRecordCreateOnSubscriptionItemParams, ValueListCreateParams, ValueListItemCreateParams, ValueListItemListParams, ValueListItemRetrieveParams, ValueListListParams, ValueListRetrieveParams, ValueListUpdateParams, VerificationReportListParams, VerificationReportRetrieveParams, VerificationSessionCancelParams, VerificationSessionCreateParams, VerificationSessionListParams, VerificationSessionRedactParams, VerificationSessionRetrieveParams, VerificationSessionUpdateParams, WebhookEndpointCreateParams, WebhookEndpointListParams, WebhookEndpointRetrieveParams, WebhookEndpointUpdateParams

public abstract class ApiRequestParams extends Object
Super class to all api request params objects. It exposes a convenient method converting the typed parameter into the legacy support of untyped Map<String, Object> param.
  • Field Details

    • EXTRA_PARAMS_KEY

      public static final String EXTRA_PARAMS_KEY
      Param key for an `extraParams` map. Any param/sub-param specifying a field intended to support extra params from users should have the annotation @SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY). Logic to handle this is in ApiRequestParamsConverter.
      See Also:
  • Constructor Details

    • ApiRequestParams

      public ApiRequestParams()
  • Method Details

    • toMap

      public Map<String,Object> toMap()
      Convert `this` api request params to an untyped map. The conversion is specific to api request params object. Please see documentation in ApiRequestParamsConverter.convert(ApiRequestParams).
    • paramsToMap

      public static Map<String,Object> paramsToMap(ApiRequestParams params)
      Convert `params` api request params to an untyped map. The conversion is specific to api request params object. Please see documentation in ApiRequestParamsConverter.convert(ApiRequestParams).