Fatura Oluşturma
Rica etmek
Sorgu parametreleri
| İsim | Parametre türü | Varsayılan değer | Tanım |
|---|---|---|---|
| amount* | string | - | Ödenecek tutar.Miktarda pennies varsa, o zaman bir ayırıcı ile gönderin '. Örnek: 10.28 |
| currency* | string | - | Para birimi kodu |
| order_id* | stringmin: 1max: 100alpha_dash | - | Sisteminizde Sipariş KimliğiParametre, alfabetik karakterler, sayılar, alt çizgiler ve çizgilerden oluşan bir dize olmalıdır. Herhangi bir alan veya özel karakter içermemelidir. order_id, satıcı faturalar/statik cüzdanlar/nüks ödemeleri içinde benzersiz olmalıdır order_id ile mevcut bir fatura bulduğumuzda, ayrıntılarını döndürürüz, yeni bir fatura oluşturulmayacaktır. |
| network | string | null | Blockchain Ağ Kodu |
| url_return | stringmin: 6max: 255url | null | Ödemeden önce, kullanıcı ödeme formundaki düğmeye tıklayabilir ve bu URL'deki mağaza sayfasına geri dönebilir. |
| url_success | stringmin: 6max: 255url | null | Başarılı ödemeden sonra kullanıcı ödeme formundaki düğmeye tıklayabilir ve bu URL'ye geri dönebilir. |
| url_callback | stringmin: 6max: 255url | null | Ödeme durumuna sahip webhooks'un hangi URL'si gönderilecek |
| is_payment_multiple | boolean | true | Kullanıcının kalan tutarı ödemesine izin verilip verilmeyeceği. Bu, kullanıcı bir işlem için faturanın tüm tutarını ödemediğinde ve tam tutarda ödeme yapmasına izin vermek istediğinizde kullanışlıdır. Bu özelliği devre dışı bırakırsanız, fatura ilk ödemeyi aldıktan sonra sonuçlandırır ve bakiyenize fon alırsınız. |
| lifetime | integermin: 300max: 43200 | 3600 | Yayınlanan faturanın ömrü (saniyeler içinde) |
| to_currency | string | - | Parametre, fatura tutarını dönüştürmek için hedef para birimini belirtmek için kullanılır. Bir fatura oluştururken, bir miktar ve para birimi sağlarsınız ve API bu miktarı to_currency'deki eşdeğer değere dönüştürür.Örneğin, Bitcoin'de 20 USD için bir fatura oluşturmak için: amount: 20 currency: usd to_currency : btcAPI, mevcut döviz kuruna göre 20 USD tutarı BTC'de eşdeğerine dönüştürecek ve kullanıcı BTC'de ödeyecek to_currency her zaman bir fiat para kodu değil, kripto para kodu olmalıdır. |
| subtract | integermin: 0max: 100 | 0 | Müşteriye tahsil edilen ödeme komisyonunun yüzdesi% 1 oranınız varsa, 100 USDT için bir fatura oluşturursanız = 100 (müşteri% 100 komisyon öder), müşteri 101 USDT ödemek zorunda kalacaktır. |
| accuracy_payment_percent | numericmin: 0max: 5 | 0 | Ödemede kabul edilebilir yanlışlık.Örneğin, 5 değerini geçerseniz, müşteri tutarın sadece% 95'ini ödese bile fatura ödenir.Gerçek ödeme tutarı bakiyeye yatırılacaktır |
| additional_data | stringmax: 255 | null | Sizin için ek bilgi (müşteriye gösterilmemiştir) |
| currencies | array | Satıcınızın ayarlarından mevcut para birimleri dizisi kullanılır (parametre ayarlanmamışsa, desteklenen tüm kripto para birimleri varsayılan olarak kullanılır).Mevcut para birimleri satıcı ayarları bölümünde ayarlanmıştır. | Ödeme için izin verilen para birimlerinin listesi. Müşterilerinizin fatura ödemek için kullanabileceği para listesini sınırlamak istiyorsanız bu yararlıdır. Yapı |
| except_currencies | array | null | Ödeme için hariç tutulan para birimlerinin listesi Yapı |
| from_referral_code | string | null | İsteği yapan satıcı, bir yönlendiriciye kodla bağlanır.Örneğin, Cryptomus API'si aracılığıyla fatura üreten bir uygulamasınız ve müşterileriniz diğer mağazalardır. Uygulamanızda API anahtarlarını ve satıcı kimliklerini girerler ve kimlik bilgileriyle istek gönderir ve yönlendirme kodunuzu geçer.Böylece, müşterileriniz Cryptomus hesabınızda sevk haline gelir ve cirolarından gelir elde edersiniz. |
| discount_percent | integermin: -99max: 90 | null | Pozitif Sayılar: indirim ayarlamanızı sağlar. Ödeme için% 5 indirim ayarlamak için bir değer geçmelisiniz: 5Negatif sayılar: Özel ek komisyon ayarlamanıza izin verir.Ödeme için% 10'luk ek bir komisyon ayarlamak için bir değer geçmelisiniz: -10Bir fatura oluştururken indirim yüzdesi, yalnızca faturada belirli bir kripto para birimi varsa dikkate alınır. |
| is_refresh | boolean | false | Bu parametreyi kullanarak, ömür boyu süresi dolmuşsa ömür boyu güncelleyebilir ve fatura için yeni bir adres alabilirsiniz.Bunu yapmak için, gerekli tüm parametreleri geçmeniz gerekir ve geçti order_id ile fatura yenilenir.Yalnızca address , payment_status ve expired_at değiştirildi. Geçen parametrelere bakılmaksızın başka hiçbir alan değiştirilmez. |
Parametre türü
stringTanım
Ödenecek tutar.Miktarda pennies varsa, o zaman bir ayırıcı ile gönderin '.
Örnek: 10.28Parametre türü
stringTanım
Para birimi koduParametre türü
stringmin: 1max: 100alpha_dashTanım
Sisteminizde Sipariş KimliğiParametre, alfabetik karakterler, sayılar, alt çizgiler ve çizgilerden oluşan bir dize olmalıdır. Herhangi bir alan veya özel karakter içermemelidir. order_id, satıcı faturalar/statik cüzdanlar/nüks ödemeleri içinde benzersiz olmalıdır order_id ile mevcut bir fatura bulduğumuzda, ayrıntılarını döndürürüz, yeni bir fatura oluşturulmayacaktır.Parametre türü
stringVarsayılan değer
nullTanım
Blockchain Ağ KoduParametre türü
stringmin: 6max: 255urlVarsayılan değer
nullTanım
Ödemeden önce, kullanıcı ödeme formundaki düğmeye tıklayabilir ve bu URL'deki mağaza sayfasına geri dönebilir.Parametre türü
stringmin: 6max: 255urlVarsayılan değer
nullTanım
Başarılı ödemeden sonra kullanıcı ödeme formundaki düğmeye tıklayabilir ve bu URL'ye geri dönebilir.Parametre türü
stringmin: 6max: 255urlVarsayılan değer
nullTanım
Ödeme durumuna sahip webhooks'un hangi URL'si gönderilecekParametre türü
booleanVarsayılan değer
trueTanım
Kullanıcının kalan tutarı ödemesine izin verilip verilmeyeceği. Bu, kullanıcı bir işlem için faturanın tüm tutarını ödemediğinde ve tam tutarda ödeme yapmasına izin vermek istediğinizde kullanışlıdır. Bu özelliği devre dışı bırakırsanız, fatura ilk ödemeyi aldıktan sonra sonuçlandırır ve bakiyenize fon alırsınız.Parametre türü
integermin: 300max: 43200Varsayılan değer
3600Tanım
Yayınlanan faturanın ömrü (saniyeler içinde)Parametre türü
stringTanım
Parametre, fatura tutarını dönüştürmek için hedef para birimini belirtmek için kullanılır. Bir fatura oluştururken, bir miktar ve para birimi sağlarsınız ve API bu miktarı to_currency'deki eşdeğer değere dönüştürür.Örneğin, Bitcoin'de 20 USD için bir fatura oluşturmak için:
amount: 20
currency: usd
to_currency : btcAPI, mevcut döviz kuruna göre 20 USD tutarı BTC'de eşdeğerine dönüştürecek ve kullanıcı BTC'de ödeyecek to_currency her zaman bir fiat para kodu değil, kripto para kodu olmalıdır.Parametre türü
integermin: 0max: 100Varsayılan değer
0Tanım
Müşteriye tahsil edilen ödeme komisyonunun yüzdesi% 1 oranınız varsa, 100 USDT için bir fatura oluşturursanız = 100 (müşteri% 100 komisyon öder), müşteri 101 USDT ödemek zorunda kalacaktır.Parametre türü
numericmin: 0max: 5Varsayılan değer
0Tanım
Ödemede kabul edilebilir yanlışlık.Örneğin, 5 değerini geçerseniz, müşteri tutarın sadece% 95'ini ödese bile fatura ödenir.Gerçek ödeme tutarı bakiyeye yatırılacaktırParametre türü
stringmax: 255Varsayılan değer
nullTanım
Sizin için ek bilgi (müşteriye gösterilmemiştir)Parametre türü
arrayVarsayılan değer
Satıcınızın ayarlarından mevcut para birimleri dizisi kullanılır (parametre ayarlanmamışsa, desteklenen tüm kripto para birimleri varsayılan olarak kullanılır).Mevcut para birimleri satıcı ayarları bölümünde ayarlanmıştır.Tanım
Ödeme için izin verilen para birimlerinin listesi. Müşterilerinizin fatura ödemek için kullanabileceği para listesini sınırlamak istiyorsanız bu yararlıdır. YapıParametre türü
stringVarsayılan değer
nullTanım
İsteği yapan satıcı, bir yönlendiriciye kodla bağlanır.Örneğin, Cryptomus API'si aracılığıyla fatura üreten bir uygulamasınız ve müşterileriniz diğer mağazalardır.
Uygulamanızda API anahtarlarını ve satıcı kimliklerini girerler ve kimlik bilgileriyle istek gönderir ve yönlendirme kodunuzu geçer.Böylece, müşterileriniz Cryptomus hesabınızda sevk haline gelir ve cirolarından gelir elde edersiniz.Parametre türü
integermin: -99max: 90Varsayılan değer
nullTanım
Pozitif Sayılar:
indirim ayarlamanızı sağlar.
Ödeme için% 5 indirim ayarlamak için bir değer geçmelisiniz: 5Negatif sayılar:
Özel ek komisyon ayarlamanıza izin verir.Ödeme için% 10'luk ek bir komisyon ayarlamak için bir değer geçmelisiniz: -10Bir fatura oluştururken indirim yüzdesi, yalnızca faturada belirli bir kripto para birimi varsa dikkate alınır.Parametre türü
booleanVarsayılan değer
falseTanım
Bu parametreyi kullanarak, ömür boyu süresi dolmuşsa ömür boyu güncelleyebilir ve fatura için yeni bir adres alabilirsiniz.Bunu yapmak için, gerekli tüm parametreleri geçmeniz gerekir ve geçti order_id ile fatura yenilenir.Yalnızca address , payment_status ve expired_at değiştirildi. Geçen parametrelere bakılmaksızın başka hiçbir alan değiştirilmez.
* - zorunlu parametre
Yapısı Para birimleri
| İsim | Tanım |
|---|---|
| currency* | Para birimi kodu |
| network | Blockchain Ağ Kodu |
Tanım
Para birimi koduTanım
Blockchain Ağ Kodu
* - zorunlu parametre
Yapısı except_currencies
| İsim | Tanım |
|---|---|
| currency* | Para birimi kodu |
| network | Blockchain Ağ Kodu |
Tanım
Para birimi koduTanım
Blockchain Ağ Kodu
* - zorunlu parametre
Talep Örneği
Aşağıda, gerekli minimum sayıda parametreye sahip örnek bir örnek verilmiştir. Bu durumda, fiat para birimi USD ile bir fatura oluşturulacaktır. Ödeme sayfasında, kullanıcı bu faturayı ödemek için kripto para birimini ve ağı seçebilecektir.
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"
}'KopyalaCevap
Yanıt parametreleri
| İsim | Parametre türü | Tanım |
|---|---|---|
| uuid | string | Fatura uuid |
| order_id | string|null | Sisteminizde Sipariş Kimliği |
| amount | string | Faturanın miktarı |
| payment_amount | string|null | Müşteri tarafından ödenen miktar |
| payment_amount_usd | string|null | USD'de Müşteri tarafından gerçekten ödenen tutar |
| payer_amount | string|null | Müşterinin bir indirim veya ek komisyon da dahil olmak üzere ödemesi gereken payer_currency . |
| payer_amount_exchange_rate | string|null | Ödeme yapıldığında uygulanan döviz kuru |
| discount_percent | integer|null | İstek parametrelerinde geçirilen indirim veya ek komisyon yüzdesi |
| discount | string | Kripto para biriminde gerçek indirim veya ek komisyon miktarı.Örneğin, fatura tutarı 15 USDT ve indirim_perent ise -5 ise, indirim değeri -0.75 olacaktıryani amount + discount = payer_amount |
| payer_currency | string|null | Müşterinin ödemeyi yapması gereken para birimi. |
| currency | string | Fatura para kodu |
| comments | string|null | Yorum |
| merchant_amount | string|null | Bakiyenize yatırılacak kripto tutarı. Payer_currency fatura belirtilmezse, değer boş olacaktır. |
| network | string|null | Blockchain Ağ Kodu |
| address | string|null | Ödeme için cüzdan adresi |
| from | string|null | Ödemenin yapıldığı cüzdanın adresi |
| txid | string|null | İşlem karma |
| payment_status | string | Ödeme durumu Tüm Ödeme Durumları |
| url | string | URL Ödeme Sayfası |
| expired_at | integer|null | Faturanın son kullanma zaman damgası |
| status | string | Ödeme durumu Tüm Ödeme Durumları |
| is_final | boolean | Faturanın sonuçlanıp sonuçlanmadığı.Fatura sonuçlandırıldığında bir fatura ödemek imkansızdır (ödenir veya süresi dolmuş) |
| additional_data | string|null | Ek Bilgiler |
| created_at | string|null | Faturanın Oluşturulması Tarihi. Timezone UTC+3'tür |
| updated_at | string|null | Son fatura güncellenen tarih. Timezone UTC+3'tür |
| commission | string|null | Cryptomus Komisyon Miktarı |
| address_qr_code | string|null | Adres QR kodu |
| convert | Ödemenin otomatik olarak dönüştürüleceği para birimi hakkında bilgi. Dönüştürme Payer_currency 'den USDT'ye gerçekleştirilirconvert_currency_code parametresi geçirilirse mevcuttur. | |
| convert.to_currency | string | Ödemenin dönüştürüleceği para birimi kodu |
| convert.commission | string | Dönüşüm ücreti |
| convert.rate | string|null | Dönüşüm oranı |
| convert.amount | string|null | Tüm komisyonlar çıkarıldığında, satıcının bakiyesine eklenen to_currency dönüşüm miktarı. |
| convert_from | Yanlış ödemenin hangi para biriminden yapıldığına dair bilgi.Ödeme hatalıysa belirtin. | |
| convert_from.from_currency | string | Para biriminden |
| convert_from.from_amount | string|null | Miktar |
| convert_from.from_network | string|null | Blockchain Ağ Kodu |
Parametre türü
stringTanım
Fatura uuidParametre türü
string|nullTanım
Sisteminizde Sipariş KimliğiParametre türü
stringTanım
Faturanın miktarıParametre türü
string|nullTanım
Müşteri tarafından ödenen miktarParametre türü
string|nullTanım
USD'de Müşteri tarafından gerçekten ödenen tutarParametre türü
string|nullTanım
Müşterinin bir indirim veya ek komisyon da dahil olmak üzere ödemesi gereken payer_currency .Parametre türü
string|nullTanım
Ödeme yapıldığında uygulanan döviz kuruParametre türü
integer|nullTanım
İstek parametrelerinde geçirilen indirim veya ek komisyon yüzdesiParametre türü
stringTanım
Kripto para biriminde gerçek indirim veya ek komisyon miktarı.Örneğin, fatura tutarı 15 USDT ve indirim_perent ise -5 ise, indirim değeri -0.75 olacaktıryani amount + discount = payer_amountParametre türü
string|nullTanım
Müşterinin ödemeyi yapması gereken para birimi.Parametre türü
stringTanım
Fatura para koduParametre türü
string|nullTanım
YorumParametre türü
string|nullTanım
Bakiyenize yatırılacak kripto tutarı. Payer_currency fatura belirtilmezse, değer boş olacaktır.Parametre türü
string|nullTanım
Blockchain Ağ KoduParametre türü
string|nullTanım
Ödeme için cüzdan adresiParametre türü
string|nullTanım
Ödemenin yapıldığı cüzdanın adresiParametre türü
string|nullTanım
İşlem karmaParametre türü
stringParametre türü
stringTanım
URL Ödeme SayfasıParametre türü
integer|nullTanım
Faturanın son kullanma zaman damgasıParametre türü
stringParametre türü
booleanTanım
Faturanın sonuçlanıp sonuçlanmadığı.Fatura sonuçlandırıldığında bir fatura ödemek imkansızdır (ödenir veya süresi dolmuş)Parametre türü
string|nullTanım
Ek BilgilerParametre türü
string|nullTanım
Faturanın Oluşturulması Tarihi. Timezone UTC+3'türParametre türü
string|nullTanım
Son fatura güncellenen tarih. Timezone UTC+3'türParametre türü
string|nullTanım
Cryptomus Komisyon MiktarıParametre türü
string|nullTanım
Adres QR koduTanım
Ödemenin otomatik olarak dönüştürüleceği para birimi hakkında bilgi. Dönüştürme Payer_currency 'den USDT'ye gerçekleştirilirconvert_currency_code parametresi geçirilirse mevcuttur.Parametre türü
stringTanım
Ödemenin dönüştürüleceği para birimi koduParametre türü
stringTanım
Dönüşüm ücretiParametre türü
string|nullTanım
Dönüşüm oranıParametre türü
string|nullTanım
Tüm komisyonlar çıkarıldığında, satıcının bakiyesine eklenen to_currency dönüşüm miktarı.Tanım
Yanlış ödemenin hangi para biriminden yapıldığına dair bilgi.Ödeme hatalıysa belirtin.Parametre türü
stringTanım
Para birimindenParametre türü
string|nullTanım
MiktarParametre türü
string|nullTanım
Blockchain Ağ Kodu
Yanıt örneği
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 "payment_amount_usd": null,
9 "payer_amount": null,
10 "payer_amount_exchange_rate": null,
11 "discount_percent": null,
12 "discount": "0.00000000",
13 "payer_currency": null,
14 "currency": "USD",
15 "comments": null,
16 "merchant_amount": null,
17 "network": null,
18 "address": null,
19 "from": null,
20 "txid": null,
21 "payment_status": "check",
22 "url": "https://pay.cryptomus.com/pay/26109ba0-b05b-4ee0-93d1-fd62c822ce95",
23 "expired_at": 1689098133,
24 "status": "check",
25 "is_final": false,
26 "additional_data": null,
27 "created_at": "2023-07-11T20:23:52+03:00",
28 "updated_at": "2023-07-11T21:24:17+03:00",
29 "commission": null,
30 "address_qr_code": null
31 }
32}KopyalaDaha fazla örnek
Tron ağında 20 USDT için bir fatura oluşturmak için veri isteyin. Faturanın yaratıldığı sırada bir adresi olacaktır.
1{
2 "amount": "20",
3 "currency": "USDT",
4 "order_id": "1",
5 "network": "tron"
6}Kopyala25 USD için bir fatura oluşturmak için veri isteyin ve istemcilerin herhangi bir ağda yalnızca USDT'ye göre ödeme yapmasına izin verin.
1{
2 "amount": "25",
3 "currency": "USD",
4 "order_id": "1",
5 "to_currency": "USDT"
6}Kopyala25 USD için bir fatura oluşturmak ve müşterilerin yalnızca Tron Network'te USDT tarafından ödeme yapmasına izin vermek için veri isteyin. Faturanın yaratıldığı sırada bir adresi olacaktır.
1{
2 "amount": "25",
3 "currency": "USD",
4 "order_id": "1",
5 "to_currency": "USDT",
6 "network": "tron"
7}Kopyala20 USDT için bir fatura oluşturmak ve müşterilerin mevcut tüm ağlarda ödeme yapmasına izin vermek için veri isteyin
1{
2 "amount": "20",
3 "currency": "USDT",
4 "order_id": "1"
5}Kopyala20 USD için bir fatura oluşturmak ve müşterilerin yalnızca Bitcoin'de ödeme yapmasına izin vermesini isteyin. Faturanın yaratıldığı sırada bir adresi olacaktır.
1{
2 "amount": "20",
3 "currency": "USD",
4 "order_id": "1",
5 "to_currency": "BTC"
6}Kopyala0.5 BTC için bir fatura oluşturmak ve istemcilerin yalnızca Bitcoin'de ödeme yapmasına izin vermesini isteyin. Faturanın yaratıldığı sırada bir adresi olacaktır.
1{
2 "amount": "0.5",
3 "currency": "BTC",
4 "order_id": "1"
5}KopyalaOlası hatalar
Doğrulama hataları
kodlamak : 422
örnek yanıtlar:
Bazı parametre gerekiyorsa ve geçmiyorsa:
1{
2 "state": 1,
3 "errors": {
4 "amount": ["validation.required"]
5 }
6}KopyalaDesteklenmeyen ağ kodunu sağladıysanız
1{
2 "state": 1,
3 "message": "The network was not found"
4}KopyalaPara birimi parametresinde sağladığınız para birimi kodunu desteklemezsek:
1{
2 "state": 1,
3 "message": "The currency was not found"
4}KopyalaÖdemeleriniz engellenirse. Bu durumda destekle iletişime geçmeniz gerekir.
1{
2 "state": 1,
3 "message": "You are forbidden"
4}Kopyalato_currency parametresinde aktarılan para biriminin ödeme hizmetini bulamazsak:
1{
2 "state": 1,
3 "message": "Not found service to_currency"
4}KopyalaEğer to_currency 'a dönüşürken yanlışlıkla bir şey olur:
1{
2 "state": 1,
3 "message": "Error convert to_currency"
4}KopyalaÖdeme tutarı, kripto para birimi için desteklenen minimum miktardan azsa, bu hata mesajını alacaksınız:
1{
2 "state": 1,
3 "message": "Minimum amount 0.5 USDT"
4}KopyalaÖdeme tutarı, kripto para birimi için desteklenen maksimum tutardan fazlaysa, bu hata mesajını alacaksınız:
1{
2 "state": 1,
3 "message": "Maximum amount 10000000 USDT"
4}KopyalaÖdemenin kripto para birimi ile aktif bir satıcı cüzdanınız olmayacaksa, bu hatayı alacaksınız:
1{
2 "state": 1,
3 "message": "Wallet not found"
4}KopyalaTeknik çalışma gerçekleşir ve ödeme geçici olarak kullanılamazsa, bu hata mesajlarını alabilirsiniz:
1{
2 "state": 1,
3 "message": "Gateway error"
4}Kopyala
1{
2 "state": 1,
3 "message": "The terminal was not found"
4}Kopyala
1{
2 "state": 1,
3 "message": "Server error"
4}Kopyalaİç Sunucu Hatası
kodlamak : 500
örnek yanıtlar:
1{
2 "message": "Server error, #1",
3 "code": 500,
4 "error": null
5}Kopyala