Get paid

There are currently three ways to create payment sessions. Via API integration, no code Woocommerce payment plugin, and payment links.

The payment flow is the following:

Get API key

On this section, get the API key you will need to call the payment_session endpoint.

Create payment sessions

There are currently two ways to create payment sessions. Via API integration and via no code Woocommerce payment plugin.

API integration

Using your API key, you can create payment sessions on any ecommerce checkout.

Base Url	https://api.sprintcheckout.com
Authentication	API Key
Key	X-SC-ApiKey
Value	e.g. dda87384-cb3f-40ee-a333-e51a0b336dc0

When a customer purchases something from you, you can create a hosted payment page session providing us with the details of the purchase

POST/checkout/v2/payment_session

Body

application/json

paymentSession*PaymentSession (object)

Response

202401500

Payment session ready

Body

application/json

redirectUrlstring

When the customer clicks proceed to payment, redirect to this URL

tokenPricesarray of TokenPrices (object)

Amount of the purchase converted to the accepted tokens. You can display them to the customer on the checkout page

Request

JavaScriptCurl

const response = await fetch('/checkout/v2/payment_session', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "paymentSession": {
        "amount": 100.5,
        "canceledUrl": "text",
        "currency": "USD, EUR, GBP, CNY, INR, MXN...",
        "failedUrl": "text",
        "orderId": "text",
        "successUrl": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "redirectUrl": "text",
  "tokenPrices": [
    {
      "symbol": "text",
      "conversion": 0
    }
  ]
}

Update a payment session adding the sessionId to the callÑ

Updates a payment session

PUT/api/checkout/v2/payment_session

Header parameters

Body

application/json

sessionId*string

Unique reference of the session in Sprintcheckout

orderIdnullable string

Unique reference of the order on your ecommerce platform

conceptnullable string

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

amountnullable number (double)

Amount of the purchase

minAmountnullable number (double)

Minimum amount of the payment

editablenullable boolean

Is the payment input editable in UI?

currencynullable string

Three letter FIAT currency code

successUrlnullable string

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

failUrlnullable string

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

cancelUrlnullable string

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

Response

200500

Payment session updated

Body

application/json

sessionIdstring

Session unique identifier

redirectUrlstring

Payment session URL that will redirect to the Sprintcheckout dApp

Request

JavaScriptCurl

const response = await fetch('/api/checkout/v2/payment_session', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sessionId": "text"
    }),
});
const data = await response.json();

Response

{
  "sessionId": "text",
  "redirectUrl": "text"
}