Class ApiRequestParams

java.lang.Object
com.stripe.net.ApiRequestParams
Direct Known Subclasses:
AccountCapabilitiesParams, AccountCreateParams, AccountDisconnectParams, AccountLinkCreateParams, AccountListOwnersParams, AccountListParams, AccountListParams, AccountPersonsParams, AccountRefreshParams, AccountRejectParams, AccountRetrieveParams, AccountRetrieveParams, AccountUpdateParams, ApplePayDomainCreateParams, ApplePayDomainListParams, ApplePayDomainRetrieveParams, ApplicationFeeListParams, ApplicationFeeRetrieveParams, AuthorizationApproveParams, AuthorizationDeclineParams, AuthorizationListParams, AuthorizationRetrieveParams, AuthorizationUpdateParams, BalanceRetrieveParams, BalanceTransactionListParams, BalanceTransactionRetrieveParams, BankAccountUpdateOnAccountParams, BankAccountUpdateOnCustomerParams, BankAccountVerifyParams, 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, ConnectionTokenCreateParams, CountrySpecListParams, CountrySpecRetrieveParams, CouponCreateParams, CouponListParams, CouponRetrieveParams, CouponUpdateParams, CreditNoteCreateParams, CreditNoteLineItemCollectionListParams, CreditNoteListParams, CreditNotePreviewParams, CreditNoteRetrieveParams, CreditNoteUpdateParams, CreditNoteVoidCreditNoteParams, CreditReversalCreateParams, CreditReversalListParams, CreditReversalRetrieveParams, CustomerBalanceTransactionCollectionCreateParams, CustomerBalanceTransactionCollectionListParams, CustomerBalanceTransactionCollectionRetrieveParams, CustomerBalanceTransactionsParams, CustomerBalanceTransactionUpdateParams, CustomerCashBalanceTransactionCollectionListParams, CustomerCashBalanceTransactionCollectionRetrieveParams, CustomerCreateFundingInstructionsParams, CustomerCreateParams, CustomerFundCashBalanceParams, CustomerListParams, CustomerListPaymentMethodsParams, CustomerRetrieveParams, CustomerRetrievePaymentMethodParams, CustomerSearchParams, CustomerUpdateParams, DebitReversalCreateParams, DebitReversalListParams, DebitReversalRetrieveParams, DisputeCloseParams, DisputeCreateParams, DisputeListParams, DisputeListParams, DisputeRetrieveParams, DisputeRetrieveParams, DisputeSubmitParams, DisputeUpdateParams, DisputeUpdateParams, EarlyFraudWarningListParams, EarlyFraudWarningRetrieveParams, EphemeralKeyCreateParams, EphemeralKeyDeleteParams, EventListParams, EventRetrieveParams, ExchangeRateListParams, ExchangeRateRetrieveParams, ExternalAccountCollectionCreateParams, ExternalAccountCollectionListParams, ExternalAccountCollectionRetrieveParams, ExternalAccountUpdateParams, FeeRefundCollectionCreateParams, FeeRefundCollectionListParams, FeeRefundCollectionRetrieveParams, FeeRefundUpdateParams, FileCreateParams, FileLinkCreateParams, FileLinkListParams, FileLinkRetrieveParams, FileLinkUpdateParams, FileListParams, FinancialAccountCreateParams, FinancialAccountListParams, FinancialAccountRetrieveFeaturesParams, FinancialAccountRetrieveParams, FinancialAccountUpdateFeaturesParams, FinancialAccountUpdateParams, InboundTransferCancelParams, InboundTransferCreateParams, InboundTransferFailParams, InboundTransferListParams, InboundTransferRetrieveParams, InboundTransferReturnInboundTransferParams, InboundTransferSucceedParams, InvoiceCreateParams, InvoiceFinalizeInvoiceParams, InvoiceItemCreateParams, InvoiceItemListParams, InvoiceItemRetrieveParams, InvoiceItemUpdateParams, InvoiceLineItemCollectionListParams, InvoiceListParams, InvoiceMarkUncollectibleParams, InvoicePayParams, InvoiceRetrieveParams, InvoiceSearchParams, InvoiceSendInvoiceParams, InvoiceUpcomingLinesParams, InvoiceUpcomingParams, InvoiceUpdateParams, InvoiceVoidInvoiceParams, LocationCreateParams, LocationDeleteParams, LocationListParams, LocationRetrieveParams, LocationUpdateParams, LoginLinkCreateOnAccountParams, MandateRetrieveParams, OutboundPaymentCancelParams, OutboundPaymentCreateParams, OutboundPaymentFailParams, OutboundPaymentListParams, OutboundPaymentPostParams, OutboundPaymentRetrieveParams, OutboundPaymentReturnOutboundPaymentParams, OutboundTransferCancelParams, OutboundTransferCreateParams, OutboundTransferFailParams, OutboundTransferListParams, OutboundTransferPostParams, OutboundTransferRetrieveParams, OutboundTransferReturnOutboundTransferParams, PaymentIntentApplyCustomerBalanceParams, PaymentIntentCancelParams, PaymentIntentCaptureParams, PaymentIntentConfirmParams, PaymentIntentCreateParams, PaymentIntentIncrementAuthorizationParams, PaymentIntentListParams, PaymentIntentRetrieveParams, PaymentIntentSearchParams, PaymentIntentUpdateParams, PaymentIntentVerifyMicrodepositsParams, PaymentLinkCreateParams, PaymentLinkListLineItemsParams, PaymentLinkListParams, PaymentLinkRetrieveParams, PaymentLinkUpdateParams, PaymentMethodAttachParams, PaymentMethodCreateParams, PaymentMethodDetachParams, PaymentMethodListParams, PaymentMethodRetrieveParams, PaymentMethodUpdateParams, PaymentSourceCollectionCreateParams, PaymentSourceCollectionListParams, PaymentSourceCollectionRetrieveParams, PayoutCancelParams, PayoutCreateParams, PayoutListParams, PayoutRetrieveParams, PayoutReverseParams, PayoutUpdateParams, PersonCollectionCreateParams, PersonCollectionListParams, PersonCollectionRetrieveParams, PersonUpdateParams, PlanCreateParams, PlanListParams, PlanRetrieveParams, PlanUpdateParams, PriceCreateParams, PriceListParams, PriceRetrieveParams, PriceSearchParams, PriceUpdateParams, ProductCreateParams, ProductListParams, ProductRetrieveParams, ProductSearchParams, ProductUpdateParams, PromotionCodeCreateParams, PromotionCodeListParams, PromotionCodeRetrieveParams, PromotionCodeUpdateParams, QuoteAcceptParams, QuoteCancelParams, QuoteCreateParams, QuoteFinalizeQuoteParams, QuoteListComputedUpfrontLineItemsParams, QuoteListLineItemsParams, QuoteListParams, QuotePdfParams, QuoteRetrieveParams, QuoteUpdateParams, ReaderCancelActionParams, ReaderCreateParams, ReaderDeleteParams, ReaderListParams, ReaderPresentPaymentMethodParams, ReaderProcessPaymentIntentParams, ReaderProcessSetupIntentParams, ReaderRetrieveParams, ReaderSetReaderDisplayParams, ReaderUpdateParams, ReceivedCreditCreateParams, ReceivedCreditListParams, ReceivedCreditRetrieveParams, ReceivedDebitCreateParams, ReceivedDebitListParams, ReceivedDebitRetrieveParams, RefundCancelParams, RefundCollectionListParams, RefundCollectionRetrieveParams, RefundCreateParams, RefundExpireParams, RefundListParams, RefundRetrieveParams, RefundUpdateParams, ReportRunCreateParams, ReportRunListParams, ReportRunRetrieveParams, ReportTypeListParams, ReportTypeRetrieveParams, ReviewApproveParams, ReviewListParams, ReviewRetrieveParams, ScheduledQueryRunListParams, ScheduledQueryRunRetrieveParams, SecretCreateParams, SecretDeleteWhereParams, SecretFindParams, SecretListParams, SessionCreateParams, SessionCreateParams, SessionCreateParams, SessionExpireParams, SessionListLineItemsParams, SessionListParams, SessionRetrieveParams, SessionRetrieveParams, SetupAttemptListParams, SetupIntentCancelParams, SetupIntentConfirmParams, SetupIntentCreateParams, SetupIntentListParams, SetupIntentRetrieveParams, SetupIntentUpdateParams, SetupIntentVerifyMicrodepositsParams, ShippingRateCreateParams, ShippingRateListParams, ShippingRateRetrieveParams, ShippingRateUpdateParams, SourceCreateParams, SourceDetachParams, SourceRetrieveParams, SourceSourceTransactionsParams, SourceUpdateParams, SourceVerifyParams, SubscriptionCancelParams, SubscriptionCreateParams, SubscriptionItemCreateParams, SubscriptionItemDeleteParams, SubscriptionItemListParams, SubscriptionItemRetrieveParams, SubscriptionItemUpdateParams, SubscriptionItemUsageRecordSummariesParams, SubscriptionListParams, SubscriptionRetrieveParams, SubscriptionScheduleCancelParams, SubscriptionScheduleCreateParams, SubscriptionScheduleListParams, SubscriptionScheduleReleaseParams, SubscriptionScheduleRetrieveParams, SubscriptionScheduleUpdateParams, SubscriptionSearchParams, SubscriptionUpdateParams, TaxCodeListParams, TaxCodeRetrieveParams, TaxIdCollectionCreateParams, TaxIdCollectionListParams, TaxIdCollectionRetrieveParams, TaxRateCreateParams, TaxRateListParams, TaxRateRetrieveParams, TaxRateUpdateParams, TestClockAdvanceParams, TestClockCreateParams, TestClockListParams, TestClockRetrieveParams, TokenCreateParams, TokenRetrieveParams, TopupCancelParams, TopupCreateParams, TopupListParams, TopupRetrieveParams, TopupUpdateParams, TransactionEntryListParams, TransactionEntryRetrieveParams, TransactionListParams, TransactionListParams, TransactionRetrieveParams, TransactionRetrieveParams, TransactionUpdateParams, TransferCreateParams, TransferListParams, TransferRetrieveParams, TransferReversalCollectionCreateParams, TransferReversalCollectionListParams, TransferReversalCollectionRetrieveParams, 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. This common abstraction is internally used in ApiResource.request(ApiResource.RequestMethod, String, ApiRequestParams, Class, RequestOptions). It also 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).