Funds hold (two-stage payments)
curl --request POST \
--url https://api.avanor.tech/gateway/v1/invoice/hold \
--header 'Content-Type: application/json' \
--header 'sign: <api-key>' \
--data '
{
"shop_id": 202203,
"shop_order_id": "389d4f2c-46b9-4164-bcc4-fbd51e00d445",
"amount": "105.45",
"currency": 840,
"payway": "payway_usd",
"client_ip": "192.168.0.1",
"description": "Description of example invoice",
"failed_url": "https://example.com/status/failed/",
"success_url": "https://example.com/status/success/",
"callback_url": "https://example.com/status/callback/",
"callback_rejected_url": "https://example.com/status/rejected/",
"expires_at": "2026-12-30T00:00:00Z",
"card": {
"number": "4814651800997171",
"cardholder": "ELIZABETH JONES",
"expiry_month": "11",
"expiry_year": "34",
"cvv": "518"
},
"issue_payment_token": true,
"client_info": {
"browser_accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8",
"browser_java_enabled": false,
"browser_javascript_enabled": true,
"browser_language": "en",
"browser_color_depth": "24",
"browser_screen_height": "800",
"browser_screen_width": "480",
"browser_tz": "-120",
"browser_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Safari/605.1.15",
"challenge_window_size": "05"
}
}
'import requests
url = "https://api.avanor.tech/gateway/v1/invoice/hold"
payload = {
"shop_id": 202203,
"shop_order_id": "389d4f2c-46b9-4164-bcc4-fbd51e00d445",
"amount": "105.45",
"currency": 840,
"payway": "payway_usd",
"client_ip": "192.168.0.1",
"description": "Description of example invoice",
"failed_url": "https://example.com/status/failed/",
"success_url": "https://example.com/status/success/",
"callback_url": "https://example.com/status/callback/",
"callback_rejected_url": "https://example.com/status/rejected/",
"expires_at": "2026-12-30T00:00:00Z",
"card": {
"number": "4814651800997171",
"cardholder": "ELIZABETH JONES",
"expiry_month": "11",
"expiry_year": "34",
"cvv": "518"
},
"issue_payment_token": True,
"client_info": {
"browser_accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8",
"browser_java_enabled": False,
"browser_javascript_enabled": True,
"browser_language": "en",
"browser_color_depth": "24",
"browser_screen_height": "800",
"browser_screen_width": "480",
"browser_tz": "-120",
"browser_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Safari/605.1.15",
"challenge_window_size": "05"
}
}
headers = {
"sign": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {sign: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
shop_id: 202203,
shop_order_id: '389d4f2c-46b9-4164-bcc4-fbd51e00d445',
amount: '105.45',
currency: 840,
payway: 'payway_usd',
client_ip: '192.168.0.1',
description: 'Description of example invoice',
failed_url: 'https://example.com/status/failed/',
success_url: 'https://example.com/status/success/',
callback_url: 'https://example.com/status/callback/',
callback_rejected_url: 'https://example.com/status/rejected/',
expires_at: '2026-12-30T00:00:00Z',
card: {
number: '4814651800997171',
cardholder: 'ELIZABETH JONES',
expiry_month: '11',
expiry_year: '34',
cvv: '518'
},
issue_payment_token: true,
client_info: {
browser_accept_header: 'text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8',
browser_java_enabled: false,
browser_javascript_enabled: true,
browser_language: 'en',
browser_color_depth: '24',
browser_screen_height: '800',
browser_screen_width: '480',
browser_tz: '-120',
browser_user_agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Safari/605.1.15',
challenge_window_size: '05'
}
})
};
fetch('https://api.avanor.tech/gateway/v1/invoice/hold', 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.avanor.tech/gateway/v1/invoice/hold",
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([
'shop_id' => 202203,
'shop_order_id' => '389d4f2c-46b9-4164-bcc4-fbd51e00d445',
'amount' => '105.45',
'currency' => 840,
'payway' => 'payway_usd',
'client_ip' => '192.168.0.1',
'description' => 'Description of example invoice',
'failed_url' => 'https://example.com/status/failed/',
'success_url' => 'https://example.com/status/success/',
'callback_url' => 'https://example.com/status/callback/',
'callback_rejected_url' => 'https://example.com/status/rejected/',
'expires_at' => '2026-12-30T00:00:00Z',
'card' => [
'number' => '4814651800997171',
'cardholder' => 'ELIZABETH JONES',
'expiry_month' => '11',
'expiry_year' => '34',
'cvv' => '518'
],
'issue_payment_token' => true,
'client_info' => [
'browser_accept_header' => 'text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8',
'browser_java_enabled' => false,
'browser_javascript_enabled' => true,
'browser_language' => 'en',
'browser_color_depth' => '24',
'browser_screen_height' => '800',
'browser_screen_width' => '480',
'browser_tz' => '-120',
'browser_user_agent' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Safari/605.1.15',
'challenge_window_size' => '05'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"sign: <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://api.avanor.tech/gateway/v1/invoice/hold"
payload := strings.NewReader("{\n \"shop_id\": 202203,\n \"shop_order_id\": \"389d4f2c-46b9-4164-bcc4-fbd51e00d445\",\n \"amount\": \"105.45\",\n \"currency\": 840,\n \"payway\": \"payway_usd\",\n \"client_ip\": \"192.168.0.1\",\n \"description\": \"Description of example invoice\",\n \"failed_url\": \"https://example.com/status/failed/\",\n \"success_url\": \"https://example.com/status/success/\",\n \"callback_url\": \"https://example.com/status/callback/\",\n \"callback_rejected_url\": \"https://example.com/status/rejected/\",\n \"expires_at\": \"2026-12-30T00:00:00Z\",\n \"card\": {\n \"number\": \"4814651800997171\",\n \"cardholder\": \"ELIZABETH JONES\",\n \"expiry_month\": \"11\",\n \"expiry_year\": \"34\",\n \"cvv\": \"518\"\n },\n \"issue_payment_token\": true,\n \"client_info\": {\n \"browser_accept_header\": \"text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8\",\n \"browser_java_enabled\": false,\n \"browser_javascript_enabled\": true,\n \"browser_language\": \"en\",\n \"browser_color_depth\": \"24\",\n \"browser_screen_height\": \"800\",\n \"browser_screen_width\": \"480\",\n \"browser_tz\": \"-120\",\n \"browser_user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Safari/605.1.15\",\n \"challenge_window_size\": \"05\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("sign", "<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://api.avanor.tech/gateway/v1/invoice/hold")
.header("sign", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"shop_id\": 202203,\n \"shop_order_id\": \"389d4f2c-46b9-4164-bcc4-fbd51e00d445\",\n \"amount\": \"105.45\",\n \"currency\": 840,\n \"payway\": \"payway_usd\",\n \"client_ip\": \"192.168.0.1\",\n \"description\": \"Description of example invoice\",\n \"failed_url\": \"https://example.com/status/failed/\",\n \"success_url\": \"https://example.com/status/success/\",\n \"callback_url\": \"https://example.com/status/callback/\",\n \"callback_rejected_url\": \"https://example.com/status/rejected/\",\n \"expires_at\": \"2026-12-30T00:00:00Z\",\n \"card\": {\n \"number\": \"4814651800997171\",\n \"cardholder\": \"ELIZABETH JONES\",\n \"expiry_month\": \"11\",\n \"expiry_year\": \"34\",\n \"cvv\": \"518\"\n },\n \"issue_payment_token\": true,\n \"client_info\": {\n \"browser_accept_header\": \"text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8\",\n \"browser_java_enabled\": false,\n \"browser_javascript_enabled\": true,\n \"browser_language\": \"en\",\n \"browser_color_depth\": \"24\",\n \"browser_screen_height\": \"800\",\n \"browser_screen_width\": \"480\",\n \"browser_tz\": \"-120\",\n \"browser_user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Safari/605.1.15\",\n \"challenge_window_size\": \"05\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.avanor.tech/gateway/v1/invoice/hold")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["sign"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"shop_id\": 202203,\n \"shop_order_id\": \"389d4f2c-46b9-4164-bcc4-fbd51e00d445\",\n \"amount\": \"105.45\",\n \"currency\": 840,\n \"payway\": \"payway_usd\",\n \"client_ip\": \"192.168.0.1\",\n \"description\": \"Description of example invoice\",\n \"failed_url\": \"https://example.com/status/failed/\",\n \"success_url\": \"https://example.com/status/success/\",\n \"callback_url\": \"https://example.com/status/callback/\",\n \"callback_rejected_url\": \"https://example.com/status/rejected/\",\n \"expires_at\": \"2026-12-30T00:00:00Z\",\n \"card\": {\n \"number\": \"4814651800997171\",\n \"cardholder\": \"ELIZABETH JONES\",\n \"expiry_month\": \"11\",\n \"expiry_year\": \"34\",\n \"cvv\": \"518\"\n },\n \"issue_payment_token\": true,\n \"client_info\": {\n \"browser_accept_header\": \"text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8\",\n \"browser_java_enabled\": false,\n \"browser_javascript_enabled\": true,\n \"browser_language\": \"en\",\n \"browser_color_depth\": \"24\",\n \"browser_screen_height\": \"800\",\n \"browser_screen_width\": \"480\",\n \"browser_tz\": \"-120\",\n \"browser_user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Safari/605.1.15\",\n \"challenge_window_size\": \"05\"\n }\n}"
response = http.request(request)
puts response.read_body{
"result": true,
"message": "Ok",
"error_code": 0,
"data": {
"data": {
"MD": "f8a2b5c7e9d14a6b3c0e8f7d6a5b4c3e",
"PaReq": "m9N2vK4xZ7pQW1rE3tY6uI5oO0pA8sD1fG3hJ2kL4lZ6xC7vB9bN1mQ3wE5rT7yU9iI2oO4pA6sD8fF0gG2hH4jJ6kK8lL1zZ3xX5cV7vB9bN2m4Q6w8E0r2T4y6U8i0I2o4O6p8A0s2D4f6F8g0G2h4Hj6J8kK0lL2zZ4xX6cC8vV0bB2nN4mM6qQ8wW0eE2rR4tT6yY8uU0iI2oO4pP6aA8sS0dD2fF4gG6hH8jJ0kK2lL4zZ6xX8cC0vV2bB4nN6mM8qQ0wW2eE4rR6tT8yY0uU2iI4oO6pP8aS0dD2fF4gG6hH8jJ0kK2lL4zZ6xX8cC0vV2bB4nN6mM8wW1eE3rR5tT7yY9uU2iI4oO6pP8aA0sS2dD4fF6gG8hH0jJ2kK4lL6zZ8xX0cC2vV4bB6nN8mM0qQ2wW4eE6rR8tT0yY2uU4iI6oO8pP0aA2sS4dD6fF8gG0hH2jJ4kK6lL",
"TermUrl": "https://card-test.domain.com/v1/invoice/finish3ds/f8a2b5c7e9d14a6b3c0e8f7d6a5b4c3e"
},
"id": 32105,
"method": "POST",
"url": "https://checkout.avanor.tech/form/"
}
}Invoice issue (payment creation)
Funds hold (two-stage payments)
This feature is available only after approval by the manager.
First step of two-step payment.
First step is performed according to the scheme invoice/create.
After successful creation and payment of the invoice, status will be equal to 8 (Invoice funds are on hold in the payment system).
To complete the funds receipt operation, execute invoice/charge or to cancel, execute invoice/unhold.
When funds are held, merchants are required to confirm or cancel the payment within 5 days. Avanor service does not automatically confirm or cancel held payments after this period.
The funds holding period cannot exceed 5 days.
Fields involved in request signature generation:
amountcurrencypaywayshop_idshop_order_id
POST
/
invoice
/
hold
Funds hold (two-stage payments)
curl --request POST \
--url https://api.avanor.tech/gateway/v1/invoice/hold \
--header 'Content-Type: application/json' \
--header 'sign: <api-key>' \
--data '
{
"shop_id": 202203,
"shop_order_id": "389d4f2c-46b9-4164-bcc4-fbd51e00d445",
"amount": "105.45",
"currency": 840,
"payway": "payway_usd",
"client_ip": "192.168.0.1",
"description": "Description of example invoice",
"failed_url": "https://example.com/status/failed/",
"success_url": "https://example.com/status/success/",
"callback_url": "https://example.com/status/callback/",
"callback_rejected_url": "https://example.com/status/rejected/",
"expires_at": "2026-12-30T00:00:00Z",
"card": {
"number": "4814651800997171",
"cardholder": "ELIZABETH JONES",
"expiry_month": "11",
"expiry_year": "34",
"cvv": "518"
},
"issue_payment_token": true,
"client_info": {
"browser_accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8",
"browser_java_enabled": false,
"browser_javascript_enabled": true,
"browser_language": "en",
"browser_color_depth": "24",
"browser_screen_height": "800",
"browser_screen_width": "480",
"browser_tz": "-120",
"browser_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Safari/605.1.15",
"challenge_window_size": "05"
}
}
'import requests
url = "https://api.avanor.tech/gateway/v1/invoice/hold"
payload = {
"shop_id": 202203,
"shop_order_id": "389d4f2c-46b9-4164-bcc4-fbd51e00d445",
"amount": "105.45",
"currency": 840,
"payway": "payway_usd",
"client_ip": "192.168.0.1",
"description": "Description of example invoice",
"failed_url": "https://example.com/status/failed/",
"success_url": "https://example.com/status/success/",
"callback_url": "https://example.com/status/callback/",
"callback_rejected_url": "https://example.com/status/rejected/",
"expires_at": "2026-12-30T00:00:00Z",
"card": {
"number": "4814651800997171",
"cardholder": "ELIZABETH JONES",
"expiry_month": "11",
"expiry_year": "34",
"cvv": "518"
},
"issue_payment_token": True,
"client_info": {
"browser_accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8",
"browser_java_enabled": False,
"browser_javascript_enabled": True,
"browser_language": "en",
"browser_color_depth": "24",
"browser_screen_height": "800",
"browser_screen_width": "480",
"browser_tz": "-120",
"browser_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Safari/605.1.15",
"challenge_window_size": "05"
}
}
headers = {
"sign": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {sign: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
shop_id: 202203,
shop_order_id: '389d4f2c-46b9-4164-bcc4-fbd51e00d445',
amount: '105.45',
currency: 840,
payway: 'payway_usd',
client_ip: '192.168.0.1',
description: 'Description of example invoice',
failed_url: 'https://example.com/status/failed/',
success_url: 'https://example.com/status/success/',
callback_url: 'https://example.com/status/callback/',
callback_rejected_url: 'https://example.com/status/rejected/',
expires_at: '2026-12-30T00:00:00Z',
card: {
number: '4814651800997171',
cardholder: 'ELIZABETH JONES',
expiry_month: '11',
expiry_year: '34',
cvv: '518'
},
issue_payment_token: true,
client_info: {
browser_accept_header: 'text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8',
browser_java_enabled: false,
browser_javascript_enabled: true,
browser_language: 'en',
browser_color_depth: '24',
browser_screen_height: '800',
browser_screen_width: '480',
browser_tz: '-120',
browser_user_agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Safari/605.1.15',
challenge_window_size: '05'
}
})
};
fetch('https://api.avanor.tech/gateway/v1/invoice/hold', 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.avanor.tech/gateway/v1/invoice/hold",
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([
'shop_id' => 202203,
'shop_order_id' => '389d4f2c-46b9-4164-bcc4-fbd51e00d445',
'amount' => '105.45',
'currency' => 840,
'payway' => 'payway_usd',
'client_ip' => '192.168.0.1',
'description' => 'Description of example invoice',
'failed_url' => 'https://example.com/status/failed/',
'success_url' => 'https://example.com/status/success/',
'callback_url' => 'https://example.com/status/callback/',
'callback_rejected_url' => 'https://example.com/status/rejected/',
'expires_at' => '2026-12-30T00:00:00Z',
'card' => [
'number' => '4814651800997171',
'cardholder' => 'ELIZABETH JONES',
'expiry_month' => '11',
'expiry_year' => '34',
'cvv' => '518'
],
'issue_payment_token' => true,
'client_info' => [
'browser_accept_header' => 'text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8',
'browser_java_enabled' => false,
'browser_javascript_enabled' => true,
'browser_language' => 'en',
'browser_color_depth' => '24',
'browser_screen_height' => '800',
'browser_screen_width' => '480',
'browser_tz' => '-120',
'browser_user_agent' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Safari/605.1.15',
'challenge_window_size' => '05'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"sign: <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://api.avanor.tech/gateway/v1/invoice/hold"
payload := strings.NewReader("{\n \"shop_id\": 202203,\n \"shop_order_id\": \"389d4f2c-46b9-4164-bcc4-fbd51e00d445\",\n \"amount\": \"105.45\",\n \"currency\": 840,\n \"payway\": \"payway_usd\",\n \"client_ip\": \"192.168.0.1\",\n \"description\": \"Description of example invoice\",\n \"failed_url\": \"https://example.com/status/failed/\",\n \"success_url\": \"https://example.com/status/success/\",\n \"callback_url\": \"https://example.com/status/callback/\",\n \"callback_rejected_url\": \"https://example.com/status/rejected/\",\n \"expires_at\": \"2026-12-30T00:00:00Z\",\n \"card\": {\n \"number\": \"4814651800997171\",\n \"cardholder\": \"ELIZABETH JONES\",\n \"expiry_month\": \"11\",\n \"expiry_year\": \"34\",\n \"cvv\": \"518\"\n },\n \"issue_payment_token\": true,\n \"client_info\": {\n \"browser_accept_header\": \"text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8\",\n \"browser_java_enabled\": false,\n \"browser_javascript_enabled\": true,\n \"browser_language\": \"en\",\n \"browser_color_depth\": \"24\",\n \"browser_screen_height\": \"800\",\n \"browser_screen_width\": \"480\",\n \"browser_tz\": \"-120\",\n \"browser_user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Safari/605.1.15\",\n \"challenge_window_size\": \"05\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("sign", "<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://api.avanor.tech/gateway/v1/invoice/hold")
.header("sign", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"shop_id\": 202203,\n \"shop_order_id\": \"389d4f2c-46b9-4164-bcc4-fbd51e00d445\",\n \"amount\": \"105.45\",\n \"currency\": 840,\n \"payway\": \"payway_usd\",\n \"client_ip\": \"192.168.0.1\",\n \"description\": \"Description of example invoice\",\n \"failed_url\": \"https://example.com/status/failed/\",\n \"success_url\": \"https://example.com/status/success/\",\n \"callback_url\": \"https://example.com/status/callback/\",\n \"callback_rejected_url\": \"https://example.com/status/rejected/\",\n \"expires_at\": \"2026-12-30T00:00:00Z\",\n \"card\": {\n \"number\": \"4814651800997171\",\n \"cardholder\": \"ELIZABETH JONES\",\n \"expiry_month\": \"11\",\n \"expiry_year\": \"34\",\n \"cvv\": \"518\"\n },\n \"issue_payment_token\": true,\n \"client_info\": {\n \"browser_accept_header\": \"text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8\",\n \"browser_java_enabled\": false,\n \"browser_javascript_enabled\": true,\n \"browser_language\": \"en\",\n \"browser_color_depth\": \"24\",\n \"browser_screen_height\": \"800\",\n \"browser_screen_width\": \"480\",\n \"browser_tz\": \"-120\",\n \"browser_user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Safari/605.1.15\",\n \"challenge_window_size\": \"05\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.avanor.tech/gateway/v1/invoice/hold")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["sign"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"shop_id\": 202203,\n \"shop_order_id\": \"389d4f2c-46b9-4164-bcc4-fbd51e00d445\",\n \"amount\": \"105.45\",\n \"currency\": 840,\n \"payway\": \"payway_usd\",\n \"client_ip\": \"192.168.0.1\",\n \"description\": \"Description of example invoice\",\n \"failed_url\": \"https://example.com/status/failed/\",\n \"success_url\": \"https://example.com/status/success/\",\n \"callback_url\": \"https://example.com/status/callback/\",\n \"callback_rejected_url\": \"https://example.com/status/rejected/\",\n \"expires_at\": \"2026-12-30T00:00:00Z\",\n \"card\": {\n \"number\": \"4814651800997171\",\n \"cardholder\": \"ELIZABETH JONES\",\n \"expiry_month\": \"11\",\n \"expiry_year\": \"34\",\n \"cvv\": \"518\"\n },\n \"issue_payment_token\": true,\n \"client_info\": {\n \"browser_accept_header\": \"text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8\",\n \"browser_java_enabled\": false,\n \"browser_javascript_enabled\": true,\n \"browser_language\": \"en\",\n \"browser_color_depth\": \"24\",\n \"browser_screen_height\": \"800\",\n \"browser_screen_width\": \"480\",\n \"browser_tz\": \"-120\",\n \"browser_user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.3 Safari/605.1.15\",\n \"challenge_window_size\": \"05\"\n }\n}"
response = http.request(request)
puts response.read_body{
"result": true,
"message": "Ok",
"error_code": 0,
"data": {
"data": {
"MD": "f8a2b5c7e9d14a6b3c0e8f7d6a5b4c3e",
"PaReq": "m9N2vK4xZ7pQW1rE3tY6uI5oO0pA8sD1fG3hJ2kL4lZ6xC7vB9bN1mQ3wE5rT7yU9iI2oO4pA6sD8fF0gG2hH4jJ6kK8lL1zZ3xX5cV7vB9bN2m4Q6w8E0r2T4y6U8i0I2o4O6p8A0s2D4f6F8g0G2h4Hj6J8kK0lL2zZ4xX6cC8vV0bB2nN4mM6qQ8wW0eE2rR4tT6yY8uU0iI2oO4pP6aA8sS0dD2fF4gG6hH8jJ0kK2lL4zZ6xX8cC0vV2bB4nN6mM8qQ0wW2eE4rR6tT8yY0uU2iI4oO6pP8aS0dD2fF4gG6hH8jJ0kK2lL4zZ6xX8cC0vV2bB4nN6mM8wW1eE3rR5tT7yY9uU2iI4oO6pP8aA0sS2dD4fF6gG8hH0jJ2kK4lL6zZ8xX0cC2vV4bB6nN8mM0qQ2wW4eE6rR8tT0yY2uU4iI6oO8pP0aA2sS4dD6fF8gG0hH2jJ4kK6lL",
"TermUrl": "https://card-test.domain.com/v1/invoice/finish3ds/f8a2b5c7e9d14a6b3c0e8f7d6a5b4c3e"
},
"id": 32105,
"method": "POST",
"url": "https://checkout.avanor.tech/form/"
}
}Authorizations
Every API request must be signed so that we can identify your account.
The signature is transferred in the request body through the sign parameter, for example:
{
"shop_id": 202203,
"shop_order_id": "1994",
"amount": "104.04",
"currency": 840,
"payway": "payway_usd",
"description": "Invoice sign",
"sign": "05f6d3712417f62af6cbf66ca81c2f0b249f7dc1b4cbe3a50e3f8d67a1fb35a2"
}
All further request examples do not include the
"sign" parameter, nevertheless your real requests must include it in the request body where required.
Signature line is generated according to the following algorithm: all request parameters involved in signature generation are ordered in the alphabetical order of keys, the values are concatenated with a colon (":") and the account secret key is added at the end (without the: sign), a sha256 hash is generated from the resulting line and its hex representation is passed in the sign request parameter.
Example of signature generation for a method invoice/create:
- Determining the list of parameters. It looks as follows for the method in consideration:
Fields involved in request signature generation:
shop_idshop_order_idamountcurrencypayway
- Let's sort keys in alphabetical sequence:
"amount", "currency", "payway", "shop_id", "shop_order_id"
- The line for generating the SHA256 hash will be as follows:
"104.04:840:payway_usd:202203:1994account-secret-key"
Where account-secret-key is the secret identification key for your account. You can request a key from the support service.
- Let's get a hash expression of the generated line using Python code:
>>> string_to_sign = '104.04:840:payway_usd:202203:1994account-secret-key'
>>> import hashlib
>>> sign = hashlib.sha256(string_to_sign.encode()).hexdigest()
>>> print(sign)
'05f6d3712417f62af6cbf66ca81c2f0b249f7dc1b4cbe3a50e3f8d67a1fb35a2'
You can check whether you have generated the signature correctly using the service https://www.xorbin.com/tools/sha256-hash-calculator.
Body
application/json
- Bank card payment
- Invoice issue by payment token
- Faster payment system
Unique shop identifier in the Avanor system.
Example:
202203
Order ID in your system. Must be unique for each new invoice.
Maximum string length:
255Example:
"389d4f2c-46b9-4164-bcc4-fbd51e00d445"
Amount received or withdrawn.
Example: "105.45"
Example:
"105.45"
Payment way for payment. Invoice currency depends on the specified payment way.
There are two ways to get a list of all payment directions available to the shop:
- Execute API request "Receiving payment methods for input" shop_input_config/shop.
- Request register from the support service.
Maximum string length:
150Pattern:
^[A-Za-z_,\[\]]+$Example:
"payway_usd"
Payer IP address
Example:
"192.168.0.1"
Optional payment description.
Maximum string length:
255Example:
"Description of example invoice"
URL where the payer will be redirected after unsuccessful invoice payment.
Example:
"https://example.com/status/failed/"
URL where the payer will be redirected after successful invoice payment.
Example:
"https://example.com/status/success/"
URL where the notification about successful payment will be sent.
Example:
"https://example.com/status/callback/"
URL where the notification about unsuccessful payment will be sent.
Example:
"https://example.com/status/rejected/"
Bank card details should be sent when:
- You have a PCI DSS certificate
- You do not need a page on the Avanor side to get card details from the buyer
In case the payment way to the cards is used and the card data is not transmitted, the response to the request will contain a link to redirect the buyer to enter the card details.
Also, method, url and data will be filled in if the user needs to be redirected to pass the 3DSecure check.
Show child attributes
Show child attributes
Example:
{
"number": "4814651800997171",
"cardholder": "ELIZABETH JONES",
"expiry_month": "11",
"expiry_year": "34",
"cvv": "518"
}
This parameter is used to generate a payment token. More details invoice/recurrent
Example:
true
Payer browser information.
See Payer Browser Authentication for 3D Secure for the details of the data gathering.
Show child attributes
Show child attributes
Response
200 - application/json
- Successful response
- Error response
Boolean value, in case of successful response it will be true, in case of error – false
Example:
true
A textual description of the error, in case of success - simply Ok
Example:
"Ok"
If this value is greater than 0, then the request ended with an error. Description of error codes
Example:
0
Show child attributes
Show child attributes