Package com.stripe

Class StripeClient

java.lang.Object

com.stripe.StripeClient

public class StripeClient
extends Object

This is the primary entrypoint to make requests against Stripe's API. It provides a means of accessing all the methods on the Stripe API, and the ability to set configuration such as apiKey and connection timeouts.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	StripeClient.StripeClientBuilder

Constructor Summary

Constructors

Constructor	Description
StripeClient(StripeResponseGetter responseGetter)	Constructs a StripeClient with a custom StripeResponseGetter.
StripeClient(String apiKey)	Constructs a StripeClient with default settings, using the provided API key.

Method Summary

Modifier and Type	Method	Description
AccountLinkService	accountLinks()
AccountService	accounts()
AccountSessionService	accountSessions()
ApplePayDomainService	applePayDomains()
ApplicationFeeService	applicationFees()
AppsService	apps()
BalanceService	balance()
BalanceTransactionService	balanceTransactions()
BillingService	billing()
BillingPortalService	billingPortal()
static StripeClient.StripeClientBuilder	builder()	Builder class for creating a StripeClient instance.
ChargeService	charges()
CheckoutService	checkout()
ClimateService	climate()
ConfirmationTokenService	confirmationTokens()
Event	constructEvent(String payload, String sigHeader, String secret)	Returns an Event instance using the provided JSON payload.
Event	constructEvent(String payload, String sigHeader, String secret, long tolerance)	Returns an Event instance using the provided JSON payload.
CountrySpecService	countrySpecs()
CouponService	coupons()
CreditNoteService	creditNotes()
CustomerService	customers()
CustomerSessionService	customerSessions()
DisputeService	disputes()
EntitlementsService	entitlements()
EphemeralKeyService	ephemeralKeys()
EventService	events()
ExchangeRateService	exchangeRates()
FileLinkService	fileLinks()
FileService	files()
FinancialConnectionsService	financialConnections()
ForwardingService	forwarding()
protected StripeResponseGetter	getResponseGetter()
IdentityService	identity()
InvoiceItemService	invoiceItems()
InvoiceService	invoices()
IssuingService	issuing()
MandateService	mandates()
PaymentIntentService	paymentIntents()
PaymentLinkService	paymentLinks()
PaymentMethodConfigurationService	paymentMethodConfigurations()
PaymentMethodDomainService	paymentMethodDomains()
PaymentMethodService	paymentMethods()
PayoutService	payouts()
PlanService	plans()
PriceService	prices()
ProductService	products()
PromotionCodeService	promotionCodes()
QuoteService	quotes()
RadarService	radar()
RefundService	refunds()
ReportingService	reporting()
ReviewService	reviews()
SetupAttemptService	setupAttempts()
SetupIntentService	setupIntents()
ShippingRateService	shippingRates()
SigmaService	sigma()
SourceService	sources()
SubscriptionItemService	subscriptionItems()
SubscriptionService	subscriptions()
SubscriptionScheduleService	subscriptionSchedules()
TaxService	tax()
TaxCodeService	taxCodes()
TaxIdService	taxIds()
TaxRateService	taxRates()
TerminalService	terminal()
TestHelpersService	testHelpers()
TokenService	tokens()
TopupService	topups()
TransferService	transfers()
TreasuryService	treasury()
WebhookEndpointService	webhookEndpoints()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StripeClient

public StripeClient(String apiKey)

Constructs a StripeClient with default settings, using the provided API key. Use the builder instead if you require more complex configuration.

StripeClient

public StripeClient(StripeResponseGetter responseGetter)

Constructs a StripeClient with a custom StripeResponseGetter.

Use this for testing, or advanced use cases where you need to make fundamental changes to how the StripeClient makes requests.

Method Details

getResponseGetter

protected StripeResponseGetter getResponseGetter()

constructEvent

public Event constructEvent(String payload,
 String sigHeader,
 String secret)
                     throws SignatureVerificationException

Returns an Event instance using the provided JSON payload. Throws a JsonSyntaxException if the payload is not valid JSON, and a SignatureVerificationException if the signature verification fails for any reason.

Parameters:

payload - the payload sent by Stripe.

sigHeader - the contents of the signature header sent by Stripe.

secret - secret used to generate the signature.

Returns:

the Event instance

Throws:

SignatureVerificationException - if the verification fails.

constructEvent

public Event constructEvent(String payload,
 String sigHeader,
 String secret,
 long tolerance)
                     throws SignatureVerificationException

Returns an Event instance using the provided JSON payload. Throws a JsonSyntaxException if the payload is not valid JSON, and a SignatureVerificationException if the signature verification fails for any reason.

Parameters:

payload - the payload sent by Stripe.

sigHeader - the contents of the signature header sent by Stripe.

secret - secret used to generate the signature.

tolerance - maximum difference in seconds allowed between the header's timestamp and the current time

Returns:

the Event instance

Throws:

SignatureVerificationException - if the verification fails.

accountLinks

public AccountLinkService accountLinks()

accountSessions

public AccountSessionService accountSessions()

accounts

public AccountService accounts()

applePayDomains

public ApplePayDomainService applePayDomains()

applicationFees

public ApplicationFeeService applicationFees()

apps

public AppsService apps()

balance

public BalanceService balance()

balanceTransactions

public BalanceTransactionService balanceTransactions()

billing

public BillingService billing()

billingPortal

public BillingPortalService billingPortal()

charges

public ChargeService charges()

checkout

public CheckoutService checkout()

climate

public ClimateService climate()

confirmationTokens

public ConfirmationTokenService confirmationTokens()

countrySpecs

public CountrySpecService countrySpecs()

coupons

public CouponService coupons()

creditNotes

public CreditNoteService creditNotes()

customerSessions

public CustomerSessionService customerSessions()

customers

public CustomerService customers()

disputes

public DisputeService disputes()

entitlements

public EntitlementsService entitlements()

ephemeralKeys

public EphemeralKeyService ephemeralKeys()

events

public EventService events()

exchangeRates

public ExchangeRateService exchangeRates()

fileLinks

public FileLinkService fileLinks()

files

public FileService files()

financialConnections

public FinancialConnectionsService financialConnections()

forwarding

public ForwardingService forwarding()

identity

public IdentityService identity()

invoiceItems

public InvoiceItemService invoiceItems()

invoices

public InvoiceService invoices()

issuing

public IssuingService issuing()

mandates

public MandateService mandates()

paymentIntents

public PaymentIntentService paymentIntents()

paymentLinks

public PaymentLinkService paymentLinks()

paymentMethodConfigurations

public PaymentMethodConfigurationService paymentMethodConfigurations()

paymentMethodDomains

public PaymentMethodDomainService paymentMethodDomains()

paymentMethods

public PaymentMethodService paymentMethods()

payouts

public PayoutService payouts()

plans

public PlanService plans()

prices

public PriceService prices()

products

public ProductService products()

promotionCodes

public PromotionCodeService promotionCodes()

quotes

public QuoteService quotes()

radar

public RadarService radar()

refunds

public RefundService refunds()

reporting

public ReportingService reporting()

reviews

public ReviewService reviews()

setupAttempts

public SetupAttemptService setupAttempts()

setupIntents

public SetupIntentService setupIntents()

shippingRates

public ShippingRateService shippingRates()

sigma

public SigmaService sigma()

sources

public SourceService sources()

subscriptionItems

public SubscriptionItemService subscriptionItems()

subscriptionSchedules

public SubscriptionScheduleService subscriptionSchedules()

subscriptions

public SubscriptionService subscriptions()

tax

public TaxService tax()

taxCodes

public TaxCodeService taxCodes()

taxIds

public TaxIdService taxIds()

taxRates

public TaxRateService taxRates()

terminal

public TerminalService terminal()

testHelpers

public TestHelpersService testHelpers()

tokens

public TokenService tokens()

topups

public TopupService topups()

transfers

public TransferService transfers()

treasury

public TreasuryService treasury()

webhookEndpoints

public WebhookEndpointService webhookEndpoints()

builder

public static StripeClient.StripeClientBuilder builder()

Builder class for creating a StripeClient instance. Allows you to specify settings like the API key, connect and read timeouts, and proxy settings.