Service Address
/Dealer/GetAccountingList
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. |
DealerAccountingRequest
Parameter |
Explanation |
TransferStartDate (datetime) |
Transfer start date and time (yyyy-MM-dd HH:mm) (required) |
TransferEndDate (datetime) |
End date and time of transfer (yyyy-MM-dd HH:mm) (required) |
CurrencyCode (string) |
Currency unit. Optional field, if not sent at all or sent blank, all currencies are shown. Other values: USD, EUR, GBP |
SubDealerId (integer) |
Sub-dealer Id. The top dealer should use this field when he wants to see the amount to be deposited with the lower dealer. If you are not a top dealer, do not submit this field or send it blank. |
Returns
Parameter |
Explanation |
AccountingList (Array) |
DealerAccountingId (integer) | Dealer Accounting Id. |
CurrencyCode (string) | Currency unit. |
TransferDate (datetime) | The day the payment is made to the dealer. |
SalesCount (integer) | Number of successful sales transactions. |
SalesTotal (decimal) | The total amount of successful sales transactions. |
SalesCommissionTotal (decimal) | Total commission of sales transactions. |
RefundCount (integer) | The number of successful returns |
RefundTotal (decimal) | The total amount of successful returns. |
RefundCommissionTotal (decimal) | Total commission of returns transactions. |
BlockedCount (integer) | Number of blocks added to the dealer. |
BlockedAmount (decimal) | Block amount added to the dealer. |
UnBlockedCount (integer) | The number of unlocked blocks from the dealer. |
UnBlockedAmount (decimal) | The total amount of the blocks cleared from the dealer. |
ChargebackCount (integer) | Number of objections sent from the bank. |
ChargebackAmount (decimal) | Total amount of objections sent from the bank. |
ChargebackCancelCount (integer) | The number of cancellations of objections sent from the bank. |
ChargebackCancelAmount (decimal) | Cancellation amount of objections sent from the bank. |
DepositAmount (decimal) | Deposit amount. |
DepositCount (integer) | Number of deposits. |
OperationFeeCount (integer) | Total number of operational fees. |
OperationFeeAmount (decimal) | Total amount of operational fees. |
OperationFeeCanceledCount (integer) | Total number of refunds of operational fees. |
OperationFeeCanceledAmount (decimal) | Total amount of refunds of operational fees. |
RefundRequestCount (integer) | The number of return requests from the dealer. |
RefundRequestAmount (decimal) | The total amount of return requests from the dealer. |
TransferCost (decimal) | EFT transaction fee. |
TransferredAmount (decimal) | The total amount to be deposited at the dealer. |
StatementList (string) | Statement list of the relevant accounting record. |
|
Sample Request (JSON)
{
"DealerAuthentication":{
"DealerCode":"XXX",
"Username":"XXX",
"Password":"XXX",
"CheckKey":"560512c3549bf8050064d12fe0325e9c0510a6f477830e96191acf111a679091"
},
"DealerAccountingRequest":{
"TransferStartDate":"2019-02-27",
"TransferEndDate":"2019-03-10",
"CurrencyCode":"TL",
"SubDealerId":""
}
}
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, there is the result of the operation returned from Moka. 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 by checking the ResultCode and ResultMessage fields in the same object. "IsSuccessful" : If true, the number of transactions is written in the "ListItemCount" field.
Data with a date range of up to 31 days can be shown.
The method of calculating the money to be deposited to the dealer is as follows:
TransferredAmount = SalesTotal - SalesCommissionTotal + RefundCommissionTotal - BlockedAmount + UnBlockedAmount - RefundRequestAmount - ChargebackAmount + ChargebackCancelAmount + DepositAmount - TransferCost
Successful Result Example
{
"Data":{
"IsSuccesfull":true,
"ResultCode":"00",
"ResultMessage":"",
"ListItemCount":1,
"AccountingList":[
{
"DealerAccountingId":600,
"CurrencyCode":"TL",
"TransferDate":"2020-06-17T00:00:00",
"SalesCount":0,
"SalesTotal":0.00,
"SalesCommissionTotal":0.00,
"RefundCount":0,
"RefundTotal":0.00,
"RefundCommissionTotal":0.00,
"BlockedCount":0,
"BlockedAmount":0.00,
"UnBlockedCount":0,
"UnBlockedAmount":0.00,
"ChargebackCount":0,
"ChargebackAmount":0.00,
"ChargebackCancelCount":0,
"ChargebackCancelAmount":0.00,
"DepositCount":0,
"DepositAmount":0.00,
"OperationFeeCount":0,
"OperationFeeAmount":0.00,
"OperationFeeCanceledCount":0,
"OperationFeeCanceledAmount":0.0,
"RefundRequestCount":0,
"RefundRequestAmount":0.00,
"TransferCost":0.00,
"TransferredAmount":0.00,
"StatementList":""
}
]
},
"ResultCode":"Success",
"ResultMessage":"",
"Exception":null
}
Failed Request Result
ResultCode | Explanation |
DealerAccounting.GetAccountingList.InvalidDateTimeFormat | The date time format is invalid. |
DealerAccounting.GetAccountingList.NoMoreThanThirtyOneDays | It should not be more than 31 days. |
DealerAccounting.GetAccountingList.InvalidDateRange | The date range is invalid. |
DealerAccounting.GetAccountingList.InvalidCurrencyCode | The currency is incorrect. (Must be in the form of TL, USD, EUR) |
DealerAccounting.GetAccountingList.InvalidSubDealerId | Sub-dealer id is invalid. |
DealerAccounting.GetAccountingList.MissingRequest | Missing request. |
DealerAccounting.GetAccountingList.InvalidRequest | The CheckKey may be bad, or the object may be bad, or the JSON may be corrupt. |
DealerAccounting.GetAccountingList.InvalidAccount | No such dealer was found. |
EX | An unexpected error has occurred |
Example of Failed Result
{
"Data":null,
"ResultCode":"DealerAccounting.GetAccountingList.NoMoreThanThirtyOneDays",
"ResultMessage":"",
"Exception":null
}