Payments

Start new Stripe account onboarding

Creates or resumes a Standard Stripe account onboarding flow for the authenticated organization and returns a provider URL. A completed setup returns its dashboard URL with status=connected. Existing direct-key or incompatible connection state returns409. Creation retries reuse a provider idempotency identity; a stale ambiguous creation attempt requires reconciliation. The returned URL does not itself prove that charges or payouts are enabled. Requires permission: one of access_payment_gateways.

POST

stripe-connect

onboarding-link

curl --request POST \
  --url https://api.gratona.com/v1/stripe-connect/onboarding-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "country": "US"
}
'

import requests

url = "https://api.gratona.com/v1/stripe-connect/onboarding-link"

payload = { "country": "US" }
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({country: 'US'})
};

fetch('https://api.gratona.com/v1/stripe-connect/onboarding-link', 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.gratona.com/v1/stripe-connect/onboarding-link",
  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([
    'country' => 'US'
  ]),
  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.gratona.com/v1/stripe-connect/onboarding-link"

	payload := strings.NewReader("{\n  \"country\": \"US\"\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://api.gratona.com/v1/stripe-connect/onboarding-link")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"country\": \"US\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/stripe-connect/onboarding-link")

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  \"country\": \"US\"\n}"

response = http.request(request)
puts response.read_body

{
  "url": "<string>",
  "status": "onboarding"
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

{
  "error": "Stripe setup is temporarily unavailable.",
  "error_code": "STRIPE_ONBOARDING_UNAVAILABLE"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

{
  "error": "Stripe setup is temporarily unavailable.",
  "error_code": "STRIPE_ONBOARDING_UNAVAILABLE"
}

Authorizations

Authorization

string

header

required

Passport bearer token authentication for legacy admin sessions.

Body

application/json

Validated request fields for this operation.

country

string

Required when creating a new Stripe account. Choose a country from payment gateway settings; normalized to uppercase.

Example:

"US"

Response

Operation result.

url

string<uri>

Provider onboarding or account dashboard URL.

status

enum<string>

Available options:

onboarding,

connected

Example:

"onboarding"

Start new Stripe account onboarding

curl --request POST \
  --url https://api.gratona.com/v1/stripe-connect/onboarding-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "country": "US"
}
'

import requests

url = "https://api.gratona.com/v1/stripe-connect/onboarding-link"

payload = { "country": "US" }
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({country: 'US'})
};

fetch('https://api.gratona.com/v1/stripe-connect/onboarding-link', 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.gratona.com/v1/stripe-connect/onboarding-link",
  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([
    'country' => 'US'
  ]),
  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.gratona.com/v1/stripe-connect/onboarding-link"

	payload := strings.NewReader("{\n  \"country\": \"US\"\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://api.gratona.com/v1/stripe-connect/onboarding-link")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"country\": \"US\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/stripe-connect/onboarding-link")

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  \"country\": \"US\"\n}"

response = http.request(request)
puts response.read_body

{
  "url": "<string>",
  "status": "onboarding"
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

{
  "error": "Stripe setup is temporarily unavailable.",
  "error_code": "STRIPE_ONBOARDING_UNAVAILABLE"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

{
  "error": "Stripe setup is temporarily unavailable.",
  "error_code": "STRIPE_ONBOARDING_UNAVAILABLE"
}