Skip to main content
POST
Create hosted checkout session

Authorizations

x-api-key
string
header
required

Your SideShift Connect API key (sk_live_* or sk_test_*). Generate from Settings → Connect.

Body

application/json
amountCents
integer
required

Net amount to credit to the wallet, in cents

Required range: x >= 100
Example:

5000

sideshiftAccountId
string

Optional destination override. Defaults to the API-key company's own SideShift wallet. If supplied, the account must belong to or be linked to your Connect integration.

Example:

"acct_a1b2c3d4e5f6"

description
string

Checkout description shown to the payer

Example:

"Premium creator bundle"

customerEmail
string<email>

Optional payer email to prefill in checkout. The payer can still edit it.

customerName
string

Optional payer name for your own reconciliation

successUrl
string<uri>

Optional URL to redirect to after SideShift verifies payment

cancelUrl
string<uri>

Optional URL for the hosted page cancel link

paymentMethodType
enum<string>

Payment method used for fee calculation. Defaults to card.

Available options:
card,
link,
apple_pay,
google_pay,
amazon_pay,
cashapp,
paypal,
venmo,
crypto,
coinbase,
us_bank_account,
us_bank_transfer,
eu_bank_transfer,
gb_bank_transfer,
au_bank_transfer,
pay_by_bank,
klarna,
affirm,
afterpay_clearpay
Example:

"card"

allowedPaymentMethods
enum<string>[]

Optional payment methods to restrict the hosted checkout to. Omit this field to use SideShift's default checkout methods.

Available options:
card,
link,
apple_pay,
google_pay,
amazon_pay,
cashapp,
paypal,
venmo,
crypto,
coinbase,
us_bank_account,
us_bank_transfer,
eu_bank_transfer,
gb_bank_transfer,
au_bank_transfer,
pay_by_bank,
klarna,
affirm,
afterpay_clearpay
Example:
metadata
object

Up to 50 key/value pairs returned in deposit webhooks

Response

Hosted checkout session created

success
boolean
data
object