?????
??? ?????? ???? ????? ?????? ?????? ?? ????? ??? ?????? ?? ???? API ???? ?? ?? ????? ?????.
API ???? ?? ?? ??? REST ????????? ??? ???. ?????? ???? ??????? ?? ? ???? ?? ?? ???? JSON ???????.
??? ????????? ????? ???? ?? ?? ???? ??? ?? ???? ?????? ???? ? ?????? ????? ????????? ?? ???? ?? ??? ????? ????? ????? ????? ???? ??? ?????? ????? ????? ?? ?????? ????.
????? ????
???? ??????? ?? API ??? ???? ?? ???? ?? ?? API KEY ???. ??? ????????? ?? ??????? ??? ?? ???? ?? ???? ? ?? ??? ?? ????????? ??? ?? ?? ????? ???? ????? ????.
??? ?? ????? ?? ?????? API KEY ??? ?? ?????? ??????? ? ????????? ???? ???????? API ?? ?? ??????? ????.
???? ????? ???? ??????? ?? ???? API KEY ?? ????? ???? ??? ?? header ????? ??????:
X-API-KEY: 6a7f99eb-7c20-4412-a972-6dfb7cd253a4
??????? | ??? | ????? | ??????? |
---|---|---|---|
X-API-KEY | string | ??? | ???? ????? ???? ??? ????? ???? ?? ??? 36 ??????? |
?????????
???? ??? API ? ???? ?????? ?? ????????? ?? header ??????? ??? ??? ???? X-SANDBOX
?? ????? ????.
?? ??????? ????? ??? ??????? true
?? 1
????? ???? ????????? ???? ????? ??????? ????? ? ???? ???? ???????.
?????? ?? ??? ???? ?????? ?? ???? ?? ???? ? IP ?? ??????? ??? ????? ??? ????? ???????? ? ??????? ??????? ??? ?? ?? ?? ?? ???? Callback ?? IP? ????? ????.
????? ??? ??? ??? ??????? false
?? 0
???.
X-SANDBOX: 1
??????? | ??? | ????? |
---|---|---|
X-SANDBOX | boolean | ??? |
????? ??????
?? ??????? ?? ???? ??? ????????? ?? ?????? ???? ????? ????.
curl -X POST https://api.idpay.ir/v1.1/payment \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: 6a7f99eb-7c20-4412-a972-6dfb7cd253a4' \
-H 'X-SANDBOX: 1' \
-d '{
"order_id": 101,
"amount": 10000,
"name": "???? ??????",
"phone": "09382198592",
"mail": "my@site.com",
"desc": "??????? ?????? ?????",
"callback": "https://example.com/callback"
}'
<?php
$params = array(
'order_id' => '101',
'amount' => 10000,
'name' => '???? ??????',
'phone' => '09382198592',
'mail' => 'my@site.com',
'desc' => '??????? ?????? ?????',
'callback' => 'https://example.com/callback',
);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.idpay.ir/v1.1/payment');
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'X-API-KEY: 6a7f99eb-7c20-4412-a972-6dfb7cd253a4',
'X-SANDBOX: 1'
));
$result = curl_exec($ch);
curl_close($ch);
var_dump($result);
var request = require('request');
var options = {
method: 'POST',
url: 'https://api.idpay.ir/v1.1/payment',
headers: {
'Content-Type': 'application/json',
'X-API-KEY': '6a7f99eb-7c20-4412-a972-6dfb7cd253a4',
'X-SANDBOX': 1,
},
body: {
'order_id': '101',
'amount': 10000,
'name': '???? ??????',
'phone': '09382198592',
'mail': 'my@site.com',
'desc': '??????? ?????? ?????',
'callback': 'https://example.com/callback',
},
json: true,
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
url := "https://api.idpay.ir/v1.1/payment"
data := map[string]string{
"order_id": "101",
"amount": "10000",
"name": "???? ??????",
"phone": "09382198592",
"mail": "my@site.com",
"desc": "??????? ?????? ?????",
"callback": "https://example.com/callback",
}
payload, _ := json.Marshal(data)
req, _ := http.NewRequest("POST", url, bytes.NewBuffer(payload))
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-API-KEY", "6a7f99eb-7c20-4412-a972-6dfb7cd253a4")
req.Header.Set("X-SANDBOX", 1)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(string(body))
???? ???????
POST https://api.idpay.ir/v1.1/payment
?????????? ???? ????
??????? | ??? | ????? | ??????? |
---|---|---|---|
order_id | string | ??? | ????? ????? ??????? ?? ??? ?????? 50 ??????? |
amount | number | ??? | ???? ???? ??? ?? ???? ???? ???? ??? 1,000 ???? ?? 500,000,000 ???? ???? |
name | string | ??? | ??? ?????? ????? ?? ??? ?????? 255 ??????? |
phone | string | ??? | ???? ????? ?????? ????? ?? ??? 11 ??????? ??? 9382198592 ?? 09382198592 ?? 989382198592 |
string | ??? | ??? ????????? ?????? ????? ?? ??? ?????? 255 ??????? |
|
desc | string | ??? | ????? ?????? ?? ??? ?????? 255 ??????? |
callback | string | ??? | ???? ?????? ?? ???? ??????? ?? ??? ?????? 2048 ??????? |
????? ????
?? ????? | ??????? |
---|---|
201 | ?????? ?? ?????? ????? ?? |
403 | ???? ????? |
405 | ???? ????? |
406 | ???? ????? |
????? 200: ?? ????? ????? ???? ????? ????? ??? ??? ?? ???? JSON ?????? ??????:
{
"id": "d2e353189823079e1e4181772cff5292",
"link": "https://idpay.ir/p/ws-sandbox/d2e353189823079e1e4181772cff5292"
}
????? 406: ?? ???? ???? ???? ????? ????? ??? ??? ?? ???? JSON ?????? ??????:
{
"error_code": 32,
"error_message": "????? ????? `order_id` ????? ???? ????."
}
????
????????? ??????? ???? ????? ????? ???? 201 Created
????? ????? ??.
?? ????? ?????? id
? link
??? ?????? ?? ???? ??? ???? ?? ?? ??????? ??? ????? ????.
??? ?? ????? ??????? ???????? ?????? ????? ???? ?? ???? ?????? ??? ????? ???.
??????? | ??? | ??????? |
---|---|---|
id | string | ???? ????? ???? ?????? |
link | string | ???? ?????? ???? ?????? ?????? ?? ????? ?????? |
?????? ?? ???? ???????
??? ?? ????? ?????? ??????? ????????? ?????? ?? ?????? ????? ??? ????? ?????? ????? ?? ????? ?? ??????? ?? callback
???? ???? ??? ????? ??????.
?????? ?????????? ??? ?? ???? callback
????? ??? ?? ????? ????? ?????? ?? ???? ?? ??????? ?? ????? ?? ??????? ???? ?? ??? ????? ??? ?????? ?? ?? ??????
?? ?? ??? POST (Post form)
?? GET (Query String)
????? ?? ????.
?????????? ?????? ?? ??? POST
??????? | ??? | ??????? |
---|---|---|
status | number | ????? ?????? |
track_id | number | ?? ?????? ???? ?? |
id | string | ???? ????? ???? ?????? ?? ?? ????? ????? ?????? ?????? ??? ??? |
order_id | string | ????? ????? ??????? ?? ?? ????? ????? ?????? ????? ??? ??? |
amount | number | ???? ??? ??? ????? ????? ?????? |
card_no | string | ????? ???? ?????? ????? ?? ???? 123456******1234 |
hashed_card_no | string | ?? ????? ???? ?????? ????? ?? ???????? SHA256 |
date | timestamp | ???? ?????? ?????? |
?????????? ?????? ?? ??? GET
??????? | ??? | ??????? |
---|---|---|
status | number | ????? ?????? |
track_id | number | ?? ?????? ???? ?? |
id | string | ???? ????? ???? ?????? ?? ?? ????? ????? ?????? ?????? ??? ??? |
order_id | string | ????? ????? ??????? ?? ?? ????? ????? ?????? ????? ??? ??? |
????? ??????
??? ?? ?????? ??????? ?? ???? ??????? ? ?????? ???? ??????? ???? ???????? ??????? ???? ?????? ?? ????? ??? ?? ?????? ????? ?????? ????? ??? ? ?? ?????? ??? ?? ?????? ????? ??????? ???.
curl -X POST https://api.idpay.ir/v1.1/payment/verify \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: 6a7f99eb-7c20-4412-a972-6dfb7cd253a4' \
-H 'X-SANDBOX: 1' \
-d '{
"id": "d2e353189823079e1e4181772cff5292",
"order_id": "101"
}'
<?php
$params = array(
'id' => 'd2e353189823079e1e4181772cff5292',
'order_id' => '101',
);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.idpay.ir/v1.1/payment/verify');
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'X-API-KEY: 6a7f99eb-7c20-4412-a972-6dfb7cd253a4',
'X-SANDBOX: 1',
));
$result = curl_exec($ch);
curl_close($ch);
var_dump($result);
var request = require('request');
var options = {
method: 'POST',
url: 'https://api.idpay.ir/v1.1/payment/verify',
headers: {
'Content-Type': 'application/json',
'X-API-KEY': '6a7f99eb-7c20-4412-a972-6dfb7cd253a4',
'X-SANDBOX': 1,
},
body: {
'id': 'd2e353189823079e1e4181772cff5292',
'order_id': '101',
},
json: true,
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
url := "https://api.idpay.ir/v1.1/payment/verify"
data := map[string]string{
"id": "d2e353189823079e1e4181772cff5292",
"order_id": "101",
}
payload, _ := json.Marshal(data)
req, _ := http.NewRequest("POST", url, bytes.NewBuffer(payload))
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-API-KEY", "6a7f99eb-7c20-4412-a972-6dfb7cd253a4")
req.Header.Set("X-SANDBOX", 1)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(string(body))
???? ???????
POST https://api.idpay.ir/v1.1/payment/verify
?????????? ???? ????
??????? | ??? | ????? | ??????? |
---|---|---|---|
id | string | ??? | ???? ????? ???? ?????? ?? ?? ????? ????? ?????? ?????? ??? ??? |
order_id | string | ??? | ????? ????? ??????? ?? ?? ????? ????? ?????? ????? ??? ??? |
????? ????
?? ????? | ??????? |
---|---|
200 | ????? ?????? ?? ?????? ????? ?? |
400 | ???? ????? |
403 | ???? ????? |
405 | ???? ????? |
406 | ???? ????? |
?? ????? ????? ???? ????? ????? ??? ??? ?? ???? JSON ?????? ??????:
{
"status": "100",
"track_id": "10012",
"id": "d2e353189823079e1e4181772cff5292",
"order_id": "101",
"amount": "10000",
"date": "1546288200",
"payment": {
"track_id": "888001",
"amount": "10000",
"card_no": "123456******1234",
"hashed_card_no": "E59FA6241C94B8836E3D03120DF33E80FD988888BBA0A122240C2E7D23B48295",
"date": "1546288500"
},
"verify": {
"date": "1546288800"
}
}
????? 406: ?? ???? ???? ???? ????? ????? ??? ??? ?? ???? JSON ?????? ??????:
{
"error_code": 32,
"error_message": "????? ????? `order_id` ????? ???? ????."
}
????
??????? | ??? | ??????? |
---|---|---|
status | number | ????? ?????? |
track_id | number | ?? ?????? ???? ?? |
id | string | ???? ????? ???? ?????? ?? ?? ????? ????? ?????? ?????? ??? ??? |
order_id | string | ????? ????? ??????? ?? ?? ????? ????? ?????? ????? ??? ??? |
amount | number | ???? ??? ??? ????? ????? ?????? |
date | timestamp | ???? ????? ?????? |
payment | object | ??????? ?????? ?????? |
track_id | string | ?? ?????? ?????? |
amount | number | ???? ???? ?????? |
card_no | string | ????? ???? ?????? ????? ?? ???? 123456******1234 |
hashed_card_no | string | ?? ????? ???? ?????? ????? ?? ???????? SHA256 |
date | timestamp | ???? ?????? ?????? |
verify | object | ??????? ????? ?????? |
date | timestamp | ???? ????? ?????? |
??????? ????? ??????
?? ??????? ?? ???? ??? ????????? ????? ????? ?? ?????? ?? ?????? ??????.
curl -X POST https://api.idpay.ir/v1.1/payment/inquiry \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: 6a7f99eb-7c20-4412-a972-6dfb7cd253a4' \
-H 'X-SANDBOX: 1' \
-d '{
"id": "d2e353189823079e1e4181772cff5292",
"order_id": "101"
}'
<?php
$params = array(
'id' => 'd2e353189823079e1e4181772cff5292',
'order_id' => '101',
);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.idpay.ir/v1.1/payment/inquiry');
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'X-API-KEY: 6a7f99eb-7c20-4412-a972-6dfb7cd253a4',
'X-SANDBOX: 1',
));
$result = curl_exec($ch);
$httpcode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($httpcode);
var_dump($result);
var request = require('request');
var options = {
method: 'POST',
url: 'https://api.idpay.ir/v1.1/payment/inquiry',
headers: {
'Content-Type': 'application/json',
'X-API-KEY': '6a7f99eb-7c20-4412-a972-6dfb7cd253a4',
'X-SANDBOX': 1,
},
body: {
'id': 'd2e353189823079e1e4181772cff5292',
'order_id': '101',
},
json: true,
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
url := "https://api.idpay.ir/v1.1/payment/inquiry"
data := map[string]string{
"id": "d2e353189823079e1e4181772cff5292",
"order_id": "101",
}
payload, _ := json.Marshal(data)
req, _ := http.NewRequest("POST", url, bytes.NewBuffer(payload))
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-API-KEY", "6a7f99eb-7c20-4412-a972-6dfb7cd253a4")
req.Header.Set("X-SANDBOX", 1)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(string(body))
???? ???????
POST https://api.idpay.ir/v1.1/payment/inquiry
?????????? ???? ????
??????? | ??? | ????? | ??????? |
---|---|---|---|
id | string | ??? | ???? ????? ???? ?????? ?? ?? ????? ????? ?????? ?????? ??? ??? |
order_id | string | ??? | ????? ????? ??????? ?? ?? ????? ????? ?????? ????? ??? ??? |
????? ????
?? ????? | ??????? |
---|---|
200 | ??????? ?? ?????? ???? ???? ?? |
400 | ???? ????? |
403 | ???? ????? |
406 | ???? ????? |
?? ????? ????? ???? ????? ????? ??? ??? ?? ???? JSON ?????? ??????:
{
"status": "100",
"track_id": "10012",
"id": "d2e353189823079e1e4181772cff5292",
"order_id": "101",
"amount": "10000",
"wage": {
"by": "payee",
"type": "percent",
"amount": "2500"
},
"date": "1546288200",
"payer": {
"name": "???? ??????",
"phone": "09382198592",
"mail": "my@site.com",
"desc": "??????? ?????? ?????"
},
"payment": {
"track_id": "888001",
"amount": "10000",
"card_no": "123456******1234",
"hashed_card_no": "E59FA6241C94B8836E3D03120DF33E80FD988888BBA0A122240C2E7D23B48295",
"date": "1546288500"
},
"verify": {
"date": "1546288800"
},
"settlement": {
"track_id": "12345678900",
"amount": "7500",
"date": "1546398000"
}
}
????? 406: ?? ???? ???? ??? ????? ????? ??? ??? ?? ???? JSON ?????? ??????:
{
"error_code": 32,
"error_message": "????? ????? `order_id` ????? ???? ????."
}
????
??????? | ??? | ??????? |
---|---|---|
status | number | ????? ?????? |
track_id | number | ?? ?????? ???? ?? |
id | string | ???? ????? ???? ?????? ?? ?? ????? ????? ?????? ?????? ??? ??? |
order_id | string | ????? ????? ??????? ?? ?? ????? ????? ?????? ????? ??? ??? |
amount | number | ???? ??? ??? ????? ????? ?????? |
wage | object | ??????? ?????? ?????? |
by | string | ?????? ?????? ?? ??????? ?? ?????? ????? - ???????: payee - ?????? ?????: payer |
type | string | ??? ?????? ?????? - ???? ????: amount - ?????: percent - ??????: stair |
amount | number | ???? ?????? ?????? |
date | timestamp | ???? ????? ?????? |
payer | object | ??????? ?????? ????? ?????? |
name | string | ??? ?????? ????? |
phone | string | ????? ???? ????? ?????? ????? |
string | ??? ????????? ?????? ????? | |
desc | string | ??????? ?????? ????? |
payment | object | ??????? ?????? ?????? |
track_id | string | ?? ?????? ?????? |
amount | number | ???? ???? ?????? |
card_no | string | ????? ???? ?????? ????? ?? ???? 123456******1234 |
hashed_card_no | string | ?? ????? ???? ?????? ????? ?? ???????? SHA256 |
date | timestamp | ???? ?????? ?????? |
verify | object | ??????? ????? ?????? |
date | timestamp | ???? ????? ?????? |
settlement | object | ??????? ????? ?????? |
track_id | number | ?? ?????? ????? |
amount | number | ???? ???? ????? |
date | timestamp | ???? ????? ?????? ?? ???? ????? ??????? |
???? ?????? ??
?? ??????? ?? ???? ??? ?? ?????? ???? ?????? ??? ??? ?? ?????? ????.
curl -X POST https://api.idpay.ir/v1.1/payment/transactions?page=0&page_size=25 \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: 6a7f99eb-7c20-4412-a972-6dfb7cd253a4' \
-H 'X-SANDBOX: 0' \
-d '{
"id": "e22952579725883bbad9f8fa429134bf",
"order_id": 101,
"amount": 10000,
"status": ["100"],
"track_id": "27384837",
"payment_card_no": "636214******5409",
"payment_hashed_card_no": "B913D97F01CE42601181135DF3D0F81DA9E98E61BE3E3AB4436E6345D6AB0AEA",
"payment_date": {"min": 1600005000, "max": 1600006000},
"settlement_date": {"min": 1600005746, "max": 1600006000}
}'
<?php
$params = array(
"id" => "e22952579725883bbad9f8fa429134bf",
"order_id" => 101,
"amount" => 10000,
"status" => ["100"],
"track_id" => "27384837",
"payment_card_no" => "636214******5409",
"payment_hashed_card_no" => "B913D97F01CE42601181135DF3D0F81DA9E98E61BE3E3AB4436E6345D6AB0AEA",
"payment_date" => ["min" => 1600005000, "max" => 1600006000],
"settlement_date" => ["min" => 1600005746, "max" => 1600006000]
);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.idpay.ir/v1.1/payment/transactions?page=0&page_size=5');
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'X-API-KEY: 6a7f99eb-7c20-4412-a972-6dfb7cd253a4',
'X-SANDBOX: 0'
));
$result = curl_exec($ch);
curl_close($ch);
var_dump($result);
var body = {
"id": "e22952579725883bbad9f8fa429134bf",
"order_id": 101,
"amount": 10000,
"status": ["100"],
"track_id": "27384837",
"payment_card_no": "636214******5409",
"payment_hashed_card_no": "B913D97F01CE42601181135DF3D0F81DA9E98E61BE3E3AB4436E6345D6AB0AEA",
"payment_date": {"min": 1600005000, "max": 1600006000},
"settlement_date": {"min": 1600005746, "max": 1600006000}
}
fetch("https://api.idpay.ir/v1.1/payment/transactions?page=0&page_size=5", {
"headers": {
'Content-Type': 'application/json',
'X-API-KEY': '6a7f99eb-7c20-4412-a972-6dfb7cd253a4',
'X-SANDBOX': 0
},
"body": JSON.stringify(body),
"method": 'POST'
})
.then(e => e.json())
.then(e => {
console.log(e)
})
url := "https://api.idpay.ir/v1.1/payment/transactions?page=0&page_size=5"
data := map[string]string{
"id": "e22952579725883bbad9f8fa429134bf",
"order_id": 101,
"amount": 10000,
"status": ["100"],
"track_id": "27384837",
"payment_card_no": "636214******5409",
"payment_hashed_card_no": "B913D97F01CE42601181135DF3D0F81DA9E98E61BE3E3AB4436E6345D6AB0AEA",
"payment_date": {"min": 1600005000, "max": 1600006000},
"settlement_date": {"min": 1600005746, "max": 1600006000}
}
payload, _ := json.Marshal(data)
req, _ := http.NewRequest("POST", url, bytes.NewBuffer(payload))
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-API-KEY", "6a7f99eb-7c20-4412-a972-6dfb7cd253a4")
req.Header.Set("X-SANDBOX", 0)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(string(body))
???? ???????
POST https://api.idpay.ir/v1.1/payment/transactions
?????????? ??????? ?? URL
??????? | ??? | ????? | ??????? |
---|---|---|---|
page | number | ??? | ????? ???? ?? ?? 0 ???? ?? ??? ? ?? ???? ??????? 0 ???. |
page_size | number | ??? | ????? ???????? ??????? ?? ?? ???? ? ?? ???? ??????? 25 ?????? ??? ???. |
????? ??? ??????? ?? ???? ???????
??????? | ??? | ????? | ??????? |
---|---|---|---|
id | string | ??? | ????? ?? ?? ????? ????? ????? ?????? ?? ???? |
order_id | string | ??? | ????? ????? ??????? ?? ??? ?????? 50 ??????? |
amount | number | ??? | ???? ?????? ?? ???? ???? ???? ??? 1,000 ???? ?? 500,000,000 ???? ???? |
status | string array |
??? | ????? ?? (?????) ?? ????? ?????? ?? |
track_id | string | ??? | ?? ?????? ???? ?? |
payment_card_no | string | ??? | ????? ???? ?????? ????? ?? ???? 123456******1234 |
payment_hashed_card_no | string | ??? | ?? ????? ???? ?????? ????? ?? ???????? SHA256 |
payment_date | object | ??? | ???? ???? ?????? ?????? ???? ????? ? ?????? ?? ??? timestamp |
settlement_date | object | ??? | ???? ???? ????? ?????? ?? ??????? ???? ????? ? ?????? ?? ??? timestamp |
????? ????
?? ????? | ??????? |
---|---|
200 | ????? ?? ?????? ?? ?? ?????? ?? ???? |
204 | ??????? ?????? ???? ??? ??? ??????? ???? ??? |
403 | ???? ????? |
406 | ???? ????? |
????? 200: ?? ????? ????? ???? ????? ????? ??? ??? ?? ???? JSON ?????? ??????:
{
"attachment": {
"timestamp": 1601376343,
"total_count": 1,
"page_count": 1,
"current_page": 0,
"total_amount": "10000",
"page_amount": 10000
},
"records": [
{
"status": "100",
"track_id": "10012",
"id": "d2e353189823079e1e4181772cff5292",
"order_id": "101",
"amount": "10000",
"wage": {
"by": "payee",
"type": "percent",
"amount": "2500"
},
"date": "1546288200",
"payer": {
"name": "???? ??????",
"phone": "09382198592",
"mail": "my@site.com",
"desc": "??????? ?????? ?????"
},
"payment": {
"track_id": "888001",
"amount": "10000",
"card_no": "123456******1234",
"hashed_card_no": "E59FA6241C94B8836E3D03120DF33E80FD988888BBA0A122240C2E7D23B48295",
"date": "1546288500"
},
"verify": {
"date": "1546288800"
},
"settlement": {
"account": {
"id": "26338651",
"iban": "IR550150000000712300672907",
"number": "712300672907",
"bank": {
"id": "1",
"title": "???? ???"
}
},
"track_id": "12345678900",
"amount": "7500",
"date": "1546398000"
}
}
]
}
????? 406: ?? ???? ???? ???? ????? ????? ??? ??? ?? ???? JSON ?????? ??????:
{
"error_code": 41,
"error_message": "????? ????? ?????? ?? ?? ????? ????? ?? (?????) ?? ????? ??? ???? ?? ??????? ????."
}
????
??????? | ??? | ??????? |
---|---|---|
status | number | ????? ?????? |
track_id | number | ?? ?????? ???? ?? |
id | string | ???? ????? ???? ?????? ?? ?? ????? ????? ?????? ?????? ??? ??? |
order_id | string | ????? ????? ??????? ?? ?? ????? ????? ?????? ????? ??? ??? |
amount | number | ???? ??? ??? ????? ????? ?????? |
wage | object | ??????? ?????? ?????? |
by | string | ?????? ?????? ?? ??????? ?? ?????? ????? - ???????: payee - ?????? ?????: payer |
type | string | ??? ?????? ?????? - ???? ????: amount - ?????: percent - ??????: stair |
amount | number | ???? ?????? ?????? |
date | timestamp | ???? ????? ?????? |
payer | object | ??????? ?????? ????? ?????? |
name | string | ??? ?????? ????? |
phone | string | ????? ???? ????? ?????? ????? |
string | ??? ????????? ?????? ????? | |
desc | string | ??????? ?????? ????? |
payment | object | ??????? ?????? ?????? |
track_id | string | ?? ?????? ?????? |
amount | number | ???? ???? ?????? |
card_no | string | ????? ???? ?????? ????? ?? ???? 123456******1234 |
hashed_card_no | string | ?? ????? ???? ?????? ????? ?? ???????? SHA256 |
date | timestamp | ???? ?????? ?????? |
verify | object | ??????? ????? ?????? |
date | timestamp | ???? ????? ?????? |
settlement | object | ??????? ????? ?????? |
account | object | ??????? ???? ????? ?? ???? ?????? ?? ?? ????? ??? ???. |
wallet | object | ??????? ??? ??? ???? ?? ?? ???? ?????? ?? ?? ????? ??? ???. |
track_id | number | ?? ?????? ????? |
track_id | number | ?? ?????? ????? |
amount | number | ???? ???? ????? |
date | timestamp | ???? ????? ?????? ?? ???? ????? ??????? |
????? ??????
????? ?????? ????? ????? ??? ??? ?? ????? ?? ?? ?? ???? ??? ???? ???:
?? ????? ?????? | ??????? |
---|---|
1 | ?????? ????? ???? ??? |
2 | ?????? ?????? ???? ??? |
3 | ??? ?? ???? ??? |
4 | ????? ??? |
5 | ????? ?? ?????? ????? |
6 | ????? ????? ?????? |
7 | ?????? ?? ?????? |
8 | ?? ????? ?????? ????? ?? |
10 | ?? ?????? ????? ?????? |
100 | ?????? ????? ??? ??? |
101 | ?????? ???? ????? ??? ??? |
200 | ?? ?????? ????? ????? ?? |
???? ?????
???? ????? ????? ????? ??? ??? ?? ????? ?? ?? ?? ???? ??? ???? ???:
????? | ?? ??? | ????? ??? |
---|---|---|
500 | -1 | ???? ??? ?????? |
403 | 11 | ????? ????? ??? ???. |
403 | 12 | API Key ???? ???. |
403 | 13 | ??????? ??? ?? {ip} ????? ??? ???. ??? IP ?? IP ??? ??? ??? ?? ?? ????? ??????? ?????. |
403 | 14 | ?? ????? ??? ?? ??? ????? ??? ? ?? ????? ???? ???. |
500 | 15 | ????? ???? ??? ?? ????? ??? ????. |
403 | 21 | ???? ????? ???? ?? ?? ????? ????? ???? ???. |
404 | 22 | ?? ???? ???? ???. |
401 | 23 | ?????? ???? ?? ????? ?????? ???. |
403 | 24 | ???? ????? ????? ?? ??? ?? ????? ??? ???? ??? ???. |
406 | 31 | ?? ?????? id ????? ???? ????. |
406 | 32 | ????? ????? order_id ????? ???? ????. |
406 | 33 | ???? amount ????? ???? ????. |
406 | 34 | ???? amount ???? ????? ?? {min-amount} ???? ????. |
406 | 35 | ???? amount ???? ???? ?? {max-amount} ???? ????. |
406 | 36 | ???? amount ????? ?? ?? ???? ???. |
406 | 37 | ???? ?????? callback ????? ???? ????. |
406 | 38 | ??????? ??? ?? ???? {domain} ????? ??? ???. ????? ???? ?????? callback ?? ???? ??? ??? ?? ?? ????? ??????? ?????. |
406 | 39 | ???? ?????? callback ??????? ???. |
406 | 41 | ????? ????? ?????? ?? ?? ????? ????? ?? (?????) ?? ????? ??? ???? ?? ??????? ????. |
406 | 42 | ????? ????? ?????? ?? ????? ????? ?? ???? ????? ??? min ? max ?? ??? timestamp ????. |
406 | 43 | ????? ????? ????? ?? ????? ????? ?? ???? ????? ??? min ? max ?? ??? timestamp ????. |
406 | 44 | ????? ?????? ???? ??? ????. |
405 | 51 | ?????? ????? ???. |
400 | 52 | ??????? ????? ?? ?????. |
405 | 53 | ????? ?????? ????? ???? ????. |
405 | 54 | ??? ???? ????? ?????? ???? ??? ???. |
Postman
???? ????? ??? ? ????? ?????? API ???? ?? ????????? ???? ??? ?? ?????? ???? ? ?? ?? ?? ?????? Postman ??????? ??????.