مستند درگاه ارتباطی
در این مستند به معرفی درگاه اعتباری دالون پرداخته میشود.
فروشگاه ها میتوانند بعد از عقد قرارداد با بالون از طریق این درگاه اقدام به اعطای تسهیلات به کاربران خود کنند.
شما میتوانید فایل پست من سرویس ها را ازاینجا دانلود کنید.
احراز هویت
دریافت توکن
import requests
data = {
'client_id': 'HX6rcf1v3qW0Ar4SfNE4lw5tWZMoMUTITg',
'client_secret': 'kls6n8QkRNkRHRIb47PgIAvtfxzfg1turu0FUA9JkOVEzBXJNDRapxnGBaegAgvW9chqdgGLFTAONV',
'grant_type': 'client_credentials',
}
response = requests.post('{{URL}}/auth/token/', data=data)
curl --location '{{URL}}/auth/token/' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id=HX6rcf1v3qW0AJ4SsdfNE4lw5tWZMoMUTITg' \
--data-urlencode 'client_secret=kls6n8QkRNkRHRIB47PgIAvtfxzfgA9JnTg1turu0FUA9JkOVEzBXJNDRapxnGBaegAgvW9chqdgGLFTAONVOZCCZ4iOeYoFKuo4TxSfkfSfsqHkM08z3E5' \
--data-urlencode 'grant_type=client_credentials'
Successful response:
{
"access_token" : "2oFvG2JBHsOYYghLfYffW12Mss",
"expires_in" : 1800,
"token_type" : "Bearer",
"scope" : "read write groups"
}
برای استفاده از سرویس ها و api ها اول باید احراز هویت شوید و token خود را در هر request بفرستید.
برای احراز هویت باید هماهنگی های لازم را با پشتیبانی انجام دهید تا client_id و client_secret خود را دریافت کنید.
HTTP Request
POST {{URL}}/auth/token/
Data Parameters
| Parameter | Required | Description |
|---|---|---|
| client_id | true | your client_id |
| client_secret | true | your client_secret |
| grant_type | true | should be client_credentials |
ساخت وام
import requests
data = {
'birthdate': '1993-08-29',
'nationalCode': '0024521664',
'loanAmount': 20000000,
'numberOfRepayments': 18,
'customerContributionAmount': 0,
}
headers = {
'Authorization': 'Bearer HX6rcf1v3qW0Ar4SfNE4lw5tWZMoMUTITg',
'Content-Type': 'application/json',
}
response = requests.post('{{URL}}/v1/daloan/loan/applications/create', data=data, headers=headers)
curl --location '{{URL}}/v1/daloan/loan/applications/create/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer hsPYVziMUWaGKsHzz0Px2QMIKtWHNS' \
--data '{
"birthdate": "1993-08-29",
"nationalCode": "",
"loanAmount": 20000000,
"numberOfRepayments": 18,
"customerContributionAmount": 0
}'
Successful response:
{
"nationalCode" : "3720747522",
"whiteListCode" : "71",
"loanApplicationRef" : "LN_00001574234"
}
با استفاده از این api میتوانید وام خود را ایجاد کنید.
HTTP Request
POST {{URL}}/v1/daloan/loan/applications/create/
Data Parameters
| Parameter | Required | Description |
|---|---|---|
| birthdate | true | your birthdate |
| nationalCode | true | your nationalCode |
| loanAmount | true | |
| numberOfRepayments | true | the installments that you should pay |
| customerContributionAmount | true | always should be 0 |
کنسل وام
import requests
data = {
'loanApplicationRef': 'LN_00001234',
}
headers = {
'Authorization': 'Bearer HX6rcf1v3qW0Ar4SfNE4lw5tWZMoMUTITg',
'Content-Type': 'application/json',
}
response = requests.post('{{URL}}/v1/daloan/loan/applications/cancel/', data=data, headers=headers)
curl --location '{{URL}}/v1/daloan/loan/applications/cancel/' \
--header 'Authorization: Bearer hsPYVziMUWaGKsHzz0Px2QMIKtWHNS' \
--header 'Content-Type: application/json' \
--data '{
"loanApplicationRef": ""
}'
Successful response:
{
"interestRate" : 22,
"whiteListCode" : 71,
"whiteListName" : "وام نقدی بالون",
"hasPartialPaid" : false,
"numberOfRepayments" : 24,
"loanApplicationStatus" : "APPLICATION_CANCELED",
"loanApplicationReference" : "LN_00001574234",
}
با استفاده از این api میتوانید وام خود را کنسل کنید.
پارامتر loanApplicationRef شناسه منحصر به فرد وام است که باید ارسال شود.
HTTP Request
POST {{URL}}/v1/daloan/loan/applications/cancel/
Data Parameters
| Parameter | Required | Description |
|---|---|---|
| loanApplicationRef | true | this is a unique id ,that will be generate when you create your loan |
اطلاعات یک وام
import requests
data = {
'loanApplicationRef': 'LN_00001234',
}
headers = {
'Authorization': 'Bearer HX6rcf1v3qW0Ar4SfNE4lw5tWZMoMUTITg',
'Content-Type': 'application/json',
}
response = requests.post('{{URL}}/v1/daloan/loan/applications/get/', data=data, headers=headers)
curl --location '{{URL}}/v1/daloan/loan/applications/get/' \
--header 'Authorization: Bearer hsPYVziMUWaGKsHzz0Px2QMIKtWHNS' \
--header 'Content-Type: application/json' \
--data '{
"loanApplicationRef": ""
}'
Successful response:
{
"loanApplicationReference" : "LN_00001574234",
"loanApplicationRequestDate" : "2023-06-28T05:51:52.807Z",
"loanAccountNumber" : "611821525352994002",
"loanApplicationStatus" : "ESTABLISHED",
"loanApplicationStatusDescList" : [],
"disbursementDate" : "2023-06-28T00:00:00.000Z",
"nextRepaymentDate" : "2023-07-29T00:00:00.000Z",
"loanOutstandingAmount" : "585000000",
"loanAmount" : "585000000",
"numberOfRepayments" : 18,
"numberOfPaidRepayments" : 0,
"hasPartialPaid" : false,
"interestRate" : 22,
"firstRepaymentAmount" : 38451262,
"automaticRepaymentStatus" : "A",
"lastInquiryDate" : "2023-06-28T06:04:06.237Z",
"whiteListCode" : 10,
"whiteListName" : "وام خرید کالا بالون"
}
با استفاده از این api میتوانید اطلاعات یک وام خاص را بگیرید.
HTTP Request
POST {{URL}}/v1/daloan/loan/applications/get/
URL Parameters
| Parameter | Required | Description |
|---|---|---|
| loanApplicationRef | true | this is a unique id ,that will be generate when you create your loan |
عملیات تسهیم
import requests
data = {
'loanApplicationRef': 'LN_00001234',
}
headers = {
'Authorization': 'Bearer HX6rcf1v3qW0Ar4SfNE4lw5tWZMoMUTITg',
'Content-Type': 'application/json',
}
response = requests.post('{{URL}}/v1/daloan/loan/applications/settlement/confirm/', data=data, headers=headers)
curl --location '{{URL}}/v1/daloan/loan/applications/settlement/confirm/' \
--header 'Authorization: Bearer hsPYVziMUWaGKsHzz0Px2QMIKtWHNS' \
--header 'Content-Type: application/json' \
--data '{
"loanApplicationRef": ""
}'
Successful response:
{}
با استفاده از این api میتوانید عملیات تسهیم را آغاز کنید.
HTTP Request
POST {{URL}}/v1/daloan/loan/applications/settlement/confirm/
Data Parameters
| Parameter | Required | Description |
|---|---|---|
| loanApplicationRef | true | this is a unique id ,that will be generate when you create your loan |
تایید وام
import requests
data = {
'loanApplicationRef': 'LN_00001234',
}
headers = {
'Authorization': 'Bearer HX6rcf1v3qW0Ar4SfNE4lw5tWZMoMUTITg',
'Content-Type': 'application/json',
}
response = requests.post('{{URL}}/v1/daloan/loan/applications/approve', data=data, headers=headers)
curl --location 'https://blu.baloan.ir/v1/daloan/loan/applications/approve' \
--header 'Authorization: Bearer hsPYVziMUWaGKsHzz0Px2QMIKtWHNS' \
--header 'Content-Type: application/json' \
--data '{
"loanApplicationRef": ""
}'
Successful response:
{
"requestId" : "e8260f5d7c3b49068399d24655933494",
"loanApplicationRef" : "LN_00001574234"
}
با استفاده از این api میتوانید در خواست تایید وام بدهید.
HTTP Request
POST https://blu.baloan.ir/v1/daloan/loan/applications/approve
Data Parameters
| Parameter | Required | Description |
|---|---|---|
| loanApplicationRef | true | this is a unique id ,that will be generate when you create your loan |
اکانت بلو بانک
mport requests
data = {
'birthdate': '1993-08-29',
'nationalCode': '0024521664',
}
headers = {
'Authorization': 'Bearer HX6rcf1v3qW0Ar4SfNE4lw5tWZMoMUTITg',
'Content-Type': 'application/json',
}
response = requests.post('{{URL}}/v1/daloan/account/has-account/', data=data, headers=headers)
curl --location '{{URL}}/v1/daloan/account/has-account/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer hsPYVziMUWaGKsHzz0Px2QMIKtWHNS' \
--data '{
"birthdate": "1993-08-29",
"nationalCode": "0024321662",
}'
Successful response:
{
"hasBluAccount" : true
}
با استفاده از این api میتوانید بررسی کنید آیا متقاضی حساب بلو بانک دارد یا خیر.
HTTP Request
POST {{URL}}/v1/daloan/account/has-account/
Data Parameters
| Parameter | Required | Description |
|---|---|---|
| birthdate | true | your birthdate |
| nationalCode | true | your nationalCode |
خطاها
درگاه اعتباری بالون به صورت کلی شامل ارور های زیر است:
| Error Code | Meaning |
|---|---|
| 400 | Bad Request -- Your request is invalid. |
| 401 | Unauthorized -- Your API key is wrong. |
| 404 | Not Found -- The specified api could not be found. |
| 429 | Too Many Requests -- You're requesting too many! Slow down! |
| 503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later. |