create_customer_prepaid Navigate to XML API

This REST API is used for creating prepaid customer.

End Point https://www.vcareapi.com:8080/customer
Field (Short Description) Value/Tag Name Format Field Example Type Notes Validation rules
action String create_customer_prepaid Required This needs to be passed as create_customer_prepaid create_customer_prepaid
enrollment_id String WSN977 Required The enrollment id is returned in the CheckServiceAvailability call and you are required to pass the same enrollment id for the enrollment you are attempting Alphanumeric
password String **** Optional This is the password that customer can setup to access the account online or through customer app.
model_id String 23 Optional If you are purchasing an equipment than you need to pass the model_id .The model_id is returned in equipment_list api. numeric
first_name String John Required This is the first name of the applicant. Accepts these special characters: space, apostrophe (‘), accent Grave (`), hyphen (-). Minimum of 1 alphabetic character.
middle_initial String Doe Optional This is the middle name of the subscriber. Accepts these special characters: space, apostrophe (‘), accent Grave (`), hyphen (-). Minimum of 1 alphabetic character
last_name String Doe Required This is the last name of the applicant. Accepts these special characters: space, apostrophe (‘), accent grave (`), hyphen (-). Minimum of 2 alphabetic characters.
alternate_phone_number String 1123113211 Optional 10 digits alternate contact number of the applicant. Only 10 digits are allowed
email String test_customer@vcaremail.com Required This is the applicant email address. Pass the valid email address.
service_address_one String ABC Main St Required Here you should pass the House number and Street of the applicant's service address Accepts these special characters: space, forward slash (/), hash (#), hyphen (-).
service_address_two String apt 7 Optional Here you should pass the apartment number of the applicant's service address. Accepts these special characters: space, forward slash (/), hash (#), hyphen (-)
service_city String CAMDEN Required This is the service address city of the applicant. Accepts these special characters: space, hyphen (-).
service_state String NJ Required This is the service address state of the applicant. State should be standard abbreviated form. Maximum two characters are allowed.
service_zip String 08104 Required This is the service address zipcode of the applicant. Should not allow letters and special characters, only numbers . Should be exactly 5 digits.
plan_id String 606 Required The plan_id is returned in the plan_list api and you are required to pass the same plan_id for the enrollment you are attempting numeric
notify_bill_via_text String Optional This determines the notify bill flag.
notify_bill_via_email String Optional This determines the notify bill flag.
phone_type String 4G Optional
part_number String Optional BYOD
equipment_id String 130 Optional
device_id String 105345443056123 Optional A device ID (device identification) is a distinctive number associated with a smartphone or similar handheld device. If you are giving the device to the customer than you need to pass the device_id. numeric
uiccid String Optional If value passed as 4G in Phone Type, this field becomes required.
brand_code String Optional ASW=>Assurance Wireless BST=>Boost SPP=>Sprint Prepaid VMU=>Virgin Mobile US SPR=>Sprint Retail Postpaid PLD=>Wholesale
sku_type String Optional INTL=>International BYO=>Bring Your Own NEW=>New device to Sprint
esn String 1268487218971713656 Optional If you have the sim/esn at the time of the order than you can pass it. Valid ESN/SIM
carrier String TMB Required This is the carrier on which you are activating the customer. Carrier abbreviated form.
activation_type String NEWACTIVATION Required If you doing the new activation than activation_type should be NEWACTIVATION . If you are doing a portin than activation_type should be portin. Expected values : NEWACTIVATION , PORTIN.
enrollment_type String SHIPMENT Required If you are not shipping anything to the customer then enrollment_type should be HANDOVER else SHIPMENT. Expected values : HANDOVER , SHIPMENT.
handover_type String cbe Required This should be "cbe" if enrollment_type ='HANDOVER'. Expected value : cbe
port_current_carrier String Metro PCS Optional This is the carrier on which the user is currently using the phone. Valid carrier name
port_first_name String John Optional Subscriber's first name with the old service provider. Only required when Activation_type = PORTIN.
port_last_name String Doe Optional Subscriber's last name with the old service provider. Only required when Activation_type = PORTIN.
port_address_one String ABC main street Optional Subscriber's service address line 1 with the old service provider. Only required when Activation_type = PORTIN.
port_address_two String Apt 7 Optional Subscriber's service address line 2 with the old service provider.
port_city String Camden Optional Subscriber's service address city with the old service provider.
port_state String NJ Optional Subscriber's service address state with the old service provider.
port_zip_code String 08104 Optional Subscriber's service address zip code with the old service provider.
port_account_number String 12345 Optional This is the subscriber's account number with the old service provider.
port_account_password String ********** Optional This is the subscriber's account password with the old service provider.
port_ssn String 1234 Optional This is the social security number with the old service provider.
port_number String 1234567895 Optional This is the number that the customer wants to portin Valid 10 digit MDN
billing_address_one String ABC main street Optional Here you should pass the house number and street of the applicant's billing address Accepts these special characters: space, forward slash (/), hash (#), hyphen (-).
billing_address_two String apt 7 Optional Here you should pass the apartment number of the applicant's billing address Accepts these special characters: space, forward slash (/), hash (#), hyphen (-).
billing_city String CAMDEN Optional This is the Billing address City of the applicant. Accepts these special characters: space , hyphen(-)
billing_state String NJ Optional This is the Billing address State of the applicant. State should be standard abbreviated form. Maximum two characters are allowed.
billing_zip String 08104 Optional This is the Billing address Zip Code of the applicant. 5 Digit ZIP code
total_tax String 1.81 Optional
processing_fee String 0.00 Optional If you are charging any processing fee than you can put it here. It is used in case of credit card. Numeric
device_type String CDMA Optional This is device type.
source String API Required Source of the order/application. Expected Value : API , WEBSITE
coupon_code String Optional
coupon_transaction_id String Optional Will get from make_payment API
agent_id String John Doe Required This is the Telgoo5 user id for the Agent/Employee who is sending the API request. This is the user login id which will be created in Telgoo5 for the API user.
agent_password String *********** 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.
dob String 1985-12-01 Required This is the date of birth of the applicant. YYYY-MM-DD is expected. hyphen allowed.
ssn String 1234 Required This is the social security number of the applicant. Only last 4 digits are allowed.
account_number String Optional
service_zip4 String 1032 Optional This is the last 4 digit of the service zip of the customer. It is used to find the specific location of the customer. Valid Zip code.
billing_zip4 String 1032 Optional This is the last 4 digit of the billing zip of the customer. It is used to find the specific location of the customer. Valid Zip code.
imei String 152436521234578 Optional This is the device-id/ IMEI of the device. If you are providing a device to the customer than you need to pass the IMEI/ device_id. Valid IMEI / device_id
security_questions_answers array What is your pet name? Optional This is used in case if the customer forgot there password.
shipping_id String Optional
is_esim String Y or N Optional If the device is esim capable than pass Y else pass N in this field. Y or N
ivr_pin String **** Optional IVR pin is used for authentication
sponsor_id String Optional This is the IBOID , used for tracking the order by the particular agent.
Sample Request REST
{
    "lines": [
        {
            "enrollment_id": "WEXCN7886",
            "password": "1234",
            "first_name": "John",
            "middle_initial": "",
            "last_name": "Doe",
            "alternate_phone_number": "2045691144",
            "email": "test@test.com",
            "service_address_one": "123 main st",
            "service_address_two": "",
            "service_city": "Albert",
            "service_state": "IL",
            "service_zip": "60409",
            "plan_id": "5060",
            "notify_bill_via_text": "",
            "notify_bill_via_email": "",
            "equipment_id": "",
            "equipment_child_id": "",
            "device_id": "",
            "esn": "",
            "carrier": "PLUM",
            "activation_type": "NEWACTIVATION",
            "enrollment_type": "SHIPMENT",
            "handover_type": "",
            "model_id": 23,
              "billing_address_one": "714 W 116th Ave",
            "billing_address_two": "",
                "billing_city": "TAMPA",
               "billing_state": "FL",
              "billing_zip": "60409",
             "device_type": "SIM",
            "port_current_carrier": "",
            "port_first_name": "",
            "port_last_name": "",
            "port_address_one": "",
            "port_address_two": "",
            "port_city": "",
            "port_state": "",
            "port_zip_code": "",
            "port_account_number": "",
            "port_account_password": "",
            "port_number": "",
            "port_ssn": ""
        }
    ],
    "action": "add_line_nonlifeline_customer",
    "agent_id": "ewebsiteapi",
    "source": "WEBSITE",
    "sub_source": "plans",
    "parent_enrollment_id": "WEXCN7886",
    "request_name": "customer",
    "vendor_id": "Telgoo5"
}
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": [
        {
            "data": {
                "cust_id": "5428",
                "customer_id": "5428",
                "enrollment_id": "WEXCN7886",
                "enrollment_type": "SHIPMENT",
                "equipment_purchase": {
                    "msg": "Equipment Successfully purchased!!",
                    "msg_code": 0
                },
                "invoice_number": null,
                "mdn": null,
                "msid": null,
                "msl": ""
            },
            "msg": "Success",
            "msg_code": "RESTAPI000"
        }
    ],
    "msg": "Success",
    "msg_code": "RESTAPI000",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiVGVsZ29vNVVzZXIiLCJwYXNzd29yZCI6Ind0S2h5dXRyd25ZNiIsInBpbiI6IjMyMTY3NDE2NDY1NDQiLCJ2ZW5kb3JfaWQiOiJUZWxnb281UHJvZHVjdGlvbiIsImxvZ19pZCI6MjI1MTgwMDc3MDA5Mzg2OCwidXJsIjoiaHR0cHM6Ly90ZWxnb281ZGVtby52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNzAxNzE4MjQ2fQ.O1Um3wFZc9d8IRimxb6xyjgW7h106FNgq_5YLsDRiFE"
}
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.