إنشاء دفعة متكررة
المدفوعات المتكررة في العملة المشفرة هي وسيلة لأتمتة المعاملات العادية باستخدام الأصول الرقمية. يمكن أن تكون مفيدة للخدمات القائمة على الاشتراك والتبرعات والعضوية والمدفوعات المتكررة الأخرى.
لاستخدام المدفوعات المتكررة ، تحتاج إلى إنشاء دفعة تحدد المبلغ والعملة وتواتر المدفوعات ، ثم مشاركتها مع دافعيك. سيتم إعادة توجيه الدافع إلى موقع Cryptomus ، حيث سيحتاج إلى تسجيل الدخول لتأكيد خطة الدفع وإجراء الدفع الأول. بعد ذلك ، سيتم إجراء المدفوعات تلقائيًا وفقًا للخطة.
post
https://api.cryptomus.com/v1/recurrence/create
طلب
معلمات الاستعلام
| اسم | نوع المعلمة | القيمة الافتراضية | تعريف |
|---|---|---|---|
| amount* | string | مبلغ الدفع المتكرر | |
| currency* | string | رمز العملة | |
| name* | stringmin:3max:60 | اسم الدفع المتكرر | |
| period* | string | فترة الدفع المتكررةمتاح:weeklymonthlythree_month | |
| to_currency | رمز العملة لقبول المدفوعاتيتم استخدام المعلمة لتحديد العملة المستهدفة لتحويل مبلغ الدفع المتكرر.على سبيل المثال ، لإنشاء دفعة متكررة مقابل 20 دولارًا في Bitcoin: amount : 20 currency : USD to_currency : BTCسيقوم API بتحويل مبلغ 20 دولارًا أمريكيًا إلى ما يعادلها في BTC بناءً على سعر الصرف الحالي وسيدفع المستخدم في BTCيجب أن يكون to_currency دائمًا رمز العملة المشفرة ، وليس رمز العملة Fiat. | ||
| order_id | stringmin:1max:100 | null | طلب معرف في نظامك |
| url_callback | url | null | عنوان URL الذي سيتم إرسال Webhooks مع حالة الدفع إليه |
| discount_days | integermin:1max:365 | 0 | أيام الخصم (مطلوب مع "Discount_amount") |
| discount_amount | string | null | مبلغ الخصم (مطلوب مع "discount_days"). هنا المبلغ في عملة المعلمة "العملة" |
| additional_data | string | null | تفاصيل الدفع المتكررة الإضافية |
نوع المعلمة
stringتعريف
مبلغ الدفع المتكررنوع المعلمة
stringتعريف
رمز العملةنوع المعلمة
stringmin:3max:60تعريف
اسم الدفع المتكررنوع المعلمة
stringتعريف
فترة الدفع المتكررةمتاح:weeklymonthlythree_monthتعريف
رمز العملة لقبول المدفوعاتيتم استخدام المعلمة لتحديد العملة المستهدفة لتحويل مبلغ الدفع المتكرر.على سبيل المثال ، لإنشاء دفعة متكررة مقابل 20 دولارًا في Bitcoin:
amount : 20
currency : USD
to_currency : BTCسيقوم API بتحويل مبلغ 20 دولارًا أمريكيًا إلى ما يعادلها في BTC بناءً على سعر الصرف الحالي وسيدفع المستخدم في BTCيجب أن يكون to_currency دائمًا رمز العملة المشفرة ، وليس رمز العملة Fiat.نوع المعلمة
stringmin:1max:100تعريف
طلب معرف في نظامكنوع المعلمة
urlتعريف
عنوان URL الذي سيتم إرسال Webhooks مع حالة الدفع إليهنوع المعلمة
integermin:1max:365تعريف
أيام الخصم (مطلوب مع "Discount_amount")نوع المعلمة
stringتعريف
مبلغ الخصم (مطلوب مع "discount_days"). هنا المبلغ في عملة المعلمة "العملة"نوع المعلمة
stringتعريف
تفاصيل الدفع المتكررة الإضافية
* - المعلمة الإلزامية
تخفيض:
الفترة الأولى في الأيام (المعلمة discount_days ) ، والتي ستكلف مبلغًا مختلفًا (المعلمة discount_amount ). على سبيل المثال ، يمكنك تعيين discount_amount لأول 30 يومًا وفترة شهرية ، ثم يدفع المستخدم الدفعة الأولى بسعر أقل ، وستكون المدفوعات الثانية واللاحقة بسعر كامل.يجب أن يكون مبلغ الخصم بالعملة المحددة بواسطة المعلمة "العملة".
طلب مثال
فيما يلي مثال على عينة مع الحد الأدنى لعدد المعلمات المطلوبة في هذه الحالة ، سيتم إنشاء فاتورة باستخدام عملة FIAT USD. في صفحة الدفع ، سيتمكن المستخدم من تحديد العملة المشفرة والشبكة لدفع هذه الفاتورة.
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"
}'إجابة
معلمات الاستجابة
| اسم | تعريف |
|---|---|
| uuid | متكرر uuid |
| name | الاسم المتكرر |
| order_id | طلب معرف في نظامك |
| amount | المبلغ متكرر |
| currency | رمز العملة |
| payer_currency | العملة التي يجب على العميل القيام بها. |
| payer_amount_usd | مبلغ USD المكافئ في payer_currency الذي يجب على العميل أن يدفعه |
| payer_amount | المبلغ الموجود في payer_currency الذي يجب على العميل أن يدفعه |
| url_callback | عنوان URL الذي سيتم إرسال Webhooks مع حالة الدفع إليه |
| period | فترة الدفع المتكررة |
| status | الحالة المتكررةالخيارات المتاحة:• wait_accept• cancel_by_merchant• active• cancel_by_user |
| url | عنوان URL لصفحة الدفع Cryptomus حيث سيقوم الدافع بالدفع |
| last_pay_off | تاريخ آخر دفعة. المنطقة الزمنية هي UTC+3. إذا كانت القيمة لاغية ، لم يتم إجراء أي مدفوعات. |
| additional_data | تفاصيل الدفع المتكررة الإضافية |
تعريف
متكرر uuidتعريف
الاسم المتكررتعريف
طلب معرف في نظامكتعريف
المبلغ متكررتعريف
رمز العملةتعريف
العملة التي يجب على العميل القيام بها.تعريف
مبلغ USD المكافئ في payer_currency الذي يجب على العميل أن يدفعهتعريف
المبلغ الموجود في payer_currency الذي يجب على العميل أن يدفعهتعريف
عنوان URL الذي سيتم إرسال Webhooks مع حالة الدفع إليهتعريف
فترة الدفع المتكررةتعريف
الحالة المتكررةالخيارات المتاحة:- wait_accept- cancel_by_merchant- active- cancel_by_userتعريف
عنوان URL لصفحة الدفع Cryptomus حيث سيقوم الدافع بالدفعتعريف
تاريخ آخر دفعة. المنطقة الزمنية هي UTC+3. إذا كانت القيمة لاغية ، لم يتم إجراء أي مدفوعات.تعريف
تفاصيل الدفع المتكررة الإضافية
مثال على الاستجابة
إذا كان الطلب ناجحًا. رمز الاستجابة هو 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}مزيد من الأمثلة
طلب مثال بيانات لإنشاء دفعة تكرار مقابل 15 دولارًا أمريكيًا
1{
2 "amount": "15",
3 "currency": "USD",
4 "name": "Recurring payment",
5 "period": "monthly",
6 "url_callback": "https://your.site/callback"
7}مثال على الاستجابة:
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}طلب بيانات الطلب لإنشاء دفعة تكرار مقابل 15 دولارًا أمريكيًا (سيتم السماح فقط بالدفع)
1{
2 "amount": "15",
3 "currency": "USDT",
4 "name": "Recurring payment",
5 "period": "monthly",
6 "url_callback": "https://your.site/callback"
7}مثال على الاستجابة:
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}طلب مثال على البيانات لإنشاء دفعة تكرار مقابل 15 دولارًا أمريكيًا والسماح فقط لعملة BTC للدفع
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}مثال على الاستجابة:
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}طلب مثال بيانات لإنشاء دفعة متكررة بمبلغ 15 دولارًا. في أول 30 يومًا ، سيكون السعر 1 دولار ، بعد ذلك - 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}مثال على الاستجابة:
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}