{"info":{"_postman_id":"28828f3e-d32d-4df8-841e-8fdd26692cde","name":"Meratas Partner API's","description":"

Meratas makes RESTful API's available to its Partners at developers.meratas.com to view its SaaS Platform data.

Authentication

Your Access Tokens will be provided to you.

Meratas's API uses Access Tokens to authenticate requests.

All requests must be made over an HTTPS connection.

Error Codes

\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

HTTP Error Code	Name	Description
400	Bad Request	The request was unacceptable, often due to missing a required parameter.
401	Unauthorized	No valid token provided.
402	Request Failed	The parameters were valid but the request failed.
403	Forbidden	The token doesn't have permissions to perform the request.
404	Not Found	The requested resource doesn't exist.
409	Conflict	The request conflicts with another request (perhaps due to using the same idempotent key).
429	Too Many Requests	Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
500, 502, 503, 504	Server Errors	Something went wrong on our side.

Rate Limit

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"},{"content":"Rate Limit","slug":"rate-limit"}],"owner":"14391551","collectionId":"28828f3e-d32d-4df8-841e-8fdd26692cde","publishedId":"UyrEgZtT","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-05-12T12:41:02.000Z"},"item":[{"name":"startapplication","item":[],"id":"b21e1571-9fdf-4b72-99eb-3a91a6179e39","description":"

Send new application data

Requirements

The fields are self-explanatory but here we will add a brief description of each field.

\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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
Unique Id	This is a unique ID assigned by the school to the applicant
First Name	The applicant’s first name
Last Name	The applicant’s last name
Email	The applicant’s email
Phone	The applicant’s phone number
Program	(Optional) The applicant’s program name registered at the partner
Street	The address that will be used by the applicant
City	The city that will be used by the applicant
State	The state that will be used by the applicant
Postal Code	The postal code that will be used by the applicant
Date of Birth	The applicant’s birthdate
Has ISA?	This indicates if the applicant has a previous ISA
programName	The program name offered by Meratas
ipcPmtDate1	(Optional) IPC payment date 1
ipcAmount1	(Optional) IPC amount 1
ipcPmtDate2	(Optional) IPC payment date 2
ipcAmount2	(Optional) IPC amount 2
ipcPmtDate3	(Optional) IPC payment date 3
ipcAmount3	(Optional) IPC amount 3
ipcPmtDate4	(Optional) IPC payment date 4
ipcAmount4	(Optional) IPC amount 4

BODY raw

{
\"Unique Id\" : \"0050A00000aUqFEQA0-test64\",
\"First Name\" : \"Jane\",
\"Last Name\" : \"Public\",
\"Email\" : \"test.test64@meratas.com\",
\"Phone\" : \"2125551212\",
\"Program\" : \"Data Science\",
\"Street\" : \"123 Main Street\",
\"City\" : \"Springfield\",
\"State\" : \"California\",
\"Postal Code\" : \"50575\",
\"Date of Birth\" : \"1979-08-01\",
\"Has ISA?\" : false,
\"programName\": \"Deferred Tuition Program\"
}

\n","event":[{"listen":"prerequest","script":{"id":"731deb74-6b0c-4537-8232-fdab1512edcf","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"aa5f4e16-5792-4079-a2ac-4ec618d48be1","type":"text/javascript","exec":[""]}}],"_postman_id":"b21e1571-9fdf-4b72-99eb-3a91a6179e39","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"28828f3e-d32d-4df8-841e-8fdd26692cde","id":"28828f3e-d32d-4df8-841e-8fdd26692cde","name":"Meratas Partner API's","type":"collection"}}},{"name":"users","item":[],"id":"bb7581dc-da3a-45a0-9635-8d40a4c5659f","description":"

See user information.

\n","_postman_id":"bb7581dc-da3a-45a0-9635-8d40a4c5659f","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"28828f3e-d32d-4df8-841e-8fdd26692cde","id":"28828f3e-d32d-4df8-841e-8fdd26692cde","name":"Meratas Partner API's","type":"collection"}}},{"name":"schools","item":[],"id":"32d5c3e2-54f1-4913-ae42-8c1f742dcead","description":"

See school information.

\n","_postman_id":"32d5c3e2-54f1-4913-ae42-8c1f742dcead","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"28828f3e-d32d-4df8-841e-8fdd26692cde","id":"28828f3e-d32d-4df8-841e-8fdd26692cde","name":"Meratas Partner API's","type":"collection"}}},{"name":"programs","item":[],"id":"a5cf2d67-c99d-43e2-8784-9fbdf4db911a","description":"

See program information.

\n","_postman_id":"a5cf2d67-c99d-43e2-8784-9fbdf4db911a","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"28828f3e-d32d-4df8-841e-8fdd26692cde","id":"28828f3e-d32d-4df8-841e-8fdd26692cde","name":"Meratas Partner API's","type":"collection"}}},{"name":"funder","item":[],"id":"465e42b3-ed6e-40d7-ad88-c09ecd0dbdd1","description":"

See funder/investor information.

\n","_postman_id":"465e42b3-ed6e-40d7-ad88-c09ecd0dbdd1","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"28828f3e-d32d-4df8-841e-8fdd26692cde","id":"28828f3e-d32d-4df8-841e-8fdd26692cde","name":"Meratas Partner API's","type":"collection"}}},{"name":"payments","item":[],"id":"0de48b84-0008-449e-9a5b-bf45ae9e998c","description":"

Payment updates.

\n","_postman_id":"0de48b84-0008-449e-9a5b-bf45ae9e998c","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"28828f3e-d32d-4df8-841e-8fdd26692cde","id":"28828f3e-d32d-4df8-841e-8fdd26692cde","name":"Meratas Partner API's","type":"collection"}}},{"name":"statuschanges","item":[],"id":"d8541a90-f435-4ded-a62e-d41bd438ed61","description":"

Receive updates when contract or payment statuses change.

\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

Field	Description
id	The student’s id assigned by the school
status	The contract’s status
userReference	The user reference
contractId	The contract identification number
paymentType	The contract type (RIC, ISA, IPC)
secondaryStatus	This value apply only for IPCs and its value is `IPC Completed`. This value is submitted only when the IPC payment(s) is fully completed

","_postman_id":"d8541a90-f435-4ded-a62e-d41bd438ed61","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"28828f3e-d32d-4df8-841e-8fdd26692cde","id":"28828f3e-d32d-4df8-841e-8fdd26692cde","name":"Meratas Partner API's","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[]}},"event":[{"listen":"prerequest","script":{"id":"4e730eb5-21c1-4251-9191-d23aa160a95f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a3c9843b-5973-494b-a570-849d5a0a83a6","type":"text/javascript","exec":[""]}}]}