Get Payment Plan History List

Service Address

/DealerSale/GetPaymentPlanHistoryList

Request Parameters

DealerSaleAuthentication

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.

DealerSaleRequest

Parameter	Explanation
DealerPaymentPlanId (integer)	It is the Unique Id of the payment step on the Moka side. The withdrawal histories (attempts) of this payment step will be displayed.

Sample Request (JSON)


{
	"DealerSaleAuthentication": {
		"DealerCode": "xxx",
		"Username": "xxx",
		"Password": "xxx",
		"CheckKey": "aabbccddeeff"
	},
	"DealerSaleRequest": {
		"DealerPaymentPlanId": "1"
	}
}

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 . The "Data" field contains the result of the returned operation. You can continue your flows by checking the information in "Data" .

Parameter

Explanation

DealerPaymentPlanId (integer)

It is the Unique Id of the payment step on the Moka side.

PaymentPlanHistoryListCount (integer)

Number of withdrawal histories (attempts) of the payment step

PaymentPlanHistoryList (Array)

List of withdrawal histories of the payment step

DealerPaymentPlanHistoryId (integer)	It is the Id given to the history of the payment step on the Moka side.
HistoryDate (datetime)	The date and time of each withdrawal attempt for the payment step
Amount (decimal)	Withdrawal amount
Currency (string)	Currency unit
InstallmentNumber (integer)	Installment amount (0 or 1 means cash)
CreditCardToken (guid)	From which card was the attempt made to shoot?
DealerCustomerTypeId (integer)	Customer type Id, if withdrawn by submitting a payment request.
DealerPaymentId (integer)	By Moka, this is the Unique Payment Id given for the withdrawal attempt
HistoryStatus (integer)	0 : Failed Capture 1 : Successful Capture
ServiceMessage (string)	Error code and message returned from our payment service

Successful Result Example


{
	"Data": {
		"PaymentPlanHistoryListCount": 1,
		"PaymentPlanHistoryList": [
			{
				"DealerPaymentPlanHistoryId": 1,
				"HistoryDate": "2017-08-17T16:52:22.963",
				"Amount": 0.01,
				"Currency": "",
				"InstallmentNumber": 1,
				"CreditCardToken": "1635BF45-854F-4D5D-83B7-E40B87C72703",
				"DealerCustomerTypeId": 0,
				"UserPosPaymentId": 0,
				"DealerPaymentId": 29940,
				"HistoryStatus": true,
				"ServiceMessage": ""
			}
		]
	},
	"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
DealerSale.GetPaymentPlanHistoryList.NoDataFound	Data not found.
DealerSale.GetPaymentPlanHistoryList.PaymentPlanNotFound	Payment plan not found.
DealerSale.GetPaymentPlanHistoryList.DealerPaymentPlanIdIsRequired	Reseller payment plan id is required.
DealerSale.GetPaymentPlanHistoryList.InvalidRequest	The CheckKey may be bad, or the object may be bad, or the JSON may be corrupt
EX	An unexpected error has occurred

Example of Failed Result


{
	"Data": null,
	"ResultCode": "DealerSale.GetPaymentPlanHistoryList.DealerPaymentPlanIdIsRequired",
	"ResultMessage": "",
	"Exception": null
}