Skip to main content
POST
/
sessions
Create payment session
curl --request POST \
  --url https://platform.usewarp.net/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "public_key": "<string>",
  "amount_usd": 1,
  "description": "<string>",
  "metadata": {},
  "return_url": "<string>",
  "cancel_url": "<string>"
}
'
{
  "session_id": "<string>",
  "checkout_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

JWT Bearer token authentication

Body

application/json
public_key
string
required

Project public key (starts with pk_)

amount_usd
number
required

Amount in USD

Required range: x >= 0
description
string

Payment description

metadata
object

Additional metadata

return_url
string<uri>

Return URL after successful payment

cancel_url
string<uri>

Cancel URL if payment is cancelled

Response

Payment session created successfully

session_id
string
required

Payment session ID

checkout_url
string<uri>
required

Checkout page URL

expires_at
string<date-time>
required

Session expiration time