Replace a checkout
curl --request PUT \
--url https://api.getsly.ai/v1/v1/ucp/checkouts/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"items": [
{
"sku": "<string>",
"quantity": 123,
"unit_price": "<string>",
"currency": "<string>",
"description": "<string>"
}
],
"currency": "USD",
"style": "modal",
"success_url": "<string>",
"cancel_url": "<string>",
"expires_in": 900,
"metadata": {}
}
'import requests
url = "https://api.getsly.ai/v1/v1/ucp/checkouts/{id}"
payload = {
"merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"items": [
{
"sku": "<string>",
"quantity": 123,
"unit_price": "<string>",
"currency": "<string>",
"description": "<string>"
}
],
"currency": "USD",
"style": "modal",
"success_url": "<string>",
"cancel_url": "<string>",
"expires_in": 900,
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
merchant_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
items: [
{
sku: '<string>',
quantity: 123,
unit_price: '<string>',
currency: '<string>',
description: '<string>'
}
],
currency: 'USD',
style: 'modal',
success_url: '<string>',
cancel_url: '<string>',
expires_in: 900,
metadata: {}
})
};
fetch('https://api.getsly.ai/v1/v1/ucp/checkouts/{id}', 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://api.getsly.ai/v1/v1/ucp/checkouts/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'merchant_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'items' => [
[
'sku' => '<string>',
'quantity' => 123,
'unit_price' => '<string>',
'currency' => '<string>',
'description' => '<string>'
]
],
'currency' => 'USD',
'style' => 'modal',
'success_url' => '<string>',
'cancel_url' => '<string>',
'expires_in' => 900,
'metadata' => [
]
]),
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://api.getsly.ai/v1/v1/ucp/checkouts/{id}"
payload := strings.NewReader("{\n \"merchant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"items\": [\n {\n \"sku\": \"<string>\",\n \"quantity\": 123,\n \"unit_price\": \"<string>\",\n \"currency\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"currency\": \"USD\",\n \"style\": \"modal\",\n \"success_url\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"expires_in\": 900,\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.getsly.ai/v1/v1/ucp/checkouts/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"merchant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"items\": [\n {\n \"sku\": \"<string>\",\n \"quantity\": 123,\n \"unit_price\": \"<string>\",\n \"currency\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"currency\": \"USD\",\n \"style\": \"modal\",\n \"success_url\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"expires_in\": 900,\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getsly.ai/v1/v1/ucp/checkouts/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"merchant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"items\": [\n {\n \"sku\": \"<string>\",\n \"quantity\": 123,\n \"unit_price\": \"<string>\",\n \"currency\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"currency\": \"USD\",\n \"style\": \"modal\",\n \"success_url\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"expires_in\": 900,\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"items": [
{
"sku": "<string>",
"quantity": 123,
"unit_price": "<string>",
"currency": "<string>",
"description": "<string>"
}
],
"total": "<string>",
"currency": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"session_url": "<string>",
"success_url": "<string>",
"cancel_url": "<string>",
"metadata": {}
}
}{
"error": "<string>",
"code": "<string>",
"details": "<unknown>",
"request_id": "<string>"
}UCP Checkouts
Replace a checkout
Full update — only allowed while status is created or pending_payment. Use PATCH //edit for partial changes.
PUT
/
v1
/
ucp
/
checkouts
/
{id}
Replace a checkout
curl --request PUT \
--url https://api.getsly.ai/v1/v1/ucp/checkouts/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"items": [
{
"sku": "<string>",
"quantity": 123,
"unit_price": "<string>",
"currency": "<string>",
"description": "<string>"
}
],
"currency": "USD",
"style": "modal",
"success_url": "<string>",
"cancel_url": "<string>",
"expires_in": 900,
"metadata": {}
}
'import requests
url = "https://api.getsly.ai/v1/v1/ucp/checkouts/{id}"
payload = {
"merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"items": [
{
"sku": "<string>",
"quantity": 123,
"unit_price": "<string>",
"currency": "<string>",
"description": "<string>"
}
],
"currency": "USD",
"style": "modal",
"success_url": "<string>",
"cancel_url": "<string>",
"expires_in": 900,
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
merchant_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
items: [
{
sku: '<string>',
quantity: 123,
unit_price: '<string>',
currency: '<string>',
description: '<string>'
}
],
currency: 'USD',
style: 'modal',
success_url: '<string>',
cancel_url: '<string>',
expires_in: 900,
metadata: {}
})
};
fetch('https://api.getsly.ai/v1/v1/ucp/checkouts/{id}', 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://api.getsly.ai/v1/v1/ucp/checkouts/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'merchant_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'items' => [
[
'sku' => '<string>',
'quantity' => 123,
'unit_price' => '<string>',
'currency' => '<string>',
'description' => '<string>'
]
],
'currency' => 'USD',
'style' => 'modal',
'success_url' => '<string>',
'cancel_url' => '<string>',
'expires_in' => 900,
'metadata' => [
]
]),
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://api.getsly.ai/v1/v1/ucp/checkouts/{id}"
payload := strings.NewReader("{\n \"merchant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"items\": [\n {\n \"sku\": \"<string>\",\n \"quantity\": 123,\n \"unit_price\": \"<string>\",\n \"currency\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"currency\": \"USD\",\n \"style\": \"modal\",\n \"success_url\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"expires_in\": 900,\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.getsly.ai/v1/v1/ucp/checkouts/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"merchant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"items\": [\n {\n \"sku\": \"<string>\",\n \"quantity\": 123,\n \"unit_price\": \"<string>\",\n \"currency\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"currency\": \"USD\",\n \"style\": \"modal\",\n \"success_url\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"expires_in\": 900,\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getsly.ai/v1/v1/ucp/checkouts/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"merchant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"items\": [\n {\n \"sku\": \"<string>\",\n \"quantity\": 123,\n \"unit_price\": \"<string>\",\n \"currency\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"currency\": \"USD\",\n \"style\": \"modal\",\n \"success_url\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"expires_in\": 900,\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"items": [
{
"sku": "<string>",
"quantity": 123,
"unit_price": "<string>",
"currency": "<string>",
"description": "<string>"
}
],
"total": "<string>",
"currency": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"session_url": "<string>",
"success_url": "<string>",
"cancel_url": "<string>",
"metadata": {}
}
}{
"error": "<string>",
"code": "<string>",
"details": "<unknown>",
"request_id": "<string>"
}Authorizations
API key (pk_test_* or pk_live_), JWT session, agent token (agent_), Ed25519 session (sess_), or portal token (portal_).
Path Parameters
Body
application/json
Minimum array length:
1Show child attributes
Show child attributes
Available options:
modal, redirect, embedded Required range:
x <= 86400Show child attributes
Show child attributes
Response
Updated
Show child attributes
Show child attributes
⌘I