Payout creation
curl --request POST \
--url https://api.avanor.tech/gateway/v1/withdraw/create \
--header 'Content-Type: application/json' \
--header 'sign: <api-key>' \
--data @- <<EOF
{
"shop_id": 202203,
"shop_currency": 840,
"payway": "example_payway_usd",
"amount": "105.45",
"account": "104008771",
"amount_type": "ps_amount",
"shop_payment_id": "4440D705-947A-4C6E-9A2E-4A383B2CD574",
"account_details": {
"name": "Ivan"
},
"description": "It's payout for my friend"
}
EOFimport requests
url = "https://api.avanor.tech/gateway/v1/withdraw/create"
payload = {
"shop_id": 202203,
"shop_currency": 840,
"payway": "example_payway_usd",
"amount": "105.45",
"account": "104008771",
"amount_type": "ps_amount",
"shop_payment_id": "4440D705-947A-4C6E-9A2E-4A383B2CD574",
"account_details": { "name": "Ivan" },
"description": "It's payout for my friend"
}
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_currency: 840,
payway: 'example_payway_usd',
amount: '105.45',
account: '104008771',
amount_type: 'ps_amount',
shop_payment_id: '4440D705-947A-4C6E-9A2E-4A383B2CD574',
account_details: {name: 'Ivan'},
description: 'It\'s payout for my friend'
})
};
fetch('https://api.avanor.tech/gateway/v1/withdraw/create', 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/withdraw/create",
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_currency' => 840,
'payway' => 'example_payway_usd',
'amount' => '105.45',
'account' => '104008771',
'amount_type' => 'ps_amount',
'shop_payment_id' => '4440D705-947A-4C6E-9A2E-4A383B2CD574',
'account_details' => [
'name' => 'Ivan'
],
'description' => 'It\'s payout for my friend'
]),
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/withdraw/create"
payload := strings.NewReader("{\n \"shop_id\": 202203,\n \"shop_currency\": 840,\n \"payway\": \"example_payway_usd\",\n \"amount\": \"105.45\",\n \"account\": \"104008771\",\n \"amount_type\": \"ps_amount\",\n \"shop_payment_id\": \"4440D705-947A-4C6E-9A2E-4A383B2CD574\",\n \"account_details\": {\n \"name\": \"Ivan\"\n },\n \"description\": \"It's payout for my friend\"\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/withdraw/create")
.header("sign", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"shop_id\": 202203,\n \"shop_currency\": 840,\n \"payway\": \"example_payway_usd\",\n \"amount\": \"105.45\",\n \"account\": \"104008771\",\n \"amount_type\": \"ps_amount\",\n \"shop_payment_id\": \"4440D705-947A-4C6E-9A2E-4A383B2CD574\",\n \"account_details\": {\n \"name\": \"Ivan\"\n },\n \"description\": \"It's payout for my friend\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.avanor.tech/gateway/v1/withdraw/create")
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_currency\": 840,\n \"payway\": \"example_payway_usd\",\n \"amount\": \"105.45\",\n \"account\": \"104008771\",\n \"amount_type\": \"ps_amount\",\n \"shop_payment_id\": \"4440D705-947A-4C6E-9A2E-4A383B2CD574\",\n \"account_details\": {\n \"name\": \"Ivan\"\n },\n \"description\": \"It's payout for my friend\"\n}"
response = http.request(request)
puts response.read_body{
"result": true,
"message": "Ok",
"error_code": 0,
"data": {
"id": 123,
"balance": 123,
"payee_receive": 123,
"ps_currency": 840,
"shop_currency": 840,
"shop_payment_id": "<string>",
"shop_write_off": 123,
"status": 2,
"redirect_info": {
"data": {
"key1": "value1",
"key2": "value2"
},
"method": "POST",
"url": "https://checkout.domain.com/form/"
}
}
}Payout creation
Payout creation
Additional parameters can be transferred in the request, for example:
description– payout description,account_details– additional information on the account for payout.
The list of these parameters depends on the payway (payway). The required additional parameters for the payway can be found in the request “Receive possible payout methods for payments” shop_output_config/shop in the account_info_config response field.
Fields involved in request signature generation:
accountamountamount_typepaywayshop_currencyshop_idshop_payment_id
POST
/
withdraw
/
create
Payout creation
curl --request POST \
--url https://api.avanor.tech/gateway/v1/withdraw/create \
--header 'Content-Type: application/json' \
--header 'sign: <api-key>' \
--data @- <<EOF
{
"shop_id": 202203,
"shop_currency": 840,
"payway": "example_payway_usd",
"amount": "105.45",
"account": "104008771",
"amount_type": "ps_amount",
"shop_payment_id": "4440D705-947A-4C6E-9A2E-4A383B2CD574",
"account_details": {
"name": "Ivan"
},
"description": "It's payout for my friend"
}
EOFimport requests
url = "https://api.avanor.tech/gateway/v1/withdraw/create"
payload = {
"shop_id": 202203,
"shop_currency": 840,
"payway": "example_payway_usd",
"amount": "105.45",
"account": "104008771",
"amount_type": "ps_amount",
"shop_payment_id": "4440D705-947A-4C6E-9A2E-4A383B2CD574",
"account_details": { "name": "Ivan" },
"description": "It's payout for my friend"
}
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_currency: 840,
payway: 'example_payway_usd',
amount: '105.45',
account: '104008771',
amount_type: 'ps_amount',
shop_payment_id: '4440D705-947A-4C6E-9A2E-4A383B2CD574',
account_details: {name: 'Ivan'},
description: 'It\'s payout for my friend'
})
};
fetch('https://api.avanor.tech/gateway/v1/withdraw/create', 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/withdraw/create",
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_currency' => 840,
'payway' => 'example_payway_usd',
'amount' => '105.45',
'account' => '104008771',
'amount_type' => 'ps_amount',
'shop_payment_id' => '4440D705-947A-4C6E-9A2E-4A383B2CD574',
'account_details' => [
'name' => 'Ivan'
],
'description' => 'It\'s payout for my friend'
]),
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/withdraw/create"
payload := strings.NewReader("{\n \"shop_id\": 202203,\n \"shop_currency\": 840,\n \"payway\": \"example_payway_usd\",\n \"amount\": \"105.45\",\n \"account\": \"104008771\",\n \"amount_type\": \"ps_amount\",\n \"shop_payment_id\": \"4440D705-947A-4C6E-9A2E-4A383B2CD574\",\n \"account_details\": {\n \"name\": \"Ivan\"\n },\n \"description\": \"It's payout for my friend\"\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/withdraw/create")
.header("sign", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"shop_id\": 202203,\n \"shop_currency\": 840,\n \"payway\": \"example_payway_usd\",\n \"amount\": \"105.45\",\n \"account\": \"104008771\",\n \"amount_type\": \"ps_amount\",\n \"shop_payment_id\": \"4440D705-947A-4C6E-9A2E-4A383B2CD574\",\n \"account_details\": {\n \"name\": \"Ivan\"\n },\n \"description\": \"It's payout for my friend\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.avanor.tech/gateway/v1/withdraw/create")
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_currency\": 840,\n \"payway\": \"example_payway_usd\",\n \"amount\": \"105.45\",\n \"account\": \"104008771\",\n \"amount_type\": \"ps_amount\",\n \"shop_payment_id\": \"4440D705-947A-4C6E-9A2E-4A383B2CD574\",\n \"account_details\": {\n \"name\": \"Ivan\"\n },\n \"description\": \"It's payout for my friend\"\n}"
response = http.request(request)
puts response.read_body{
"result": true,
"message": "Ok",
"error_code": 0,
"data": {
"id": 123,
"balance": 123,
"payee_receive": 123,
"ps_currency": 840,
"shop_currency": 840,
"shop_payment_id": "<string>",
"shop_write_off": 123,
"status": 2,
"redirect_info": {
"data": {
"key1": "value1",
"key2": "value2"
},
"method": "POST",
"url": "https://checkout.domain.com/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
Unique shop identifier in the Avanor system.
Example:
202203
Payment direction for payout. Currency of receipt depends on the specified payment way.
There are two ways to get a list of all payment ways available to the shop:
- Execute the API request "Receiving payment methods for payouts" shop_output_config/shop.
- Request a register from the support service.
Maximum string length:
150Pattern:
^[A-Za-z_,\[\]]+$Example:
"example_payway_usd"
Amount received or withdrawn.
Example: "105.45"
Example:
"105.45"
Account of the recipient of funds in the payment system or service. For example, phone, card number or steam login.
Example:
"104008771"
Indicates the amount type, possible values:
ps_amount – the exact amount indicated in the amount will be sent to a beneficiary card or wallet. Credit currency will correspond to the currency of the payway,
shop_amount – the exact amount indicated in the amount will be written off from the shop balance, beneficiary will receive this amount minus transaction fees. Debit currency will correspond to the currency of the shop_currency.
Available options:
ps_amount, shop_amount Example:
"ps_amount"
Order ID in your system. Must be unique for each new payment.
Example:
"4440D705-947A-4C6E-9A2E-4A383B2CD574"
Detailed account information. If additional parameters were transferred in the /withdraw/try response in the account_info_config field, they must be transferred in the account_details field.
Example:
{ "name": "Ivan" }
Description of the payout. Transferred in the payway provided that the payment system has this function.
Maximum string length:
255Example:
"It's payout for my friend"
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