cURL
curl --request POST \
--url https://app.example.com/v1/public/finance/bookings/<bookingId>/payment-schedules/<scheduleId>/payment-session \
--header 'Content-Type: application/json' \
--data '{
"payerName": "<string>",
"payerEmail": "<string>",
"method": "card",
"returnUrl": "<string>"
}'const response = await fetch("https://app.example.com/v1/public/finance/bookings/<bookingId>/payment-schedules/<scheduleId>/payment-session", {
method: "POST",
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({
"payerName": "<string>",
"payerEmail": "<string>",
"method": "card",
"returnUrl": "<string>"
}),
});
const data = await response.json();import requests
response = requests.post(
"https://app.example.com/v1/public/finance/bookings/<bookingId>/payment-schedules/<scheduleId>/payment-session",
json={
"payerName": "<string>",
"payerEmail": "<string>",
"method": "card",
"returnUrl": "<string>"
}
)
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{operatorDomain}/v1/public/finance/bookings/{bookingId}/payment-schedules/{scheduleId}/payment-session",
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([
'payerName' => '<string>',
'payerEmail' => 'jsmith@example.com',
'returnUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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://{operatorDomain}/v1/public/finance/bookings/{bookingId}/payment-schedules/{scheduleId}/payment-session"
payload := strings.NewReader("{\n \"payerName\": \"<string>\",\n \"payerEmail\": \"jsmith@example.com\",\n \"returnUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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://{operatorDomain}/v1/public/finance/bookings/{bookingId}/payment-schedules/{scheduleId}/payment-session")
.header("Content-Type", "application/json")
.body("{\n \"payerName\": \"<string>\",\n \"payerEmail\": \"jsmith@example.com\",\n \"returnUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{operatorDomain}/v1/public/finance/bookings/{bookingId}/payment-schedules/{scheduleId}/payment-session")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"payerName\": \"<string>\",\n \"payerEmail\": \"jsmith@example.com\",\n \"returnUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "psess_01HZX...",
"status": "open",
"amountCents": 119000,
"currency": "EUR",
"provider": "netopia",
"redirectUrl": "<string>",
"payerEmail": "<string>",
"payerName": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}Customer portal
Start a payment session for a schedule installment
Open a payment session against a booking payment schedule installment. Requires the checkout payment:start capability; supports an Idempotency-Key header.
POST
/
v1
/
public
/
finance
/
bookings
/
{bookingId}
/
payment-schedules
/
{scheduleId}
/
payment-session
cURL
curl --request POST \
--url https://app.example.com/v1/public/finance/bookings/<bookingId>/payment-schedules/<scheduleId>/payment-session \
--header 'Content-Type: application/json' \
--data '{
"payerName": "<string>",
"payerEmail": "<string>",
"method": "card",
"returnUrl": "<string>"
}'const response = await fetch("https://app.example.com/v1/public/finance/bookings/<bookingId>/payment-schedules/<scheduleId>/payment-session", {
method: "POST",
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({
"payerName": "<string>",
"payerEmail": "<string>",
"method": "card",
"returnUrl": "<string>"
}),
});
const data = await response.json();import requests
response = requests.post(
"https://app.example.com/v1/public/finance/bookings/<bookingId>/payment-schedules/<scheduleId>/payment-session",
json={
"payerName": "<string>",
"payerEmail": "<string>",
"method": "card",
"returnUrl": "<string>"
}
)
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{operatorDomain}/v1/public/finance/bookings/{bookingId}/payment-schedules/{scheduleId}/payment-session",
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([
'payerName' => '<string>',
'payerEmail' => 'jsmith@example.com',
'returnUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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://{operatorDomain}/v1/public/finance/bookings/{bookingId}/payment-schedules/{scheduleId}/payment-session"
payload := strings.NewReader("{\n \"payerName\": \"<string>\",\n \"payerEmail\": \"jsmith@example.com\",\n \"returnUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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://{operatorDomain}/v1/public/finance/bookings/{bookingId}/payment-schedules/{scheduleId}/payment-session")
.header("Content-Type", "application/json")
.body("{\n \"payerName\": \"<string>\",\n \"payerEmail\": \"jsmith@example.com\",\n \"returnUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{operatorDomain}/v1/public/finance/bookings/{bookingId}/payment-schedules/{scheduleId}/payment-session")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"payerName\": \"<string>\",\n \"payerEmail\": \"jsmith@example.com\",\n \"returnUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "psess_01HZX...",
"status": "open",
"amountCents": 119000,
"currency": "EUR",
"provider": "netopia",
"redirectUrl": "<string>",
"payerEmail": "<string>",
"payerName": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}{
"error": "<string>",
"code": "<string>",
"requestId": "<string>",
"details": {}
}Body
application/json
Response
Payment session
Redacted public projection of a payment session — the session id is itself the bearer credential.
Show child attributes
Show child attributes
⌘I