تفاوت این وبسرویس با درگاهپرداختهای معمولی در قابلیت تبادل ارزهای دیجیتال میباشد. در وبسرویس جیب علاوه بر ریال، دلار و سایر ارزهای رایج میتوانید بر بستر بلاکچین نیز تراکنش داشته باشید.
curl -X GET "https://api.apieco.ir/jeeb/api/payments/invoice?token="
--header 'apieco_key:{YOUR_APIECO_KEY}'
پارامترهای پایانه
Header Parameters:
apieco_key:{YOUR_APIECO_KEY}
Required Parameters:
token
آدرس پایانه
curl -X POST "https://api.apieco.ir/jeeb/api/payments/invoice
--header 'apieco_key:{YOUR_APIECO_KEY}'
-d {
"token": "token ایجاد شده برای پرداخت"
}
پارامترهای پایانه
Header Parameters:
apieco_key:{YOUR_APIECO_KEY}
Required Parameters:
token
آدرس پایانه
curl -X POST "https://api.apieco.ir/jeeb/api/payments/{signature}/issue
--header 'apieco_key:{YOUR_APIECO_KEY}'
-d {
Required: coins,orderNo,value,webhookUrl
orderNo:
string
شماره سفارش در سیستم پذیرنده
value:
number
مبلغ تراکنش به بیت کوین. مبلغ پایه تمام تراکنش ها به بیت کوین محاسبه می شود و می تواند شامل 8 رقم اعشار باشد.
coins:
string
لیست کوین های قابل پرداخت. شما می توانید هر تعداد کوینی که می خواهید در این فیلد وارد کنید، ولی در حال حاضر تنها 3 کوین اول پردازش می شوند. برای مشاهده لیست کوین ها به جدول کوین ها مراجعه کنید. این فیلد می بایست به صورت زیر وارد شود. coin1/coin2/coin3/.....
callbackUrl:
string
آدرس بازگشت به وب سایت پذیرنده (اجباریست در صورتی که از روش اول پیاده سازی استفاده می کنید)
webhookUrl:
string
آدرس ارسال اعلان ها به وب سایت پذیرنده
language:
string
جهت انتخاب زبان بخش پرداخت استفاده می شود، که در حال حاضر فقط en ، fa و null قابل قبول است. در صورتی که مقداری وارد نشود، بر اساس موقعیت حدودی پرداخت کننده، جیب تصمیم می گیرد که بخش پرداخت با چه زبانی بارگزاری شود.
expiration:
number
مقدار اولیه 15 (دقیقه) جهت افزایش زمان انقضای پرداخت استفاده می شود. این فیلد می تواند مقداری بین 15 تا 2880 داشته باشد.
allowReject:
boolean
مقدار اولیه true اگر true باشد و کاربر دقیقا مبلغ درخواست شده را واریز نکرده باشد، تراکنش پس از دریافت تاییدیه، از وضعیت 3 به 6 و یا 7 ختم شده و مبلغ واریز شده با کسر فی شبکه مسترد می شود.
allowTestNet:
boolean
مقدار اولیه false تنها در صورتی که این فیلد true باشد، امکان پردازش تست کوین ها در فیلد coins خواهد بود. توجه داشته باشید که تست کوین ها تنها برای برنامه نویس ها و به جهت تست ارتباطات ارائه شده اند و به هیچ عنوان نباید در نسخه نهایی استفاده شوند.
}
پارامترهای پایانه
Header Parameters:
apieco_key:{YOUR_APIECO_KEY}
Required Parameters:
signature
"orderNo"
"value"
"coins"
"webhookUrl"
optional Parameters:
callbackUrl
language
expiration
allowReject
allowTestNet
آدرس پایانه
curl -X POST "https://api.apieco.ir/jeeb/api/payments/{signature}/confirm"
--header 'apieco_key:{YOUR_APIECO_KEY}'
-d {
"token": "token ایجاد شده برای پرداخت"
}
پارامترهای پایانه
Header Parameters:
apieco_key:{YOUR_APIECO_KEY}
Required Parameters:
signature
token
آدرس پایانه
curl -X POST "https://api.apieco.ir/jeeb/api/payments/{signature}/status"
--header 'apieco_key:{YOUR_APIECO_KEY}'
-d {
"token": "token ایجاد شده برای پرداخت"
}
پارامترهای پایانه
Header Parameters:
apieco_key:{YOUR_APIECO_KEY}
Required Parameters:
signature
token
آدرس پایانه
curl -X POST "https://api.apieco.ir/jeeb/ReceiverAddress"
--header 'apieco_key:{YOUR_APIECO_KEY}'
-d {
Required: baseValue,expirationTime,orderNo,referenceNo,signature,stateId,token,webhookUrl
referenceNo:
string
شماره رهگیری پرداخت در جیب
orderNo:
string
شماره سفارش در سیستم پذیرنده
stateId:
number
کد وضعیت پرداخت
baseValue:
number
مبلغ پایه به بیت کوین، این فیلد برابر است با فیلد value در ورودی وب سرویس issue
coin:
string
کوینی که کاربر بر روی آن تراکنش انجام داده است
value:
number
مبلغ درخواستی بر روی کوین انتخابی
paidValue:
number
مبلغ پرداختی بر روی کوین انتخابی
rate:
number
نرخ تبدیل مبلغ پایه به مبلغ درخواستی کوین انتخابی
expirationTime:
string
تاریخ و زمان انقضای پرداخت
finalizedTime:
string
تاریخ و زمان نهایی شدن پرداخت
token:
string
token پرداخت
signature:
string
امضای دیجیتال درگاه
webhookUrl:
string
webhook url تنظیم شده برای پرداخت
callbackUrl:
string
callback url تنظیم شده برای پرداخت
}
پارامترهای پایانه
Header Parameters:
apieco_key:{YOUR_APIECO_KEY}
Required Parameters:
"referenceNo"
"orderNo"
"stateId"
"baseValue"
optional Parameters:
"coin"
"value"
"paidValue"
"rate"
آدرس پایانه
curl -X POST "https://api.apieco.ir/jeeb/ReceiverAddress/"
--header 'apieco_key:{YOUR_APIECO_KEY}'
-d {
referenceNo* string
شماره رهگیری پرداخت در جیب
orderNo* string
شماره سفارش در سیستم پذیرنده
stateId* number
کد وضعیت پرداخت
baseValue number
مبلغ پایه به بیت کوین، این فیلد برابر است با فیلد value در ورودی وب سرویس issue
coin string
کوینی که کاربر بر روی آن تراکنش انجام داده است
value number
مبلغ درخواستی بر روی کوین انتخابی
paidValue number
مبلغ پرداختی بر روی کوین انتخابی
rate number
نرخ تبدیل مبلغ پایه به مبلغ درخواستی کوین انتخابی