Invoice preliminary calculation
curl --request POST \
--url https://api.avanor.tech/gateway/v1/invoice/try \
--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",
"description": "Description of example invoice"
}
'import requests
url = "https://api.avanor.tech/gateway/v1/invoice/try"
payload = {
"shop_id": 202203,
"shop_order_id": "389d4f2c-46b9-4164-bcc4-fbd51e00d445",
"amount": "105.45",
"currency": 840,
"payway": "payway_usd",
"description": "Description of example invoice"
}
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',
description: 'Description of example invoice'
})
};
fetch('https://api.avanor.tech/gateway/v1/invoice/try', 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/try",
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',
'description' => 'Description of example invoice'
]),
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/try"
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 \"description\": \"Description of example invoice\"\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/try")
.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 \"description\": \"Description of example invoice\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.avanor.tech/gateway/v1/invoice/try")
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 \"description\": \"Description of example invoice\"\n}"
response = http.request(request)
puts response.read_body{
"result": true,
"message": "Ok",
"error_code": 0,
"data": {
"add_ons_config": {
"email": {
"comment": {
"en": "Enter your e-mail",
"ru": "Введите Ваш e-mail"
},
"example": "someone@example.com",
"label": {
"en": "E-mail",
"ru": "Электронная почта"
},
"regex": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+.[a-zA-Z0-9-.]+$"
}
},
"payer_price": 146.1,
"paymethod_id": 2,
"paymethod_name": "method_example",
"ps_currency": 840,
"info": {},
"manual": {
"en": "Please enter your email we will use it to send you a billing statement",
"ru": "Пожалуйста укажите свой email, мы вышлем на него квитанцию об оплате"
},
"warning": {}
}
}Invoice issue (payment creation)
Invoice preliminary calculation
Retrieves additional information for invoice creation.
This method is not mandatory for all payment ways. For more information, please contact the technical support service.
It can be used in the following cases:
- You want to find out the total amount subject to all fees paid by the user, before invoice.
- Payment way requires dynamic set of fields depending on the payment parameters.
In this case, you need to use the
add_ons_config,info,manualandwarningto generate customer form.
Fields involved in request signature generation:
amountcurrencypaywayshop_idshop_order_id
POST
/
invoice
/
try
Invoice preliminary calculation
curl --request POST \
--url https://api.avanor.tech/gateway/v1/invoice/try \
--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",
"description": "Description of example invoice"
}
'import requests
url = "https://api.avanor.tech/gateway/v1/invoice/try"
payload = {
"shop_id": 202203,
"shop_order_id": "389d4f2c-46b9-4164-bcc4-fbd51e00d445",
"amount": "105.45",
"currency": 840,
"payway": "payway_usd",
"description": "Description of example invoice"
}
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',
description: 'Description of example invoice'
})
};
fetch('https://api.avanor.tech/gateway/v1/invoice/try', 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/try",
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',
'description' => 'Description of example invoice'
]),
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/try"
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 \"description\": \"Description of example invoice\"\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/try")
.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 \"description\": \"Description of example invoice\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.avanor.tech/gateway/v1/invoice/try")
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 \"description\": \"Description of example invoice\"\n}"
response = http.request(request)
puts response.read_body{
"result": true,
"message": "Ok",
"error_code": 0,
"data": {
"add_ons_config": {
"email": {
"comment": {
"en": "Enter your e-mail",
"ru": "Введите Ваш e-mail"
},
"example": "someone@example.com",
"label": {
"en": "E-mail",
"ru": "Электронная почта"
},
"regex": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+.[a-zA-Z0-9-.]+$"
}
},
"payer_price": 146.1,
"paymethod_id": 2,
"paymethod_name": "method_example",
"ps_currency": 840,
"info": {},
"manual": {
"en": "Please enter your email we will use it to send you a billing statement",
"ru": "Пожалуйста укажите свой email, мы вышлем на него квитанцию об оплате"
},
"warning": {}
}
}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
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"
Optional payment description.
Maximum string length:
255Example:
"Description of example invoice"
Response
200 - application/json
OK
- 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