Skip to main content
POST
/
api
/
checkout
/
v2
/
payment_session
Creates a payment session
curl --request POST \
  --url https://api.sprintcheckout.com/api/checkout/v2/payment_session \
  --header 'Content-Type: application/json' \
  --header 'X-SC-ApiKey: <x-sc-apikey>' \
  --data '
{
  "amount": 100.5,
  "currency": "USD",
  "orderType": "STATIC",
  "minAmount": 100.5,
  "editable": true,
  "orderId": "inv-00010",
  "successUrl": "<string>",
  "cancelUrl": "<string>"
}
'
{
  "sessionId": "<string>",
  "redirectUrl": "<string>"
}

Headers

​
X-SC-ApiKey
string
required

Get an Api Key from Sprintcheckout Dashboard > Get paid

Body

application/json
​
amount
number<double>
required

Amount of the purchase

Example:

100.5

​
currency
string
required

Three letter FIAT currency code

Example:

"USD"

​
orderType
string | null

An order can be STATIC or TRANSIENT (default behavior). A static order will not expire. A typical example could be a donation scenario. A transient order will not be reusable once is paid.

Pattern: STATIC|TRANSIENT
Example:

"STATIC"

​
minAmount
number<double> | null

Minimum amount of the payment

Example:

100.5

​
editable
boolean | null

Is the payment input editable in UI?

​
orderId
string | null

Unique reference of the order on your ecommerce platform

Example:

"inv-00010"

​
successUrl
string | null

URL where the user will be redirected from the hosted payment page on a successful payment

​
cancelUrl
string | null

URL where the user will be redirected from the hosted payment page on a canceled payment

Response

Payment session created

​
sessionId
string

Session unique identifier

​
redirectUrl
string

Payment session URL that will redirect to the Sprintcheckout dApp