SOsolvapay
Checkout Sessions

Create a checkout session

Changed on

Creates a hosted checkout session for a customer to purchase a product plan, or to top up credits (purpose: "credit_topup", which skips productRef). Returns a session ID and checkout URL for redirect.

post/v1/sdk/checkout-sessions

Request

Request body

customerRefstring required
planRefstring
productRefstring
purpose'credit_topup'
returnUrlstring

Response

Checkout session created

checkoutUrlstring required

Full checkout URL based on backend configuration (ready to redirect customer)

sessionIdstring required

Checkout session ID/token

Example response

{
  "checkoutUrl": "https://solvapay.com/customer/checkout?id=e3f1c2d4b6a89f001122334455667788",
  "sessionId": "e3f1c2d4b6a89f001122334455667788"
}

Changes

  • bbc2ff2bc849Revision changes
    • warning

      the request property's maxLength was set to 20

    • warning

      the request property's maxLength was set to 20

    • warning

      the request property's maxLength was set to 20

  • a30b6aef464dRevision changes
    • info

      the endpoint scheme security SecretKey was added to the API

    • info

      the endpoint scheme security bearer was removed from the API