inter-API Credit Application Services
Introduction
It is the transaction group that includes loan disbursement services.
Methods
SendCreditiumOneTimePassword
VerifyCreditiumOneTimePassword
QueryCreditiumDigitalCredit
CreateCreditiumDigitalCreditDocument
ApproveCreditiumDigitalCreditDocument
UtilizeCreditiumCredit
How to Get Started
Step 1 - Sign Up & Register: To start building with our APIs, you'll need to sign up for account. Read our documentation on how to use the Inter-API services and secure your connection with the right electronic certificate
Step 2 - Get Subscription Key: To get your Subscription Key, you'll first need to Subscribe for a package on Products page.
Step 3 - Activate: Get your subscription key under profile menu. You can also add your applications here.
Step 4 - Test API Methods: Include your access token and the information needed for that API. From there, use the response for your application and you’re all set. Now you can start building applications with our API.
Step 5 - For Production: You 're now up and running on inter-API Portal. Submit for production When you’re finished testing, you may want to submit your app for production. If it seems like we’d be a good fit, we’ll look into it and do some testing together. Then, we’ll talk about next steps to move to production.
Credit Application Flow Diagram
SendCreditiumOneTimePassword
It checks the existing customer with the entered tc no and sends a single-use password to the customer.
Request
{
"Header": {
"AppKey": "***",
"Channel": "API",
"ChannelSessionId": "331eb5f529c74df2b800926b5f34b874",
"ChannelRequestId": "5252012362481156055"
},
"Parameters": [
{
"ReferenceNumber": "1212",
"IdentityNumber": 68561316398,
"PhoneNumber": 5052456564,
"TransactionType": 1,
"Amount": 1000
}
]
}Response
{
"$type": "ServiceResponseMessage",
"Data": {
"$type": "SendCreditiumOneTimePasswordMessage",
"OtpReferenceId": 754183,
"State": 2
}
}VerifyCreditiumOneTimePassword
It verifies the single-use password transmitted.
Request
{
"Header": {
"AppKey": "***",
"Channel": "API",
"ChannelSessionId": "331eb5f529c74df2b800926b5f34b874",
"ChannelRequestId": "5252012362481156055"
},
"Parameters": [
{
"OtpPassword": "999999",
"OtpReferenceId": 754169,
"IdentityNumber": 68561316398,
"ReferenceNumber": "1212"
}
]
}Response
{
"$type": "ServiceResponseMessage",
"Data": {
"$type": "VerifyCreditiumOneTimePasswordMessage",
"State": 2
}
}QueryCreditiumDigitalCredit
It decides on the credit type according to the type of the customer and starts the necessary loan process and returns the payment options
Request
{
"Header": {
"AppKey": "***",
"Channel": "API",
"ChannelSessionId": "331eb5f529c74df2b800926b5f34b874",
"ChannelRequestId": "5252012362481156055"
},
"Parameters": [
{
"CardNumber": "",
"CardType": 1,
"IdentityNumber": 68561316398,
"OrderAmount": 1000.0,
"BasketInfo": [
{
"ProductId": "p1",
"BasketType": "Bilgisayar",
"ProductAmount": 12.10
}
],
"CampaignCode": "",
"TransactionType": 1,
"ReferenceNumber": "1212",
"FirmCode":0
}
]
}Response
{
"$type": "ServiceResponseMessage",
"Data": {
"$type": "QueryCreditiumDigitalCreditMessage",
"ReferenceNumber": "1212",
"PaymentInfo": [
{
"$type": "CreditiumPaymentInfo",
"InstallmentId": 186,
"NumberOfInstallment": 24,
"InstallmentAmount": 41.666666666666664,
"FirstInstallmentDate": "2021-06-28T00:00:00",
"MonthlyInterestRate": 0.0,
"AnnualCostRate": 0.0,
"RePaymentAmount": 1000.0,
"AccountNumber": "9142-14102683-351",
"PaymentDay": null,
"LoanFee": 0.0
}
]
}
}CreateCreditiumDigitalCreditDocument
The customer creates the bank documents according to the payment option selected in the previous step and transmits the documents.
Request
{
"Header": {
"AppKey": "***",
"Channel": "API",
"ChannelSessionId": "331eb5f529c74df2b800926b5f34b874",
"ChannelRequestId": "5252012362481156055"
},
"Parameters": [
{
"ReferenceNumber": "1212",
"InstallmentId": 1,
"TransactionType": 1
}
]
}Response
{
"$type": "ServiceResponseMessage",
"Data": {
"$type": "CreateCreditiumDigitalCreditDocumentMessage",
"State": 2
}
}ApproveCreditiumDigitalCreditDocument
It provides approval of the created documents.
Request
{
"Header": {
"AppKey": "***",
"Channel": "API",
"ChannelSessionId": "331eb5f529c74df2b800926b5f34b874",
"ChannelRequestId": "5252012362481156055"
},
"Parameters": [
{
"ReferenceNumber": "1212",
"InstallmentId": 1,
"TransactionType": 1,
"FirmCode": 0,
"Documents": [
{
"DocumentType": 1,
"ApprovementStatus": true
}
]
}
]
}Response
{
"$type": "ServiceResponseMessage",
"Data": {
"$type": "ApproveCreditiumDigitalCreditDocumentMessage",
"State": 2,
"ReferenceNumber": "1212",
"OtpStatus": "ApprovementWaiting",
"OtpTransactionId": 754184
}
}UtilizeCreditiumCredit
It makes loan disbursement transactions.
Request
{
"Header": {
"AppKey": "***",
"Channel": "API",
"ChannelSessionId": "331eb5f529c74df2b800926b5f34b874",
"ChannelRequestId": "5252012362481156055"
},
"Parameters": [
{
"ReferenceNumber": "1212",
"OtpTransactionId": 754155,
"OtpCode": "999999"
}
]
}Response
{
"$type": "ServiceResponseMessage",
"Data": {
"$type": "UtilizeCreditiumCreditMessage",
"State": 2
}
}