Get Payment Plan

Service Address

/DealerSale/GetPaymentPlan

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.

Sample Request (JSON)


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

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)	This is the Unique Id given by Moka for this payment step.
DealerSaleId (integer)	On the Moka side, it is the Id of the sale to which this payment step is added.
SaleCode (integer)	It is the code of the sale to which this payment step is added on the dealer side.
PaymentDate (string)	Date of shooting
Amount (decimal)	Amount to be withdrawn
Currency (string)	Currency unit
InstallmentNumber (integer)	Installment information
HistoryDate (datetime)	If the payment date has come and the payment process has been started, the date of the last withdrawal attempt will be returned, otherwise it will be blank.
CardToken (guid)	If the payment date has come and the payment process has been started, the Token of the credit card will be returned, otherwise it will be blank.
DealerCustomerTypeId (integer)	If payment is made by sending a payment request, it will be filled.
UserPosPaymentId (integer)	If the payment date has come and the payment process has been started, the Token of the credit card will be returned, otherwise it will be blank.
DealerPaymentId (integer)	If the payment date has come and the payment process has been started, the payment ID of the last withdrawal will be returned, otherwise it will be blank.
IsManualPlan (boolean)	It turns "true" if it is a manually entered payment step, "false" if it is automatically created by the Moka system according to the dealer's time schedule.
PlanStatus (integer)	0 : The plan is formed, it is not time to shoot yet. 1 : Shooting completed successfully. 2 : Shooting failed. Will try again. 3: Shooting failed, will not be attempted again..

Successful Result Example


{
	"Data": {
		"DealerPaymentPlanId": 1003,
		"DealerSaleId": 1003,
		"SaleCode": "satis",
		"PaymentDate": "20170825",
		"Amount": 1,
		"Currency": "TL",
		"InstallmentNumber": 1,
		"HistoryDate": "",
		"CardToken": "",
		"DealerCustomerTypeId": 0,
		"UserPosPaymentId": 0,
		"DealerPaymentId": 0,
		"IsManualPlan": true,
		"PlanStatus": 0
	},
	"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.GetPaymentPlan.PaymentPlanNotFound	Payment plan not found.
DealerSale.GetPaymentPlan.DealerPaymentPlanIdIsRequired	Reseller payment plan id is required.
DealerSale.GetPaymentPlan.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.GetPaymentPlan.DealerPaymentPlanIdIsRequired",
	"ResultMessage": "",
	"Exception": null
}