Get Stripe onboarding link
curl --request GET \
--url https://app.base44.com/api/apps/{app_id}/payments/stripe/sandbox/claim-url \
--header 'api_key: <api-key>'import requests
url = "https://app.base44.com/api/apps/{app_id}/payments/stripe/sandbox/claim-url"
headers = {"api_key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {api_key: '<api-key>'}};
fetch('https://app.base44.com/api/apps/{app_id}/payments/stripe/sandbox/claim-url', 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://app.base44.com/api/apps/{app_id}/payments/stripe/sandbox/claim-url",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.base44.com/api/apps/{app_id}/payments/stripe/sandbox/claim-url"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api_key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.base44.com/api/apps/{app_id}/payments/stripe/sandbox/claim-url")
.header("api_key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.base44.com/api/apps/{app_id}/payments/stripe/sandbox/claim-url")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"claim_url": "https://dashboard.stripe.com/claim/example",
"is_claimable": true,
"no_link_reason": "unavailable"
}Stripe
Get Stripe onboarding link
This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.
Returns a link to claim a sandbox or resume unfinished activation. This call can refresh onboarding state and links. Requires write access to the app. Workspace viewers cannot call this operation.
GET
/
api
/
apps
/
{app_id}
/
payments
/
stripe
/
sandbox
/
claim-url
Get Stripe onboarding link
curl --request GET \
--url https://app.base44.com/api/apps/{app_id}/payments/stripe/sandbox/claim-url \
--header 'api_key: <api-key>'import requests
url = "https://app.base44.com/api/apps/{app_id}/payments/stripe/sandbox/claim-url"
headers = {"api_key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {api_key: '<api-key>'}};
fetch('https://app.base44.com/api/apps/{app_id}/payments/stripe/sandbox/claim-url', 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://app.base44.com/api/apps/{app_id}/payments/stripe/sandbox/claim-url",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.base44.com/api/apps/{app_id}/payments/stripe/sandbox/claim-url"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api_key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.base44.com/api/apps/{app_id}/payments/stripe/sandbox/claim-url")
.header("api_key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.base44.com/api/apps/{app_id}/payments/stripe/sandbox/claim-url")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"claim_url": "https://dashboard.stripe.com/claim/example",
"is_claimable": true,
"no_link_reason": "unavailable"
}Authorizations
Personal API key.
Path Parameters
ID of the Base44 app.
Response
Successful Response
Claim URL response.
Stripe onboarding link, or null when no link is available. Treat this link as a credential.
Example:
"https://dashboard.stripe.com/claim/example"
Whether the returned link starts a claim. A link that resumes activation of an already claimed sandbox returns false.
Example:
true
Reason no link is returned. Either already_active, sandbox_expired, or unavailable, or null when a link is returned. Defaults to null.
Available options:
already_active, sandbox_expired, unavailable Example:
"unavailable"
Was this page helpful?