Get Dealer
Service Address
/Dealer/GetDealer
Request Parameters
PaymentDealerAuthentication
| Parameter | Explanation |
|---|---|
| DealerCode(string) | Dealer code issued by the Moka system |
| Username (string) | Api username given by Moka system |
| Password (string) | Api password given by Moka system |
| CheckKey (string) | The control key (DealerCode + "MK" + Username + "PD" + Password) is created by passing this information, combined as a String, through the SHA-256 hash algorithm. Click here to go to the trial screen. |
PaymentDealerRequest
| Parameter | Explanation |
|---|---|
| SubDealerCode (string) | It is the "DealerCode" field given to you in the result returned from the successfully run "CreateDealer" service. This is the Moka dealer code for your sub-dealer. |
Returns
| Parameter | Explanation |
|---|---|
| DealerId (integer) | The dealer's ID in the Moka system |
| DealerCode (string) | Dealer's Code in Moka system (used for API operations) |
| UserName (string) | Reseller's API username |
| Password (string) | Reseller's API password |
| DealerName (string) | Dealer's name |
| DealerType (integer) | Type of dealer 1 : Real Person (No Tax Plate), 2 : Legal Entity (Ltd.A.Ş), 3: Legal Entity (Personal Firm) (Mandatory) |
| Title (string) | Dealer's title |
| ContactName (string) | Dealer's authorized person name |
| PhoneNumber (string) | Telephone of the dealer or authorized person |
| Email (string) | Email address of the dealer or authorized person |
| IdentityNumber (string) | TC number of the authorized person |
| WebSiteURL (string) | Dealer's web address |
| NaceCode (string) | Main activity code of the dealer on the tax plate (6 digits) |
| IsThreeDRequired (bool) | Is 3D payment mandatory for this dealer? (True, False) |
| DailyTrxAmountLimit (decimal) | Daily payment amount limit (in TL) |
| DailyTrxNumberLimit (integer) | Daily payment limit |
| DailyTrxAmountLimitNon3D (decimal) | Daily Non-3D payment amount limit (TL) – if 3D is mandatory |
| DailyTrxNumberLimitNon3D (integer) | Daily Non-3D payment limit – if 3D is mandatory |
| EachTrxAmountLimit (decimal) | Amount limit for each payment transaction (in TL) |
| EachTrxAmountLimitNon3D (decimal) | Amount limit for each Non-3D payment transaction (TL) – if 3D is mandatory |
| DailyCardAmountLimit (decimal) | Daily limit of payment from the same card (in TL) |
| DailyCardNumberLimit (integer) | Quantity limit to pay from the same card per day |
| DailyCardNumberAlertLimit (integer) | Number of daily payments from the same card (only alarm occurs) |
| MonthlyTrxAmountLimit (decimal) | Monthly payment amount limit (in TL) |
| MonthlyTrxNumberLimit (integer) | Limit of monthly payments |
| MonthlyTrxAmountLimitNon3D (decimal) | Monthly Non-3D payment amount limit (TL) – if 3D is mandatory |
| MonthlyTrxNumberLimitNon3D (integer) | Monthly non-3D payment limit – if 3D is mandatory |
| IBan (string) | The bank account number to which the money will be deposited. |
| IBanFullName (string) | Name and surname of the account holder to whom the money will be deposited |
| Bank (string) | Bank names |
| CommissionStartDate (dacetime) | Starting date of the commission rate to be applied to the dealer |
| CommissionRate (decimal) | Percentage commission rate to be received from the dealer |
| CommissionAmount (decimal) | Fixed commission amount to be taken from the dealer |
| CommissionRateFC (decimal) | Percentage commission rate for foreign currency withdrawal from the dealer |
| CommissionAmountFC (decimal) | Fixed commission amount to be charged for foreign currency withdrawal from the dealer |
| CommissionRateDebit (decimal) | Percentage commission rate for bank cards from the dealer |
| CommissionAmountDebit (decimal) | Fixed commission amount for bank cards from the dealer |
| CommissionAmountInternational (decimal) | Fixed commission amount to be collected from the dealer for international cards (undefined thousands) |
| CommissionRate2 (decimal) | Percentage commission rate to be taken from the dealer when the number of installments is 2 |
| CommissionRate3 (decimal) | Percentage commission rate to be received from the dealer when the number of installments is 3 |
| CommissionRate4 (decimal) | When the number of installments is 4, the percentage commission rate to be received from the dealer |
| CommissionRate5 (decimal) | Percentage commission rate to be taken from the dealer when the number of installments is 5 |
| CommissionRate6 (decimal) | Percentage commission rate to be taken from the dealer when the number of installments is 6 |
| CommissionRate7 (decimal) | Percentage commission rate to be received from the dealer when the number of installments is 7 |
| CommissionRate8 (decimal) | Percentage commission rate to be taken from the dealer when the number of installments is 8 |
| CommissionRate9 (decimal) | Percentage commission rate to be received from the dealer when the number of installments is 9 |
| CommissionRate10 (decimal) | Percentage commission rate to be received from the dealer when the number of installments is 10 |
| CommissionRate11 (decimal) | Percentage commission rate to be received from the dealer when the number of installments is 11 |
| CommissionRate12 (decimal) | Percentage commission rate to be received from the dealer when the number of installments is 12 |
Sample Request (JSON)
{
"DealerAuthentication":{
"DealerCode":"xxx",
"Username":"xxx",
"Password":"xxx",
"CheckKey":"28ba1f316e661ee7a0477a13aa30613da548c94a8098829af9255b04d7e916e3"
},
"DealerRequest":{
"SubDealerCode":"2460"
}
}
Successful Request Result
If the sent request data has been processed successfully in Moka, "Success" information is written in the "ResultCode" field of the return object . In the "Data" field, the result of the transaction returned from the bank is found. The status of the operation is checked by checking the "IsSuccessful" (true/false) field in "Data" . If this field returns false, it can be seen why the operation failed on the virtual pos by checking the ResultCode and ResultMessage fields in the same object.
Successful Result Example
{
"Data":{
"DealerId":2460,
"DealerCode":"2460",
"DealerName":"Zeynep Hashan",
"Username":"xxxxxxxxx",
"Password":"xxxxxxxxxxx",
"DealerType":1,
"Title":"Zeynep Hashan",
"ContactName":"Zeynep Hashan",
"PhoneNumber":"5455415555",
"Email":"zeynep.hashan@moka.com",
"IdentityNumber":"68012069620",
"WebSiteURL":"",
"NaceCode":"",
"IsThreeDRequired":true,
"DailyTrxAmountLimit":1500.00,
"DailyTrxNumberLimit":15,
"DailyTrxAmountLimitNon3D":5.00,
"DailyTrxNumberLimitNon3D":100,
"EachTrxAmountLimit":2.00,
"EachTrxAmountLimitNon3D":20.00,
"DailyCardAmountLimit":5.00,
"DailyCardNumberLimit":10,
"DailyCardNumberAlertLimit":10,
"MonthlyTrxAmountLimit":5000.00,
"MonthlyTrxNumberLimit":50,
"MonthlyTrxAmountLimitNon3D":6.00,
"MonthlyTrxNumberLimitNon3D":100,
"IBan":"TR480006214645589777765216",
"IBanFullName":"IbanName",
"CommissionList":[
{
"GroupName":"",
"Bank":"0 - Genel",
"CommissionStartDate":"2019-10-04T16:48:06.997",
"CommissionRate":2.30,
"CommissionAmount":0.00,
"CommissionRateFC":0.00,
"CommissionAmountFC":0.00,
"CommissionRate2":-1.00,
"CommissionRate3":-1.00,
"CommissionRate4":-1.00,
"CommissionRate5":-1.00,
"CommissionRate6":-1.00,
"CommissionRate7":-1.00,
"CommissionRate8":-1.00,
"CommissionRate9":-1.00,
"CommissionRate10":-1.00,
"CommissionRate11":-1.00,
"CommissionRate12":-1.00,
"CommissionRateDebit":-1.00,
"CommissionAmountDebit":0.00,
"CommissionRateInternational":-1.00,
"CommissionAmountInternational":0.00
},
{
"GroupName":"AXESS",
"Bank":"4 - AKBANK",
"CommissionStartDate":"2019-10-04T16:48:06.997",
"CommissionRate":2.30,
"CommissionAmount":0.00,
"CommissionRateFC":0.00,
"CommissionAmountFC":0.00,
"CommissionRate2":4.47,
"CommissionRate3":5.13,
"CommissionRate4":5.78,
"CommissionRate5":6.44,
"CommissionRate6":7.09,
"CommissionRate7":7.75,
"CommissionRate8":8.41,
"CommissionRate9":9.06,
"CommissionRate10":-1.00,
"CommissionRate11":-1.00,
"CommissionRate12":-1.00,
"CommissionRateDebit":-1.00,
"CommissionAmountDebit":0.00,
"CommissionRateInternational":-1.00,
"CommissionAmountInternational":0.00
},
{
"GroupName":"CARDFINANS",
"Bank":"98 - FİNANSBANK",
"CommissionStartDate":"2019-10-04T16:48:06.997",
"CommissionRate":2.30,
"CommissionAmount":0.00,
"CommissionRateFC":0.00,
"CommissionAmountFC":0.00,
"CommissionRate2":4.35,
"CommissionRate3":5.00,
"CommissionRate4":5.95,
"CommissionRate5":6.90,
"CommissionRate6":7.85,
"CommissionRate7":8.75,
"CommissionRate8":9.70,
"CommissionRate9":10.65,
"CommissionRate10":-1.00,
"CommissionRate11":-1.00,
"CommissionRate12":-1.00,
"CommissionRateDebit":-1.00,
"CommissionAmountDebit":0.00,
"CommissionRateInternational":-1.00,
"CommissionAmountInternational":0.00
},
{
"GroupName":"MAXIMUM",
"Bank":"122 - İŞ BANKASI",
"CommissionStartDate":"2019-10-04T16:48:06.997",
"CommissionRate":2.30,
"CommissionAmount":0.00,
"CommissionRateFC":0.00,
"CommissionAmountFC":0.00,
"CommissionRate2":4.50,
"CommissionRate3":5.00,
"CommissionRate4":5.50,
"CommissionRate5":6.50,
"CommissionRate6":7.00,
"CommissionRate7":7.50,
"CommissionRate8":8.50,
"CommissionRate9":9.50,
"CommissionRate10":-1.00,
"CommissionRate11":-1.00,
"CommissionRate12":-1.00,
"CommissionRateDebit":-1.00,
"CommissionAmountDebit":0.00,
"CommissionRateInternational":-1.00,
"CommissionAmountInternational":0.00
},
{
"GroupName":"BONUS",
"Bank":"168 - ŞEKERBANK",
"CommissionStartDate":"2019-10-04T16:48:06.997",
"CommissionRate":2.30,
"CommissionAmount":0.00,
"CommissionRateFC":0.00,
"CommissionAmountFC":0.00,
"CommissionRate2":5.00,
"CommissionRate3":5.75,
"CommissionRate4":6.25,
"CommissionRate5":6.75,
"CommissionRate6":7.25,
"CommissionRate7":7.75,
"CommissionRate8":8.25,
"CommissionRate9":9.00,
"CommissionRate10":-1.00,
"CommissionRate11":-1.00,
"CommissionRate12":-1.00,
"CommissionRateDebit":-1.00,
"CommissionAmountDebit":0.00,
"CommissionRateInternational":-1.00,
"CommissionAmountInternational":0.00
},
{
"GroupName":"WORLD",
"Bank":"215 - YAPI KREDİ",
"CommissionStartDate":"2019-10-04T16:48:07.01",
"CommissionRate":2.30,
"CommissionAmount":0.00,
"CommissionRateFC":0.00,
"CommissionAmountFC":0.00,
"CommissionRate2":5.00,
"CommissionRate3":5.55,
"CommissionRate4":6.50,
"CommissionRate5":7.00,
"CommissionRate6":7.50,
"CommissionRate7":8.00,
"CommissionRate8":8.50,
"CommissionRate9":9.00,
"CommissionRate10":-1.00,
"CommissionRate11":-1.00,
"CommissionRate12":-1.00,
"CommissionRateDebit":-1.00,
"CommissionAmountDebit":0.00,
"CommissionRateInternational":-1.00,
"CommissionAmountInternational":0.00
}
]
},
"ResultCode":"Success",
"ResultMessage":"",
"Exception":null
}
Failed Request Result
If the sent request data could not be processed in Moka streams, the "ResultCode" field of the return object contains one of the error codes in the table below.
When an unexpected software error occurs, EX is written in the "ResultCode" field and the error message (Exception) is displayed in the "ResultMessage" field
In both cases, the "Data" object arrives as null.
| ResultCode | Explanation |
|---|---|
| Dealer.CheckDealerAuthentication.InvalidRequest | The CheckKey may be bad, or the object may be bad, or the JSON may be corrupt. |
| Dealer.GetDealer.InvalidAccount | No such dealer was found, Dealer code, dealer username and/or password were entered incorrectly. |
| Dealer.GetDealer.SubDealerCodeRequired | Sub-dealer code required |
| Dealer.GetDealer.SubDealerNotFound | Sub-dealer not found. |
| Dealer.GetDealer.GetDealerNotAllowed | The dealer is not allowed |
| EX | An unexpected error has occurred. |
Example of Failed Result
{
"Data":null,
"ResultCode":"Dealer.GetDealer.SubDealerNotFound",
"ResultMessage":"",
"Exception":null
}