Шот-фактураны құру

post
https://api.cryptomus.com/v1/payment
Еліктеу

Өтініш

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

ЕсімПараметр түріӘдепкі мәнАнықтама
amount*stringТөленетін сома.methods.If there are pennies in the amount
currency*stringВалюта кодексі
order_id*stringmin: 1max: 128alpha_dashСіздің жүйеңіздегі идентификаторПараметр алфавиттік таңбалардан, сандардан, астында сызбалардан және сызықшалардан тұратын жол болуы керек. Ол ешқандай кеңістік немесе арнайы таңбалар болмауы керек. order_id Сатушы шот-фактуралар / статикалық әмияндар / қайталану төлемдерінде ерекше болуы керекБіз order_id бар шот-фактураны тапқан кезде, біз оның мәліметтерін қайтарамыз, жаңа шот-фактура жасалмайды.
networkstringnullBlockChain желілік коды
url_returnstringmin: 6max: 255urlnullТөлем жасамас бұрын, пайдаланушы төлем нысанындағы түймені басып, осы URL мекен-жайы бойынша Дүкен бетіне оралуға болады.
url_successstringmin: 6max: 255urlnullТөлем сәтті аяқталғаннан кейін, пайдаланушы төлем нысанындағы түймені басып, осы URL мекен-жайына оралуға болады.
url_callbackstringmin: 6max: 255urlnullТөлем мәртебесі бар веб-үйге жіберілетін URL мекенжайы
is_payment_multiplebooleantrueПайдаланушыға қалған соманы төлеуге рұқсат етіле ме. Бұл пайдаланушы бір транзакция үшін шот-фактураның барлық сомасын төлемеген кезде пайдалы және сіз оған толық сомаға төлеуге рұқсат бергіңіз келеді. Егер сіз бұл мүмкіндікті өшірсеңіз, шот-фактура алғашқы төлемді алғаннан кейін аяқталады және сіз өз балансына қаражат аласыз.
lifetimeintegermin: 300max: 432003600Берілген шот-фактураның қызмет мерзімі (секундпен)
to_currencystringПараметр шот-фактура сомасын айырбастауға арналған мақсатты валютаны көрсету үшін пайдаланылады. Шот-фактураны жасау кезінде сома мен валютаны бересіз және API бұл соманы to_currency ішіндегі баламалы мәнге түрлендіреді.Мысалы, биткоинде 20 долларға шот-фактураны жасау үшін:
amount: 20
currency: USD
to_currency : btc
API ағымдағы бағам бойынша BTC-дегі 20 доллар сомасын баламасына айырбастайды және пайдаланушы BTC-де төлейді to_currency әрқашан Fiat валюта коды емес, криптошталдық коды болуы керек.
subtractintegermin: 0max: 1000Клиентке алынатын төлем комиссиясының пайызыЕгер сізде 1% мөлшерлемесі болса, онда егер сіз 100 USDT-ге 100 USDT үшін шот-фактураны шығарсаңыз = 100 (клиент 100% комиссия төлейді), клиент 101 USDT төлеуге міндетті.
accuracy_payment_percentnumericmin: 0max: 50Төлемнің қолайлы еместігі.Мысалы, егер сіз 5 мәнін тапсаңыз, шот-фактура Клиент соманың 95% төлеген болса да, ақылы деп белгіленеді.Нақты төлем сомасы балансқа есептеледі
additional_datastringmax: 255nullСізге қосымша ақпарат (клиентке көрсетілмейді)
currenciesarrayСаудагердің параметрлерінен қол жетімді валюталар жиынтығы қолданылады (егер параметр орнатылмаған болса, барлық қолдау көрсетілетін криптоцерлер әдепкі бойынша қолданылады).Қол жетімді валюталар Сатушы параметрлері бөлімінде орнатылған.Төлеуге рұқсат етілген валюталардың тізімі. Бұл сіздің тұтынушыларыңыз шот-фактураларды төлеу үшін пайдалана алатын монеталардың тізімін шектегіңіз келсе пайдалы. Құрылым
except_currenciesarraynullТөлем үшін алынып тасталған валюталардың тізімі Құрылым
course_sourcestringmin: 4max: 20Қол жетімді мәндерBinanceBinanceP2PExmoKucoinЕгер өтпесе, криптомиканың бағамы қолданылады.Валюта бағамдары шот-фактурада айырбастау үшін қабылданады.
from_referral_codestringnullСұраныс жасаған саудагерге сілтеме жасаушыға код бойынша қосылады.Мысалы, сіз Cryptomus API арқылы шот-фактураларды жасайтын қосымшасыз, ал сіздің клиенттеріңіз басқа дүкендер болып табылады.
Олар сіздің API кілті мен сауда идентификаторын қосымшаңызға енгізеді және сіз олардың тіркелгі деректері бойынша сұраныстарды жіберіп, жүгіндік кодыңызды жібересіз.
Осылайша, сіздің клиенттеріңіз сіздің Cryptomus есептік жазбаңызға жіберіліп, олардың айналымынан табыс алады.
discount_percentintegermin: -99max: 100nullОң сандар:
сізге жеңілдіктер жасауға мүмкіндік береді.
Төлем үшін 5% жеңілдік орнатылған кезде, сіз құнды өтеуіңіз керек: 5
Теріс сандар:
сізге қосымша қосымша комиссия орнатуға мүмкіндік береді.
Төлем үшін қосымша комиссияны орнату үшін сіз: -10 мәнін беруіңіз керекШот-фактураны құру кезінде дисконт пайызы шот-фактураның нақты криптоциалды болуы болған жағдайда ғана ескеріледі.
is_refreshbooleanfalseОсы параметрді пайдаланып, сіз өмір сүру мерзімін жаңарта аласыз және егер өмір бойы жарамдылық мерзімі аяқталған болса, шот-фактураның жаңа мекен-жайын аласыз.Ол үшін сіз барлық қажетті параметрлерді тапсыруыңыз керек, және өткен тапсырыс_идімен шот-фактура жаңартылады.Тек 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 : btc
API ағымдағы бағам бойынша 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*Валюта кодексі
networkBlockChain желілік коды

Анықтама

Валюта кодексі

Анықтама

BlockChain желілік коды

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

Құрылымы except_currencies

ЕсімАнықтама
currency*Валюта кодексі
networkBlockChain желілік коды

Анықтама

Валюта кодексі

Анықтама

BlockChain желілік коды

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

Шот-фактурада тек валюта немесе to_currency парағы криптоцент болса және желі параметрі берілсе, белгілі бір крипточкалық және мекен-жайға ие болады (немесе желілік параметр берілген) (немесе CRYPTocurrence-да тек бір желі бар), мысалы BTC).

Мысал сұрау

Төменде қажетті параметрлер бар үлгі мысал келтірілген. Бұл жағдайда 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 болады.
networkBlockChain желілік коды
addressТөлем үшін әмиян мекен-жайы
fromТөлем жасалған әмиянның мекен-жайы
txidТранзакция хэш
payment_statusТөлем мәртебесі Барлық төлемдер мәртебесі
urlURL төлем парағы
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}
Еліктеу