Тесттік webhook

Тестілеу

post
https://api.heleket.com/v1/test-webhook/payment
Copy

Webhook деректер массивінен қолтаңбаны растау үшін, төлем API пернесін пайдаланыңыз.

Сіз webhooks-ты дұрыс алып жатқаныңызға және қолтаңбаны тексере алатыныңызға көз жеткізу үшін, төлем үшін webhooks-ты тексеру үшін осы әдісті пайдалану керек.
Өтінеміз, деректер дерекқорға сақталмайды және webhook арқылы алынған деректер тексеру мақсатында массивте ғана сақталады, бұл қолтаңбаның дұрыстығын қамтамасыз ету және осы массивті бізден алу процесін тексеру үшін қажет.

Мәзірдегі webhook тестілеу үшін, оның uuid немесе тапсырыс ID-ін ұсыныңыз. Егер бұл параметрлер берілмесе, webhook тестілік шот-фактурамен жіберіледі.

Өтініш

Сұрау параметрлері

ЕсімПараметр түріӘдепкі мәнАнықтама
url_callback*stringmin:6max:150urlURL, оған төлем күйі бар webhooks жіберіледі
currency*stringШот-фактураның валюталық коды
network*stringШот-фактура желісінің коды
uuidstringuuidКездейсоқ Uuid жолышот-фактураның uuid
order_idstringmin:1max:32alpha_dashКездейсоқ жолШот-фактураның идентификаторы
status*stringpaidТөлем мәртебесіҚол жетімді опциялар:processcheckpaidpaid_overfailwrong_amountcancelsystem_failrefund_processrefund_failrefund_paidlocked

Параметр түрі

stringmin:6max:150url

Анықтама

URL, оған төлем күйі бар webhooks жіберіледі

Параметр түрі

string

Анықтама

Шот-фактураның валюталық коды

Параметр түрі

string

Анықтама

Шот-фактура желісінің коды

Параметр түрі

stringuuid

Анықтама

шот-фактураның uuid

Параметр түрі

stringmin:1max:32alpha_dash

Анықтама

Шот-фактураның идентификаторы

Параметр түрі

string

Анықтама

Төлем мәртебесіҚол жетімді опциялар:- process- check- paid- paid_over- fail- wrong_amount- cancel- system_fail- refund_process- refund_fail- refund_paid- locked

* - Міндетті параметр

Егер сіз екеуін де, есептік жазбаны UUID арқылы анықтайтын UUID немесе TEST_ID параметрлерінің бірін өткізуге болады

Мысал сұрау


curl http://api.merchant.heleket.local/v1/test-webhook/payment \
-X POST \
-H 'merchant: 860166ce-478c-4087-9813-55cfb6c34580' \
-H 'sign: a466b82fad9415cdbf5f47802b8d376c' \
-H 'Content-Type: application/json' \
-d '{
	"uuid": "e1830f1b-50fc-432e-80ec-15b58ccac867",
	"currency": "ETH",
	"url_callback": "https://your.site/callback",
	"network": "eth",
	"status": "paid"
}'
Copy

Жауап

Жауаптың мысалы


1{
2  "state": 0,
3  "result": []
4}
Copy

Төлемді тексеру

post
https://api.heleket.com/v1/test-webhook/payout
Copy

Webhook деректер массивінен қолтаңбаны растау үшін, төлем API пернесін пайдаланыңыз.

Өтініш

Сұрау параметрлері

ЕсімПараметр түріӘдепкі мәнАнықтама
url_callback*stringmin:6max:150urlURL, оған төлем күйі бар webhooks жіберіледі
currency*stringТөлем валютасының коды
network*stringТөлем желісінің коды
uuidstringuuidКездейсоқ Uuid жолыТөлемнің ууидері
order_idstringmin:1max:32alpha_dashКездейсоқ жолТөлемнің жеке куәлігі
status*stringpaidТөлем мәртебесіҚол жетімді опциялар:processcheckpaidfailcancelsystem_fail

Параметр түрі

stringmin:6max:150url

Анықтама

URL, оған төлем күйі бар webhooks жіберіледі

Параметр түрі

string

Анықтама

Төлем валютасының коды

Параметр түрі

string

Анықтама

Төлем желісінің коды

Параметр түрі

stringuuid

Анықтама

Төлемнің ууидері

Параметр түрі

stringmin:1max:32alpha_dash

Анықтама

Төлемнің жеке куәлігі

Параметр түрі

string

Анықтама

Төлем мәртебесіҚол жетімді опциялар:- process- check- paid- fail- cancel- system_fail

* - Міндетті параметр

Егер сіз екеуін де, есептік жазбаны UUID арқылы анықтайтын UUID немесе TEST_ID параметрлерінің бірін өткізуге болады

Мысал сұрау


curl http://api.merchant.heleket.local/v1/test-webhook/payout \
-X POST -H 'merchant: 860166ce-478c-4087-9813-55cfb6c34580' \
-H 'sign: a466b82fad9415cdbf5f47802b8d376c' \
-H 'Content-Type: application/json' \
-d '{
	"uuid": "e1830f1b-50fc-432e-80ec-15b58ccac867",
	"currency": "ETH",
	"url_callback": "https://your.site/callback",
	"network": "eth",
	"status": "paid"
}'
Copy

Жауап

Жауаптың мысалы


1{
2  "state": 0,
3  "result": []
4}
Copy

Әмиянды тексеру

post
https://api.heleket.com/v1/test-webhook/wallet
Copy

Webhook деректер массивінен қолтаңбаны растау үшін, төлем API пернесін пайдаланыңыз.

Өтініш

Сұрау параметрлері

ЕсімПараметр түріӘдепкі мәнАнықтама
url_callback*stringmin:6max:150urlURL, оған төлем күйі бар webhooks жіберіледі
currency*stringТөлем валютасының коды
network*stringТөлем желісінің коды
uuidstringuuidКездейсоқ Uuid жолыІскери әмиянның uuidorder_id жоқ болса қажет
order_idstringmin:1max:32alpha_dashКездейсоқ жолШот-фактураның идентификаторыuuid жоқ болса қажет
status*stringpaidТөлем мәртебесіҚол жетімді опциялар:processcheckpaidpaid_overfailwrong_amountcancelsystem_failrefund_processrefund_failrefund_paidlocked

Параметр түрі

stringmin:6max:150url

Анықтама

URL, оған төлем күйі бар webhooks жіберіледі

Параметр түрі

string

Анықтама

Төлем валютасының коды

Параметр түрі

string

Анықтама

Төлем желісінің коды

Параметр түрі

stringuuid

Анықтама

Іскери әмиянның uuidorder_id жоқ болса қажет

Параметр түрі

stringmin:1max:32alpha_dash

Анықтама

Шот-фактураның идентификаторыuuid жоқ болса қажет

Параметр түрі

string

Анықтама

Төлем мәртебесіҚол жетімді опциялар:- process- check- paid- paid_over- fail- wrong_amount- cancel- system_fail- refund_process- refund_fail- refund_paid- locked

* - Міндетті параметр

Мысал сұрау


curl http://api.merchant.heleket.local/v1/test-webhook/wallet \
-X POST -H 'merchant: 860166ce-478c-4087-9813-55cfb6c34580' \
-H 'sign: a466b82fad9415cdbf5f47802b8d376c' \
-H 'Content-Type: application/json' \
-d '{
	"uuid": "e1830f1b-50fc-432e-80ec-15b58ccac867",
	"currency": "ETH",
	"url_callback": "https://your.site/callback",
	"network": "eth",
	"status": "paid"
}'
Copy

Жауап

Жауаптың мысалы


1{
2  "state": 0,
3  "result": []
4}
Copy

Мүмкін қателер

Тексеру қателері

код : 422

Мысал жауаптары:

Егер сіз uuid order_id және шот-фактура / Төлем табылмаса:


1{
2    "state": 1,
3    "message": "Not found payment"
4}
Copy


1{
2    "state": 1,
3    "message": "Not found payout"
4}
Copy


1{
2    "state": 1,
3    "message": "Not found wallet"
4}
Copy

Егер сіз қажетті параметрлерді бермесеңіз:


1{
2	"state": 1,
3	"errors": {
4		"currency": ["validation.required"]
5	}
6}
Copy

Егер ұсынылған валюта мен желі крипто болмаса немесе қолдау көрсетілмесе:


1{
2    "state": 1,
3    "message": "Payment service not found"
4}
Copy


1{
2    "state": 1,
3    "message": "Payout service not found"
4}
Copy