Hisob-fakturani yaratish

post

https://api.cryptomus.com/v1/payment

Nusxa ko'chirmoq

Talab qilmoq

So'rov parametrlari

Ism	Parametr turi	Standart qiymat	Ta'rif
amount*	string		To'lanishi kerak bo'lgan miqdor.Agar miqdorda pennies bo'lsa, ularni ajratuvchi bilan yuboring. : 10.28
currency*	string		Valyuta kodi
order_id*	stringmin: 1max: 128alpha_dash		Tizimingizda buyurtma identifikatoriParametr alifbo harflari, raqamlar, pastki chiziqlar, pastki chiziqlardan iborat satr bo'lishi kerak. U hech qanday bo'sh joy yoki maxsus belgilar bo'lmasligi kerak. order_id savdogar schyot-fakturalar / statik hamyon / takrorlash to'lovlari ichida noyob bo'lishi kerakMavjud schyot-fakturani topganda order_id bilan biz o'z ma'lumotlarini qaytaramiz, yangi faktura yaratilmaydi.
network	string	null	BlockChain tarmog'i kodi
url_return	stringmin: 6max: 255url	null	To'lovni to'lashdan oldin foydalanuvchi to'lov shaklida tugmachani bosishi va ushbu URL manzilidagi do'kon sahifasiga qaytishi mumkin.
url_success	stringmin: 6max: 255url	null	Muvaffaqiyatli to'lovdan so'ng foydalanuvchi to'lov shaklidagi tugmachani bosishi va ushbu URL manziliga qaytishi mumkin.
url_callback	stringmin: 6max: 255url	null	To'lov holati bilan qaysi WebHook yuboriladi
is_payment_multiple	boolean	true	Foydalanuvchi qolgan miqdorni to'lashiga ruxsat beriladimi. Bu foydalanuvchi bitta bitimga schyot-fakturaning to'liq miqdorini to'lamagan bo'lsa, siz unga to'liq miqdorni to'lashga ruxsat berishni xohlaysiz. Agar siz ushbu xususiyatni o'chirib qo'ysangiz, faktura birinchi to'lovni olgandan so'ng yakunlanadi va siz hisobingizga mablag 'olasiz.
lifetime	integermin: 300max: 43200	3600	Berilgan hisob-fakturaning ishlashi (soniyalarda)
to_currency	string		Parametr fakturaning miqdorini almashtirish uchun maqsadli valyutani belgilash uchun ishlatiladi. Hisob-fakturani yaratishda siz miqdor va valyutani taqdim etasiz va API ushbu summani to_currency Mdagi ekvivalent qiymatga o'zgartirasiz.methods.For example, to create an invoice for 20 USD in bitcoinAPI 20 AQSh dollari miqdorini BTCda joriy ayirboshlash kursi asosida va foydalanuvchi BTCda to'laydi to_currency har doim Fiat valyuta kodi emas, balki CryptoSurrencection Kodeksi bo'lishi kerak.
subtract	integermin: 0max: 100	0	Mijozga to'lanadigan to'lov komissiyasining foiziAgar sizda 1% stavka bo'lsa, unda 100 AQSh dollari uchun schyot-fakturani yaratsangiz (Mijoz 100% komissiya to'laydi), mijoz 101 USDt to'lashi kerak bo'ladi.
accuracy_payment_percent	numericmin: 0max: 5	0	To'lovda tushunarli xato.Masalan, agar siz 5 qiymatdan o'tsangiz, schyot-faktura mijoz atigi 95% to'lagan bo'lsa ham, hisob-fakturasi to'lanadi.Haqiqiy to'lov miqdori balansga tushadi
additional_data	stringmax: 255	null	Siz uchun qo'shimcha ma'lumot (mijozga ko'rsatilmagan)
currencies	array	Savdogarlaringiz sozlamalaridan mavjud valyutalar qo'llaniladi (agar parametr o'rnatilmagan bo'lsa, qo'llab-quvvatlanadigan krapbatlar sukut bo'yicha qo'llaniladi).Mavjud valyutalar savdogar sozlamalari bo'limiga o'rnatiladi.	To'lov uchun ruxsat berilgan valyutalar ro'yxati. Agar siz o'z mijozlaringiz schyot-fakturalarni to'lash uchun foydalanishi mumkin bo'lgan tangalar ro'yxatini cheklamoqchi bo'lsangiz, bu foydalidir. Tuzilish
except_currencies	array	null	To'lov uchun chiqariladigan valyutalar ro'yxati Tuzilish
course_source	stringmin: 4max: 20Mavjud qiymatlar• Binance• BinanceP2P• Exmo• Kucoin	Agar o'tgan bo'lsa, kriptous almashinuvi kurslari qo'llaniladi.	Hisobot stavkalari hisob-fakturada qabul qilinganligi uchun xizmat.
from_referral_code	string	null	So'rovni kiritadigan savdogar elektron pochta manziliga kiradi.Masalan, siz kriptous API orqali schyot-fakturalarni keltirib chiqaradigan dasturingiz va mijozlaringiz boshqa do'konlardir. ular sizning arizangizda API kaliti va savdo markazi identifikatorini kiritadilar va siz so'rovlarni o'z ma'lumotlari bilan yuborasiz va tavsiyanoma kodini topshirasiz.Shunday qilib, sizning mijozlaringiz sizning kriptomus hisob qaydnomangizda tavba qilishadi va siz ularning aylanmasidan daromad olasiz.
discount_percent	integermin: -99max: 100	null	Ijobiy raqamlar: chegirma o'rnatishga imkon beradi. hi to'lov uchun 5% chegirmani belgilash uchun siz qiymatdan o'tishingiz kerak: 5Salbiy raqamlar: sizga maxsus qo'shimcha komissiya o'rnatishga imkon beradi.To'lov uchun 10% qo'shimcha komissiyani belgilash uchun siz qiymatdan o'tishingiz kerak: -10Hisob-fakturani yaratishda chegirma foizi hisobga olinadi, agar hisob-fakturaning o'ziga xos kriptofiysti bo'lsa.
is_refresh	boolean	false	Ushbu parametrdan foydalanib, siz umr bo'yi yangilashingiz va faktura muddati tugagan bo'lsa, fakturaning yangi manzilini olishingiz mumkin.Buning uchun siz barcha kerakli parametrlarni yuborishingiz kerak va buyurtmani o'tkazib yuborilgan schyot-faktura yangilanadi.Faqat address, payment_status va expired_at o'zgartirilgan. Boshqa hech qanday maydonlar o'zgarmaydi, parametrlardan qat'i nazar, parametrlardan qat'iy nazar.

Parametr turi

string

Ta'rif

To'lanishi kerak bo'lgan miqdor.Agar miqdorda pennies bo'lsa, ularni ajratuvchi bilan yuboring.
: 10.28

Parametr turi

string

Ta'rif

Valyuta kodi

Parametr turi

stringmin: 1max: 128alpha_dash

Ta'rif

Tizimingizda buyurtma identifikatoriParametr alifbo harflari, raqamlar, pastki chiziqlar, pastki chiziqlardan iborat satr bo'lishi kerak. U hech qanday bo'sh joy yoki maxsus belgilar bo'lmasligi kerak. order_id savdogar schyot-fakturalar / statik hamyon / takrorlash to'lovlari ichida noyob bo'lishi kerakMavjud schyot-fakturani topganda order_id bilan biz o'z ma'lumotlarini qaytaramiz, yangi faktura yaratilmaydi.

Parametr turi

string

Ta'rif

BlockChain tarmog'i kodi

Parametr turi

stringmin: 6max: 255url

Ta'rif

To'lovni to'lashdan oldin foydalanuvchi to'lov shaklida tugmachani bosishi va ushbu URL manzilidagi do'kon sahifasiga qaytishi mumkin.

Parametr turi

stringmin: 6max: 255url

Ta'rif

Muvaffaqiyatli to'lovdan so'ng foydalanuvchi to'lov shaklidagi tugmachani bosishi va ushbu URL manziliga qaytishi mumkin.

Parametr turi

stringmin: 6max: 255url

Ta'rif

To'lov holati bilan qaysi WebHook yuboriladi

Parametr turi

boolean

Ta'rif

Foydalanuvchi qolgan miqdorni to'lashiga ruxsat beriladimi. Bu foydalanuvchi bitta bitimga schyot-fakturaning to'liq miqdorini to'lamagan bo'lsa, siz unga to'liq miqdorni to'lashga ruxsat berishni xohlaysiz. Agar siz ushbu xususiyatni o'chirib qo'ysangiz, faktura birinchi to'lovni olgandan so'ng yakunlanadi va siz hisobingizga mablag 'olasiz.

Parametr turi

integermin: 300max: 43200

Ta'rif

Berilgan hisob-fakturaning ishlashi (soniyalarda)

Parametr turi

string

Ta'rif

Parametr fakturaning miqdorini almashtirish uchun maqsadli valyutani belgilash uchun ishlatiladi. Hisob-fakturani yaratishda siz miqdor va valyutani taqdim etasiz va API ushbu summani to_currency Mdagi ekvivalent qiymatga o'zgartirasiz.methods.For example, to create an invoice for 20 USD in bitcoinAPI 20 AQSh dollari miqdorini BTCda joriy ayirboshlash kursi asosida va foydalanuvchi BTCda to'laydi to_currency har doim Fiat valyuta kodi emas, balki CryptoSurrencection Kodeksi bo'lishi kerak.

Parametr turi

integermin: 0max: 100

Ta'rif

Mijozga to'lanadigan to'lov komissiyasining foiziAgar sizda 1% stavka bo'lsa, unda 100 AQSh dollari uchun schyot-fakturani yaratsangiz (Mijoz 100% komissiya to'laydi), mijoz 101 USDt to'lashi kerak bo'ladi.

Parametr turi

numericmin: 0max: 5

Ta'rif

To'lovda tushunarli xato.Masalan, agar siz 5 qiymatdan o'tsangiz, schyot-faktura mijoz atigi 95% to'lagan bo'lsa ham, hisob-fakturasi to'lanadi.Haqiqiy to'lov miqdori balansga tushadi

Parametr turi

stringmax: 255

Ta'rif

Siz uchun qo'shimcha ma'lumot (mijozga ko'rsatilmagan)

Parametr turi

array

Ta'rif

To'lov uchun ruxsat berilgan valyutalar ro'yxati. Agar siz o'z mijozlaringiz schyot-fakturalarni to'lash uchun foydalanishi mumkin bo'lgan tangalar ro'yxatini cheklamoqchi bo'lsangiz, bu foydalidir. Tuzilish

Parametr turi

array

Ta'rif

To'lov uchun chiqariladigan valyutalar ro'yxati Tuzilish

Parametr turi

stringmin: 4max: 20
Mavjud qiymatlar- Binance- BinanceP2P- Exmo- Kucoin

Ta'rif

Hisobot stavkalari hisob-fakturada qabul qilinganligi uchun xizmat.

Parametr turi

string

Ta'rif

So'rovni kiritadigan savdogar elektron pochta manziliga kiradi.Masalan, siz kriptous API orqali schyot-fakturalarni keltirib chiqaradigan dasturingiz va mijozlaringiz boshqa do'konlardir.
ular sizning arizangizda API kaliti va savdo markazi identifikatorini kiritadilar va siz so'rovlarni o'z ma'lumotlari bilan yuborasiz va tavsiyanoma kodini topshirasiz.Shunday qilib, sizning mijozlaringiz sizning kriptomus hisob qaydnomangizda tavba qilishadi va siz ularning aylanmasidan daromad olasiz.

Parametr turi

integermin: -99max: 100

Ta'rif

Ijobiy raqamlar:
chegirma o'rnatishga imkon beradi.
hi to'lov uchun 5% chegirmani belgilash uchun siz qiymatdan o'tishingiz kerak: 5Salbiy raqamlar:
sizga maxsus qo'shimcha komissiya o'rnatishga imkon beradi.To'lov uchun 10% qo'shimcha komissiyani belgilash uchun siz qiymatdan o'tishingiz kerak: -10Hisob-fakturani yaratishda chegirma foizi hisobga olinadi, agar hisob-fakturaning o'ziga xos kriptofiysti bo'lsa.

Parametr turi

boolean

Ta'rif

Ushbu parametrdan foydalanib, siz umr bo'yi yangilashingiz va faktura muddati tugagan bo'lsa, fakturaning yangi manzilini olishingiz mumkin.Buning uchun siz barcha kerakli parametrlarni yuborishingiz kerak va buyurtmani o'tkazib yuborilgan schyot-faktura yangilanadi.Faqat address, payment_status va expired_at o'zgartirilgan. Boshqa hech qanday maydonlar o'zgarmaydi, parametrlardan qat'i nazar, parametrlardan qat'iy nazar.

* - Majburiy parametr

Tarkibi Valyutalar

Ism	Ta'rif
currency*	Valyuta kodi
network	BlockChain tarmog'i kodi

: Ta'rif
Valyuta kodi
: Ta'rif
BlockChain tarmog'i kodi

* - Majburiy parametr

Tarkibi except_currencies

Ism	Ta'rif
currency*	Valyuta kodi
network	BlockChain tarmog'i kodi

: Ta'rif
Valyuta kodi
: Ta'rif
BlockChain tarmog'i kodi

* - Majburiy parametr

Hisob-faktura yaratish vaqtida o'ziga xos kriptofiylik va manzili bo'ladi, faqat valyuta yoki to_currency parametri kriptcocurti va tarmoq parametridir (yoki Cryptocurity faqat bitta tarmoqqa ega, masalan, BTC).

Misolga misol

Quyida zarur bo'lgan minimal parametrlar bo'yicha namunaviy misol keltirilgan. Bunday holda, Fiat valyuta AQSh dollari bilan schyot-faktura yaratiladi. To'lov sahifasida foydalanuvchi ushbu to'lovni to'lash uchun kriptocujlik va tarmoqni tanlashi mumkin.


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"
}'

Nusxa ko'chirmoq

Javob

Javob parametrlari

Ism	Ta'rif
uuid	Uuid hisob-fakturasi
order_id	Tizimingizda buyurtma identifikatori
amount	Hisob-faktura miqdori
payment_amount	Mijoz tomonidan to'langan summa
payer_amount	payer_currency Tab германдық идентификаторында. URL мекен-жайы мен сипаттамаларын енгізіп, Жіберу түймесін басыңыз.
discount_percent	Talabnoma parametrlarida o'tkazilgan chegirma yoki qo'shimcha komissiya foizi
discount	Kriptcolatsiyada chegirma yoki qo'shimcha komissiya.Masalan, hisob-faktura miqdori 15 AQSh dollari va chegirma_5, chegirma qiymati 80.75 ga teng bo'ladiI.E. amount discount = payer_amount
payer_currency	Mijoz to'lovni amalga oshirishi kerak bo'lgan valyuta.
currency	Hisob-faktura valyuta kodi
merchant_amount	Sizning muvozanatingizga kiritiladigan kripto-da. Agar foto-faktura to'lovi_currentation ko'rsatilmagan bo'lsa, qiymat nol bo'ladi.
network	BlockChain tarmog'i kodi
address	To'lov uchun hamyon manzili
from	To'lov amalga oshirilgan hamyonning manzili
txid	Bitim xash
payment_status	To'lov holati Barcha to'lov holatlari
url	URL to'lov sahifasi
expired_at	Hisob-faktura muddati tugashi
is_final	Hisob-faktura yakunlanadimi.Hisob-faktura tugagach, hisob-fakturani to'lash mumkin emas (u to'langan yoki muddati tugagan)
additional_data	Qo'shimcha ma'lumot
created_at	Hisob-fakturaning yaratilishi. Vaqtzone - UTC + 3
updated_at	Oxirgi schyot-faktura yangilangan sanasi. Vaqtzone - UTC + 3

: Ta'rif
Uuid hisob-fakturasi
: Ta'rif
Tizimingizda buyurtma identifikatori
: Ta'rif
Hisob-faktura miqdori
: Ta'rif
Mijoz tomonidan to'langan summa
: Ta'rif
payer_currency Tab германдық идентификаторында. URL мекен-жайы мен сипаттамаларын енгізіп, Жіберу түймесін басыңыз.
: Ta'rif
Talabnoma parametrlarida o'tkazilgan chegirma yoki qo'shimcha komissiya foizi
: Ta'rif
Kriptcolatsiyada chegirma yoki qo'shimcha komissiya.Masalan, hisob-faktura miqdori 15 AQSh dollari va chegirma_5, chegirma qiymati 80.75 ga teng bo'ladiI.E. amount discount = payer_amount
: Ta'rif
Mijoz to'lovni amalga oshirishi kerak bo'lgan valyuta.
: Ta'rif
Hisob-faktura valyuta kodi
: Ta'rif
Sizning muvozanatingizga kiritiladigan kripto-da. Agar foto-faktura to'lovi_currentation ko'rsatilmagan bo'lsa, qiymat nol bo'ladi.
: Ta'rif
BlockChain tarmog'i kodi
: Ta'rif
To'lov uchun hamyon manzili
: Ta'rif
To'lov amalga oshirilgan hamyonning manzili
: Ta'rif
Bitim xash
: Ta'rif
To'lov holati Barcha to'lov holatlari
: Ta'rif
URL to'lov sahifasi
: Ta'rif
Hisob-faktura muddati tugashi
: Ta'rif
Hisob-faktura yakunlanadimi.Hisob-faktura tugagach, hisob-fakturani to'lash mumkin emas (u to'langan yoki muddati tugagan)
: Ta'rif
Qo'shimcha ma'lumot
: Ta'rif
Hisob-fakturaning yaratilishi. Vaqtzone - UTC + 3
: Ta'rif
Oxirgi schyot-faktura yangilangan sanasi. Vaqtzone - UTC + 3

Javob namunasi


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}

Nusxa ko'chirmoq

Boshqa misollar

Tenon tarmog'ida 20 AQSh dollari uchun schyot-fakturani yaratish uchun ma'lumotlarni talab qiling. Hisob-faktura yaratish paytida manzil bo'ladi.


1{
2	"amount": "20",
3	"currency": "USDT",
4	"order_id": "1",
5	"network": "tron"
6}

Nusxa ko'chirmoq

25 AQSh dollari uchun schyot-fakturani yaratish va mijozlarga har qanday tarmoqda faqat USDT orqali to'lashiga ruxsat bering.


1{
2	"amount": "25",
3	"currency": "USD",
4	"order_id": "1",
5	"to_currency": "USDT"
6}

Nusxa ko'chirmoq

25 AQSh dollari uchun schyot-fakturani yaratish va mijozlarga faqat tron tarmog'ida faqat USDT orqali to'lashlarini so'rang. Hisob-faktura yaratish paytida manzil bo'ladi.


1{
2	"amount": "25",
3	"currency": "USD",
4	"order_id": "1",
5	"to_currency": "USDT",
6	"network": "tron"
7}

Nusxa ko'chirmoq

20 USDT uchun schyot-fakturani yaratish va mijozlarga barcha mavjud tarmoqlarda to'lashiga ruxsat bering


1{
2	"amount": "20",
3	"currency": "USDT",
4	"order_id": "1"
5}

Nusxa ko'chirmoq

20 AQSh dollari uchun schyot-fakturani yaratish va mijozlarga faqat bitikdan to'lashga ruxsat berish uchun ma'lumotlarni talab qiling. Hisob-faktura yaratish paytida manzil bo'ladi.


1{
2	"amount": "20",
3	"currency": "USD",
4	"order_id": "1",
5	"to_currency": "BTC"
6}

Nusxa ko'chirmoq

0,5 BTC uchun schyot-fakturani yaratish va mijozlarga faqat bitkoinda to'lashiga ruxsat berish. Hisob-faktura yaratish paytida manzil bo'ladi.


1{
2	"amount": "0.5",
3	"currency": "BTC",
4	"order_id": "1"
5}

Nusxa ko'chirmoq

Mumkin bo'lgan xatolar

Tasdiqlash xatolari

kod : 422

Misol javoblar:

Agar ba'zi parametr talab qilinsa va berilmasa:


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

Nusxa ko'chirmoq

Agar siz qo'llab-quvvatlanmaydigan tarmoq kodini taqdim qilsangiz


1{
2    "state": 1,
3    "message": "The network was not found"
4}

Nusxa ko'chirmoq

Agar biz currency parametrida taqdim eta olmaymiz:


1{
2    "state": 1,
3    "message": "The currency was not found"
4}

Nusxa ko'chirmoq

Agar sizning to'lovlaringiz bloklangan bo'lsa. Bunday holda siz yordam berishingiz kerak.


1{
2    "state": 1,
3    "message": "You are forbidden"
4}

Nusxa ko'chirmoq

Agar biz to_currency parametrida o'tgan valyutaning to'lov xizmatini topmasak:


1{
2    "state": 1,
3    "message": "Not found service to_currency"
4}

Nusxa ko'chirmoq

Agar tasodifan to_currency o'zgartirganda:


1{
2    "state": 1,
3    "message": "Error convert to_currency"
4}

Nusxa ko'chirmoq

Agar to'lov summasi kriptcolatsiya uchun eng kam qo'llab-quvvatlanadigan summadan kam bo'lsa, ushbu xato xabarini olasiz:


1{
2    "state": 1,
3    "message": "Minimum amount 0.5 USDT"
4}

Nusxa ko'chirmoq

Agar to'lov miqdori kriptofiystit uchun qo'llab-quvvatlanadigan maksimal miqdordan katta bo'lsa, siz ushbu xato xabarini olasiz:


1{
2    "state": 1,
3    "message": "Maximum amount 10000000 USDT"
4}

Nusxa ko'chirmoq

Agar siz to'lovning kriptcolatsial yordamida faol savdo-sotiq hamyoningiz bo'lmasa, siz ushbu xatoni olasiz:


1{
2    "state": 1,
3    "message": "Wallet not found"
4}

Nusxa ko'chirmoq

Agar texnik ish sodir bo'lsa va to'lov vaqtincha mavjud bo'lmasa, ushbu xato xabarlarini olishingiz mumkin:


1{
2    "state": 1,
3    "message": "Gateway error"
4}

Nusxa ko'chirmoq


1{
2    "state": 1,
3    "message": "The terminal was not found"
4}

Nusxa ko'chirmoq


1{
2    "state": 1,
3    "message": "Server error"
4}

Nusxa ko'chirmoq

Serverdagi ichki xatolik

kod : 500

Misol javoblar:


1{
2	"message": "Server error, #1",
3	"code": 500,
4	"error": null
5}

Nusxa ko'chirmoq