Delete Payment Plan
Service Address
/DealerSale/DeletePaymentPlan
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. This payment step will be deleted. Only manually created payment steps can be deleted. |
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" .
Successful Result Example
{
"Data": true,
"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.DeletePaymentPlan.InvalidRequest | The CheckKey may be bad, or the object may be bad, or the JSON may be corrupt |
DealerSale.DeletePaymentPlan.DealerPaymentPlanIdIsRequired | Reseller payment plan id required. |
DealerSale.DeletePaymentPlan.PaymentPlanNotFound | Payment plan not found. |
DealerSale.DeletePaymentPlan.PaymentDatePassed | The payment date has passed.. |
EX | An unexpected error has occurred |
Example of Failed Result
{
"Data": null,
"ResultCode": "DealerSale.DeletePaymentPlan.PaymentPlanNotFound",
"ResultMessage": "",
"Exception": null
}