Шот-фактураны құру
Өтініш
Сұрау параметрлері
Есім | Параметр түрі | Әдепкі мән | Анықтама |
---|---|---|---|
amount* | string | Төленетін сома.methods.If there are pennies in the amount | |
currency* | string | Валюта кодексі | |
order_id* | stringmin: 1max: 128alpha_dash | Сіздің жүйеңіздегі идентификаторПараметр алфавиттік таңбалардан, сандардан, астында сызбалардан және сызықшалардан тұратын жол болуы керек. Ол ешқандай кеңістік немесе арнайы таңбалар болмауы керек. order_id Сатушы шот-фактуралар / статикалық әмияндар / қайталану төлемдерінде ерекше болуы керекБіз order_id бар шот-фактураны тапқан кезде, біз оның мәліметтерін қайтарамыз, жаңа шот-фактура жасалмайды. | |
network | string | null | BlockChain желілік коды |
url_return | stringmin: 6max: 255url | null | Төлем жасамас бұрын, пайдаланушы төлем нысанындағы түймені басып, осы URL мекен-жайы бойынша Дүкен бетіне оралуға болады. |
url_success | stringmin: 6max: 255url | null | Төлем сәтті аяқталғаннан кейін, пайдаланушы төлем нысанындағы түймені басып, осы URL мекен-жайына оралуға болады. |
url_callback | stringmin: 6max: 255url | null | Төлем мәртебесі бар веб-үйге жіберілетін URL мекенжайы |
is_payment_multiple | boolean | true | Пайдаланушыға қалған соманы төлеуге рұқсат етіле ме. Бұл пайдаланушы бір транзакция үшін шот-фактураның барлық сомасын төлемеген кезде пайдалы және сіз оған толық сомаға төлеуге рұқсат бергіңіз келеді. Егер сіз бұл мүмкіндікті өшірсеңіз, шот-фактура алғашқы төлемді алғаннан кейін аяқталады және сіз өз балансына қаражат аласыз. |
lifetime | integermin: 300max: 43200 | 3600 | Берілген шот-фактураның қызмет мерзімі (секундпен) |
to_currency | string | Параметр шот-фактура сомасын айырбастауға арналған мақсатты валютаны көрсету үшін пайдаланылады. Шот-фактураны жасау кезінде сома мен валютаны бересіз және API бұл соманы to_currency ішіндегі баламалы мәнге түрлендіреді.Мысалы, биткоинде 20 долларға шот-фактураны жасау үшін: amount: 20 currency: USD to_currency : btcAPI ағымдағы бағам бойынша BTC-дегі 20 доллар сомасын баламасына айырбастайды және пайдаланушы BTC-де төлейді to_currency әрқашан Fiat валюта коды емес, криптошталдық коды болуы керек. | |
subtract | integermin: 0max: 100 | 0 | Клиентке алынатын төлем комиссиясының пайызыЕгер сізде 1% мөлшерлемесі болса, онда егер сіз 100 USDT-ге 100 USDT үшін шот-фактураны шығарсаңыз = 100 (клиент 100% комиссия төлейді), клиент 101 USDT төлеуге міндетті. |
accuracy_payment_percent | numericmin: 0max: 5 | 0 | Төлемнің қолайлы еместігі.Мысалы, егер сіз 5 мәнін тапсаңыз, шот-фактура Клиент соманың 95% төлеген болса да, ақылы деп белгіленеді.Нақты төлем сомасы балансқа есептеледі |
additional_data | stringmax: 255 | null | Сізге қосымша ақпарат (клиентке көрсетілмейді) |
currencies | array | Саудагердің параметрлерінен қол жетімді валюталар жиынтығы қолданылады (егер параметр орнатылмаған болса, барлық қолдау көрсетілетін криптоцерлер әдепкі бойынша қолданылады).Қол жетімді валюталар Сатушы параметрлері бөлімінде орнатылған. | Төлеуге рұқсат етілген валюталардың тізімі. Бұл сіздің тұтынушыларыңыз шот-фактураларды төлеу үшін пайдалана алатын монеталардың тізімін шектегіңіз келсе пайдалы. Құрылым |
except_currencies | array | null | Төлем үшін алынып тасталған валюталардың тізімі Құрылым |
course_source | stringmin: 4max: 20Қол жетімді мәндер• Binance• BinanceP2P• Exmo• Kucoin | Егер өтпесе, криптомиканың бағамы қолданылады. | Валюта бағамдары шот-фактурада айырбастау үшін қабылданады. |
from_referral_code | string | null | Сұраныс жасаған саудагерге сілтеме жасаушыға код бойынша қосылады.Мысалы, сіз Cryptomus API арқылы шот-фактураларды жасайтын қосымшасыз, ал сіздің клиенттеріңіз басқа дүкендер болып табылады. Олар сіздің API кілті мен сауда идентификаторын қосымшаңызға енгізеді және сіз олардың тіркелгі деректері бойынша сұраныстарды жіберіп, жүгіндік кодыңызды жібересіз.Осылайша, сіздің клиенттеріңіз сіздің Cryptomus есептік жазбаңызға жіберіліп, олардың айналымынан табыс алады. |
discount_percent | integermin: -99max: 100 | null | Оң сандар: сізге жеңілдіктер жасауға мүмкіндік береді. Төлем үшін 5% жеңілдік орнатылған кезде, сіз құнды өтеуіңіз керек: 5Теріс сандар: сізге қосымша қосымша комиссия орнатуға мүмкіндік береді.Төлем үшін қосымша комиссияны орнату үшін сіз: -10 мәнін беруіңіз керекШот-фактураны құру кезінде дисконт пайызы шот-фактураның нақты криптоциалды болуы болған жағдайда ғана ескеріледі. |
is_refresh | boolean | false | Осы параметрді пайдаланып, сіз өмір сүру мерзімін жаңарта аласыз және егер өмір бойы жарамдылық мерзімі аяқталған болса, шот-фактураның жаңа мекен-жайын аласыз.Ол үшін сіз барлық қажетті параметрлерді тапсыруыңыз керек, және өткен тапсырыс_идімен шот-фактура жаңартылады.Тек address , payment_status және expired_at өзгертілді. Өткізілген параметрлерге қарамастан, басқа өрістер өзгертілмейді. |
Параметр түрі
stringАнықтама
Төленетін сома.methods.If there are pennies in the amountПараметр түрі
stringАнықтама
Валюта кодексіПараметр түрі
stringmin: 1max: 128alpha_dashАнықтама
Сіздің жүйеңіздегі идентификаторПараметр алфавиттік таңбалардан, сандардан, астында сызбалардан және сызықшалардан тұратын жол болуы керек. Ол ешқандай кеңістік немесе арнайы таңбалар болмауы керек. order_id Сатушы шот-фактуралар / статикалық әмияндар / қайталану төлемдерінде ерекше болуы керекБіз order_id бар шот-фактураны тапқан кезде, біз оның мәліметтерін қайтарамыз, жаңа шот-фактура жасалмайды.Параметр түрі
stringАнықтама
BlockChain желілік кодыПараметр түрі
stringmin: 6max: 255urlАнықтама
Төлем жасамас бұрын, пайдаланушы төлем нысанындағы түймені басып, осы URL мекен-жайы бойынша Дүкен бетіне оралуға болады.Параметр түрі
stringmin: 6max: 255urlАнықтама
Төлем сәтті аяқталғаннан кейін, пайдаланушы төлем нысанындағы түймені басып, осы URL мекен-жайына оралуға болады.Параметр түрі
stringmin: 6max: 255urlАнықтама
Төлем мәртебесі бар веб-үйге жіберілетін URL мекенжайыПараметр түрі
booleanАнықтама
Пайдаланушыға қалған соманы төлеуге рұқсат етіле ме. Бұл пайдаланушы бір транзакция үшін шот-фактураның барлық сомасын төлемеген кезде пайдалы және сіз оған толық сомаға төлеуге рұқсат бергіңіз келеді. Егер сіз бұл мүмкіндікті өшірсеңіз, шот-фактура алғашқы төлемді алғаннан кейін аяқталады және сіз өз балансына қаражат аласыз.Параметр түрі
integermin: 300max: 43200Анықтама
Берілген шот-фактураның қызмет мерзімі (секундпен)Параметр түрі
stringАнықтама
Параметр шот-фактура сомасын айырбастауға арналған мақсатты валютаны көрсету үшін пайдаланылады. Шот-фактураны жасау кезінде сома мен валютаны бересіз және API бұл соманы to_currency ішіндегі баламалы мәнге түрлендіреді.Мысалы, биткоинде 20 долларға шот-фактураны жасау үшін:
amount: 20
currency: USD
to_currency : btcAPI ағымдағы бағам бойынша BTC-дегі 20 доллар сомасын баламасына айырбастайды және пайдаланушы BTC-де төлейді to_currency әрқашан Fiat валюта коды емес, криптошталдық коды болуы керек.Параметр түрі
integermin: 0max: 100Анықтама
Клиентке алынатын төлем комиссиясының пайызыЕгер сізде 1% мөлшерлемесі болса, онда егер сіз 100 USDT-ге 100 USDT үшін шот-фактураны шығарсаңыз = 100 (клиент 100% комиссия төлейді), клиент 101 USDT төлеуге міндетті.Параметр түрі
numericmin: 0max: 5Анықтама
Төлемнің қолайлы еместігі.Мысалы, егер сіз 5 мәнін тапсаңыз, шот-фактура Клиент соманың 95% төлеген болса да, ақылы деп белгіленеді.Нақты төлем сомасы балансқа есептеледіПараметр түрі
stringmax: 255Анықтама
Сізге қосымша ақпарат (клиентке көрсетілмейді)Параметр түрі
arrayАнықтама
Төлеуге рұқсат етілген валюталардың тізімі. Бұл сіздің тұтынушыларыңыз шот-фактураларды төлеу үшін пайдалана алатын монеталардың тізімін шектегіңіз келсе пайдалы. ҚұрылымПараметр түрі
arrayАнықтама
Төлем үшін алынып тасталған валюталардың тізімі ҚұрылымПараметр түрі
stringmin: 4max: 20
Қол жетімді мәндер- Binance- BinanceP2P- Exmo- KucoinАнықтама
Валюта бағамдары шот-фактурада айырбастау үшін қабылданады.Параметр түрі
stringАнықтама
Сұраныс жасаған саудагерге сілтеме жасаушыға код бойынша қосылады.Мысалы, сіз Cryptomus API арқылы шот-фактураларды жасайтын қосымшасыз, ал сіздің клиенттеріңіз басқа дүкендер болып табылады.
Олар сіздің API кілті мен сауда идентификаторын қосымшаңызға енгізеді және сіз олардың тіркелгі деректері бойынша сұраныстарды жіберіп, жүгіндік кодыңызды жібересіз.Осылайша, сіздің клиенттеріңіз сіздің Cryptomus есептік жазбаңызға жіберіліп, олардың айналымынан табыс алады.Параметр түрі
integermin: -99max: 100Анықтама
Оң сандар:
сізге жеңілдіктер жасауға мүмкіндік береді.
Төлем үшін 5% жеңілдік орнатылған кезде, сіз құнды өтеуіңіз керек: 5Теріс сандар:
сізге қосымша қосымша комиссия орнатуға мүмкіндік береді.Төлем үшін қосымша комиссияны орнату үшін сіз: -10 мәнін беруіңіз керекШот-фактураны құру кезінде дисконт пайызы шот-фактураның нақты криптоциалды болуы болған жағдайда ғана ескеріледі.Параметр түрі
booleanАнықтама
Осы параметрді пайдаланып, сіз өмір сүру мерзімін жаңарта аласыз және егер өмір бойы жарамдылық мерзімі аяқталған болса, шот-фактураның жаңа мекен-жайын аласыз.Ол үшін сіз барлық қажетті параметрлерді тапсыруыңыз керек, және өткен тапсырыс_идімен шот-фактура жаңартылады.Тек address , payment_status және expired_at өзгертілді. Өткізілген параметрлерге қарамастан, басқа өрістер өзгертілмейді.
* - Міндетті параметр
Құрылымы Валюталар
Есім | Анықтама |
---|---|
currency* | Валюта кодексі |
network | BlockChain желілік коды |
Анықтама
Валюта кодексіАнықтама
BlockChain желілік коды
* - Міндетті параметр
Құрылымы except_currencies
Есім | Анықтама |
---|---|
currency* | Валюта кодексі |
network | BlockChain желілік коды |
Анықтама
Валюта кодексіАнықтама
BlockChain желілік коды
* - Міндетті параметр
Мысал сұрау
Төменде қажетті параметрлер бар үлгі мысал келтірілген. Бұл жағдайда FIAT валютасы АҚШ долларымен шот-фактура жасалады. Төлем бетіне пайдаланушы осы шотты төлеу үшін CREPTocurrence және желіні таңдай алады.
curl https://api.cryptomus.com/v1/payment \
-X POST \
-H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
-H 'sign: fe99035f86fa436181717b302b95bacff1' \
-H 'Content-Type: application/json' \
-d '{
"amount": "15",
"currency": "USD",
"order_id": "1"
}'
ЕліктеуЖауап
Жауап параметрлері
Есім | Анықтама |
---|---|
uuid | Шот-фактура UUID |
order_id | Сіздің жүйеңіздегі идентификатор |
amount | Шот-фактураның мөлшері |
payment_amount | Клиент төлеген сома |
payer_amount | Төлеуші_куреттілік Тапсырыс беруші төлеуі керек, оның ішінде жеңілдік немесе қосымша комиссия. |
discount_percent | Сұраныс параметрлерінде өткен дисконт немесе қосымша комиссияның пайызы |
discount | Жеңілдіктің нақты мөлшері немесе криптокуралықта қосымша комиссия.Мысалы, егер шот-фактураның мөлшері 15 USDT және жеңілдіктер-% болса, жеңілдік мәні -5, жеңілдік мәні -0,75 боладыi.e amount discount = discount_amount |
payer_currency | Тапсырыс беруші төлем жасауы керек валютасы. |
currency | Шот-фактураның валюталық коды |
merchant_amount | Сіздің балансыңызға есептелетін крипто мөлшері. Егер шот-фактура төлеуші_каяқтық көрсетілмесе, мән NULL болады. |
network | BlockChain желілік коды |
address | Төлем үшін әмиян мекен-жайы |
from | Төлем жасалған әмиянның мекен-жайы |
txid | Транзакция хэш |
payment_status | Төлем мәртебесі Барлық төлемдер мәртебесі |
url | URL төлем парағы |
expired_at | Шот-фактураның жарамдылық мерзімін ұзарту |
is_final | Шот-фактураның аяқталуы керек пе.Шот-фактура аяқталған кезде шот-фактураны төлеу мүмкін емес (ол төленген немесе мерзімі аяқталған) |
additional_data | Қосымша Ақпарат |
created_at | Шот-фактураның құрылған күні. TimeZone - UTC + 3 |
updated_at | Соңғы шот-фактура жаңартылған күн. TimeZone - UTC + 3 |
Анықтама
Шот-фактура UUIDАнықтама
Сіздің жүйеңіздегі идентификаторАнықтама
Шот-фактураның мөлшеріАнықтама
Клиент төлеген сомаАнықтама
Төлеуші_куреттілік Тапсырыс беруші төлеуі керек, оның ішінде жеңілдік немесе қосымша комиссия.Анықтама
Сұраныс параметрлерінде өткен дисконт немесе қосымша комиссияның пайызыАнықтама
Жеңілдіктің нақты мөлшері немесе криптокуралықта қосымша комиссия.Мысалы, егер шот-фактураның мөлшері 15 USDT және жеңілдіктер-% болса, жеңілдік мәні -5, жеңілдік мәні -0,75 боладыi.e amount discount = discount_amountАнықтама
Тапсырыс беруші төлем жасауы керек валютасы.Анықтама
Шот-фактураның валюталық кодыАнықтама
Сіздің балансыңызға есептелетін крипто мөлшері. Егер шот-фактура төлеуші_каяқтық көрсетілмесе, мән NULL болады.Анықтама
BlockChain желілік кодыАнықтама
Төлем үшін әмиян мекен-жайыАнықтама
Төлем жасалған әмиянның мекен-жайыАнықтама
Транзакция хэшАнықтама
Төлем мәртебесі Барлық төлемдер мәртебесіАнықтама
URL төлем парағыАнықтама
Шот-фактураның жарамдылық мерзімін ұзартуАнықтама
Шот-фактураның аяқталуы керек пе.Шот-фактура аяқталған кезде шот-фактураны төлеу мүмкін емес (ол төленген немесе мерзімі аяқталған)Анықтама
Қосымша АқпаратАнықтама
Шот-фактураның құрылған күні. TimeZone - UTC + 3Анықтама
Соңғы шот-фактура жаңартылған күн. TimeZone - UTC + 3
Жауаптың мысалы
1{
2 "state": 0,
3 "result": {
4 "uuid": "26109ba0-b05b-4ee0-93d1-fd62c822ce95",
5 "order_id": "1",
6 "amount": "15.00",
7 "payment_amount": null,
8 "payer_amount": null,
9 "discount_percent": null,
10 "discount": "0.00000000",
11 "payer_currency": null,
12 "currency": "USD",
13 "merchant_amount": null,
14 "network": null,
15 "address": null,
16 "from": null,
17 "txid": null,
18 "payment_status": "check",
19 "url": "https://pay.cryptomus.com/pay/26109ba0-b05b-4ee0-93d1-fd62c822ce95",
20 "expired_at": 1689098133,
21 "status": "check",
22 "is_final": false,
23 "additional_data": null,
24 "created_at": "2023-07-11T20:23:52+03:00",
25 "updated_at": "2023-07-11T21:24:17+03:00"
26 }
27}
ЕліктеуҚосымша мысалдар
Деректерді Tron Network-де 20 USDT шот-фактурасын жасау үшін сұрау. Шот-фактурада құрылған кезде мекен-жайы болады.
1{
2 "amount": "20",
3 "currency": "USDT",
4 "order_id": "1",
5 "network": "tron"
6}
ЕліктеуДеректерді 25 АҚШ долларына шот-фактураны жасау және клиенттерге тек кез-келген желіде тек USDT төлеуге мүмкіндік беріңіз.
1{
2 "amount": "25",
3 "currency": "USD",
4 "order_id": "1",
5 "to_currency": "USDT"
6}
ЕліктеуДеректерді 25 АҚШ долларына шот-фактураны жасау және клиенттерге тек Tron Network-те ғана төлеуге мүмкіндік береді. Шот-фактурада құрылған кезде мекен-жайы болады.
1{
2 "amount": "25",
3 "currency": "USD",
4 "order_id": "1",
5 "to_currency": "USDT",
6 "network": "tron"
7}
ЕліктеуДеректерді 20 USDT үшін шот-фактураны жасау және клиенттерге барлық қол жетімді желілерде төлеуге мүмкіндік беру
1{
2 "amount": "20",
3 "currency": "USDT",
4 "order_id": "1"
5}
ЕліктеуДеректерді 20 АҚШ долларына шот-фактураны жасау және клиенттерге тек Bitcoin-де төлеуге мүмкіндік беріңіз. Шот-фактурада құрылған кезде мекен-жайы болады.
1{
2 "amount": "20",
3 "currency": "USD",
4 "order_id": "1",
5 "to_currency": "BTC"
6}
ЕліктеуДеректерді сұрау 0,5 BTC-ге шот-фактураны жасау және клиенттерге тек Bitcoin-де төлеуге мүмкіндік береді. Шот-фактурада құрылған кезде мекен-жайы болады.
1{
2 "amount": "0.5",
3 "currency": "BTC",
4 "order_id": "1"
5}
ЕліктеуМүмкін қателер
Тексеру қателері
код : 422
Мысал жауаптары:
Егер кейбір параметрлер қажет болса және жіберілмесе:
1{
2 "state": 1,
3 "errors": {
4 "amount": ["validation.required"]
5 }
6}
ЕліктеуЕгер сіз қолдау көрсетілмейтін желі кодын берсеңіз
1{
2 "state": 1,
3 "message": "The network was not found"
4}
ЕліктеуЕгер біз currency ұсынылған валюта кодын қолдамасақ, параметрі:
1{
2 "state": 1,
3 "message": "The currency was not found"
4}
ЕліктеуЕгер сіздің төлемдеріңіз бұғатталған болса. Бұл жағдайда қолдау қызметіне хабарласу керек.
1{
2 "state": 1,
3 "message": "You are forbidden"
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": "Wallet not found"
4}
ЕліктеуЕгер техникалық жұмыс орын алса және төлем уақытша қол жетімді болмаса, сіз осы қате туралы хабарламаларды ала аласыз:
1{
2 "state": 1,
3 "message": "Gateway error"
4}
Еліктеу
1{
2 "state": 1,
3 "message": "The terminal was not found"
4}
Еліктеу
1{
2 "state": 1,
3 "message": "Server error"
4}
ЕліктеуІшкі қате
код : 500
Мысал жауаптары:
1{
2 "message": "Server error, #1",
3 "code": 500,
4 "error": null
5}
Еліктеу