Platform Payments
Creates a settlement request
POST
/
settlements
/
request
Creates a settlement request
curl --request POST \
--url https://commerce1.on-hellgate.dev/settlements/request \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"amount": 123,
"currency_code": "<string>",
"distributions": [
{
"amount": 123,
"commission": 123,
"currency": "<string>",
"destination_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"order_id": "<string>"
}
'import requests
url = "https://commerce1.on-hellgate.dev/settlements/request"
payload = {
"amount": 123,
"currency_code": "<string>",
"distributions": [
{
"amount": 123,
"commission": 123,
"currency": "<string>",
"destination_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"order_id": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 123,
currency_code: '<string>',
distributions: [
{
amount: 123,
commission: 123,
currency: '<string>',
destination_account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
],
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
order_id: '<string>'
})
};
fetch('https://commerce1.on-hellgate.dev/settlements/request', 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://commerce1.on-hellgate.dev/settlements/request",
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([
'amount' => 123,
'currency_code' => '<string>',
'distributions' => [
[
'amount' => 123,
'commission' => 123,
'currency' => '<string>',
'destination_account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'order_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://commerce1.on-hellgate.dev/settlements/request"
payload := strings.NewReader("{\n \"amount\": 123,\n \"currency_code\": \"<string>\",\n \"distributions\": [\n {\n \"amount\": 123,\n \"commission\": 123,\n \"currency\": \"<string>\",\n \"destination_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"order_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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://commerce1.on-hellgate.dev/settlements/request")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"currency_code\": \"<string>\",\n \"distributions\": [\n {\n \"amount\": 123,\n \"commission\": 123,\n \"currency\": \"<string>\",\n \"destination_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"order_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://commerce1.on-hellgate.dev/settlements/request")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"currency_code\": \"<string>\",\n \"distributions\": [\n {\n \"amount\": 123,\n \"commission\": 123,\n \"currency\": \"<string>\",\n \"destination_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"order_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"classifier": "<string>",
"code": 123,
"message": "<string>"
}Authorizations
Headers
Identifies the account. Required when authenticating via mTLS — omit when using an API key (account is inferred from the key).
Body
application/json
Body
Response
Success
⌘I
Creates a settlement request
curl --request POST \
--url https://commerce1.on-hellgate.dev/settlements/request \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"amount": 123,
"currency_code": "<string>",
"distributions": [
{
"amount": 123,
"commission": 123,
"currency": "<string>",
"destination_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"order_id": "<string>"
}
'import requests
url = "https://commerce1.on-hellgate.dev/settlements/request"
payload = {
"amount": 123,
"currency_code": "<string>",
"distributions": [
{
"amount": 123,
"commission": 123,
"currency": "<string>",
"destination_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"order_id": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 123,
currency_code: '<string>',
distributions: [
{
amount: 123,
commission: 123,
currency: '<string>',
destination_account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
],
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
order_id: '<string>'
})
};
fetch('https://commerce1.on-hellgate.dev/settlements/request', 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://commerce1.on-hellgate.dev/settlements/request",
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([
'amount' => 123,
'currency_code' => '<string>',
'distributions' => [
[
'amount' => 123,
'commission' => 123,
'currency' => '<string>',
'destination_account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'order_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://commerce1.on-hellgate.dev/settlements/request"
payload := strings.NewReader("{\n \"amount\": 123,\n \"currency_code\": \"<string>\",\n \"distributions\": [\n {\n \"amount\": 123,\n \"commission\": 123,\n \"currency\": \"<string>\",\n \"destination_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"order_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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://commerce1.on-hellgate.dev/settlements/request")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"currency_code\": \"<string>\",\n \"distributions\": [\n {\n \"amount\": 123,\n \"commission\": 123,\n \"currency\": \"<string>\",\n \"destination_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"order_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://commerce1.on-hellgate.dev/settlements/request")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"currency_code\": \"<string>\",\n \"distributions\": [\n {\n \"amount\": 123,\n \"commission\": 123,\n \"currency\": \"<string>\",\n \"destination_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"order_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"classifier": "<string>",
"code": 123,
"message": "<string>"
}