{"info":{"_postman_id":"a0f21601-fd48-44d2-8d91-e0587077deae","name":"Collexo API Documentation","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"24697426","collectionId":"a0f21601-fd48-44d2-8d91-e0587077deae","publishedId":"2s8YzMYkYo","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-03-24T11:21:49.000Z"},"item":[{"name":"Overview","item":[{"name":"Getting Started","item":[],"id":"d422d4fd-aa23-4fe4-a1ae-94bf75abd84e","description":"

To access Collexo APIs, you need to have a Collexo Account. Once your account is ready or if you already have an account with us, you will be able to fetch your integration keys (Client Code and API Key) which are required to access any API.

\n","_postman_id":"d422d4fd-aa23-4fe4-a1ae-94bf75abd84e"},{"name":"Auth","item":[],"id":"a40548e1-0545-43ac-bce6-c898e733e75e","description":"

Every API call requires you to pass the API Key and Client Code associated with your account.

\n

You can retrieve these keys from your Collexo Account:

\n
    \n
  1. Go to Account Settings > Integration
    2. \n
  2. Click on Generate Button on the Other Applications Card.
    3. \n
  3. This will generate the API Key and Client Code.
    4. \n
  4. Click on View Keys.
    5. \n
  5. Copy the API Key and Client Code.
    6. \n
\n","_postman_id":"a40548e1-0545-43ac-bce6-c898e733e75e"},{"name":"HTTP response codes","item":[],"id":"9032c3e9-cfdf-4b45-a049-357812c41ad9","description":"

Below are the standard response codes and their description.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response CodeTextDescription
200SuccessThis is the status code for a successful API hit.
400Bad RequestThe JSON body on the request is not as per API specification. Make sure that the JSON body has the correct attribute names and format.
401UnauthorizedThe API call was made with an invalid Client Code or API Key.
403ForbiddenRequest made to the API has been approved but unable to return due to permission not being granted.
404Not FoundThe API URL could not be found.
429Too Many RequestsAPI calls exceeded the limit assigned to your entity.
500Internal Server ErrorThe API call has failed due to some server problem.
\n

In addition to the HTTP status code, most errors will also return a response body containing more information to help debug the error.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
StatusDescription
SUCCESSStatus will be SUCCESS only when the API hit is successful and the objective has been met.
ERRORStatus will be ERROR in case of an error. This means that the objective has not been met and you need to correct the error and try again.
\n
","_postman_id":"9032c3e9-cfdf-4b45-a049-357812c41ad9"}],"id":"f6911eec-dcb1-406b-a07d-d0f8738676ad","description":"

Collexo Developer Portal is core part of our mission to empower organizations to BUILD, SCALE and GROW. Our APIs are designed to enable teams of any shape or size to build custom solutions through robust integrations with Collexo and derive value benefits.

\n

All Collexo APIs are built using Representational State Transfer (REST) conventions and

\n
    \n
  1. Have a standard and predictable URL structure
    2. \n
  2. Use many standard HTTP features, including methods (POST, GET, PUT, DELETE)
    3. \n
  3. Provide standard error response codes
    4. \n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Request MethodPurpose
POSTTo insert or create
GETTo fetch one or more data points
PUTTo update existing data
DELETETo delete a data
\n

All Collexo API calls are made under https://api.collexo.com/ and all responses return standard JSON.

\n","_postman_id":"f6911eec-dcb1-406b-a07d-d0f8738676ad"},{"name":"Payment","item":[{"name":"Get Fee Eligibility","id":"4929d244-c9f6-4191-b610-b1a35e816835","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fee_id\": [\n 1\n ],\n \"data\": {\n \"child_gender\": \"Boy\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v1/payment/get-workflow-status/{{clientCode}}/","description":"

Get Fee Eligibility API checks if the customer is eligible for the fees. This helps in identifying which customers should pay which fees.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Request ParametersMandatoryDescription
fee_idyesThis field accepts a list of fee IDs for which you want to check eligibility.
{\"fee_id\": [1557, 1558]
}
datayesThis field accepts an array of key-value pairs of customer/applicant data for whom you want to check the eligibility.
{
\"gender\": \"Female\"
\"course\": \"MBA\"
}
\n

You can retrieve the fee id from your Collexo Account:

\n
    \n
  1. Go to Fee Setup > Fee Connect
    2. \n
  2. View the IDs for the fees you made on Collexo.
    3. \n
\n","urlObject":{"path":["v1","payment","get-workflow-status","{{clientCode}}",""],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"8cdc619c-25ad-48ac-97cf-681a9fd6c68f","name":"Get Fee Eligibility","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fee_id\": [\n 1\n ],\n \"data\": {\n \"child_gender\": \"Boy\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v1/payment/get-workflow-status/{{clientCode}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 12 Jun 2023 14:13:13 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1972"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept, Cookie"},{"key":"Allow","value":"OPTIONS, POST"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"code\": 200,\n \"message\": \"\",\n \"data\": [\n {\n \"fee_id\": 1,\n \"fee_amount_type\": \"fixed_amount\",\n \"fee_breakup\": [\n {\n \"fee_head_id\": \"2\",\n \"fee_head_name\": \"Tuition Fees\",\n \"fee_amount\": \"1000.00\",\n \"original_fee_amount\": \"1000.00\"\n }\n ],\n \"original_fee_amount\": \"1000.00\",\n \"show_original_fee\": false,\n \"fcid\": \"1\",\n \"status\": \"eligible\",\n \"fee_title\": \"UniApply Sanity Fees 1\",\n \"fee_amount\": \"1000.00\",\n \"currency_code\": \"INR\",\n \"start_date\": \"1635750720\",\n \"end_date\": \"1704562200\",\n \"due_date_string\": \"\",\n \"will_start_date_string\": \"\",\n \"end_date_string\": \"\",\n \"is_pp_allow\": \"1\",\n \"pp_max_trans\": \"2\",\n \"pp_min_amount\": \"1\",\n \"emi_plan\": {\n \"1\": {\n \"title\": \"6 Month EMI\",\n \"tenure_month\": 6,\n \"emi_amount\": 174.455770615519,\n \"interest\": \"15.85% pa\",\n \"interest_amount\": 7.789103948852329,\n \"total_emi_without_interest\": 1000,\n \"total_interest\": 46.73,\n \"total_emi_with_interest\": 1046.73,\n \"interset_rate\": 4.672999999999999,\n \"interest_rate_calculation\": \"interest_cost\",\n \"interser_rate_text\": \"Effective Interest cost on Loan Amount\"\n },\n \"4\": {\n \"title\": \"9 Month EMI\",\n \"tenure_month\": 9,\n \"emi_amount\": 144.6320361728504,\n \"interest\": \"67.50% pa\",\n \"interest_amount\": 33.52092506173929,\n \"total_emi_without_interest\": 1000,\n \"total_interest\": 301.69,\n \"total_emi_with_interest\": 1301.69,\n \"interset_rate\": 30.169,\n \"interest_rate_calculation\": \"interest_cost\",\n \"interser_rate_text\": \"Effective Interest cost on Loan Amount\"\n },\n \"6\": {\n \"title\": \"8 Month EMI\",\n \"tenure_month\": 8,\n \"emi_amount\": 125,\n \"interest\": \"0% pa\",\n \"interest_amount\": 0,\n \"total_emi_without_interest\": 1000,\n \"total_interest\": 0,\n \"total_emi_with_interest\": 1000,\n \"interset_rate\": 0,\n \"interest_rate_calculation\": \"default_rate\",\n \"interser_rate_text\": \"Interest Rate\"\n }\n },\n \"payment_modes\": [\n \"1\",\n \"2\",\n \"3\",\n \"4\"\n ],\n \"session_data\": {},\n \"show_pay_option\": true,\n \"fee_error_message\": \"\",\n \"backend_fee_amount\": \"1000.00\",\n \"show_fee_due_date\": \"no\",\n \"total_lf_paid\": 0,\n \"fee_button_name\": \"Pay Now\",\n \"late_fee\": \"0.00\"\n }\n ],\n \"error_list\": {}\n}"}],"_postman_id":"4929d244-c9f6-4191-b610-b1a35e816835"},{"name":"Generate Order","id":"5ba6f0aa-ea5a-452a-b1b7-91694888ff42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"api-key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fee_id\": \"1\",\n \"email\": \"john@yopmail.com\",\n \"order_no\": \"test123\",\n \"order_description\": \"test description\",\n \"order_notes\": \"\",\n \"dial_code\": \"+91\",\n \"mobile\": \"9876543210\",\n \"full_name\": \"John Doe\",\n \"data\": {\n \"child_gender\": \"Boy\"\n },\n \"success_url\": \"https://www.success.com/\",\n \"cancel_url\": \"https://www.cancel.com/\",\n \"webhook_url\": \"https://www.webhook.com/\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v1/payment/generate-order/{{clientCode}}/","description":"

Generate Order API generates an order on Collexo to collect any payment. This must contain details such as the transaction amount, fee id, currency, etc.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Request ParametersMandatoryDescription
fee_idyesThis field accepts Collexo fee id, this will be different for different plans and fee types.
{\"fee_id\": \"24\"}
order_noyesThis field accepts the unique key for each fee for each customer/applicant/student.
{\"order_no\": \"i-19/12788\"}
order_descriptionyesThis field accepts the description of the order.
{\"order_description\": \"Order to collect fees\"}
order_notesnoThis field accepts an array of key-value pairs of any other details that you want to see in the Collexo transaction summary
{\"order_notes\": {
\"class\": ,
\"section\": ,
\"fee heads\":
}}
dial_codenoThis field accepts the dial code of the mobile no. of the customer/applicant/student.
{\"dial_code\": \"+91\"}
mobileyesThis field accepts the mobile no. of the customer/applicant/student. The communication will be sent to this mobile no. on successful payment
{\"mobile\": \"9876543210\"}
emailyesThis field accepts the email id of the customer/applicant/student. The communication will be sent to this email id on successful payment
{\"email\": \"abc@gmail.com\"}
full_namenoThis field accepts the name of the customer/applicant/student.
{\"full_name\": \"Virat Singh\"}
datayesThis field accepts an array of key-value pairs of customer/applicant data for whom you want to check the eligibility.
{
\"gender\": \"Female\"
\"course\": \"MBA\"
}
success_urlyesThis field accepts a URL where the customer will be redirected after successful payment.
{ \"success_url\": \"https://your-redirection-url-here/\"}
cancel_urlyesThis field accepts a URL where the customer will be redirected if the user cancels the payment.
{\"cancel_url\": \"https://your-redirection-url-here/\"}
webhook_urlnoThis field accepts a URL on which the payment data will be posted after successful payment.
{\"webhook_url\": \"https://your-url-here/\"}
\n
","urlObject":{"path":["v1","payment","generate-order","{{clientCode}}",""],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"92106374-aebf-4fd4-9dc4-e7816b9e10fa","name":"Generate Order","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"api-key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fee_id\": \"1\",\n \"email\": \"john@yopmail.com\",\n \"order_no\": \"test123\",\n \"order_description\": \"test description\",\n \"order_notes\": \"\",\n \"dial_code\": \"+91\",\n \"mobile\": \"9876543210\",\n \"full_name\": \"John Doe\",\n \"data\": {\n \"child_gender\": \"Boy\"\n },\n \"success_url\": \"https://www.success.com/\",\n \"cancel_url\": \"https://www.cancel.com/\",\n \"webhook_url\": \"https://www.webhook.com/\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v1/payment/generate-order/{{clientCode}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 12 Jun 2023 14:13:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"336"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept, Cookie"},{"key":"Allow","value":"OPTIONS, POST"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"up_order_id\": \"e8caf836a4fb6069f89b39553487fffe\",\n \"page_url\": \"https://www.collexo.com/payment/redirect/06219d5093b8cd7de2dfeb94a4c5250a/e8caf836a4fb6069f89b39553487fffe/c1219039cb5f22fa4f97bcc4c582b903/\",\n \"order_description\": \"test description\",\n \"order_notes\": \"\",\n \"due_amount\": \"1000.00\"\n },\n \"status\": \"SUCCESS\",\n \"code\": 200\n}"}],"_postman_id":"5ba6f0aa-ea5a-452a-b1b7-91694888ff42"},{"name":"Get Order Details","id":"4e14bcd0-659b-4c66-a344-ee2987c5d5c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"up_order_id\": \"e8caf836a4fb6069f89b39553487fffe\"\n}"},"url":"{{host}}/v1/payment/get-payment-details/{{clientCode}}/","description":"

This API can be used to fetch latest status of the order.

\n

Below are all possible statuses of the order.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueMeaning
order.createdWhen order is is successfuly created.
payment.pendingWhen user lands on checkout page but payment has not been made yet.
payment.approvedWhen user's payment has been captured successfully.
payment.under_reviewWhen user has submitted DD/Cash details but has not been verifed yet by the institute.
payment.failedWhen user's payment couldn't be captured or failed because of any reason.
payment.rejectedWhen user submitted DD/Cash details have been verifed and rejected.
\n
","urlObject":{"path":["v1","payment","get-payment-details","{{clientCode}}",""],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"3a41b8da-d14a-4180-a538-0dadd318d5d9","name":"Get Order Details","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"up_order_id\": \"e8caf836a4fb6069f89b39553487fffe\"\n}"},"url":"{{host}}/v1/payment/get-payment-details/{{clientCode}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 12 Jun 2023 14:21:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1773"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept, Cookie"},{"key":"Allow","value":"OPTIONS, POST"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"code\": 200,\n \"message\": \"\",\n \"data\": {\n \"up_order_no\": \"6103_1_3\",\n \"order_no\": \"test123\",\n \"email\": \"john@yopmail.com\",\n \"mobile\": \"+91 9876543210\",\n \"fee_title\": \"UniApply Sanity Fees 1\",\n \"full_amount\": \"1000.00\",\n \"paid_amount\": \"1000.00\",\n \"payment_currency\": \"INR\",\n \"payment_mode\": \"NA\",\n \"payment_date\": \"NA\",\n \"order_status\": \"order.created\",\n \"gateway_transaction_id\": \"NA\",\n \"gateway_order_id\": \"NA\",\n \"order_notes\": \"\",\n \"up_order_id\": \"e8caf836a4fb6069f89b39553487fffe\",\n \"cash_details\": \"NA\",\n \"dd_details\": \"NA\",\n \"bank_transfer_details\": \"NA\",\n \"pos_details\": \"NA\",\n \"approval_data\": \"NA\",\n \"fcid\": 1,\n \"extension_id\": 2,\n \"post_params\": \"{\\\"fee_id\\\": \\\"1\\\", \\\"email\\\": \\\"john@yopmail.com\\\", \\\"order_no\\\": \\\"test123\\\", \\\"order_description\\\": \\\"test description\\\", \\\"order_notes\\\": \\\"\\\", \\\"dial_code\\\": \\\"+91\\\", \\\"mobile\\\": \\\"9876543210\\\", \\\"full_name\\\": \\\"John Doe\\\", \\\"data\\\": {\\\"child_gender\\\": \\\"Boy\\\", \\\"order_no\\\": \\\"test123\\\", \\\"fee_id\\\": \\\"1\\\"}, \\\"success_url\\\": \\\"https://www.success.com/\\\", \\\"cancel_url\\\": \\\"https://www.cancel.com/\\\", \\\"webhook_url\\\": \\\"https://www.webhook.com/\\\", \\\"client_code\\\": \\\"1a0bde40-3bc0-11ec-9cbd-0270324ba8b8\\\", \\\"api_key\\\": \\\"oddfcvtxwfzhsmixfkweipzgcgbdwcrh\\\", \\\"entity_id\\\": 1, \\\"db_id\\\": \\\"db1_school\\\", \\\"table_id\\\": 1, \\\"entity_code\\\": \\\"06219d5093b8cd7de2dfeb94a4c5250a\\\", \\\"name\\\": \\\"UniApply Demo School's\\\", \\\"student_full_name\\\": \\\"John Doe\\\", \\\"customer_email\\\": \\\"aman.g@nopaperforms.com\\\"}\",\n \"late_fee_amount\": \"NA\",\n \"coupon_code\": \"NA\",\n \"discount_amount\": \"NA\",\n \"payment_mode_text\": \"NA\",\n \"fee_id\": 1,\n \"order_details\": [\n {\n \"fee_amount\": \"1000.00\",\n \"fee_full_amount\": \"1000.00\",\n \"fee_head\": \"Tuition Fees\"\n }\n ],\n \"due_amount\": \"1000.00\",\n \"total_paid_amount\": \"0.00\",\n \"offline_reference_no\": \"\"\n },\n \"error_list\": {}\n}"}],"_postman_id":"4e14bcd0-659b-4c66-a344-ee2987c5d5c2"}],"id":"664dcb00-927c-41db-8622-fd2ea4ba43ea","description":"

This is the collection of APIs required to run an end-to-end payment in Collexo. This collection contains

\n\n","_postman_id":"664dcb00-927c-41db-8622-fd2ea4ba43ea"},{"name":"Applicant","item":[{"name":"Add Applicant","id":"bde21ff1-397c-4670-ac4e-3b743ba1502f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{apiKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"application_no\": \"COL/384/495363\",\n \"year\":\"2023-2024\",\n \"name\":\"Ram\",\n \"dial_code\":\"91\",\n \"mobile\":\"9999999999\",\n \"email\":\"test@abc.com\",\n \"cf_program\":\"B.Tech\",\n \"af_tuition_fee\":\"12000.54\",\n \"af_admission_fee\":\"5000\",\n \"df_start_date\":\"20/01/2023\",\n \"df_due_date\":\"20/03/2023\",\n \"df_end_date\":\"20/04/2023\"\n}\n","options":{"raw":{"language":"json"}}},"url":"{{host}}/v1/applicant/add/{{clientCode}}/","description":"

Add Applicant API, adds the applicant on Collexo to collect the payments. This contains details such as name, mobile number, email, applicant no, etc.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Request ParametersMandatoryDescription
application_noyesThis field accepts the unique value for each applicant in a particular year. You can add applicant no/roll no/enrollment no whichever is unique in your system. { \"application_no\": \"ABC/22-23/183716\" }
yearyesThis is the year in which you want to add the applicant. { \"year\": \"2023-2024\" } Note: Before use please ensure, that the year should be active in your plan.
namenoName of the applicant
emailnoEmail of the applicant. All email communication will send on this.
dial_codeyes (if you use mobile key)Email of the applicant/parent/guardian. All communication will send on this.
mobilenoMobile number of the applicant/parent/guardian. All communication will send on this.
custom_fieldsnoThese fields are used to manage the applicant profile eg. program, course, class etc. Validation will work according to the field type.
amount_fieldsnoThese fields are used to manage the fee head amount. The value should be a number only up to 2 decimals. If you send a value without a decimal it automatically adds \".00\" to the amount value.
date_fieldsnoThese fields are used to manage the dates for fee collection
\n

Special Notes:

\n\n","urlObject":{"path":["v1","applicant","add","{{clientCode}}",""],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"e6a772ee-50b6-4606-ac5a-7e283d0850c0","name":"Add Applicant","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"application_no\": \"COL/384/495363\",\n \"year\":\"2023-2024\",\n \"name\":\"Ram\",\n \"dial_code\":\"91\",\n \"mobile\":\"9999999999\",\n \"email\":\"test@abc.com\",\n \"cf_program\":\"B.Tech\",\n \"af_tuition_fee\":\"12000.54\",\n \"af_admission_fee\":\"5000\",\n \"df_start_date\":\"20/01/2023\",\n \"df_due_date\":\"20/03/2023\",\n \"df_end_date\":\"20/04/2023\"\n}\n","options":{"raw":{"language":"json"}}},"url":"{{host}}/v1/applicant/add/{{clientCode}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 12 Jun 2023 14:14:41 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"181"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept, Cookie"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"code\": 200,\n \"message\": \"Application Added\",\n \"data\": {\n \"mng_id\": \"64872851c1c33b2a9811827b\",\n \"application_no\": \"COL/384/495363\"\n },\n \"debug\": \"\",\n \"error_list\": {}\n}"}],"_postman_id":"bde21ff1-397c-4670-ac4e-3b743ba1502f"},{"name":"Update Applicant","id":"43ac797a-3673-4b35-91cc-9c0ebcef8b83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{apiKey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"application_no\": \"COL/384/495363\",\n \"year\":\"2023-2024\",\n \"name\":\"Ram\",\n \"dial_code\":\"91\",\n \"mobile\":\"9999999999\",\n \"email\":\"test@abc.com\",\n \"cf_program\":\"B.Tech\",\n \"af_tuition_fee\":\"12000.54\",\n \"af_admission_fee\":\"5000\",\n \"df_start_date\":\"20/01/2023\",\n \"df_due_date\":\"20/03/2023\",\n \"df_end_date\":\"20/04/2023\"\n}\n","options":{"raw":{"language":"json"}}},"url":"{{host}}/v1/applicant/update/{{clientCode}}/","description":"

Update Applicant API, updates the applicant on the basis of application no. & year. You must pass the fields which you what to update.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Request ParametersMandatoryDescription
application_noyesThis field accepts the unique value for each applicant in a particular year. You can add applicant no/roll no/enrollment no whichever is unique in your system. { \"application_no\": \"ABC/22-23/183716\" }
yearyesThis is the year in which you want to add the applicant. { \"year\": \"2023-2024\" } Note: Before use please ensure, that the year should be active in your plan.
namenoName of the applicant
emailnoEmail of the applicant. All email communication will send on this.
dial_codeyes (if you use mobile key)Email of the applicant/parent/guardian. All communication will send on this.
mobilenoMobile number of the applicant/parent/guardian. All communication will send on this.
custom_fieldsnoThese fields are used to manage the applicant profile eg. program, course, class etc. Validation will work according to the field type.
amount_fieldsnoThese fields are used to manage the fee head amount. The value should be a number only up to 2 decimals. If you send a value without a decimal it automatically adds \".00\" to the amount value.
date_fieldsnoThese fields are used to manage the dates for fee collection
\n
","urlObject":{"path":["v1","applicant","update","{{clientCode}}",""],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"bdd364e8-d39c-4449-b2c0-4ac05b37f7bf","name":"Update Applicant","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"application_no\": \"COL/384/495363\",\n \"year\":\"2023-2024\",\n \"name\":\"Ram\",\n \"dial_code\":\"91\",\n \"mobile\":\"9999999999\",\n \"email\":\"test@abc.com\",\n \"cf_program\":\"B.Tech\",\n \"af_tuition_fee\":\"12000.54\",\n \"af_admission_fee\":\"5000\",\n \"df_start_date\":\"20/01/2023\",\n \"df_due_date\":\"20/03/2023\",\n \"df_end_date\":\"20/04/2023\"\n}\n","options":{"raw":{"language":"json"}}},"url":"{{host}}/v1/applicant/update/{{clientCode}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 12 Jun 2023 14:15:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"183"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept, Cookie"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"code\": 200,\n \"message\": \"Application Updated\",\n \"data\": {\n \"mng_id\": \"64872851c1c33b2a9811827b\",\n \"application_no\": \"COL/384/495363\"\n },\n \"debug\": \"\",\n \"error_list\": {}\n}"}],"_postman_id":"43ac797a-3673-4b35-91cc-9c0ebcef8b83"},{"name":"Delete Applicant","id":"75e14395-33d7-4aa2-ac52-84fa86c7f6fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"application_no\": \"COL/384/495363\",\n \"year\": \"2023-2024\"\n}"},"url":"{{host}}/v1/applicant/delete/{{clientCode}}/","description":"

Delete Applicant API, deletes the applicant on the basis of application no. & year.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Request ParametersMandatoryDescription
application_noyesThis field accepts the unique value for each applicant in a particular year. You can add applicant no/roll no/enrollment no whichever is unique in your system. { \"application_no\": \"ABC/22-23/183716\" }
yearyesThis is the year in which you want to add the applicant. { \"year\": \"2023-2024\" } Note: Before use please ensure, that the year should be active in your plan.
\n
","urlObject":{"path":["v1","applicant","delete","{{clientCode}}",""],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"1b17d9e1-9a14-46ff-b8b3-5711612b8683","name":"Delete Applicant","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"{{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"application_no\": \"COL/384/495363\",\n \"year\": \"2023-2024\"\n}"},"url":"{{host}}/v1/applicant/delete/{{clientCode}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 14 Jun 2023 08:23:53 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"107"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept, Cookie"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"message\": \"Record deleted successfully.\",\n \"data\": {},\n \"debug\": \"\",\n \"error_list\": {}\n}"}],"_postman_id":"75e14395-33d7-4aa2-ac52-84fa86c7f6fa"}],"id":"4f8c19b7-4ff6-47c4-b250-376cb12cf04e","description":"

The Applicant API is a powerful tool that enables users to seamlessly add and update information related to applicants in Collexo. With this API, users can easily manage applicant profiles, fees, and fee dates.

\n","_postman_id":"4f8c19b7-4ff6-47c4-b250-376cb12cf04e"}],"event":[{"listen":"prerequest","script":{"id":"72bc2c79-ad30-49e5-8d71-171bda47a730","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ab9978f6-d94f-4b80-bb2a-abedbd47d80c","type":"text/javascript","exec":[""]}}],"variable":[{"key":"client_code","value":"de2676bc-454d-11ed-a21a-02b2aae25bf2"},{"key":"url","value":"url"},{"key":"api_key","value":"{{apikey-manipal}}"}]}