Yinelenen Ödeme Oluşturma

Kripto para biriminde tekrar eden ödemeler, dijital varlıkları kullanarak düzenli işlemleri otomatikleştirmenin bir yoludur. Abonelik tabanlı hizmetler, bağışlar, üyelikler ve diğer yinelenen ödemeler için yararlı olabilirler.

Yinelenen ödemeleri kullanmak için, ödemelerin tutarını, para birimini ve sıklığını belirten bir ödeme oluşturmanız ve ardından ödeyicilerinizle paylaşmanız gerekir. Ödeme, ödeme planını onaylamak ve ilk ödemeyi yapmak için giriş yapması gereken Cryptomus web sitesine yönlendirilecektir. Bundan sonra, ödemeler plana göre otomatik olarak yapılacaktır.


post https://api.cryptomus.com/v1/recurrence/create Kopyala

Rica etmek

Sorgu parametreleri

İsimParametre türüVarsayılan değerTanım
amount*string-Yinelenen ödeme tutarı
currency*string-Para birimi kodu
name*stringmin:3max:60-Yinelenen Ödeme Adı
period*string-Yinelenen ödeme süresimevcut:weeklymonthlythree_month
to_currency-Ödemeleri kabul etmek için para birimi koduParametre, tekrarlayan ödeme tutarını dönüştürmek için hedef para birimini belirtmek için kullanılır.methods.For example, to create an recurrent payment for 20 USD in bitcoinAPI, 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.
order_idstringmin:1max:100alpha_dashnullSisteminizde Sipariş Kimliği
url_callbackurlnullÖdeme durumuna sahip webhooks'un hangi URL'si gönderilecek
discount_daysintegermin:1max:3650İndirim Dönemi Günleri ('indirim_amount' ile gerekli)
discount_amountstringnullİndirim miktarı ('indirim_days' ile gerekli). Burada "para birimi" parametresinin para birimindeki tutar
additional_datastringnullEk yinelenen ödeme detayları

Parametre türü

string

Tanım

Yinelenen ödeme tutarı

Parametre türü

string

Tanım

Para birimi kodu

Parametre türü

stringmin:3max:60

Tanım

Yinelenen Ödeme Adı

Parametre türü

string

Tanım

Yinelenen ödeme süresimevcut:weeklymonthlythree_month

Tanım

Ödemeleri kabul etmek için para birimi koduParametre, tekrarlayan ödeme tutarını dönüştürmek için hedef para birimini belirtmek için kullanılır.methods.For example, to create an recurrent payment for 20 USD in bitcoinAPI, 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ü

stringmin:1max:100alpha_dash

Varsayılan değer

null

Tanım

Sisteminizde Sipariş Kimliği

Parametre türü

url

Varsayılan değer

null

Tanım

Ödeme durumuna sahip webhooks'un hangi URL'si gönderilecek

Parametre türü

integermin:1max:365

Varsayılan değer

0

Tanım

İndirim Dönemi Günleri ('indirim_amount' ile gerekli)

Parametre türü

string

Varsayılan değer

null

Tanım

İndirim miktarı ('indirim_days' ile gerekli). Burada "para birimi" parametresinin para birimindeki tutar

Parametre türü

string

Varsayılan değer

null

Tanım

Ek yinelenen ödeme detayları

* - zorunlu parametre

İndirim:

Günlerdeki ilk dönem (discount_days parametresi), bu farklı bir miktara mal olacak ( discount_amount parametresi). Örneğin, ilk 30 gün ve aylık bir süre için bir discount_amount ayarlayabilirsiniz, daha sonra kullanıcı ilk ödemeyi daha düşük bir fiyatla ödeyecek, ikinci ve sonraki ödemeler tam fiyatta olacaktır.

İndirim miktarı, "Para Birimi" parametresi tarafından belirtilen para biriminde olmalıdır.

Talep Örneği

Aşağıda, bu durumda gerekli minimum sayıda parametreye sahip örnek bir örnek verilmiştir, 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/recurrence/create \
-X POST \
-H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
-H 'sign: fe99035f86fa436181717b302b95bacff1' \
-H 'Content-Type: application/json' \
-d '{
	"amount": "15",
	"currency": "USDT",
	"name": "Recurring payment",
	"period": "monthly"
}'
Kopyala

Cevap

Yanıt parametreleri

İsimParametre türüTanım
uuidstringTekrarlayan uuid
namestringTekrarlayan isim
order_idstring|nullSisteminizde Sipariş Kimliği
amountstringTekrarlayan miktar
currencystringPara birimi kodu
payer_currencystring|nullMüşterinin ödemeyi yapması gereken para birimi.
payer_amount_usdstringMüşterinin ödemesi gereken payer_currency eşdeğer USD miktarı
payer_amountstring|nullMüşterinin ödemesi gereken payer_currency
url_callbackstring|nullÖdeme durumuna sahip webhooks'un hangi URL'si gönderilecek
periodstringYinelenen ödeme süresi
statusstringTekrarlayan statüMevcut seçenekler:• wait_accept• cancel_by_merchant• active• cancel_by_user
urlstringÖdemenin ödeyeceği Cryptomus ödeme sayfasının URL'si
last_pay_offstring|nullSon ödeme tarihi. Saat dilimi UTC+3'tür. Değer boşsa, ödeme yapılmadı.
additional_datastring|nullEk yinelenen ödeme detayları

Parametre türü

string

Tanım

Tekrarlayan uuid

Parametre türü

string

Tanım

Tekrarlayan isim

Parametre türü

string|null

Tanım

Sisteminizde Sipariş Kimliği

Parametre türü

string

Tanım

Tekrarlayan miktar

Parametre türü

string

Tanım

Para birimi kodu

Parametre türü

string|null

Tanım

Müşterinin ödemeyi yapması gereken para birimi.

Parametre türü

string

Tanım

Müşterinin ödemesi gereken payer_currency eşdeğer USD miktarı

Parametre türü

string|null

Tanım

Müşterinin ödemesi gereken payer_currency

Parametre türü

string|null

Tanım

Ödeme durumuna sahip webhooks'un hangi URL'si gönderilecek

Parametre türü

string

Tanım

Yinelenen ödeme süresi

Parametre türü

string

Tanım

Tekrarlayan statüMevcut seçenekler:- wait_accept- cancel_by_merchant- active- cancel_by_user

Parametre türü

string

Tanım

Ödemenin ödeyeceği Cryptomus ödeme sayfasının URL'si

Parametre türü

string|null

Tanım

Son ödeme tarihi. Saat dilimi UTC+3'tür. Değer boşsa, ödeme yapılmadı.

Parametre türü

string|null

Tanım

Ek yinelenen ödeme detayları

Yanıt örneği

Talep başarılı olursa. Yanıt kodu 200'tür.


1{
2	"state": 0,
3	"result": {
4		"uuid": "afd050e8-35ea-4129-bbdd-73f510dce556",
5		"name": "Recurring payment",
6		"order_id": null,
7		"amount": "15",
8		"currency": "USDT",
9		"payer_currency": "USDT",
10		"payer_amount_usd": "15.00",
11		"payer_amount": "15.00000000",
12		"url_callback": null,
13		"period": "monthly",
14		"status": "wait_accept",
15		"url": "https://pay.cryptomus.com/recurring/afd050e8-35ea-4129-bbdd-73f510dce556",
16		"last_pay_off": null
17	}
18}
Kopyala

Daha fazla örnek

15 USD için bir nüks ödemesi oluşturmak için veri örneği isteyin


1{
2	"amount": "15",
3	"currency": "USD",
4	"name": "Recurring payment",
5	"period": "monthly",
6	"url_callback": "https://your.site/callback"
7}
Kopyala

Yanıt örneği:


1{
2	"state": 0,
3	"result": {
4		"uuid": "1d4c1ef7-1dcd-4f98-9433-2e19d2e62820",
5		"name": "Recurring payment",
6		"order_id": null,
7		"amount": "15",
8		"currency": "USD",
9		"payer_currency": null,
10		"payer_amount_usd": "0.00",
11		"payer_amount": null,
12		"url_callback": "https://your.site/callback",
13		"period": "monthly",
14		"status": "wait_accept",
15		"url": "https://pay.cryptomus.com/recurring/1d4c1ef7-1dcd-4f98-9433-2e19d2e62820",
16		"last_pay_off": null
17	}
18}
Kopyala

15 USDT için bir nüks ödemesi oluşturmak için veri örneği isteyin (ödeme için yalnızca USDT'ye izin verilecektir)


1{
2	"amount": "15",
3	"currency": "USDT",
4	"name": "Recurring payment",
5	"period": "monthly",
6	"url_callback": "https://your.site/callback"
7}
Kopyala

Yanıt örneği:


1{
2	"state": 0,
3	"result": {
4		"uuid": "ec04dc64-fea4-445a-9698-59baa474317a",
5		"name": "Recurring payment",
6		"order_id": null,
7		"amount": "15",
8		"currency": "USDT",
9		"payer_currency": "USDT",
10		"payer_amount_usd": "15.00",
11		"payer_amount": "15.00000000",
12		"url_callback": "https://your.site/callback",
13		"period": "monthly",
14		"status": "wait_accept",
15		"url": "https://pay.cryptomus.com/recurring/ec04dc64-fea4-445a-9698-59baa474317a",
16		"last_pay_off": null
17	}
18}
Kopyala

15 USD için bir nüks ödemesi oluşturmak için veri örneği isteyin ve ödeme için yalnızca BTC para birimine izin verin


1{
2	"amount": "15",
3	"currency": "USD",
4	"to_currency": "BTC",
5	"name": "Recurring payment",
6	"period": "monthly",
7	"url_callback": "https://your.site/callback"
8}
Kopyala

Yanıt örneği:


1{
2	"state": 0,
3	"result": {
4		"uuid": "e7d9c265-3849-4ff8-84c1-15435368f05f",
5		"name": "Recurring payment",
6		"order_id": null,
7		"amount": "15",
8		"currency": "USD",
9		"payer_currency": "BTC",
10		"payer_amount_usd": "15.00",
11		"payer_amount": "0.00051495",
12		"url_callback": "https://your.site/callback",
13		"period": "monthly",
14		"status": "wait_accept",
15		"url": "https://pay.cryptomus.com/recurring/e7d9c265-3849-4ff8-84c1-15435368f05f",
16		"last_pay_off": null
17	}
18}
Kopyala

15 $ tutarında yinelenen bir ödeme oluşturmak için veri örneği örneği isteyin. İlk 30 gün fiyat 1 $ olacak, bundan sonra - 15 $:


1{
2	"amount": "15",
3	"currency": "USD",
4	"name": "Recurring payment",
5	"period": "monthly",
6	"discount_days": 30,
7  "discount_amount": "1"
8	"url_callback": "https://your.site/callback"
9}
Kopyala

Yanıt örneği:


1{
2	"state": 0,
3	"result": {
4		"uuid": "1ee00fbd-42e7-4653-b316-1ab12f8a447b",
5		"name": "Recurring payment",
6		"order_id": null,
7		"amount": "15",
8		"currency": "USD",
9		"payer_currency": null,
10		"payer_amount_usd": "0.00",
11		"payer_amount": null,
12		"url_callback": "https://your.site/callback",
13		"discount_days": "30",
14                "discount_amount": "1",
15		"end_of_discount": "2023-07-11T20:23:52+03:00",
16		"period": "monthly",
17		"status": "wait_accept",
18		"url": "https://pay.cryptomus.com/recurring/1ee00fbd-42e7-4653-b316-1ab12f8a447b",
19		"last_pay_off": null
20	}
21}
Kopyala