Service Address
/DealerCustomer/AddCustomer
Request Parameters
DealerCustomerAuthentication
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. |
DealerCustomerRequest
Parameter |
Explanation |
CustomerCode (string) |
Unique code/number to identify the customer on the dealer side (Max 100 chars) |
Password (string) |
When the customer wants to withdraw from his stored card, if the dealer wants the customer's password to be asked, the customer's own password is entered in this field. (Max 50 chars) |
FirstName (string) |
Customer's name (Max 50 chars) |
LastName (string) |
Customer's last name (Max 50 chars) |
Gender (integer) |
Gender of the customer (1: male 2: female) |
BirthDate (date) |
Customer's date of birth (in YYYYMMDD format, ex: "19901218") |
GsmNumber (string) |
Customer's phone (Max 20 chars) |
Email (string) |
Customer's email address (Max 100 chars) |
Address (string) |
Customer's address (Max 200 chars) |
Sample Request (JSON)
{
"DealerCustomerAuthentication": {
"DealerCode": "xxx",
"Username": "xxx",
"Password": " xxx",
"CheckKey": "aabbccddeeff"
},
"DealerCustomerRequest": {
"CustomerCode": "Customer",
"Password": "Elif1234",
"FirstName": "Elif",
"LastName": "Yetimoğlu",
"Gender": "2",
"BirthDate": "19901218",
"GsmNumber": "5301111111",
"Email": "elif.y@moka.com",
"Address": "TAŞDELEN"
}
}
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 |
DealerCustomerId (integer) |
When the customer is added, the Unique Id in Moka is returned |
CustomerCode (string) |
Unique code given by the dealer to its customer. |
Password (string) |
When the customer wants to withdraw from his stored card, if the dealer wants the customer's password to be asked, the customer's own password is entered in this field. (Max 50 chars) |
FirstName(string) |
If the customer is to be registered in the Moka system for the first time, the customer's name is entered. |
LastName (string) |
If the customer is to be registered in the Moka system for the first time, the customer's surname is entered. |
Gender (integer) |
If the customer is to be registered in the Moka system for the first time, the gender of the customer is entered. 1: male 2: female |
BirthDate (date) |
If the customer is to be registered in the Moka system for the first time, the date of birth of the customer is entered. |
GsmNumber (integer) |
If the customer is to be registered in the Moka system for the first time, the customer's mobile phone is entered.. |
Email (integer) |
If the customer is to be registered in the Moka system for the first time, the customer's email address is entered. |
Address (integer) |
If the customer is to be registered in the Moka system for the first time, the customer's residential address is entered. |
CardListCount (integer) |
The number of the customer's stored cards. "0" |
CardList (Array) |
Since the customer has just been added, the customer's card list will be empty. |
Successful Result Example
{
"Data": {
"DealerCustomer": {
"DealerCustomerId": 1033,
"CustomerCode": "Customer",
"Password": "Elif1234",
"FirstName": "Elif",
"LastName": "Y",
"Gender": 2,
"BirthDate": "19901218",
"GsmNumber": "5301111111",
"Email": "elif.y@moka.com",
"Address": "TAŞDELEN"
},
"CardListCount": 0,
"CardList": []
},
"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 |
DealerCustomer.AddCustomer.InvalidRequest | The CheckKey may be bad, or the object may be bad, or the JSON may be corrupt. |
DealerCustomer.AddCustomer.CustomerCodeAlreadyUsing | There is a registration with the customer code sent. |
DealerCustomer.AddCustomer.InvalidEmailFormat | Invalid e-mail address |
EX | An unexpected error has occurred |
Example of Failed Result
{
"Data": null,
"ResultCode": "DealerCustomer.AddCustomer.CustomerCodeAlreadyUsing",
"ResultMessage": "",
"Exception": null
}