It will contain all the User related API calls. It includes API call like Login, Forgot Password, Registration etc

Endpoint Description
POST rest/login Authenticate and Login to the system
POST rest/forgotPassword Forgot password can be retrieved with this.
POST rest/checkEmailExistance Check the existence of email in the studio
POST rest/authUserPaymentInfo Authenticate entered card details.
POST rest/registerUser Registering a user to a studio

Login

Using the request parameter email and password a user can login to the system. Logged in user will return the user details but if fails then it will return error code and message with that.

Parameters

Name Required? Type Description
authToken Optional String Valid authToken
password Optional string Password

Example Response

{
    "id": "123214",
    "email": "johnmuvi@gmail.com",
    "display_name": "John Doe",
    "studio_id": "3215",
    "profile_image": "http:\/\/d2gx0xinochgze.cloudfront.net\/public\/no-user.png",
    "code": 200,
    "status": "OK",
    "msg": "Login Success"
}

Forgot Password

A user can retrieve his/her forgot password by using this method. It will ask for entering valid email and if email is valid then a reset link will be sent to users email. Using that link user can be able to reset the password.

Parameters

Name Required? Type Description
authToken Optional String Valid Auth Token
email Optional string Email

Example Response

{
    "code": 200,
    "status": "OK",
    "msg": "Please check your email to reset your password."
}

Check Email Existence

It will take the email id as input and check if that email id exists for the studio or Not.

Parameters

Name Required? Type Description
authToken Optional String Valid authToken

Example Response

{
    "isExists": 0,
    "code": 200,
    "msg": "OK"
}

Authenticate Card

It will take the card details as input and authenticate if the card is valid or not. If valid then it will create a profile in the chosen payment gateway by the studio.

Parameters

Name Required? Type Description
authToken Optional String Valid authToken
nameOnCard Optional String Name as on credit card
cardNumber Optional String Credit card Number
expiryMonth Optional Integer Expiry Month as on Card
expiryYear Optional Integer Expiry Year as on card
cvv Optional Integer CVV as on Card

Example Response

{
"isSuccess": 1,
"TransactionRecord": "========== TRANSACTION RECORD ==========\nMuvi DEMO0848\nBhubaneswar, odisha, India\nBhubaneswar, AL 751013\nUnited States\n\n\nTYPE: Pre-Authorization\n\nACCT: Visa                    $ 0.00 USD\n\nCARDHOLDER NAME : gayadhar khilar\nCARD NUMBER     : ############1111\nDATE\/TIME       : 15 Sep 15 08:36:20\nREFERENCE #     : 03 000352 T\nAUTHOR. #       : ET123629\nTRANS. REF.     : \n\n    Approved - Thank You 100\n\n\nPlease retain this copy for your records.\n\nCardholder will pay above amount to\ncard issuer pursuant to cardholder\nagreement.\n========================================",
"code": "100",
"card": {
"profile_id": "",
"status": "Approved",
"reference_no": 62387603,
"card_type": "Visa",
"card_last_fourdigit": "############1111",
"auth_num": "ET123629",
"token": "8831993568031111",
"response_text": "O:9:\"FirstData\":10:{s:11:\"\u0000*\u0000username\";s:9:\"AI1578-05\";s:11:\"\u0000*\u0000password\";s:32:\"4cfbpr5x3k9yux227g5a612p800xyae8\";s:18:\"\u0000*\u0000transactionType\";s:2:\"01\";s:12:\"\u0000*\u0000errorCode\";i:0;s:15:\"\u0000*\u0000errorMessage\";s:0:\"\";s:11:\"\u0000*\u0000response\";s:1358:\"{\"transaction_error\":0,\"transaction_approved\":1,\"exact_resp_code\":\"00\",\"exact_message\":\"Transaction Normal\",\"bank_resp_code\":\"100\",\"bank_message\":\"Approved\",\"sequence_no\":\"000352\",\"cvv2\":\"M\",\"retrieval_ref_no\":\"4469925\",\"merchant_name\":\"Muvi DEMO0848\",\"merchant_address\":\"Bhubaneswar, odisha, India\",\"merchant_city\":\"Bhubaneswar\",\"merchant_province\":\"Alabama\",\"merchant_country\":\"United States\",\"merchant_postal\":\"751013\",\"ctr\":\"========== TRANSACTION RECORD ==========\\nMuvi DEMO0848\\nBhubaneswar, odisha, India\\nBhubaneswar, AL 751013\\nUnited States\\n\\n\\nTYPE: Pre-Authorization\\n\\nACCT: Visa                    $ 0.00 USD\\n\\nCARDHOLDER NAME : gayadhar khilar\\nCARD NUMBER     : ############1111\\nDATE\/TIME       : 15 Sep 15 08:36:20\\nREFERENCE #     : 03 000352 T\\nAUTHOR. #       : ET123629\\nTRANS. REF.     : \\n\\n    Approved - Thank You 100\\n\\n\\nPlease retain this copy for your records.\\n\\nCardholder will pay above amount to\\ncard issuer pursuant to cardholder\\nagreement.\\n========================================\",\"gateway_id\":\"AI1578-05\",\"transaction_type\":\"01\",\"amount\":0.0,\"transaction_tag\":62387603,\"authorization_num\":\"ET123629\",\"cc_expiry\":\"0617\",\"cardholder_name\":\"gayadhar khilar\",\"cc_verification_str2\":\"121\",\"cvd_presence_ind\":1,\"currency_code\":\"USD\",\"partial_redemption\":0,\"transarmor_token\":\"8831993568031111\",\"credit_card_type\":\"Visa\"}\";s:10:\"\u0000*\u0000headers\";a:26:{s:3:\"url\";s:62:\"https:\/\/api.demo.globalgatewaye4.firstdata.com\/transaction\/v11\";s:12:\"content_type\";s:31:\"application\/json; charset=utf-8\";s:9:\"http_code\";i:201;s:11:\"header_size\";i:489;s:12:\"request_size\";i:440;s:8:\"filetime\";i:-1;s:17:\"ssl_verify_result\";i:0;s:14:\"redirect_count\";i:0;s:10:\"total_time\";d:1.326000000000000067501559897209517657756805419921875;s:15:\"namelookup_time\";d:0;s:12:\"connect_time\";d:0.296999999999999986233234494648058898746967315673828125;s:16:\"pretransfer_time\";d:0.87399999999999999911182158029987476766109466552734375;s:11:\"size_upload\";d:243;s:13:\"size_download\";d:1358;s:14:\"speed_download\";d:1024;s:12:\"speed_upload\";d:183;s:23:\"download_content_length\";d:-1;s:21:\"upload_content_length\";d:243;s:18:\"starttransfer_time\";d:1.326000000000000067501559897209517657756805419921875;s:13:\"redirect_time\";d:0;s:12:\"redirect_url\";s:0:\"\";s:10:\"primary_ip\";s:12:\"54.149.69.83\";s:8:\"certinfo\";a:0:{}s:12:\"primary_port\";i:443;s:8:\"local_ip\";s:13:\"192.168.3.129\";s:10:\"local_port\";i:55948;}s:16:\"\u0000*\u0000arrayResponse\";O:8:\"stdClass\":29:{s:17:\"transaction_error\";i:0;s:20:\"transaction_approved\";i:1;s:15:\"exact_resp_code\";s:2:\"00\";s:13:\"exact_message\";s:18:\"Transaction Normal\";s:14:\"bank_resp_code\";s:3:\"100\";s:12:\"bank_message\";s:8:\"Approved\";s:11:\"sequence_no\";s:6:\"000352\";s:4:\"cvv2\";s:1:\"M\";s:16:\"retrieval_ref_no\";s:7:\"4469925\";s:13:\"merchant_name\";s:13:\"Muvi DEMO0848\";s:16:\"merchant_address\";s:26:\"Bhubaneswar, odisha, India\";s:13:\"merchant_city\";s:11:\"Bhubaneswar\";s:17:\"merchant_province\";s:7:\"Alabama\";s:16:\"merchant_country\";s:13:\"United States\";s:15:\"merchant_postal\";s:6:\"751013\";s:3:\"ctr\";s:567:\"========== TRANSACTION RECORD ==========\nMuvi DEMO0848\nBhubaneswar, odisha, India\nBhubaneswar, AL 751013\nUnited States\n\n\nTYPE: Pre-Authorization\n\nACCT: Visa                    $ 0.00 USD\n\nCARDHOLDER NAME : gayadhar khilar\nCARD NUMBER     : ############1111\nDATE\/TIME       : 15 Sep 15 08:36:20\nREFERENCE #     : 03 000352 T\nAUTHOR. #       : ET123629\nTRANS. REF.     : \n\n    Approved - Thank You 100\n\n\nPlease retain this copy for your records.\n\nCardholder will pay above amount to\ncard issuer pursuant to cardholder\nagreement.\n========================================\";s:10:\"gateway_id\";s:9:\"AI1578-05\";s:16:\"transaction_type\";s:2:\"01\";s:6:\"amount\";d:0;s:15:\"transaction_tag\";i:62387603;s:17:\"authorization_num\";s:8:\"ET123629\";s:9:\"cc_expiry\";s:4:\"0617\";s:15:\"cardholder_name\";s:15:\"gayadhar khilar\";s:20:\"cc_verification_str2\";s:3:\"121\";s:16:\"cvd_presence_ind\";i:1;s:13:\"currency_code\";s:3:\"USD\";s:18:\"partial_redemption\";i:0;s:16:\"transarmor_token\";s:16:\"8831993568031111\";s:16:\"credit_card_type\";s:4:\"Visa\";}s:13:\"\u0000*\u0000postFields\";a:0:{}s:13:\"\u0000*\u0000apiVersion\";s:3:\"v11\";}"
},
"Message": "Approved"
}

Register User

It will register a user to the studio. It requires the parameters as mentioned. If the studio has activated payment gateway then user has to register with a subscription plan to the studio. User has to provide all the information to enter to the system. If registration is successful then user will be logged in to the system and Loggedin information will be returned.

Parameters

Name Required? Type Description
email Optional String Email id to register with
name Optional String Full name of the user
password Optional String Password for login to the application
plan_id Yes Integer Selected Subscription plan id.
nameOnCard Yes String Name as on Card
expiryMonth Yes Integer Expiry Month as on Card
expiryYear Yes Integer Expiry year as on card
card_last_fourdigit Yes String Last 4 digits of the credit card
auth_num Yes String Card authentication Number
token Yes String Token as returned by the payment gateway.
card_type Yes String Type of card as returned from card authentication. (Visa/Master etc)
reference_no Yes String Reference as returned by Payment gateway
response_text Yes Text Complete json response as returned by Payment Gateway.
status Yes String As Returned by Payment Gateway
profile_id Yes String Profile id returned by payment gateway

Example Response

{
"id": "11832233",
"email": "johndoe@gmail.com",
"display_name": "John Doe",
"studio_id": "70242323",
"profile_image": "http:\/\/d2gx0xinochgze.cloudfront.net\/public\/no-user.png",
"code": 200,
"status": "OK",
"msg": "Login Success"
}


We use cookies for best experience on website. By using our site you agree to

Cookies Policy