Package com.stripe.net
Class ApiRequestParams
- java.lang.Object
-
- com.stripe.net.ApiRequestParams
-
- Direct Known Subclasses:
AccountCapabilitiesParams
,AccountCreateParams
,AccountLinkCreateParams
,AccountListParams
,AccountPersonsParams
,AccountRejectParams
,AccountRetrieveParams
,AccountUpdateParams
,ApplePayDomainCreateParams
,ApplePayDomainListParams
,ApplePayDomainRetrieveParams
,ApplicationFeeListParams
,ApplicationFeeRetrieveParams
,AuthorizationApproveParams
,AuthorizationDeclineParams
,AuthorizationListParams
,AuthorizationRetrieveParams
,AuthorizationUpdateParams
,BalanceRetrieveParams
,BalanceTransactionListParams
,BalanceTransactionRetrieveParams
,BankAccountUpdateOnAccountParams
,BankAccountUpdateOnCustomerParams
,BankAccountVerifyParams
,BitcoinReceiverListParams
,BitcoinReceiverRetrieveParams
,BitcoinTransactionCollectionListParams
,CapabilityCollectionListParams
,CapabilityCollectionRetrieveParams
,CapabilityUpdateParams
,CardCreateParams
,CardDetailsParams
,CardholderCreateParams
,CardholderListParams
,CardholderRetrieveParams
,CardholderUpdateParams
,CardListParams
,CardRetrieveParams
,CardUpdateOnAccountParams
,CardUpdateOnCustomerParams
,CardUpdateParams
,ChargeCaptureParams
,ChargeCreateParams
,ChargeListParams
,ChargeRetrieveParams
,ChargeUpdateParams
,ConfigurationCreateParams
,ConfigurationListParams
,ConfigurationRetrieveParams
,ConfigurationUpdateParams
,ConnectionTokenCreateParams
,CountrySpecListParams
,CountrySpecRetrieveParams
,CouponCreateParams
,CouponListParams
,CouponRetrieveParams
,CouponUpdateParams
,CreditNoteCreateParams
,CreditNoteLineItemCollectionListParams
,CreditNoteListParams
,CreditNotePreviewParams
,CreditNoteRetrieveParams
,CreditNoteUpdateParams
,CreditNoteVoidCreditNoteParams
,CustomerBalanceTransactionCollectionCreateParams
,CustomerBalanceTransactionCollectionListParams
,CustomerBalanceTransactionCollectionRetrieveParams
,CustomerBalanceTransactionsParams
,CustomerBalanceTransactionUpdateParams
,CustomerCreateParams
,CustomerListParams
,CustomerListPaymentMethodsParams
,CustomerRetrieveParams
,CustomerUpdateParams
,DisputeCloseParams
,DisputeCreateParams
,DisputeListParams
,DisputeListParams
,DisputeRetrieveParams
,DisputeRetrieveParams
,DisputeSubmitParams
,DisputeUpdateParams
,DisputeUpdateParams
,EarlyFraudWarningListParams
,EarlyFraudWarningRetrieveParams
,EphemeralKeyCreateParams
,EventListParams
,EventRetrieveParams
,ExchangeRateListParams
,ExchangeRateRetrieveParams
,ExternalAccountCollectionCreateParams
,ExternalAccountCollectionListParams
,ExternalAccountCollectionRetrieveParams
,ExternalAccountUpdateParams
,FeeRefundCollectionCreateParams
,FeeRefundCollectionListParams
,FeeRefundCollectionRetrieveParams
,FeeRefundUpdateParams
,FileCreateParams
,FileLinkCreateParams
,FileLinkListParams
,FileLinkRetrieveParams
,FileLinkUpdateParams
,FileListParams
,InvoiceCreateParams
,InvoiceFinalizeInvoiceParams
,InvoiceItemCreateParams
,InvoiceItemListParams
,InvoiceItemRetrieveParams
,InvoiceItemUpdateParams
,InvoiceLineItemCollectionListParams
,InvoiceListParams
,InvoiceMarkUncollectibleParams
,InvoicePayParams
,InvoiceRetrieveParams
,InvoiceSendInvoiceParams
,InvoiceUpcomingParams
,InvoiceUpdateParams
,InvoiceVoidInvoiceParams
,IssuerFraudRecordListParams
,IssuerFraudRecordRetrieveParams
,LocationCreateParams
,LocationDeleteParams
,LocationListParams
,LocationRetrieveParams
,LocationUpdateParams
,LoginLinkCreateOnAccountParams
,MandateRetrieveParams
,OrderCreateParams
,OrderListParams
,OrderPayParams
,OrderRetrieveParams
,OrderReturnListParams
,OrderReturnOrderParams
,OrderReturnRetrieveParams
,OrderUpdateParams
,PaymentIntentCancelParams
,PaymentIntentCaptureParams
,PaymentIntentConfirmParams
,PaymentIntentCreateParams
,PaymentIntentListParams
,PaymentIntentRetrieveParams
,PaymentIntentUpdateParams
,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
,PriceUpdateParams
,ProductCreateParams
,ProductListParams
,ProductRetrieveParams
,ProductUpdateParams
,PromotionCodeCreateParams
,PromotionCodeListParams
,PromotionCodeRetrieveParams
,PromotionCodeUpdateParams
,QuoteAcceptParams
,QuoteCancelParams
,QuoteCollectionListParams
,QuoteCreateParams
,QuoteFinalizeParams
,QuoteFinalizeQuoteParams
,QuoteListComputedUpfrontLineItemsParams
,QuoteListLineItemsParams
,QuoteListParams
,QuotePdfParams
,QuoteRetrieveParams
,QuoteUpdateParams
,ReaderCreateParams
,ReaderDeleteParams
,ReaderListParams
,ReaderRetrieveParams
,ReaderUpdateParams
,RecipientCreateParams
,RecipientListParams
,RecipientRetrieveParams
,RecipientUpdateParams
,RefundCollectionListParams
,RefundCollectionRetrieveParams
,RefundCreateParams
,RefundListParams
,RefundRetrieveParams
,RefundUpdateParams
,ReportRunCreateParams
,ReportRunListParams
,ReportRunRetrieveParams
,ReportTypeListParams
,ReportTypeRetrieveParams
,ReviewApproveParams
,ReviewListParams
,ReviewRetrieveParams
,ScheduledQueryRunListParams
,ScheduledQueryRunRetrieveParams
,SessionCreateParams
,SessionCreateParams
,SessionExpireParams
,SessionListLineItemsParams
,SessionListParams
,SessionRetrieveParams
,SetupAttemptListParams
,SetupIntentCancelParams
,SetupIntentConfirmParams
,SetupIntentCreateParams
,SetupIntentListParams
,SetupIntentRetrieveParams
,SetupIntentUpdateParams
,ShippingRateCreateParams
,ShippingRateListParams
,ShippingRateRetrieveParams
,ShippingRateUpdateParams
,SkuCreateParams
,SkuListParams
,SkuRetrieveParams
,SkuUpdateParams
,SourceCreateParams
,SourceDetachParams
,SourceRetrieveParams
,SourceSourceTransactionsParams
,SourceUpdateParams
,SourceVerifyParams
,SubscriptionCancelParams
,SubscriptionCreateParams
,SubscriptionItemCreateParams
,SubscriptionItemDeleteParams
,SubscriptionItemListParams
,SubscriptionItemRetrieveParams
,SubscriptionItemUpdateParams
,SubscriptionItemUsageRecordSummariesParams
,SubscriptionListParams
,SubscriptionRetrieveParams
,SubscriptionScheduleCancelParams
,SubscriptionScheduleCreateParams
,SubscriptionScheduleListParams
,SubscriptionScheduleReleaseParams
,SubscriptionScheduleRetrieveParams
,SubscriptionScheduleUpdateParams
,SubscriptionUpdateParams
,TaxCodeListParams
,TaxCodeRetrieveParams
,TaxIdCollectionCreateParams
,TaxIdCollectionListParams
,TaxIdCollectionRetrieveParams
,TaxRateCreateParams
,TaxRateListParams
,TaxRateRetrieveParams
,TaxRateUpdateParams
,ThreeDSecureCreateParams
,ThreeDSecureRetrieveParams
,TokenCreateParams
,TokenRetrieveParams
,TopupCancelParams
,TopupCreateParams
,TopupListParams
,TopupRetrieveParams
,TopupUpdateParams
,TransactionListParams
,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 java.lang.Object
Super class to all api request params objects. This common abstraction is internally used inApiResource.request(ApiResource.RequestMethod, String, ApiRequestParams, Class, RequestOptions)
. It also exposes a convenient method converting the typed parameter into the legacy support of untypedMap<String, Object>
param.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ApiRequestParams.EnumParam
Interface implemented by all enum parameter to get the actual string value that Stripe API expects.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
EXTRA_PARAMS_KEY
Param key for an `extraParams` map.
-
Constructor Summary
Constructors Constructor Description ApiRequestParams()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Map<java.lang.String,java.lang.Object>
toMap()
Convert `this` api request params to an untyped map.
-
-
-
Field Detail
-
EXTRA_PARAMS_KEY
public static final java.lang.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 inApiRequestParamsConverter
.- See Also:
- Constant Field Values
-
-