Басты
/Төлемдер
/Төлем жасау
API арқылы төленетін төлемдер сіздің бизнесіңіздің әмияндарыңыздың қалдықтарынан ғана жасалады.
Төлемдерді әр түрлі жолдармен жасауға болады:
| Есім | Параметр түрі | Әдепкі мән | Анықтама |
|---|---|---|---|
| amount* | string | Төлем сомасы | |
| currency* | string | Төлемге арналған валюталық кодЕгер валюта болса, егер FIAT болса, to_currency параметрі қажет . | |
| order_id* | stringmin:1max:100alpha_dash | Сіздің жүйеңіздегі идентификаторПараметр алфавиттік таңбалардан, сандардан, астында сызбалардан және сызықшалардан тұратын жол болуы керек. Ол ешқандай кеңістік немесе арнайы таңбалар болмауы керек. order_id саудагерлердің төлемдерінде ерекше болуы керекЕгер біз order_id бар төлемді тапқан кезде, біз оның мәліметтерін қайтарамыз, жаңа төлем жасалмайды. | |
| address* | string | Шығаруға болатын әмиянның мекен-жайы | |
| is_subtract* | boolean | Шығару ақысы шегерілетінін анықтайдыTRUE - сіздің балансыңызданЖалған - төлем сомасынан төлем сомасы азаяды | |
| network* | string | BlockChain желілік коды валюта/to_currency - бұл криптокюрлік болған кезде қажет емес, мысалы, тек бір желі бар, мысалы BTC | |
| url_callback | Webhook-тегі URL мекен-жайы, қайтарады | ||
| to_currency | Төлем жасалатын криптоштік код. Ол currency параметрі Fiat болған кезде қолданылады. Төмендегі мысалдарды қараңыз | ||
| course_source | stringҚол жетімді мәндер• Binance• BinanceP2p• Exmo• Kucoin | Сатушының параметрлерінің мәні | Валюта бағамдары шот-фактурада айырбастау үшін қабылданады.Параметр валюта Fiat болған жағдайда ғана қолданылады, әйтпесе, сатушы параметрлерден әдепкі мән алынады. |
| from_currency | string | null | Шығару сомасын автоматты түрде түрлендіріп, ішінен rongrience тепе-теңдігін пайдалануға мүмкіндік береді. Тек USDT қол жетімді. |
| priority | stringmin: 4max: 11Қол жетімді мәндер• recommended• economy• high• highest | recommended | Шығарудың басымдылығын таңдау параметрі. Шығару комиссиясының құны таңдалған параметрге байланысты.Бұл параметр BTC, Eth, Polygon және BSC желілерін пайдаланған жағдайда ғана қолданылады. |
| memo | stringmin: 1max: 30 | Белгілі бір алушыны немесе нысананы көрсету үшін пайдаланылатын тонна үшін қосымша идентификатор |
Параметр түрі
stringАнықтама
Төлем сомасыПараметр түрі
stringАнықтама
Төлемге арналған валюталық кодЕгер валюта болса, егер FIAT болса, to_currency параметрі қажет .Параметр түрі
stringmin:1max:100alpha_dashАнықтама
Сіздің жүйеңіздегі идентификаторПараметр алфавиттік таңбалардан, сандардан, астында сызбалардан және сызықшалардан тұратын жол болуы керек. Ол ешқандай кеңістік немесе арнайы таңбалар болмауы керек. order_id саудагерлердің төлемдерінде ерекше болуы керекЕгер біз order_id бар төлемді тапқан кезде, біз оның мәліметтерін қайтарамыз, жаңа төлем жасалмайды.Параметр түрі
stringАнықтама
Шығаруға болатын әмиянның мекен-жайыПараметр түрі
booleanАнықтама
Шығару ақысы шегерілетінін анықтайдыTRUE - сіздің балансыңызданЖалған - төлем сомасынан төлем сомасы азаядыПараметр түрі
stringАнықтама
BlockChain желілік коды валюта/to_currency - бұл криптокюрлік болған кезде қажет емес, мысалы, тек бір желі бар, мысалы BTCАнықтама
Webhook-тегі URL мекен-жайы, қайтарадыАнықтама
Төлем жасалатын криптоштік код. Ол currency параметрі Fiat болған кезде қолданылады. Төмендегі мысалдарды қараңызПараметр түрі
stringАнықтама
Валюта бағамдары шот-фактурада айырбастау үшін қабылданады.Параметр валюта Fiat болған жағдайда ғана қолданылады, әйтпесе, сатушы параметрлерден әдепкі мән алынады.Параметр түрі
stringАнықтама
Шығару сомасын автоматты түрде түрлендіріп, ішінен rongrience тепе-теңдігін пайдалануға мүмкіндік береді. Тек USDT қол жетімді.Параметр түрі
stringmin: 4max: 11Анықтама
Шығарудың басымдылығын таңдау параметрі. Шығару комиссиясының құны таңдалған параметрге байланысты.Бұл параметр BTC, Eth, Polygon және BSC желілерін пайдаланған жағдайда ғана қолданылады.Параметр түрі
stringmin: 1max: 30Анықтама
Белгілі бір алушыны немесе нысананы көрсету үшін пайдаланылатын тонна үшін қосымша идентификатор* - Міндетті параметр
curl https://api.heleket.com/v1/payout \
-X POST \
-H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
-H 'sign: fe99035f86fa436181717b302b95bacff1' \
-H 'Content-Type: application/json' \
-d '{
"amount": "5",
"currency": "USDT",
"network": "TRON",
"order_id": "1",
"address": "TDD97yguPESTpcrJMqU6h2ozZbibv4Vaqm",
"url_callback": "https://your.site/callback",
"is_subtract": "1",
}'
Көшіру| Есім | Анықтама |
|---|---|
| uuid | Төлемнің ууидері |
| amount | Төлем сомасы currency |
| currency | Төлемге арналған валюталық код |
| network | Төлем жасалатын блок-камера желісінің коды |
| address | Төлем жасалған әмиянның мекен-жайы |
| txid | Бояудағы транзакция идентификаторы |
| status | Төлем мәртебесі Барлық қол жетімді күйлерді қараңыз |
| is_final | Төлем аяқталған ба, жоқ паТөлем процесі сәтті төленгеннен кейін немесе ол сәтсіз болған кезде аяқталады деп саналады. Төлем сәтсіз болған жағдайда қаражат сіздің төлем процесін қайтадан бастауға талап ететін қалдыққа қайтарылады. |
| balance | Саудагердің тепе-теңдігі бойынша қалған қаражат. |
| payer_currency | Төлем жасалған криптошалық коды іс жүзінде жасалады. Төлем мекен-жайы төлем валютасын алады. |
| payer_amount | Төлемнің төлеуші_валютасындағы сомасы |
| commission | Қызмет көрсету комиссиясы |
| merchant_amount | Барлық комиссияларды ескере отырып, баланстан есептен шығарылған сома |
| convert | Конверсия туралы ақпарат. Конверсия валютадан валютаға дейін жүзеге асырылады.Валютадан өтпесеңіз немесе ол валютаға_бірдей болса, айырбастау өрісі болмайды. Құрылым |
Анықтама
Төлемнің ууидеріАнықтама
Төлем сомасы currencyАнықтама
Төлемге арналған валюталық кодАнықтама
Төлем жасалатын блок-камера желісінің кодыАнықтама
Төлем жасалған әмиянның мекен-жайыАнықтама
Бояудағы транзакция идентификаторыАнықтама
Төлем аяқталған ба, жоқ паТөлем процесі сәтті төленгеннен кейін немесе ол сәтсіз болған кезде аяқталады деп саналады. Төлем сәтсіз болған жағдайда қаражат сіздің төлем процесін қайтадан бастауға талап ететін қалдыққа қайтарылады.Анықтама
Саудагердің тепе-теңдігі бойынша қалған қаражат.Анықтама
Төлем жасалған криптошалық коды іс жүзінде жасалады. Төлем мекен-жайы төлем валютасын алады.Анықтама
Төлемнің төлеуші_валютасындағы сомасыАнықтама
Қызмет көрсету комиссиясыАнықтама
Барлық комиссияларды ескере отырып, баланстан есептен шығарылған сомаАнықтама
Конверсия туралы ақпарат. Конверсия валютадан валютаға дейін жүзеге асырылады.Валютадан өтпесеңіз немесе ол валютаға_бірдей болса, айырбастау өрісі болмайды. Құрылым| Есім | Анықтама |
|---|---|
| to_currency | Төлем ауыстырылатын валютаның коды |
| from_currency | Төлем ауыстырылатын валюта |
| commission | Конверсия ақысы |
| rate | Конверсия көрсеткіші |
| from_amount | Баланстан барлық комиссиялар алынып тасталған from_currency валютасына ауыстырылған сома. |
Анықтама
Төлем ауыстырылатын валютаның кодыАнықтама
Төлем ауыстырылатын валютаАнықтама
Конверсия ақысыАнықтама
Конверсия көрсеткішіАнықтама
Баланстан барлық комиссиялар алынып тасталған from_currency валютасына ауыстырылған сома.
1{
2 "state": 0,
3 "result": {
4 "uuid": "a7c0caec-a594-4aaa-b1c4-77d511857594",
5 "amount": "3",
6 "currency": "USDT",
7 "commission": "0.001",
8 "merchant_amount": "3.001"
9 "network": "TRON",
10 "address": "TJ...",
11 "txid": null,
12 "status": "process",
13 "is_final": false,
14 "balance": 129,
15 "payer_currency": "USD",
16 "payer_amount": 3
17 }
18}
19Көшірукод : 422
Мысал жауаптары:
1{
2 "state": 1,
3 "errors": {
4 "amount": ["validation.required"]
5 }
6}КөшіруЕгер төлемдеріңізден немесе пайдаланушысыңызда төлемдер бұғатталған болса, сіз осы қате туралы хабарлама аласыз. Бұл, мысалы, парольді өзгерткен кезде және төлемдер 24 сағат бойы бұғатталған кезде.
1{
2 "state": 1,
3 "message": "You are forbidden"
4}КөшіруЕгер біз валюта параметрінде ұсынған валюта кодын қолдамасақ, сіз осы қате туралы хабарлама аласыз:
1{
2 "state": 1,
3 "message": "The currency was not found"
4}КөшіруЕгер біз төлемді орындау қызметін таба алмасақ, сіз осы қате туралы хабарлама аласыз. Сіз криптоцерттіктің қолдау көрсетілетініне көз жеткізуіңіз керек. Енгізілген мәндердің дұрыстығын тексеріңіз. Валюта, желі, from_currency, to_currency:
1{
2 "state": 1,
3 "message": "The service was not found"
4}КөшіруЕгер алу сомасы тым кішкентай болса, сіз осы қате туралы хабарлама аласыз:
1{
2 "state": 1,
3 "message": "The withdrawal amount is too small"
4}КөшіруЕгер сізде жалақы криптофавкасы бар белсенді саудагер әмиян болмаса, сіз осы қатені аласыз:
1{
2 "state": 1,
3 "message": "Wallet not found"
4}КөшіруЕгер төлем сомасы, оның ішінде барлық комиссиялар сіздің теңгеріміңізден гөрі, сіз осы қате туралы хабарлама аласыз:
1{
2 "state": 1,
3 "message": "Not enough funds"
4}КөшіруЕгер біз to_currency параметрінде өткен валютаның төлем қызметін таба алмасақ, сіз осы қате туралы хабарлама аласыз:
1{
2 "state": 1,
3 "message": "Not found service to_currency"
4}КөшіруЕгер to_currency-ге конвертация кезінде кездейсоқ бірдеңе болса, сіз бұл қате хабарламасын аласыз:
1{
2 "state": 1,
3 "message": "Error convert to_currency"
4}КөшіруЕгер төлем сомасы криптокуралдылық үшін ең аз қолдау көрсетілетін сомадан аз болса, сіз осы қате туралы хабарлама аласыз:
1{
2 "state": 1,
3 "message": "Minimum amount 0.5 USDT"
4}КөшіруЕгер төлем сомасы криптокуралдылық үшін ең көп қолдау көрсетілетін сомадан үлкен болса, сіз осы қате туралы хабарлама аласыз:
1{
2 "state": 1,
3 "message": "Maximum amount 10000000 USDT"
4}КөшіруЕгер сізде төлем жасау үшін қаражат жеткіліксіз болса, сіз осы қате туралы хабарлама аласыз:
1{
2 "state": 1,
3 "message": "Not enough funds"
4}КөшіруЕгер сізде төлем сомасын төлеу үшін қаражат жеткіліксіз болса, сіз осы қате туралы хабарлама аласыз:
1{
2 "state": 1,
3 "message": "Not enough balance for convert USDT to LTC"
4}КөшіруЕгер техникалық жұмыс орын алса және төлем уақытша қол жетімді емес болса, сіз бұл қате туралы хабарлама аласыз
1{
2 "state": 1,
3 "message": "The terminal was not found"
4}Көшірукод : 500
Мысал жауаптары:
1{
2 "message": "Server error, #1",
3 "code": 500,
4 "error": null
5}Көшіру