Reports & Transactions
Creates a settlement report
POST
/
settlements
/
reports
Creates a settlement report
curl --request POST \
--url https://commerce1.on-hellgate.dev/settlements/reports \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"currency_code": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"items": [
{
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"commission": 123,
"date": "2023-11-07T05:31:56Z",
"gross_credit_amount": 123,
"gross_debit_amount": 123,
"net_credit_amount": 123,
"net_debit_amount": 123
}
],
"reporting_period_end": "2023-11-07T05:31:56Z",
"reporting_period_start": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://commerce1.on-hellgate.dev/settlements/reports"
payload = {
"currency_code": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"items": [
{
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"commission": 123,
"date": "2023-11-07T05:31:56Z",
"gross_credit_amount": 123,
"gross_debit_amount": 123,
"net_credit_amount": 123,
"net_debit_amount": 123
}
],
"reporting_period_end": "2023-11-07T05:31:56Z",
"reporting_period_start": "2023-11-07T05:31:56Z"
}
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({
currency_code: '<string>',
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
items: [
{
account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
commission: 123,
date: '2023-11-07T05:31:56Z',
gross_credit_amount: 123,
gross_debit_amount: 123,
net_credit_amount: 123,
net_debit_amount: 123
}
],
reporting_period_end: '2023-11-07T05:31:56Z',
reporting_period_start: '2023-11-07T05:31:56Z'
})
};
fetch('https://commerce1.on-hellgate.dev/settlements/reports', 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/reports",
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([
'currency_code' => '<string>',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'items' => [
[
'account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'commission' => 123,
'date' => '2023-11-07T05:31:56Z',
'gross_credit_amount' => 123,
'gross_debit_amount' => 123,
'net_credit_amount' => 123,
'net_debit_amount' => 123
]
],
'reporting_period_end' => '2023-11-07T05:31:56Z',
'reporting_period_start' => '2023-11-07T05:31:56Z'
]),
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/reports"
payload := strings.NewReader("{\n \"currency_code\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"items\": [\n {\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"commission\": 123,\n \"date\": \"2023-11-07T05:31:56Z\",\n \"gross_credit_amount\": 123,\n \"gross_debit_amount\": 123,\n \"net_credit_amount\": 123,\n \"net_debit_amount\": 123\n }\n ],\n \"reporting_period_end\": \"2023-11-07T05:31:56Z\",\n \"reporting_period_start\": \"2023-11-07T05:31:56Z\"\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/reports")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"currency_code\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"items\": [\n {\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"commission\": 123,\n \"date\": \"2023-11-07T05:31:56Z\",\n \"gross_credit_amount\": 123,\n \"gross_debit_amount\": 123,\n \"net_credit_amount\": 123,\n \"net_debit_amount\": 123\n }\n ],\n \"reporting_period_end\": \"2023-11-07T05:31:56Z\",\n \"reporting_period_start\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://commerce1.on-hellgate.dev/settlements/reports")
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 \"currency_code\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"items\": [\n {\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"commission\": 123,\n \"date\": \"2023-11-07T05:31:56Z\",\n \"gross_credit_amount\": 123,\n \"gross_debit_amount\": 123,\n \"net_credit_amount\": 123,\n \"net_debit_amount\": 123\n }\n ],\n \"reporting_period_end\": \"2023-11-07T05:31:56Z\",\n \"reporting_period_start\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"currency_code": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"items": [
{
"date": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settlement_report_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"commission": 123,
"fee_type": "<string>",
"gross_credit_amount": 123,
"gross_debit_amount": 123,
"net_credit_amount": 123,
"net_debit_amount": 123,
"payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"reporting_period_end": "2023-11-07T05:31:56Z",
"reporting_period_start": "2023-11-07T05:31:56Z"
}{
"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
⌘I
Creates a settlement report
curl --request POST \
--url https://commerce1.on-hellgate.dev/settlements/reports \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"currency_code": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"items": [
{
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"commission": 123,
"date": "2023-11-07T05:31:56Z",
"gross_credit_amount": 123,
"gross_debit_amount": 123,
"net_credit_amount": 123,
"net_debit_amount": 123
}
],
"reporting_period_end": "2023-11-07T05:31:56Z",
"reporting_period_start": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://commerce1.on-hellgate.dev/settlements/reports"
payload = {
"currency_code": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"items": [
{
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"commission": 123,
"date": "2023-11-07T05:31:56Z",
"gross_credit_amount": 123,
"gross_debit_amount": 123,
"net_credit_amount": 123,
"net_debit_amount": 123
}
],
"reporting_period_end": "2023-11-07T05:31:56Z",
"reporting_period_start": "2023-11-07T05:31:56Z"
}
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({
currency_code: '<string>',
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
items: [
{
account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
commission: 123,
date: '2023-11-07T05:31:56Z',
gross_credit_amount: 123,
gross_debit_amount: 123,
net_credit_amount: 123,
net_debit_amount: 123
}
],
reporting_period_end: '2023-11-07T05:31:56Z',
reporting_period_start: '2023-11-07T05:31:56Z'
})
};
fetch('https://commerce1.on-hellgate.dev/settlements/reports', 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/reports",
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([
'currency_code' => '<string>',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'items' => [
[
'account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'commission' => 123,
'date' => '2023-11-07T05:31:56Z',
'gross_credit_amount' => 123,
'gross_debit_amount' => 123,
'net_credit_amount' => 123,
'net_debit_amount' => 123
]
],
'reporting_period_end' => '2023-11-07T05:31:56Z',
'reporting_period_start' => '2023-11-07T05:31:56Z'
]),
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/reports"
payload := strings.NewReader("{\n \"currency_code\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"items\": [\n {\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"commission\": 123,\n \"date\": \"2023-11-07T05:31:56Z\",\n \"gross_credit_amount\": 123,\n \"gross_debit_amount\": 123,\n \"net_credit_amount\": 123,\n \"net_debit_amount\": 123\n }\n ],\n \"reporting_period_end\": \"2023-11-07T05:31:56Z\",\n \"reporting_period_start\": \"2023-11-07T05:31:56Z\"\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/reports")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"currency_code\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"items\": [\n {\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"commission\": 123,\n \"date\": \"2023-11-07T05:31:56Z\",\n \"gross_credit_amount\": 123,\n \"gross_debit_amount\": 123,\n \"net_credit_amount\": 123,\n \"net_debit_amount\": 123\n }\n ],\n \"reporting_period_end\": \"2023-11-07T05:31:56Z\",\n \"reporting_period_start\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://commerce1.on-hellgate.dev/settlements/reports")
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 \"currency_code\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"items\": [\n {\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"commission\": 123,\n \"date\": \"2023-11-07T05:31:56Z\",\n \"gross_credit_amount\": 123,\n \"gross_debit_amount\": 123,\n \"net_credit_amount\": 123,\n \"net_debit_amount\": 123\n }\n ],\n \"reporting_period_end\": \"2023-11-07T05:31:56Z\",\n \"reporting_period_start\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"currency_code": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"items": [
{
"date": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settlement_report_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"commission": 123,
"fee_type": "<string>",
"gross_credit_amount": 123,
"gross_debit_amount": 123,
"net_credit_amount": 123,
"net_debit_amount": 123,
"payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"reporting_period_end": "2023-11-07T05:31:56Z",
"reporting_period_start": "2023-11-07T05:31:56Z"
}{
"classifier": "<string>",
"code": 123,
"message": "<string>"
}