Membuat pembayaran berulang

Pembayaran berulang dalam mata uang kripto adalah cara untuk mengotomatiskan transaksi rutin menggunakan aset digital. Pembayaran ini dapat bermanfaat untuk layanan berbasis langganan, donasi, keanggotaan, dan pembayaran berulang lainnya.

Untuk menggunakan pembayaran berulang, Anda perlu membuat pembayaran yang menentukan jumlah, mata uang, dan frekuensi pembayaran, lalu membagikannya dengan pembayar Anda. Pembayar akan diarahkan ke situs web cryptomus, di mana ia harus masuk untuk mengonfirmasi rencana pembayaran dan melakukan pembayaran pertama. Setelah itu, pembayaran akan dilakukan secara otomatis sesuai rencana.


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

Meminta

Parameter kueri

NamaJenis parameterNilai defaultDefinisi
amount*string-Jumlah pembayaran berulang
currency*string-Kode mata uang
name*stringmin:3max:60-Nama pembayaran berulang
period*string-Periode pembayaran berulangtersedia:weeklymonthlythree_month
to_currency-Kode mata uang untuk menerima pembayaranParameter ini digunakan untuk menentukan mata uang target untuk mengonversi jumlah pembayaran berulang.Misalnya, untuk membuat pembayaran berulang sebesar 20 USD dalam bitcoin:
jumlah: 20
mata uang: USD
to_currency: BTC
API akan mengonversi jumlah 20 USD ke jumlah yang setara dalam BTC berdasarkan nilai tukar saat ini dan pengguna akan membayar dalam BTCto_currency harus selalu berupa kode mata uang kripto, bukan kode mata uang fiat.
order_idstringmin:1max:100nullID Pesanan di sistem Anda
url_callbackurlnullURL tempat webhook dengan status pembayaran akan dikirim
discount_daysintegermin:1max:3650Hari periode diskon (diperlukan dengan 'discount_amount')
discount_amountstringnullJumlah diskon (diperlukan dengan 'discount_days'). Di sini jumlah dalam mata uang parameter 'currency'
additional_datastringnullDetail pembayaran berulang tambahan

Jenis parameter

string

Definisi

Jumlah pembayaran berulang

Jenis parameter

string

Definisi

Kode mata uang

Jenis parameter

stringmin:3max:60

Definisi

Nama pembayaran berulang

Jenis parameter

string

Definisi

Periode pembayaran berulangtersedia:weeklymonthlythree_month

Definisi

Kode mata uang untuk menerima pembayaranParameter ini digunakan untuk menentukan mata uang target untuk mengonversi jumlah pembayaran berulang.Misalnya, untuk membuat pembayaran berulang sebesar 20 USD dalam bitcoin:
jumlah: 20
mata uang: USD
to_currency: BTC
API akan mengonversi jumlah 20 USD ke jumlah yang setara dalam BTC berdasarkan nilai tukar saat ini dan pengguna akan membayar dalam BTCto_currency harus selalu berupa kode mata uang kripto, bukan kode mata uang fiat.

Jenis parameter

stringmin:1max:100

Nilai default

null

Definisi

ID Pesanan di sistem Anda

Jenis parameter

url

Nilai default

null

Definisi

URL tempat webhook dengan status pembayaran akan dikirim

Jenis parameter

integermin:1max:365

Nilai default

0

Definisi

Hari periode diskon (diperlukan dengan 'discount_amount')

Jenis parameter

string

Nilai default

null

Definisi

Jumlah diskon (diperlukan dengan 'discount_days'). Di sini jumlah dalam mata uang parameter 'currency'

Jenis parameter

string

Nilai default

null

Definisi

Detail pembayaran berulang tambahan

* - parameter wajib

Diskon:

Periode pertama dalam hari (parameter discount_days), yang akan dikenakan biaya berbeda (parameter discount_amount). Misalnya, Anda dapat menetapkan discount_amount untuk 30 hari pertama dan periode bulanan. Kemudian, pengguna akan membayar pembayaran pertama dengan harga lebih rendah, sedangkan pembayaran kedua dan selanjutnya akan dikenakan harga penuh.

Jumlah diskon harus dalam mata uang yang ditentukan oleh parameter ‘mata uang’.

Contoh permintaan

Berikut adalah contoh dengan jumlah parameter minimum yang diperlukan. Dalam kasus ini, faktur akan dibuat dengan mata uang fiat USD. Di halaman pembayaran, pengguna dapat memilih mata uang kripto dan jaringan untuk membayar tagihan ini.


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

Tanggapan

Parameter respons

NamaDefinisi
uuiduuid berulang
nameNama berulang
order_idID Pesanan di sistem Anda
amountJumlah berulang
currencyKode mata uang
payer_currencyMata uang yang harus digunakan pelanggan untuk melakukan pembayaran.
payer_amount_usdJumlah USD yang setara dalam payer_currency yang harus dibayar oleh pelanggan
payer_amountJumlah dalam payer_currency yang harus dibayar oleh pelanggan
url_callbackURL tempat webhook dengan status pembayaran akan dikirim
periodPeriode pembayaran berulang
statusStatus berulangPilihan yang tersedia:wait_acceptcancel_by_merchantactivecancel_by_user
urlURL halaman pembayaran Cryptomus tempat pembayar akan melakukan pembayaran
last_pay_offTanggal pembayaran terakhir. Zona waktu adalah UTC+3. Jika nilainya null, tidak ada pembayaran yang dilakukan.
additional_dataDetail pembayaran berulang tambahan

Definisi

uuid berulang

Definisi

Nama berulang

Definisi

ID Pesanan di sistem Anda

Definisi

Jumlah berulang

Definisi

Kode mata uang

Definisi

Mata uang yang harus digunakan pelanggan untuk melakukan pembayaran.

Definisi

Jumlah USD yang setara dalam payer_currency yang harus dibayar oleh pelanggan

Definisi

Jumlah dalam payer_currency yang harus dibayar oleh pelanggan

Definisi

URL tempat webhook dengan status pembayaran akan dikirim

Definisi

Periode pembayaran berulang

Definisi

Status berulangPilihan yang tersedia:- wait_accept- cancel_by_merchant- active- cancel_by_user

Definisi

URL halaman pembayaran Cryptomus tempat pembayar akan melakukan pembayaran

Definisi

Tanggal pembayaran terakhir. Zona waktu adalah UTC+3. Jika nilainya null, tidak ada pembayaran yang dilakukan.

Definisi

Detail pembayaran berulang tambahan

Contoh respons

Jika permintaan berhasil, kode responsnya adalah 200.


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}
Menyalin

Contoh lainnya

Contoh permintaan data untuk membuat pembayaran berulang sebesar 15 USD


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

Contoh respons:


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}
Menyalin

Contoh permintaan data untuk membuat pembayaran berulang sebesar 15 USDT (hanya USDT yang akan diizinkan untuk pembayaran)


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

Contoh respons:


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}
Menyalin

Contoh permintaan data untuk membuat pembayaran berulang sebesar 15 USD dan hanya mengizinkan mata uang BTC untuk pembayaran


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}
Menyalin

Contoh respons:


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}
Menyalin

Contoh permintaan data untuk membuat pembayaran berulang sebesar $15. 30 hari pertama harganya $1, setelah itu - $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}
Menyalin

Contoh respons:


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}
Menyalin