create_customer_prepaid_multiline Navigate to XML API

This REST API is used for creating prepaid customers and to add lines under a prepaid customer account. You can create a single line or multiple lines under a parent account.

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_multiline Required This needs to be passed as create_customer_prepaid_multiline Expected value : create_customer_prepaid_multiline
lines String Required If you are creating just one line you will pass "lines" array of object only once.
In case you are adding multiple lines you will be sending "lines" array of objects the number of times equal to the number of lines you are adding.		 Only numeric
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 1212 Optional This is the customer account password which will be setup for the customer accounts. Using this password customers will be able to log on to the website and app
model_id String 12 Optional This is the model id for the device that you are assigning to the customer.
first_name String John Required This is the first name of the applicant. Only English alphabet letters, space, apostrophe, Accent Grave ("`") and hyphen.Max length - 50 symbols.Space characters at the start or end of the name should be cut off.
middle_initial String Optional This is the middle name of the applicant. 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 digit alternate contact number of the applicant. Only 10 digits are allowed.
email String noreply@gmail.com Required This is the applicant's email address. Email address standard form is validated.
service_address_one String ABC Main St Required This is the service address line 1 of the applicant. Here you should pass the House number and the street of the applicant. Accepts these special characters: space, forward slash (/), hash (#), hyphen (-).
service_address_two String apt 7 Optional This is the service address line 2 of the applicant. Here you should pass the apartment number of the applicant. Accepts these special characters: space, forward slash (/), hash (#), hyphen (-).
service_city String CAMDEN Required This is the city name of service address 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 a standard abbreviated form. Maximum two characters are allowed.
service_zip String 08104 Required This is the ZIP code of the service address of the applicant. Should not allow letters and special characters, only numbers . Should be exactly 5 digits.
plan_id String 606 Required This is the plan id of the plan on which you are enrolling the customer. Plan id is returned from the plan_list API. Only 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 This determines the phone capability and it accepts the value which could be 4G, 3G, 4GLTE.
part_number String Optional This is only applicable for SPRINT bring your own device. BYOD
equipment_id String 130 Optional If customer is also buying an accessories from you then you will need to pass the equipment_id in this field of the accessory customer is buying.
device_id String 7894561230215420 Optional A device ID (device identification) is a distinctive number associated with a smartphone or similar handheld device.
uiccid String Optional If value passed as 4G in Phone Type, this field becomes required.
brand_code String Optional This is only applicable for SPRINT bring your own device. ASW=>Assurance Wireless BST=>Boost SPP=>Sprint Prepaid VMU=>Virgin Mobile US SPR=>Sprint Retail Postpaid PLD=>Wholesale
sku_type String Optional This is only applicable for SPRINT bring your own device. INTL=>International BYO=>Bring Your Own NEW=>New device to Sprint
esn String 1564235647894512345 Optional If enrollment_type is HANDOVER than you need to pass the ESN/SIM. A valid SIM / ESN.
carrier String TMB Optional If you are passing the ESN / SIM and the enrollment_type is HANDOVER than you need to pass the carrier. Valid abbreviated form of carrier .
activation_type String NEWACTIVATION Required If it's a portin order than you need pass PORTIN else NEWACTIVATION Accepted values are NEWACTIVATION and PORTIN
enrollment_type String SHIPMENT Required If you are not shipping anything to the customer then enrollment_type should be HANDOVER else SHIPMENT. Accepted values are SHIPMENT or HANDOVER
handover_type String cbe Required If the enrollment_type is HANDOVER than you need to pass the handover_type as cbe. Expected value : cbe
port_current_carrier String Neutral Tandem Optional This is the current carrier from where the number is being ported. You can get this from validate_portin API. Only required when Activation_type = PORTIN.
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 Deo 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. Here you should pass the House number and street of the applicant with the old service provider or carrier. Only required when Activation_type = PORTIN.
port_address_two String apt 7 Optional Subscriber's service address line 2 with the old service provider. Here you should pass the apartment number of the applicant with the old service provider or carrier.
 Only required when Activation_type = PORTIN.
port_city String CAMDEN Optional Subscriber's service address city with the old service provider.
Only required when Activation_type = PORTIN.
port_state String NJ Optional Subscriber's service address state with the old service provider.
Only required when Activation_type = PORTIN.
port_zip_code String 08104 Optional Subscriber's service address zip code with the old service provider.
Only required when Activation_type = PORTIN.
port_account_number String 456123 Optional This is the subscriber's account number with the old service provider.
Only required when Activation_type = PORTIN.
port_account_password String ***** Optional This is the subscriber's account password with the old service provider.
Only required when Activation_type = PORTIN.
port_ssn String 1234 Optional This is the social security number with the old service provider.
Only required when Activation_type = PORTIN.
port_number String 1234567895 Optional This is the number that is being ported in Only required when Activation_type = PORTIN.
billing_address_one String Optional This is the Billing address line 1 for the associated bank account.
billing_address_two String apt 7 Optional This is the Billing address line 2 for the associated bank account.
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.
Abbreviated form of state. Maximum 2 characters are allowed
billing_zip String 08104 Optional This is the Billing address Zip Code of the applicant. Should not allow letters and special characters, only numbers. Should be exactly 5 digits.
device_type String CDMA Optional This is to determine if the customer device is CDMA or GSM Accepted values are CDMA and GSM
coupon_code String Optional This is the coupon code that is being applied on the payment.
coupon_transaction_id String Optional Will get from make_payment API
parent_enrollment_id String WN116 Required This is the enrollment id of the parent account under which all the additional lines need to be added.
invoice_number String Optional This is the invoice number of the payment which was taken for the order. You will get the invoice number when you make the payment for the plan using make_payment API.
source String API Required Source of the order/application Expected Value : API , WEBSITE
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.
activation_later String Y or N Optional "activation_later": "Y" - This tag will attach the SIM to the customer's account but will not send it to the carrier for provisioning. The customer can activate it later.
"activation_later": "N" - This tag will attach the SIM to the customer's account and will send it to the carrier for provisioning instantly.
 If the "activation_later" tag is not included or left blank in the API, then the SIM will be sent to the carrier instantly for provisioning.
Sample Request REST
{
"lines": [
    {
        "enrollment_id": "wn116",
        "password": "1599",
        "first_name": "test",
        "middle_initial": "",
        "last_name": "test",
        "alternate_phone_number": "1561651651",
        "email": "test@gmail.com",
        "service_address_one": "112 N 41ST ST",
        "service_address_two": "",
        "service_city": "SEATTLE",
        "service_state": "WA",
        "service_zip": "98103",
        "plan_id": "1828",
        "notify_bill_via_text": "",
        "notify_bill_via_email": "",
        "phone_type": null,
        "part_number": null,
        "equipment_id": "",
        "equipment_child_id": "",
        "model_id": null,
        "device_id": "",
        "uiccid": "",
        "brand_code": "",
        "sku_type": "",
        "esn": "",
        "carrier": "TMB",
        "activation_type": "NEWACTIVATION",
        "enrollment_type": "SHIPMENT",
        "handover_type": "",
        "action": null,
        "billing_address_one": "112 N 41ST st",
        "billing_address_two": "",
        "billing_city": "seattle",
        "billing_state": "wa",
        "billing_zip": "98103",
        "activation_later": "Y"
    },
    {
        "enrollment_id": "wn118",
        "first_name": "test",
        "middle_initial": "",
        "last_name": "test",
        "alternate_phone_number": "1561651651",
        "email": "test@gmail.com",
        "service_address_one": "112 N 41ST ST",
        "service_address_two": "",
        "service_city": "SEATTLE",
        "service_state": "WA",
        "service_zip": "98103",
        "plan_id": "1828",
        "notify_bill_via_text": "",
        "notify_bill_via_email": "",
        "phone_type": null,
        "part_number": null,
        "equipment_id": "",
        "equipment_child_id": "",
        "model_id": null,
        "device_id": "",
        "uiccid": "",
        "brand_code": "",
        "sku_type": "",
        "esn": "",
        "carrier": "TMB",
        "activation_type": "NEWACTIVATION",
        "enrollment_type": "SHIPMENT",
        "handover_type": "",
        "action": null,
        "billing_address_one": "112 N 41ST ST",
        "billing_address_two": "",
        "billing_city": "SEATTLE",
        "billing_state": "WA",
        "billing_zip": "98103",
        "activation_later": "Y"
    }
],
"action": "add_line_nonlifeline_customer",
"agent_id": "ewebsiteapi",
"source": "WEBSITE",
"sub_source": "plans",
"parent_enrollment_id": "WN116",
"invoice_number": "2021-09-1288"
}
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": [
    {
      "msg_code": "RESTAPI000",
      "msg": "Success",
      "data": {
        "customer_id": "3188",
        "enrollment_id": "WN11174",
        "enrollment_type": "SHIPMENT",
        "cust_id": "3188",
        "mdn": null,
        "msid": null,
        "msl": "",
        "invoice_number": "2021-09-1288"
      }
    }
  ],
  "msg": "Success",
  "msg_code": "RESTAPI000"
}
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.