Verify a payment
curl --request POST \
--url https://{instance}.{env}.on-hellgate.cloud/payments-verification \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"amount": 1,
"continuation": {
"error": "<string>",
"success": "<string>"
},
"currency_code": "<string>",
"order_id": "<string>",
"additional_information": {},
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"distributions": [
{
"amount": 2,
"seller_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>"
}
],
"metadata": {},
"vault_payment_method": true
}
'import requests
url = "https://{instance}.{env}.on-hellgate.cloud/payments-verification"
payload = {
"amount": 1,
"continuation": {
"error": "<string>",
"success": "<string>"
},
"currency_code": "<string>",
"order_id": "<string>",
"additional_information": {},
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"distributions": [
{
"amount": 2,
"seller_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>"
}
],
"metadata": {},
"vault_payment_method": True
}
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: 1,
continuation: {error: '<string>', success: '<string>'},
currency_code: '<string>',
order_id: '<string>',
additional_information: {},
customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
distributions: [
{
amount: 2,
seller_account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
description: '<string>'
}
],
metadata: {},
vault_payment_method: true
})
};
fetch('https://{instance}.{env}.on-hellgate.cloud/payments-verification', 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-verification",
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' => 1,
'continuation' => [
'error' => '<string>',
'success' => '<string>'
],
'currency_code' => '<string>',
'order_id' => '<string>',
'additional_information' => [
],
'customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'distributions' => [
[
'amount' => 2,
'seller_account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'description' => '<string>'
]
],
'metadata' => [
],
'vault_payment_method' => true
]),
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://{instance}.{env}.on-hellgate.cloud/payments-verification"
payload := strings.NewReader("{\n \"amount\": 1,\n \"continuation\": {\n \"error\": \"<string>\",\n \"success\": \"<string>\"\n },\n \"currency_code\": \"<string>\",\n \"order_id\": \"<string>\",\n \"additional_information\": {},\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"distributions\": [\n {\n \"amount\": 2,\n \"seller_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\"\n }\n ],\n \"metadata\": {},\n \"vault_payment_method\": true\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://{instance}.{env}.on-hellgate.cloud/payments-verification")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 1,\n \"continuation\": {\n \"error\": \"<string>\",\n \"success\": \"<string>\"\n },\n \"currency_code\": \"<string>\",\n \"order_id\": \"<string>\",\n \"additional_information\": {},\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"distributions\": [\n {\n \"amount\": 2,\n \"seller_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\"\n }\n ],\n \"metadata\": {},\n \"vault_payment_method\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.{env}.on-hellgate.cloud/payments-verification")
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\": 1,\n \"continuation\": {\n \"error\": \"<string>\",\n \"success\": \"<string>\"\n },\n \"currency_code\": \"<string>\",\n \"order_id\": \"<string>\",\n \"additional_information\": {},\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"distributions\": [\n {\n \"amount\": 2,\n \"seller_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\"\n }\n ],\n \"metadata\": {},\n \"vault_payment_method\": true\n}"
response = http.request(request)
puts response.read_body{
"amount": 1,
"continuation": {
"error": "<string>",
"success": "<string>"
},
"currency_code": "<string>",
"order_id": "<string>",
"additional_information": {},
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"distributions": [
{
"amount": 2,
"seller_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>"
}
],
"metadata": {},
"payment_method": {
"first_payment_reference": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"token": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"vault_payment_method": true
}{
"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
Body
- PaymentIntentParams
- PaymentIntentParams
x >= 0Show child attributes
Show child attributes
Show child attributes
Show child attributes
Key-value pairs. Max 20 entries. Keys max 20 characters, values must be strings max 80 characters. No nested objects.
Show child attributes
Show child attributes
Token is required for all types except BANK_TRANSFER. For BANK_TRANSFER, token must not be provided.
Show child attributes
Show child attributes
When true, customer_id is required.
Response
Success
- PaymentIntentParams
- PaymentIntentParams
x >= 0Show child attributes
Show child attributes
Show child attributes
Show child attributes
Key-value pairs. Max 20 entries. Keys max 20 characters, values must be strings max 80 characters. No nested objects.
Show child attributes
Show child attributes
Token is required for all types except BANK_TRANSFER. For BANK_TRANSFER, token must not be provided.
Show child attributes
Show child attributes
When true, customer_id is required.
curl --request POST \
--url https://{instance}.{env}.on-hellgate.cloud/payments-verification \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"amount": 1,
"continuation": {
"error": "<string>",
"success": "<string>"
},
"currency_code": "<string>",
"order_id": "<string>",
"additional_information": {},
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"distributions": [
{
"amount": 2,
"seller_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>"
}
],
"metadata": {},
"vault_payment_method": true
}
'import requests
url = "https://{instance}.{env}.on-hellgate.cloud/payments-verification"
payload = {
"amount": 1,
"continuation": {
"error": "<string>",
"success": "<string>"
},
"currency_code": "<string>",
"order_id": "<string>",
"additional_information": {},
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"distributions": [
{
"amount": 2,
"seller_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>"
}
],
"metadata": {},
"vault_payment_method": True
}
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: 1,
continuation: {error: '<string>', success: '<string>'},
currency_code: '<string>',
order_id: '<string>',
additional_information: {},
customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
distributions: [
{
amount: 2,
seller_account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
description: '<string>'
}
],
metadata: {},
vault_payment_method: true
})
};
fetch('https://{instance}.{env}.on-hellgate.cloud/payments-verification', 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-verification",
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' => 1,
'continuation' => [
'error' => '<string>',
'success' => '<string>'
],
'currency_code' => '<string>',
'order_id' => '<string>',
'additional_information' => [
],
'customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'distributions' => [
[
'amount' => 2,
'seller_account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'description' => '<string>'
]
],
'metadata' => [
],
'vault_payment_method' => true
]),
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://{instance}.{env}.on-hellgate.cloud/payments-verification"
payload := strings.NewReader("{\n \"amount\": 1,\n \"continuation\": {\n \"error\": \"<string>\",\n \"success\": \"<string>\"\n },\n \"currency_code\": \"<string>\",\n \"order_id\": \"<string>\",\n \"additional_information\": {},\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"distributions\": [\n {\n \"amount\": 2,\n \"seller_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\"\n }\n ],\n \"metadata\": {},\n \"vault_payment_method\": true\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://{instance}.{env}.on-hellgate.cloud/payments-verification")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 1,\n \"continuation\": {\n \"error\": \"<string>\",\n \"success\": \"<string>\"\n },\n \"currency_code\": \"<string>\",\n \"order_id\": \"<string>\",\n \"additional_information\": {},\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"distributions\": [\n {\n \"amount\": 2,\n \"seller_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\"\n }\n ],\n \"metadata\": {},\n \"vault_payment_method\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.{env}.on-hellgate.cloud/payments-verification")
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\": 1,\n \"continuation\": {\n \"error\": \"<string>\",\n \"success\": \"<string>\"\n },\n \"currency_code\": \"<string>\",\n \"order_id\": \"<string>\",\n \"additional_information\": {},\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"distributions\": [\n {\n \"amount\": 2,\n \"seller_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\"\n }\n ],\n \"metadata\": {},\n \"vault_payment_method\": true\n}"
response = http.request(request)
puts response.read_body{
"amount": 1,
"continuation": {
"error": "<string>",
"success": "<string>"
},
"currency_code": "<string>",
"order_id": "<string>",
"additional_information": {},
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"distributions": [
{
"amount": 2,
"seller_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>"
}
],
"metadata": {},
"payment_method": {
"first_payment_reference": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"token": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"vault_payment_method": true
}{
"classifier": "<string>",
"code": 123,
"message": "<string>"
}