handover_activation Navigate to XML API

This REST API is used to check if the specific Zip Code is added as a serviceable area in Telgoo5. If an specific Zip Code is not added a serviceable area, partner can add using Telgoo5 or contact their account manager for assistance.

End Point https://www.vcareapi.com:8080/handover
Field (Short Description) Value/Tag Name Format Field Example Type Notes Validation rules
action String handover_activation Required This needs to be passed as handover_activation handover_activation
enrollment_id String ABC123 Required
esn String 4544546465 Required
areacode String Required
source String API Required Source of the order/application/API call Expected Value:API, TABLET, WEBSITE
agent_id String John Doe Required This is the Telgoo5 user id for the Agent/Employee who is sending the API request.
handover_type String Optional
model_name_paid String Optional
advance_billing_month_txt String Optional
card_type String VISA Optional This is the type of the card. Required if ACTION="sale" or "auth". VISA, MASTERCARD, DISCOVER, AMERICAN EXPRESS, AMEX
card_number String 4111111111111110 Optional This is the credit/debit card number. Required if ACTION="sale" or "auth". Max=16 digits
cvv String 234 Optional This is the CVV number of the card. Required if ACTION="sale" or "auth". Max=4 digits
expiration_month String 11 Optional This is the expiration month of the credit/debit card. Required if ACTION="sale" or "auth".Max. digits=2
expiration_year String 2018 Optional This is the expiration year of the credit/debit. Required if ACTION="sale" or "auth".Exactly 4 digits.
name_on_card String John Doe Optional This is the name on the credit/debit. Required if ACTION="sale" or "auth".
billing_state String CA Optional This is the state of the registered billing address in the bank account to which the card is associated. Required if ACTION="sale" or "auth". State should be standard abbreviated form.
billing_city String San Jose Optional Required if ACTION="sale" or "auth". This is the Billing address City for the associated bank account. Should allow only letters, hyphen and space.
billing_zip String 90001 Optional Required if ACTION="sale" or "auth". This is the Billing address Zip Code for the associated bank account. Should not allow letters and special characters, only numbers should be exactly 5 digits.
billing_address1 String 123 Main st Optional This is the Billing address line 1 for the associated bank account.
 Required if ACTION="sale" or "auth". Should allow only letters, numbers, space and: hyphen ; forward slash Max length for the fields - 50 symbols. Cannot contain phrases "PO Box" or "P.O. Box".
billing_address2 String Apt 1 Optional Required if ACTION="sale" or "auth". This is the Billing address line 2 for the associated bank account. Should allow only letters, numbers, space and: hyphen ; forward slash Max length for the fields - 50 symbols. Cannot contain phrases "PO Box" or "P.O. Box".
brand_code String EDF90 Optional
carrier String SPR/ATTH Optional
device_id String 1221 Optional
device_type String CDMA / GSM Optional
sku_type String EDF90 Optional
uiccid String 4545545454545 Optional
agent_password String JohnDoe Optional This is the password for the Agent Id mentioned above. This is configuration level field. If you have set the permissions for the Agent Id for the requirement of the password in API transactions then you will need to pass the Agent Password in all the REST API transaction, else if you have set the permissions to password not required then you don't need to pass the Agent Password in the REST API.
child_device_id String 350802890 Optional
payment_method String CREDIT_CARD Optional Method of Payment: CREDIT_CARD, CASH, COUPONCODE etc. Default is CREDIT_CARD
set_autopay String Y or N Optional
service_zip String 74501 Optional
device_benefit_already_reimbursed String Y or N Optional
is_free_phone_order String Y or N Optional
is_paid_phone_order String Y or N Optional
model_id String AN12345 Optional
coupon_info array Optional {
"coupon_code" :"TEST11",
"address_one": "2013 S CHESTNUT ST",
"address_two": "",
"city":"PINE BLUFF",
"state":"AR",
"zip_code":"71601"
}
Sample Request REST
{  
   "enrollment_id":"EPCX1568",
   "esn":"400500600",
   "card_type":"",
   "card_number":"",
   "cvv":"",
   "expiration_month":"",
   "expiration_year":"",
   "name_on_card":"",
   "billing_state":"AR",
   "billing_city":"PINE BLUFF",
   "billing_zip":"71601",
   "billing_address1":"2013 S CHESTNUT ST",
   "billing_address2":"",
   "child_device_id":"",
   "payment_method": "COUPONCODE",
   "set_autopay":"",
   "service_zip":"71601",
   "device_benefit_already_reimbursed": "Y",
   "is_free_phone_order":"Y",
   "is_paid_phone_order":"",
   "model_id":"",
   "coupon_info": {
        "coupon_code" :"TEST11",
        "address_one": "2013 S CHESTNUT ST",
        "address_two": "",
        "city":"PINE BLUFF",
        "state":"AR",
        "zip_code":"71601"
   },
   "action":"handover_activation",
   "agent_id":"ewebsiteapi",
   "source":"ENROLLMENT_PORTAL",
}
List of status code, description and resolution.
Status Code Description How to Resolve?
RESTAPI000 SUCCESS SUCCESS
RESTAPI001 FAIL Multiple errors like Invalid Token, Token already used, Token expire & Invalid Access!!
RESTAPI101 FAIL Module required.
RESTAPI102 FAIL Action required.
RESTAPI103 FAIL Source Not Allowed.
RESTAPI104 FAIL Invalid Agent ID or Password.
RESTAPI105 FAIL Module does not exist.
RESTAPI106 FAIL Action does not exist.
RESTAPI107 FAIL Invalid company.
RESTAPI108 FAIL Invalid method.
RESTAPI109 FAIL Unauthorized Access.
RESTAPI010 FAIL Multiple errors come in an array.
Sample Response
{  
   "data":{  
      "enrollment_id":"EPCX1568",
      "customer_id":"40",
      "customer_firstname":"ANTHONY",
      "customer_lastname":"HURST",
      "plan_id":"394",
      "plan_price":"0.00",
      "customer_state":"AR"
   },
   "success":"successfully proceed",
   "msg_code":"RESTAPI000",
   "msg":"Success",
   "token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.OTM0fQ.bG15ow1TqsA8-8yvk4blibP1XvIhUKAw1BJDOlNXEc0"
}
SUCCESS
Sample Fail Response: 1
{
    
    "msg": "Invalid Token",
    "msg_code": "RESTAPI001",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Invalid Token
How to Resolve?: Provide valid token in header
Sample Fail Response: 2
{
    
    "msg": "Invalid Access!!",
    "msg_code": "RESTAPI001",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Invalid Access!!
How to Resolve?: Request method will be POST
Sample Fail Response: 3
{
    "errors":["Source Not Allowed"]
    "msg": "Source Not Allowed",
    "msg_code": "RESTAPI103",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Source Not Allowed
How to Resolve?: Provide valid Source
Sample Fail Response: 4
{
    "errors":["Agent Id should not be blank"]
    "msg": "Agent Id should not be blank",
    "msg_code": "RESTAPI104",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Agent Id should not be blank
How to Resolve?: Provide valid Agent Id
Sample Fail Response: 5
{
    "errors":["Invalid Agent Id"]
    "msg": "Invalid Agent Id",
    "msg_code": "RESTAPI104",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Invalid Agent Id
How to Resolve?: Provide valid Agent Id
Sample Fail Response: 6
{
    
    "msg": "Token already used",
    "msg_code": "RESTAPI001",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Token already used
How to Resolve?: You can use token once per request
Sample Fail Response: 7
{
    
    "msg": "Token expire",
    "msg_code": "RESTAPI001",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Token expire
How to Resolve?: Create token again
Sample Fail Response: 8
{
    "errors":["Please enter Enrollment Id"]
    "msg": "Error occurred",
    "msg_code": "RESTAPI110",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Error occurred
How to Resolve?: Provide Enrollment Id

All the status codes are listed under the status code sections. Please click here to go to the status code.