PUT
/
api
/
checkout
/
v2
/
payment_session

Headers

​
X-SC-ApiKey
string
required

Body

application/json
​
sessionId
string
required

Unique reference of the session in Sprintcheckout

Minimum length: 1
​
orderId
string | null

Unique reference of the order on your ecommerce platform

​
concept
string | null

If it's a payment link, will contain the payment concept

​
amount
number | null

Amount of the purchase

​
minAmount
number | null

Minimum amount of the payment

​
editable
boolean | null

Is the payment input editable in UI?

​
currency
string | null

Three letter FIAT currency code

​
successUrl
string | null

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

​
failUrl
string | null

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

​
cancelUrl
string | null

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

Response

200 - application/json
​
sessionId
string

Session unique identifier

​
redirectUrl
string

Payment session URL that will redirect to the Sprintcheckout dApp

Create payment session