Payment Operations
List and filter payments
GET
/
payments
List and filter payments
curl --request GET \
--url https://{instance}.{env}.on-hellgate.cloud/payments \
--header 'X-API-Key: <api-key>'import requests
url = "https://{instance}.{env}.on-hellgate.cloud/payments"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://{instance}.{env}.on-hellgate.cloud/payments', 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://{instance}.{env}.on-hellgate.cloud/payments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://{instance}.{env}.on-hellgate.cloud/payments"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-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://{instance}.{env}.on-hellgate.cloud/payments")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.{env}.on-hellgate.cloud/payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"additional_information": {},
"amount": 123,
"continuation": {
"error": "<string>",
"success": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"currency": "<string>",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"distributions": [
{
"amount": 123,
"description": "<string>",
"seller_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"order_id": "<string>",
"payment_method": {
"data": {},
"token": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "FIRST_PAYMENT"
},
"processing": {
"requirement": {
"action": "<string>",
"message": "<string>",
"options": [
{}
]
},
"status": "ACTION_REQUIRED"
},
"processor": {
"amount_authorized": 123,
"amount_captured": 123,
"amount_refunded": 123,
"merchant_id": "<string>",
"name": "<string>"
},
"refunds": [
{
"amount": 123,
"created_at": "2023-11-07T05:31:56Z",
"currency_code": "<string>",
"distributions": [
{
"amount": 123,
"description": "<string>",
"seller_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>"
}
],
"settlements": [
{
"amount": 123,
"currency_code": "<string>",
"date": "2023-11-07T05:31:56Z",
"settlement_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settlement_report_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
],
"status": "OPEN",
"transactions": [
{
"amount": 123,
"ended_at": "2023-11-07T05:31:56Z",
"failure_reasons": [
{
"classifier": "<string>",
"message": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"processor_name": "<string>",
"processor_transaction_id": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"status": "PENDING",
"transaction_type": "AUTHORIZE"
}
]
}
],
"next_page": 123,
"previous_page": 123
}{
"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).
⌘I
List and filter payments
curl --request GET \
--url https://{instance}.{env}.on-hellgate.cloud/payments \
--header 'X-API-Key: <api-key>'import requests
url = "https://{instance}.{env}.on-hellgate.cloud/payments"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://{instance}.{env}.on-hellgate.cloud/payments', 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://{instance}.{env}.on-hellgate.cloud/payments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://{instance}.{env}.on-hellgate.cloud/payments"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-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://{instance}.{env}.on-hellgate.cloud/payments")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.{env}.on-hellgate.cloud/payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"additional_information": {},
"amount": 123,
"continuation": {
"error": "<string>",
"success": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"currency": "<string>",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"distributions": [
{
"amount": 123,
"description": "<string>",
"seller_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"order_id": "<string>",
"payment_method": {
"data": {},
"token": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "FIRST_PAYMENT"
},
"processing": {
"requirement": {
"action": "<string>",
"message": "<string>",
"options": [
{}
]
},
"status": "ACTION_REQUIRED"
},
"processor": {
"amount_authorized": 123,
"amount_captured": 123,
"amount_refunded": 123,
"merchant_id": "<string>",
"name": "<string>"
},
"refunds": [
{
"amount": 123,
"created_at": "2023-11-07T05:31:56Z",
"currency_code": "<string>",
"distributions": [
{
"amount": 123,
"description": "<string>",
"seller_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>"
}
],
"settlements": [
{
"amount": 123,
"currency_code": "<string>",
"date": "2023-11-07T05:31:56Z",
"settlement_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settlement_report_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
],
"status": "OPEN",
"transactions": [
{
"amount": 123,
"ended_at": "2023-11-07T05:31:56Z",
"failure_reasons": [
{
"classifier": "<string>",
"message": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"processor_name": "<string>",
"processor_transaction_id": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"status": "PENDING",
"transaction_type": "AUTHORIZE"
}
]
}
],
"next_page": 123,
"previous_page": 123
}{
"classifier": "<string>",
"code": 123,
"message": "<string>"
}