Create a checkout session
curl --request POST \
--url https://openapi.orriven.com/v1/events/{eventId}/checkout-sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"itemId": "<string>",
"quantity": 50
}
],
"email": "jsmith@example.com",
"name": "<string>",
"responses": {},
"redemptionCode": "<string>",
"promotionCode": "<string>",
"returnUrl": "<string>"
}
'import requests
url = "https://openapi.orriven.com/v1/events/{eventId}/checkout-sessions"
payload = {
"items": [
{
"itemId": "<string>",
"quantity": 50
}
],
"email": "jsmith@example.com",
"name": "<string>",
"responses": {},
"redemptionCode": "<string>",
"promotionCode": "<string>",
"returnUrl": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [{itemId: '<string>', quantity: 50}],
email: 'jsmith@example.com',
name: '<string>',
responses: {},
redemptionCode: '<string>',
promotionCode: '<string>',
returnUrl: '<string>'
})
};
fetch('https://openapi.orriven.com/v1/events/{eventId}/checkout-sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://openapi.orriven.com/v1/events/{eventId}/checkout-sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'items' => [
[
'itemId' => '<string>',
'quantity' => 50
]
],
'email' => 'jsmith@example.com',
'name' => '<string>',
'responses' => [
],
'redemptionCode' => '<string>',
'promotionCode' => '<string>',
'returnUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://openapi.orriven.com/v1/events/{eventId}/checkout-sessions"
payload := strings.NewReader("{\n \"items\": [\n {\n \"itemId\": \"<string>\",\n \"quantity\": 50\n }\n ],\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"responses\": {},\n \"redemptionCode\": \"<string>\",\n \"promotionCode\": \"<string>\",\n \"returnUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://openapi.orriven.com/v1/events/{eventId}/checkout-sessions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"itemId\": \"<string>\",\n \"quantity\": 50\n }\n ],\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"responses\": {},\n \"redemptionCode\": \"<string>\",\n \"promotionCode\": \"<string>\",\n \"returnUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://openapi.orriven.com/v1/events/{eventId}/checkout-sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"itemId\": \"<string>\",\n \"quantity\": 50\n }\n ],\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"responses\": {},\n \"redemptionCode\": \"<string>\",\n \"promotionCode\": \"<string>\",\n \"returnUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"url": "<string>",
"expiresAt": "<string>"
}{
"error": {
"code": 404,
"status": "NOT_FOUND",
"message": "Event not found.",
"details": [
"<unknown>"
]
}
}{
"error": {
"code": 404,
"status": "NOT_FOUND",
"message": "Event not found.",
"details": [
"<unknown>"
]
}
}{
"error": {
"code": 404,
"status": "NOT_FOUND",
"message": "Event not found.",
"details": [
"<unknown>"
]
}
}{
"error": {
"code": 404,
"status": "NOT_FOUND",
"message": "Event not found.",
"details": [
"<unknown>"
]
}
}{
"error": {
"code": 404,
"status": "NOT_FOUND",
"message": "Event not found.",
"details": [
"<unknown>"
]
}
}Orders
Create a checkout session
The Stripe Checkout shape: name what the buyer chose (and anything you already know about them), then send them to the returned url. orriven’s hosted page collects the missing details, holds the seat, takes payment and shows the result, then offers the way back to returnUrl. A session holds no seat itself and lives 24 hours. An unpublished event answers 412.
POST
/
v1
/
events
/
{eventId}
/
checkout-sessions
Create a checkout session
curl --request POST \
--url https://openapi.orriven.com/v1/events/{eventId}/checkout-sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"itemId": "<string>",
"quantity": 50
}
],
"email": "jsmith@example.com",
"name": "<string>",
"responses": {},
"redemptionCode": "<string>",
"promotionCode": "<string>",
"returnUrl": "<string>"
}
'import requests
url = "https://openapi.orriven.com/v1/events/{eventId}/checkout-sessions"
payload = {
"items": [
{
"itemId": "<string>",
"quantity": 50
}
],
"email": "jsmith@example.com",
"name": "<string>",
"responses": {},
"redemptionCode": "<string>",
"promotionCode": "<string>",
"returnUrl": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [{itemId: '<string>', quantity: 50}],
email: 'jsmith@example.com',
name: '<string>',
responses: {},
redemptionCode: '<string>',
promotionCode: '<string>',
returnUrl: '<string>'
})
};
fetch('https://openapi.orriven.com/v1/events/{eventId}/checkout-sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://openapi.orriven.com/v1/events/{eventId}/checkout-sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'items' => [
[
'itemId' => '<string>',
'quantity' => 50
]
],
'email' => 'jsmith@example.com',
'name' => '<string>',
'responses' => [
],
'redemptionCode' => '<string>',
'promotionCode' => '<string>',
'returnUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://openapi.orriven.com/v1/events/{eventId}/checkout-sessions"
payload := strings.NewReader("{\n \"items\": [\n {\n \"itemId\": \"<string>\",\n \"quantity\": 50\n }\n ],\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"responses\": {},\n \"redemptionCode\": \"<string>\",\n \"promotionCode\": \"<string>\",\n \"returnUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://openapi.orriven.com/v1/events/{eventId}/checkout-sessions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"itemId\": \"<string>\",\n \"quantity\": 50\n }\n ],\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"responses\": {},\n \"redemptionCode\": \"<string>\",\n \"promotionCode\": \"<string>\",\n \"returnUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://openapi.orriven.com/v1/events/{eventId}/checkout-sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"itemId\": \"<string>\",\n \"quantity\": 50\n }\n ],\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"responses\": {},\n \"redemptionCode\": \"<string>\",\n \"promotionCode\": \"<string>\",\n \"returnUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"url": "<string>",
"expiresAt": "<string>"
}{
"error": {
"code": 404,
"status": "NOT_FOUND",
"message": "Event not found.",
"details": [
"<unknown>"
]
}
}{
"error": {
"code": 404,
"status": "NOT_FOUND",
"message": "Event not found.",
"details": [
"<unknown>"
]
}
}{
"error": {
"code": 404,
"status": "NOT_FOUND",
"message": "Event not found.",
"details": [
"<unknown>"
]
}
}{
"error": {
"code": 404,
"status": "NOT_FOUND",
"message": "Event not found.",
"details": [
"<unknown>"
]
}
}{
"error": {
"code": 404,
"status": "NOT_FOUND",
"message": "Event not found.",
"details": [
"<unknown>"
]
}
}Authorizations
The API key's secret (osk_…), shown once when the key is created in the console.
Path Parameters
Body
application/json
Maximum array length:
50Show child attributes
Show child attributes
Maximum string length:
320Maximum string length:
200Show child attributes
Show child attributes
Required string length:
1 - 64Required string length:
1 - 64Maximum string length:
2000Available options:
en, zh-CN ⌘I