{"info":{"_postman_id":"79bf716d-4180-4eff-8506-1fd12768bd14","name":"Platform API","description":"

The Plinqit Services API empowers institutions by leveraging the Plinqit savings platform. Institutions have the option of integrating their core of choice or using the Plinqit core to manage users, goals, and the complete ACH lifecycle.

Throughout this document, the term 'integration settings' refers to the primary configuration of the service for a single institution. This configuration includes workflow options, lookup values, and flags to enable/disable various features.

Overview model

$\"Overview$

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"5021078","collectionId":"79bf716d-4180-4eff-8506-1fd12768bd14","publishedId":"S1Lr4rBi","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-04-30T19:04:40.000Z"},"item":[{"name":"Auth","item":[{"name":"Login","event":[{"listen":"test","script":{"id":"404c4874-fe97-459d-a9a1-f5565cd9a1e9","exec":[""],"type":"text/javascript"}}],"id":"de48b5b3-6a20-41b6-97c9-9ccdceba43e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"email\": \"user@domain.com\",\n\t\"password\": \"{{plinqitServicesUserPassword}}\"\n}"},"url":"io.plinqit.com/api/v2/auth/login","description":"

The Plinqit Services API has been configured to accept standard JWT Bearer tokens in the Authorization header. This authentication scheme can be adjusted according to the security requirements of integrating institutions.

The development environment allows simple web tokens to be passed as the \"User-Token\" header variable.

If MFA is enabled in the integration settings, users will either be required or have the option to receive an MFA code via SMS.

\n","urlObject":{"path":["api","v2","auth","login"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"fd23f33e-075a-43d2-a80f-a761784cb29a","name":"Retrieve an authentication token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"user@domain.com\",\n\t\"password\": \"{{plinqitServicesUserPassword}}\"\n}"},"url":"io.plinqit.com/api/v2/auth/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:33:51 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"464"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": \"\",\n \"data\": {\n \"userid\": \"1038ccc5-bb08-432e-8cf0-0ab969717394\",\n \"token\": \"95d67662-3fef-4104-8d55-d82b6ad98826\",\n \"expires\": \"2020-08-01 22:07:21\",\n \"mfa_device\": \"(555) 423-5555\"\n }\n}"}],"_postman_id":"de48b5b3-6a20-41b6-97c9-9ccdceba43e6"},{"name":"MFA Auth","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"84bef3b9-c77b-422f-879f-f78e5a8ffff1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Token","type":"text","value":"__TOKEN__"}],"body":{"mode":"raw","raw":"{\n \"code\": \"468229\"\n}"},"url":"io.plinqit.com/api/v2/auth/mfa","description":"

Submit an MFA code that was sent to the mfa_device specified in the response to the login call. The request must include the token received in the previous login call. A successful response will include a new token to be used for the remainder of the user session.

\n","urlObject":{"path":["api","v2","auth","mfa"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"c5b9d49d-9a91-49a1-84b3-74dfe968c055","name":"MFA Authentication","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Token","value":"__TOKEN__","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"code\": \"426229\"\n}"},"url":"io.plinqit.com/api/v2/auth/mfa"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"is_success\": true\n },\n \"data\": {\n \t\"user-token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\"\n }\n}"}],"_postman_id":"84bef3b9-c77b-422f-879f-f78e5a8ffff1"}],"id":"e99e9f99-97ad-404e-aff3-cc59094c51f9","_postman_id":"e99e9f99-97ad-404e-aff3-cc59094c51f9","description":""},{"name":"User","item":[{"name":"Create user","event":[{"listen":"test","script":{"id":"404c4874-fe97-459d-a9a1-f5565cd9a1e9","exec":[""],"type":"text/javascript"}}],"id":"f95e172c-a5fe-4694-857a-10dad3460343","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"user@domain.com\",\n\t\"password\": \"mypassword\"\n}"},"url":"io.plinqit.com/api/v2/user","description":"

Create a new user.

User token not required in header. The token will be available to the user after the account has been created and the login route is called.

\n","urlObject":{"path":["api","v2","user"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"a895a020-b76b-4e05-b0f0-e26734797f71","name":"Create user","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"user@domain.com\",\n\t\"password\": \"mypassword\"\n}"},"url":"io.plinqit.com/user"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:33:51 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"464"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"is_created\": true\n },\n \"data\": {\n \"id\": \"79adba14-a928-4029-ae21-fffe7cc8f4b5\",\n \"status\": \"active\",\n \"regdate\": \"2019-02-01 11:01:08\",\n\t\t\"email\": \"user@domain.com\"\n }\n}"}],"_postman_id":"f95e172c-a5fe-4694-857a-10dad3460343"},{"name":"Get user","event":[{"listen":"test","script":{"id":"404c4874-fe97-459d-a9a1-f5565cd9a1e9","exec":[""],"type":"text/javascript"}}],"id":"3c61f0c0-5c2f-45a8-9718-29f958194430","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{plinqitServicesUserToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"url":"io.plinqit.com/api/v2/user/USER_GUID","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\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

Property	Type	Description
id	GUID	Unique identifier of user
status	String	See status lookup table
regdate	Date YYYY-MM-DD HH:mm:ss	Date registered
email	String	Email address of the user
phone	String	Mobile phone contact number
firstname	String	User first name
lastname	String	User last name
addr1	String	Street address; PO Box not allowed
addr2	String	[optional] Street address 2
city	String	City
state	String	2-character State
postalcode	Integer	Zip code of user residence
birthdate	Date YYYY-MM-DD	User date of birth (must be 18)
ss	Integer	[optional] Social security number

User status lookup table

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Description
active	User has active, inactive, paused, or completed goals
archived	All goals associated with user have been cancelled or archived

","urlObject":{"path":["api","v2","user","USER_GUID"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"d6cb319d-3040-4f4f-a8bd-a87e30a44fc0","name":"Get user","originalRequest":{"method":"GET","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"url":"io.plinqit.com/api/v2/user/USER_GUID"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:33:51 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"464"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"records\": 1\n },\n \"data\": {\n \"id\": \"79adba14-a928-4029-ae21-fffe7cc8f4b5\",\n \"status\": \"active\",\n \"regdate\": \"2019-02-01 11:01:08\",\n \"email\": \"api_check@plinqit.com\",\n \"firstname\": \"API\",\n \"lastname\": \"TEST\",\n \"addr1\": \"123 Main St.\",\n \"addr2\": \"\",\n \"city\": \"Newton Falls\",\n \"state\": \"OH\",\n \"postalcode\": \"44444\",\n \"birthdate\": \"1977-07-07\",\n \"phone\": \"5555551212\"\n }\n}"}],"_postman_id":"3c61f0c0-5c2f-45a8-9718-29f958194430"},{"name":"Update user","event":[{"listen":"test","script":{"id":"404c4874-fe97-459d-a9a1-f5565cd9a1e9","exec":[""],"type":"text/javascript"}}],"id":"045008c6-bda3-4275-8080-d2dee552809c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"status\": \"active\",\n\t\"email\": \"user@domain.com\",\n\t\"phone\": \"1234567890\",\n\t\"firstname\": \"John\",\n\t\"lastname\": \"Smith\",\n\t\"addr1\": \"123 Main St.\",\n\t\"addr2\": \"\",\n\t\"city\": \"Newton Falls\",\n\t\"state\": \"OH\",\n\t\"postalcode\": \"12345\",\n\t\"birthdate\": \"01/01/1950\",\n\t\"ss\": false\n}"},"url":"io.plinqit.com/api/v2/user/USER_GUID","description":"

Update user contact and demographic information.

\n","urlObject":{"path":["api","v2","user","USER_GUID"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"3b39ff3c-caf3-4d3d-91be-0e8d43aba10c","name":"Update user","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/javascript","type":"text"},{"key":"User-Token","value":"__TOKEN__","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"status\": \"active\",\n\t\"email\": \"user@domain.com\",\n\t\"phone\": \"1234567890\",\n\t\"firstname\": \"John\",\n\t\"lastname\": \"Smith\",\n\t\"addr1\": \"123 Main St.\",\n\t\"addr2\": \"\",\n\t\"city\": \"Newton Falls\",\n\t\"state\": \"OH\",\n\t\"postalcode\": \"12345\",\n\t\"birthdate\": \"01/01/1950\",\n\t\"ss\": false\n}"},"url":"io.plinqit.com/api/v2/user/USER_GUID"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:33:51 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"464"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"is_updated\": true\n },\n \"data\": {\n \"id\": \"79adba14-a928-4029-ae21-fffe7cc8f4b5\",\n \"status\": \"active\",\n \"regdate\": \"2019-02-01 11:01:08\",\n\t\t\"email\": \"user@domain.com\",\n\t\t\"phone\": \"1234567890\",\n\t\t\"firstname\": \"John\",\n\t\t\"lastname\": \"Smith\",\n\t\t\"addr1\": \"123 Main St.\",\n\t\t\"addr2\": \"\",\n\t\t\"city\": \"Newton Falls\",\n\t\t\"state\": \"OH\",\n\t\t\"postalcode\": \"12345\",\n\t\t\"birthdate\": \"01/01/1950\",\n\t\t\"ss\": false\n }\n}"}],"_postman_id":"045008c6-bda3-4275-8080-d2dee552809c"},{"name":"Update user credentials","event":[{"listen":"test","script":{"id":"404c4874-fe97-459d-a9a1-f5565cd9a1e9","exec":[""],"type":"text/javascript"}}],"id":"662528e7-347f-46c8-9ca6-46d9c631a379","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"User-Token","type":"text","value":"__TOKEN__"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"password\": \"NEW_PASSWORD\"\n}"},"url":"io.plinqit.com/api/v2/user/USER_GUID/credentials","description":"

Update user credentials. This route may kick off an email or SMS verification workflow depending on the user type and integration settings.

\n","urlObject":{"path":["api","v2","user","USER_GUID","credentials"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"4d7e585a-8efd-4fe2-b835-cd1777eb6096","name":"Update user credentials","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/javascript","type":"text"},{"key":"User-Token","value":"__TOKEN__","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"password\": \"NEW_PASSWORD\"\n}"},"url":"io.plinqit.com/api/v2/user/USER_GUID/credentials"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:33:51 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"464"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"is_updated\": true\n },\n \"data\": {\n \"id\": \"79adba14-a928-4029-ae21-fffe7cc8f4b5\",\n \"status\": \"active\",\n \"regdate\": \"2019-02-01 11:01:08\",\n\t\t\"email\": \"user@domain.com\",\n\t\t\"phone\": \"1234567890\",\n\t\t\"firstname\": \"John\",\n\t\t\"lastname\": \"Smith\",\n\t\t\"addr1\": \"123 Main St.\",\n\t\t\"addr2\": \"\",\n\t\t\"city\": \"Newton Falls\",\n\t\t\"state\": \"OH\",\n\t\t\"postalcode\": \"12345\",\n\t\t\"birthdate\": \"01/01/1950\",\n\t\t\"ss\": false\n }\n}"}],"_postman_id":"662528e7-347f-46c8-9ca6-46d9c631a379"}],"id":"925cbebb-9c17-4ff9-a5a5-c000545ea617","description":"

A 'user' is defined as an entity with one or more goals in the Plinqit Services API.

Other than user credentials, all user properties can be updated via PUT on the goal resource. User credentials have their own route.

\n","event":[{"listen":"prerequest","script":{"id":"858692d7-fdc1-4941-9820-d38efa37223c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8eacc3e4-223e-4b8d-b1ea-9e79ee360dbd","type":"text/javascript","exec":[""]}}],"_postman_id":"925cbebb-9c17-4ff9-a5a5-c000545ea617"},{"name":"Goals","item":[{"name":"Create goal","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"25beb0af-5dce-4570-8ba1-8e9edc465d48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"User-Token","value":"__TOKEN__","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"1200\",\n \"increment\": \"100\",\n \"iterations\": \"12\",\n \"duration\": \"12\",\n \"frequency\": \"monthly\",\n \"type\": \"time\",\n \"label\": \"Shoes\",\n \"confidence\": 50,\n \"startdate\": \"01/01/1950\",\n \"weekday\": false,\n\t\"monthday\": 15\n}"},"url":"io.plinqit.com/api/v2/user/USER_GUID/goals","description":"

Create a new goal.

\n","urlObject":{"path":["api","v2","user","USER_GUID","goals"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"5efa4a14-d71d-4b3b-a1e0-a5d649fd1f93","name":"Create goal","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"User-Token","value":"__TOKEN__","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"amount\": \"1200\",\n\t\"increment\": \"100\",\n\t\"iterations\": \"12\",\n\t\"duration\": \"12\",\n\t\"frequency\": \"monthly\",\n\t\"type\": \"time\",\n\t\"label\": \"Shoes\",\n\t\"confidence\": 50,\n\t\"startdate\": \"03/01/2019\",\n\t\"weekday\": false,\n\t\"monthday\": 15\n}"},"url":"io.plinqit.com/api/v2/user/USER_GUID/goals"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"is_created\": true\n },\n \"data\": {\n \"id\": \"cdaaae34-d78b-4bb8-9ee1-6e8d0bcad71d\",\n \"status\": \"inactive\",\n \t\t\"type\": \"time\",\n \"regdate\": \"2019-02-11 22:11:58\",\n\t\t\"amount\": \"1200\",\n\t\t\"increment\": \"100\",\n\t\t\"iterations\": \"12\",\n\t\t\"duration\": \"12\",\n\t\t\"frequency\": \"monthly\",\n\t\t\"label\": \"Shoes\",\n\t\t\"icon\": false,\n\t\t\"custom_icon\": \"372b0cbf-8e29-4263-92bb-8c60eed4d9b1\",\n\t\t\"confidence\": 50,\n\t\t\"penalty\": 12.50,\n\t\t\"reward\": 6.25,\n\t\t\"startdate\": \"2019-03-01\",\n\t\t\"enddate\": \"2020-02-28\",\n\t\t\"weekday\": false,\n\t\t\"monthday\": 15\n }\n}"}],"_postman_id":"25beb0af-5dce-4570-8ba1-8e9edc465d48"},{"name":"Get goal","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"b262ab97-9e0a-4941-8c83-8789bfd29804","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"User-Token","type":"text","value":"__TOKEN__"}],"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID","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\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

Property	Type	Description
id	GUID	Unique identifier of goal
status	String	See lookup table
type	String	Goal by amount or by time
regdate	Date YYYY-MM-DD HH:mm:ss	Date created
amount	Decimal(2)	Amount of the goal
increment	Decimal(2)	Amount of each savings deposit
iterations	Integer	Number of total scheduled deposits
duration	Integer	Duration of goal in months
frequency	String	Frequency of ACH savings transactions
label	String	Item being saved for
icon	String	Reference icon if using stock
custom_icon	String	User uploaded image (S3 GUID)
confidence	Integer (0-100)	Sliding value for penalty calculation
penalty	Decimal	Calculated penalty
reward	Decimal	Calculated reward
startdate	Date YYYY-MM-DD	Date of goal's first transaction
enddate	Date YYYY-MM-DD	Date of goal's final transaction
weekday	Enum (Mon-Fri) [optional]	Day of week transfer preference
monthday	Integer (1-31) [optional]	Day of month transfer preference

","urlObject":{"path":["api","v2","user","USER_GUID","goals","GOAL_GUID"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"f7051ba4-654d-4757-8918-165bd02724b3","name":"Get goal","originalRequest":{"method":"GET","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"records\": 1\n },\n \"data\": {\n \"id\": \"cdaaae34-d78b-4bb8-9ee1-6e8d0bcad71d\",\n \"status\": \"active\",\n \"type\": \"amount\",\n \"regdate\": \"2019-02-11 22:11:58\",\n\t\t\"amount\": \"1200\",\n\t\t\"increment\": \"100\",\n\t\t\"iterations\": \"12\",\n\t\t\"duration\": \"12\",\n\t\t\"frequency\": \"monthly\",\n\t\t\"label\": \"Shoes\",\n\t\t\"icon\": false,\n\t\t\"custom_icon\": \"372b0cbf-8e29-4263-92bb-8c60eed4d9b1\",\n\t\t\"confidence\": 50,\n\t\t\"penalty\": 12.50,\n\t\t\"reward\": 6.25,\n\t\t\"startdate\": \"2019-03-01\",\n\t\t\"enddate\": \"2020-02-28\",\n\t\t\"weekday\": false,\n\t\t\"monthday\": 15\n }\n}"}],"_postman_id":"b262ab97-9e0a-4941-8c83-8789bfd29804"},{"name":"Update goal prerun","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"7b2fa755-c962-4b76-a026-7e618bd81156","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"User-Token","type":"text","value":"__TOKEN__"}],"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/prerun?increment=50&confidence=0","description":"

Prior to updating a goal, this route returns data representing what the goal object would look like after the update. Calculation of the new end date (if required) and updated goal and transaction amounts require this to be performed as a \"dry run\" using the Plinqit scheduler. The Plinqit scheduler calculates the new dates and values by referencing the transaction calendar against Federal holidays and user preferences such as withdrawal day.

Calling this route will not affect the goal. The response object represents what the goal object would look like after being updated with the given parameters. This data can be used to present a confirmation screen or modal to the user.

The request object should only contain properties that vary from the production goal object.

\n","urlObject":{"path":["api","v2","user","USER_GUID","goals","GOAL_GUID","prerun"],"host":["io.plinqit.com"],"query":[{"description":{"content":"

(num) Goal type is 'amount', so reducing the increment from 100 to 50 will increase the goal duration and change the end date.

\n","type":"text/plain"},"key":"increment","value":"50"},{"description":{"content":"

(Int) No reward, no penalty

\n","type":"text/plain"},"key":"confidence","value":"0"}],"variable":[]}},"response":[{"id":"75f56554-7433-4244-8df8-bd90872a9268","name":"Get post-update values for goal","originalRequest":{"method":"GET","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"url":{"raw":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/prerun?increment=50&penalty=0&reward=0","host":["io.plinqit.com"],"path":["api","v2","user","USER_GUID","goals","GOAL_GUID","prerun"],"query":[{"key":"increment","value":"50"},{"key":"penalty","value":"0"},{"key":"reward","value":"0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"is_updated\": false\n },\n \"data\": {\n \"id\": \"cdaaae34-d78b-4bb8-9ee1-6e8d0bcad71d\",\n \"status\": \"active\",\n \"type\": \"amount\",\n \"regdate\": \"2019-02-11 22:11:58\",\n\t\t\"amount\": \"1200\",\n\t\t\"increment\": \"50\",\n\t\t\"iterations\": \"24\",\n\t\t\"duration\": \"24\",\n\t\t\"frequency\": \"monthly\",\n\t\t\"label\": \"Shoes\",\n\t\t\"icon\": false,\n\t\t\"custom_icon\": \"372b0cbf-8e29-4263-92bb-8c60eed4d9b1\",\n\t\t\"confidence\": 0,\n\t\t\"penalty\": 0,\n\t\t\"reward\": 0,\n\t\t\"startdate\": \"2019-03-01\",\n\t\t\"enddate\": \"2021-01-15\",\n\t\t\"weekday\": false,\n\t\t\"monthday\": 15\n }\n}"}],"_postman_id":"7b2fa755-c962-4b76-a026-7e618bd81156"},{"name":"Update goal","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"514371a3-beae-4c35-b34e-fd7866919eeb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"User-Token","value":"__TOKEN__","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"amount\": \"1200\",\n\t\"increment\": \"100\",\n\t\"iterations\": \"12\",\n\t\"duration\": \"12\",\n\t\"frequency\": \"monthly\",\n\t\"type\": \"time\",\n\t\"label\": \"Shoes\",\n\t\"confidence\": 0,\n\t\"weekday\": false,\n\t\"monthday\": 15\n}"},"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID","urlObject":{"path":["api","v2","user","USER_GUID","goals","GOAL_GUID"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"04bca866-d4d9-4714-bd56-48fb68022fbd","name":"Update goal","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"User-Token","value":"__TOKEN__","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"amount\": \"1200\",\n\t\"increment\": \"100\",\n\t\"iterations\": \"12\",\n\t\"duration\": \"12\",\n\t\"frequency\": \"monthly\",\n\t\"type\": \"time\",\n\t\"label\": \"Shoes\",\n\t\"penalty\": 0,\n\t\"reward\": 0,\n\t\"weekday\": false,\n\t\"monthday\": 15\n}"},"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"is_updated\": true\n },\n \"data\": {\n \"id\": \"cdaaae34-d78b-4bb8-9ee1-6e8d0bcad71d\",\n \"status\": \"active\",\n \"regdate\": \"2019-02-11 22:11:58\",\n\t\t\"amount\": \"1200\",\n\t\t\"increment\": \"100\",\n\t\t\"iterations\": \"12\",\n\t\t\"duration\": \"12\",\n\t\t\"frequency\": \"monthly\",\n\t\t\"type\": \"time\",\n\t\t\"label\": \"Shoes\",\n\t\t\"icon\": false,\n\t\t\"custom_icon\": \"372b0cbf-8e29-4263-92bb-8c60eed4d9b1\",\n\t\t\"confidence\": 0,\n\t\t\"penalty\": 0,\n\t\t\"reward\": 0,\n\t\t\"startdate\": \"2019-03-01\",\n\t\t\"enddate\": \"2020-02-28\",\n\t\t\"weekday\": false,\n\t\t\"monthday\": 15\n }\n}"}],"_postman_id":"514371a3-beae-4c35-b34e-fd7866919eeb"},{"name":"Get all goals","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"6e731868-9d5b-4983-9223-bf243018f235","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"url":"io.plinqit.com/api/v2/user/USER_GUID/goals","description":"

Get an array of all goal objects belonging to the user.

\n","urlObject":{"path":["api","v2","user","USER_GUID","goals"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"8b4918c0-9093-4a8f-afbc-8f5a210cfaeb","name":"Get all goals","originalRequest":{"method":"GET","header":[{"key":"User-Token","value":"__TOKEN__"}],"url":"io.plinqit.com/api/v2/user/USER_GUID/goals"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"records\": 1\n },\n \"data\": [\n \t{\n\t \"id\": \"cdaaae34-d78b-4bb8-9ee1-6e8d0bcad71d\",\n\t \"status\": \"active\",\n\t \"regdate\": \"2019-02-11 22:10:58\",\n\t\t\t\"amount\": \"1200\",\n\t\t\t\"increment\": \"100\",\n\t\t\t\"iterations\": \"12\",\n\t\t\t\"duration\": \"12\",\n\t\t\t\"frequency\": \"monthly\",\n\t\t\t\"type\": \"time\",\n\t\t\t\"item\": \"shoes\",\n\t\t\t\"label\": \"Shoes\",\n\t\t\t\"icon\": false,\n\t\t\t\"custom_icon\": \"372b0cbf-8e29-4263-92bb-8c60eed4d9b1\",\n\t\t\t\"confidence\": 50,\n\t\t\t\"penalty\": 12.50,\n\t\t\t\"reward\": 6.25,\n\t\t\t\"startdate\": \"2019-11-30\",\n\t\t\t\"enddate\": \"2020-11-29\",\n\t\t\t\"weekday\": false,\n\t\t\t\"monthday\": 15\n \t}\n ]\n}"}],"_postman_id":"6e731868-9d5b-4983-9223-bf243018f235"},{"name":"Pause goal","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"b5964584-b7b8-49a7-8730-abc74cc08d35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"body":{"mode":"raw","raw":""},"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/pause","description":"

Put all savings transactions associated with a goal on hold. Calling this endpoint will add 30 days to the processing date of all future scheduled transactions. The goal status will be updated from 'active' to 'paused'.

The goal and its associated transactions will resume after 30 days or when the resume endpoint is called.

\n","urlObject":{"path":["api","v2","user","USER_GUID","goals","GOAL_GUID","pause"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"a95e0ad1-fe8f-497c-8bb9-738a1dea5ea2","name":"Pause goal","originalRequest":{"method":"POST","header":[{"key":"User-Token","value":"__TOKEN__"}],"body":{"mode":"raw","raw":""},"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/pause"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"is_paused\": true\n },\n \"data\": {\n \"id\": \"cdaaae34-d78b-4bb8-9ee1-6e8d0bcad71d\",\n \"status\": \"paused\",\n \"type\": \"time\",\n \"regdate\": \"2019-02-11 22:11:58\",\n\t\t\"amount\": \"1200\",\n\t\t\"increment\": \"100\",\n\t\t\"iterations\": \"12\",\n\t\t\"duration\": \"13\",\n\t\t\"frequency\": \"monthly\",\n\t\t\"label\": \"Shoes\",\n\t\t\"icon\": false,\n\t\t\"custom_icon\": \"372b0cbf-8e29-4263-92bb-8c60eed4d9b1\",\n\t\t\"confidence\": 50,\n\t\t\"penalty\": 12.50,\n\t\t\"reward\": 6.25,\n\t\t\"startdate\": \"2019-03-01\",\n\t\t\"enddate\": \"2020-03-15\",\n\t\t\"weekday\": false,\n\t\t\"monthday\": 15\n }\n}"}],"_postman_id":"b5964584-b7b8-49a7-8730-abc74cc08d35"},{"name":"Resume goal","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"054d357d-f1d2-4404-95d7-c2f55efb24da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"body":{"mode":"raw","raw":""},"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/resume","description":"

Immediately resume a paused goal by rescheduling all future savings deposits to resume immediately at the cadence previously defined by the user.

\n","urlObject":{"path":["api","v2","user","USER_GUID","goals","GOAL_GUID","resume"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"4bc95c3d-7cb5-4c6f-8506-4a9fad2be8d2","name":"Resume goal","originalRequest":{"method":"POST","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"body":{"mode":"raw","raw":""},"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/resume"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"is_resumed\": true\n },\n \"data\": {\n \"id\": \"cdaaae34-d78b-4bb8-9ee1-6e8d0bcad71d\",\n \"status\": \"active\",\n \"type\": \"time\",\n \"regdate\": \"2019-02-11 22:11:58\",\n\t\t\"amount\": \"1200\",\n\t\t\"increment\": \"100\",\n\t\t\"iterations\": \"12\",\n\t\t\"duration\": \"12\",\n\t\t\"frequency\": \"monthly\",\n\t\t\"label\": \"Shoes\",\n\t\t\"icon\": false,\n\t\t\"custom_icon\": \"372b0cbf-8e29-4263-92bb-8c60eed4d9b1\",\n\t\t\"confidence\": 50,\n\t\t\"penalty\": 12.50,\n\t\t\"reward\": 6.25,\n\t\t\"startdate\": \"2019-03-01\",\n\t\t\"enddate\": \"2020-02-15\",\n\t\t\"weekday\": false,\n\t\t\"monthday\": 15\n }\n}"}],"_postman_id":"054d357d-f1d2-4404-95d7-c2f55efb24da"},{"name":"Cancel goal","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"3ad0c722-6e58-4afd-b2dc-6c9d6bfa2af8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"User-Token","type":"text","value":"__TOKEN__"}],"body":{"mode":"raw","raw":""},"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/cancel","description":"

Update the goal status to \"Cancelled\" and delete all unsubmitted transactions for the goal.

\n","urlObject":{"path":["api","v2","user","USER_GUID","goals","GOAL_GUID","cancel"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"04251ad4-442d-4278-b4c3-91cd6709a25a","name":"Cancel goal","originalRequest":{"method":"POST","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"body":{"mode":"raw","raw":""},"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"is_cancelled\": true\n },\n \"data\": {\n \"id\": \"cdaaae34-d78b-4bb8-9ee1-6e8d0bcad71d\",\n \"status\": \"cancelled\",\n \"regdate\": \"2019-02-11 22:11:58\",\n \"canceldate\": \"2019-04-17 20:07:26\",\n\t\t\"startdate\": \"2019-03-01\"\n }\n}"}],"_postman_id":"3ad0c722-6e58-4afd-b2dc-6c9d6bfa2af8"},{"name":"Add/update goal icon","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"40d3b691-06f2-4803-8530-5cf2b055cd6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"key":"User-Token","type":"text","value":"__TOKEN__"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"

Optional .PNG or .JPG image file

\n","key":"custom_image","type":"text","value":""}]},"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/image?stock_id={{id}}","description":"

Add/update the image associated with a goal.

If a stock_id value is provided, the goal will be updated to use the associated stock image file. If a binary file or base64-encoded string is provided for custom_image the custom image will be used instead.

\n","urlObject":{"path":["api","v2","user","USER_GUID","goals","GOAL_GUID","image"],"host":["io.plinqit.com"],"query":[{"description":{"content":"

Optional identifier of stock image if customer image not being provided

\n","type":"text/plain"},"key":"stock_id","value":"{{id}}"}],"variable":[]}},"response":[{"id":"64be293f-3476-4975-b536-b0609df0e0bb","name":"Provide a custom image for the goal","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"User-Token","value":"__TOKEN__","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"custom_image","value":"R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7","description":"Base64 encoded image","type":"text"}]},"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/{{goalid}}/image"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"is_created\": true\n },\n \"data\": {\n \"id\": \"cdaaae34-d78b-4bb8-9ee1-6e8d0bcad71d\",\n \"status\": \"inactive\",\n \"type\": \"time\",\n \"regdate\": \"2019-02-11 22:11:58\",\n\t\t\"amount\": \"1200\",\n\t\t\"increment\": \"100\",\n\t\t\"iterations\": \"12\",\n\t\t\"duration\": \"12\",\n\t\t\"frequency\": \"monthly\",\n\t\t\"label\": \"Shoes\",\n\t\t\"icon\": false,\n\t\t\"custom_icon\": \"372b0cbf-8e29-4263-92bb-8c60eed4d9b1\",\n\t\t\"confidence\": 0,\n\t\t\"penalty\": 0,\n\t\t\"reward\": 0,\n\t\t\"startdate\": \"2019-03-01\",\n\t\t\"enddate\": \"2020-02-28\",\n\t\t\"weekday\": false,\n\t\t\"monthday\": 15\n }\n}"}],"_postman_id":"40d3b691-06f2-4803-8530-5cf2b055cd6c"},{"name":"Get reward/ penalty values","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"b9e9f51a-bd90-4cbc-b09d-618c033eb179","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"User-Token","type":"text","value":"__TOKEN__"}],"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/reward_penalty","description":"

Get the reward and penalty values for the goal as calculated by the sliding value entered by the user and the rates matrix configured for the integration.

\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

Property	Type	Description
confidence	Integer (0-100)	Maps to the Goal.reward or Goal.penalty value
reward	Decimal	Reward amount if goal is completed
penalty	Decimal	Penalty amount if user withdraws funds prior to goal completion

Updating the reward/penalty values can be done by updating the confidence property (value between 0 and 100) in the goal object via the PUT operation.

\n","urlObject":{"path":["api","v2","user","USER_GUID","goals","GOAL_GUID","reward_penalty"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"df5ccab5-08b7-4798-ad64-7dab1f15d287","name":"Get reward and penalty","originalRequest":{"method":"GET","header":[{"key":"User-Token","value":"__TOKEN__"}],"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/reward_penalty"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {},\n \"data\": [\n \t{\n\t \"confidence\": 50,\n\t \"reward\": \"7.75\",\n\t \"penalty\": \"15.50\"\n \t}\n ]\n}"}],"_postman_id":"b9e9f51a-bd90-4cbc-b09d-618c033eb179"},{"name":"Others saving for","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"b1401fdb-8ecc-4e19-927e-859bfa4a4b8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"User-Token","type":"text","value":"__TOKEN__"}],"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/others?page=1","description":"

Get a list of goals that other users are saving for.

\n","urlObject":{"path":["api","v2","user","USER_GUID","goals","others"],"host":["io.plinqit.com"],"query":[{"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"894a7f57-bacf-4215-954b-a2560c9f167c","name":"Get goals of others","originalRequest":{"method":"GET","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"url":{"raw":"io.plinqit.com/api/v2/user/USER_GUID/goals/others?page=1","host":["io.plinqit.com"],"path":["api","v2","user","USER_GUID","goals","others"],"query":[{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"page\": 1,\n \t\"records\": 5\n },\n \"data\": [\n \t{\n\t \"amount\": \"1200\",\n\t\t\t\"increment\": \"100\",\n\t\t\t\"iterations\": \"12\",\n\t\t\t\"duration\": \"12\",\n\t\t\t\"frequency\": \"monthly\",\n\t\t\t\"type\": \"amount\",\n\t\t\t\"label\": \"Shoes\",\n\t\t\t\"icon\": \"4f2ee808-3149-48e7-96fe-28ece444dfcf\",\n\t\t\t\"custom_icon\": false\n \t},\n \t{\n\t \"amount\": \"7208.25\",\n\t\t\t\"increment\": \"500\",\n\t\t\t\"iterations\": \"15\",\n\t\t\t\"duration\": \"4\",\n\t\t\t\"frequency\": \"weekly\",\n\t\t\t\"type\": \"time\",\n\t\t\t\"label\": \"Summer trip\",\n\t\t\t\"icon\": false,\n\t\t\t\"custom_icon\": \"372b0cbf-8e29-4263-92bb-8c60eed4d9b1\"\n \t},\n \t{\n\t \"amount\": \"2500\",\n\t\t\t\"increment\": \"100\",\n\t\t\t\"iterations\": \"25\",\n\t\t\t\"duration\": \"12\",\n\t\t\t\"frequency\": \"biweekly\",\n\t\t\t\"type\": \"amount\",\n\t\t\t\"label\": \"New tires\",\n\t\t\t\"icon\": \"d210c8bf-a490-4005-94dd-a164262a2bc0\",\n\t\t\t\"custom_icon\": false\n \t},\n \t{\n\t \"amount\": \"1200\",\n\t\t\t\"increment\": \"100\",\n\t\t\t\"iterations\": \"12\",\n\t\t\t\"duration\": \"12\",\n\t\t\t\"frequency\": \"monthly\",\n\t\t\t\"type\": \"time\",\n\t\t\t\"label\": \"Shoes\",\n\t\t\t\"icon\": false,\n\t\t\t\"custom_icon\": \"372b0cbf-8e29-4263-92bb-8c60eed4d9b1\"\n \t},\n \t{\n\t \"amount\": \"9620\",\n\t\t\t\"increment\": \"350.75\",\n\t\t\t\"iterations\": \"28\",\n\t\t\t\"duration\": \"28\",\n\t\t\t\"frequency\": \"monthly\",\n\t\t\t\"type\": \"amount\",\n\t\t\t\"label\": \"Wedding\",\n\t\t\t\"icon\": false,\n\t\t\t\"custom_icon\": \"a6f439f2-fe04-4219-a826-5f18a6800a93\"\n \t}\n ]\n}"}],"_postman_id":"b1401fdb-8ecc-4e19-927e-859bfa4a4b8b"}],"id":"4416378b-6a97-416a-af4b-aab72b573df7","description":"

Integration options within the Plinqit Services API include reward and penalty values for each goal. When set, a penalty will be issued if the user withdraws funds prior to reaching their goal, and a reward will be issued if the goal is met. The amount of the reward and penalty are based on a sliding scale defined by the user. The value submitted to the API must be between 0 (no reward/penalty) to 100 (max reward/penalty). If a reward or penalty condition is met, the amount is calculated by referencing the user defined value against a reward/penalty matrix as defined in your integration settings.

Goal status lookup table

\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

Status	Description
inactive	Goal being created
active	Goal transactions created by scheduler
complete	All transactions settled, funds available
paused	Goal transactions paused
hold	An unprocessed return has been encountered
cancelled	Cancelled prior to goal completion
archived	Goal complete and funds moved

Goal type lookup table

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Type	Description
amount	Goal defined by amount, duration in months
time	Goal defined by end date, amount secondary

","event":[{"listen":"prerequest","script":{"id":"6c455769-635f-4bb3-aaf6-47a9b40e9b0d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"14ad68d0-0c21-42f7-b411-43b13eb96fd8","type":"text/javascript","exec":[""]}}],"_postman_id":"4416378b-6a97-416a-af4b-aab72b573df7"},{"name":"Transactions","item":[{"name":"Get transaction","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"73aec5b7-e8ce-42a6-a9bc-02cf940890ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/transaction/{{transactionId}}","description":"

Get transaction details relating to the given transactionId.

\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

Property	Type	Description
id	GUID	Unique identifier of transaction
status	Enum	See lookup table
type	Enum	See lookup table
procdate	Date YYYY-MM-DD	Date user expects funds to be transferred
submitted_date	Date YYYY-MM-DD HH:mm:ss	Date ACH file submitted to FED
available_date	Date YYYY-MM-DD HH:mm:ss	Date of fund availability to user
amount	Decimal(2)	Amount of the transaction
is_immediate	Bool	Processed in next available ACH submission

Transaction status lookup table

\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

Status	Description
scheduled	Scheduled for future
submitted	Submitted to FED via ACH
settled	Submitted and funds available
void	Voided after ACH submission
cancelled	Cancelled prior to ACH submission
hold	Transaction settled but funds held
returned	Transaction failure or Chargeback

Transaction type lookup table

\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

Type	Description
recurring	Standard savings deposit created by scheduler
withdrawal	Funds transferred by user to external account
onetime	Additional savings initiated by user
extend	Funds transferred from completed goal
promo	Promotional activity credited to goal account
interest	Earned interest on goal account funds
penalty	Early withdrawal or institutional fee

","urlObject":{"path":["api","v2","user","USER_GUID","goals","GOAL_GUID","transaction","{{transactionId}}"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"8bb0d12c-9943-4d53-b3f7-451f143ecbe1","name":"Get transaction","originalRequest":{"method":"GET","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/transaction/{{transactionId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"records\": 1\n },\n \"data\": {\n \t\"id\": \"94dabf90-0c77-47db-82be-dc26b71db7b0\",\n \t\"status\": \"scheduled\",\n\t\t\"amount\": \"1200.50\",\n\t\t\"type\": \"recurring\",\n\t\t\"procdate\": \"2019-03-05\",\n\t\t\"submitted_date\": \"2019-03-04 13:21:15\",\n\t\t\"available_date\": \"2019-03-08 13:21:15\",\n\t\t\"is_immediate\": false\n }\n}"}],"_postman_id":"73aec5b7-e8ce-42a6-a9bc-02cf940890ae"},{"name":"Get all transactions","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"36168b62-60a3-4d9d-92bc-6875109aeaa8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"User-Token","type":"text","value":"__TOKEN__"}],"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/transactions?status=submitted,settled","description":"

Get all transactions with the given transaction status.

\n","urlObject":{"path":["api","v2","user","USER_GUID","goals","GOAL_GUID","transactions"],"host":["io.plinqit.com"],"query":[{"description":{"content":"

Comma delimited status filter

\n","type":"text/plain"},"key":"status","value":"submitted,settled"}],"variable":[]}},"response":[{"id":"3e04bd3b-5583-4831-bba5-40b51dbfb244","name":"Get transactions","originalRequest":{"method":"GET","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/transactions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"records\": 3\n },\n \"data\": [\n \t{\n\t \t\"id\": \"94dabf90-0c77-47db-82be-dc26b71db7b0\",\n\t \t\"status\": \"submitted\",\n\t\t\t\"amount\": \"125.00\",\n\t\t\t\"type\": \"recurring\",\n\t\t\t\"procdate\": \"12/01/2019\",\n\t\t\t\"submitted_date\": \"11/30/2019 13:21:15\",\n\t\t\t\"available_date\": \"21/05/2019 13:21:15\",\n\t\t\t\"is_immediate\": false\n \t},\n \t{\n\t \t\"id\": \"4511e1a8-93b8-4e39-9b33-88969c328294\",\n\t \t\"status\": \"settled\",\n\t\t\t\"amount\": \"125.00\",\n\t\t\t\"type\": \"recurring\",\n\t\t\t\"procdate\": \"11/15/2019\",\n\t\t\t\"submitted_date\": \"11/14/2019 13:21:15\",\n\t\t\t\"available_date\": \"11/19/2019 13:21:15\",\n\t\t\t\"is_immediate\": false\n \t},\n \t{\n\t \t\"id\": \"67da7e19-5f3b-402e-aeba-67a4e5caeae3\",\n\t \t\"status\": \"settled\",\n\t\t\t\"amount\": \"125.00\",\n\t\t\t\"type\": \"recurring\",\n\t\t\t\"procdate\": \"11/01/2019\",\n\t\t\t\"submitted_date\": \"10/31/2019 13:21:15\",\n\t\t\t\"available_date\": \"11/05/2019 13:21:15\",\n\t\t\t\"is_immediate\": false\n \t}\n ]\n}"}],"_postman_id":"36168b62-60a3-4d9d-92bc-6875109aeaa8"},{"name":"Create transaction","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"4aeec245-b97b-47f8-b319-a47b8611316c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"User-Token","type":"text","value":"__TOKEN__"}],"body":{"mode":"raw","raw":"{\n\t\"amount\": \"1200.50\",\n\t\"type\": \"onetime\",\n\t\"procdate\": \"12/01/2019\",\n\t\"is_immediate\": false\n}"},"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/transaction","description":"

Submit a transaction to the scheduler. Transactions can either be scheduled for ACH processing immediately or in the future.

\n","urlObject":{"path":["api","v2","user","USER_GUID","goals","GOAL_GUID","transaction"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"357b30d6-e9c9-4aa7-b44d-13c06dc026b3","name":"Create transaction","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"User-Token","value":"__TOKEN__","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"amount\": \"1200.50\",\n\t\"type\": \"scheduled_savings\",\n\t\"procdate\": \"12/01/2019\",\n\t\"is_immediate\": false\n}"},"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/transaction"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"is_created\": true\n },\n \"data\": {\n \t\"id\": \"94dabf90-0c77-47db-82be-dc26b71db7b0\",\n \t\"status\": \"scheduled\",\n\t\t\"amount\": \"1200.50\",\n\t\t\"type\": \"onetime\",\n\t\t\"procdate\": \"2019-12-01\",\n\t\t\"submitted_date\": \"\",\n\t\t\"available_date\": \"\",\n\t\t\"is_immediate\": false\n }\n}"}],"_postman_id":"4aeec245-b97b-47f8-b319-a47b8611316c"},{"name":"Cancel transaction","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"43d1a2c2-62ee-46d7-a5be-437f4b3bd698","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"body":{"mode":"raw","raw":""},"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/transaction/{{transactionId}}","description":"

Cancel a future scheduled savings deposit.

\n","urlObject":{"path":["api","v2","user","USER_GUID","goals","GOAL_GUID","transaction","{{transactionId}}"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"a762f256-d461-4e36-9391-041dad8aca39","name":"Cancel a future deposit","originalRequest":{"method":"DELETE","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"body":{"mode":"raw","raw":""},"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/transaction/{{transactionId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"is_cancelled\": true\n },\n \"data\": {\n \t\"id\": \"94dabf90-0c77-47db-82be-dc26b71db7b0\",\n \t\"status\": \"cancelled\",\n\t\t\"amount\": \"1200.50\",\n\t\t\"type\": \"recurring\",\n\t\t\"procdate\": \"2019-12-01\",\n\t\t\"submitted_date\": \"\",\n\t\t\"available_date\": \"\",\n\t\t\"is_immediate\": false\n }\n}"}],"_postman_id":"43d1a2c2-62ee-46d7-a5be-437f4b3bd698"}],"id":"ef630ff1-e07b-476b-b9ed-6a46c454488d","description":"

The transactions endpoint is used to create, modify, and get information about all fund transactions associated with a goal.

When a goal is created, the Plinqit Services API immediately builds a calendar of transactions to fulfill the goal using the goal's start date, frequency, increment, weekday, monthday, and duration (or end date).

Any time a new transaction is created, the source/funding account and destination account is automatically set according to the transaction type. When the ACH file is created the account numbers are pulled from the institution's funding account, the user's funding account, and the account currently linked to the goal.

When calling the get all transactions route, a filter can be provided to only return transactions with a given status.

\n","event":[{"listen":"prerequest","script":{"id":"42768de4-eb48-45a8-a148-77a83e153560","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7313b47c-3158-439c-88e1-d08d93c2402a","type":"text/javascript","exec":[""]}}],"_postman_id":"ef630ff1-e07b-476b-b9ed-6a46c454488d"},{"name":"Account","item":[{"name":"Get account","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"3992823f-81a3-4841-858d-96b9f93d79f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/account","description":"

Get the linked account details and financials associated with the given goal.

\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

Property	Type	Description
available_balance	Decimal(2)	Amount available for transfer
pending_balance	Decimal(2)	Amount submitted but not yet reflected in available balance
account_number	String	Obfuscated account number
routing_number	String	ABA routing transit number of ODFI
account_type	String	CHECKING, SAVINGS, MONEYMARKET
account_name	String	ODFI account name
provider	String	Name of the ODFI
is_verified	Bool	Is verified via microdeposits or provider credentials

","urlObject":{"path":["api","v2","user","USER_GUID","goals","GOAL_GUID","account"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"f533f373-b2b0-4408-a823-ba47cad00acc","name":"Get account data for the associated goal","originalRequest":{"method":"GET","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/account"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"records\": 1\n },\n \"data\": {\n \t\"available_balance\": 0,\n \t\"pending_balance\": 0,\n\t\t\"account_number\": \"*******6789\",\n\t\t\"routing_number\": 401150976,\n\t\t\"account_type\": \"CHECKING\",\n\t\t\"account_name\": \"John Checking\",\n\t\t\"provider\": \"PNC BANK\",\n\t\t\"is_verified\": true\n }\n}"}],"_postman_id":"3992823f-81a3-4841-858d-96b9f93d79f6"},{"name":"Update account","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"dd92b4aa-0549-4184-8879-8eef726b0c1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"User-Token","value":"__TOKEN__","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"account_number\": 123456789,\n\t\"routing_number\": 401150976,\n\t\"account_type\": \"CHECKING\",\n\t\"account_name\": \"John Checking\",\n\t\"provider\": \"PNC BANK\"\n}"},"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/account","description":"

Update the account and routing number attached to the goal. All future activity will utilize the new account.

\n","urlObject":{"path":["api","v2","user","USER_GUID","goals","GOAL_GUID","account"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"33449eda-d6b4-47fa-b0c3-b2d7135e6a90","name":"Submit new linked account details","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"User-Token","value":"__TOKEN__","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"account_number\": 123456789,\n\t\"routing_number\": 123456789,\n\t\"account_type\": \"CHECKING\",\n\t\"account_name\": \"John Checking\",\n\t\"provider\": \"PNC BANK\"\n}"},"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/account"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": \"\",\n \"data\": {\n \t\"available_balance\": 0,\n \t\"pending_balance\": 0,\n\t\t\"account_number\": 123456789,\n\t\t\"routing_number\": 123456789,\n\t\t\"account_type\": \"CHECKING\",\n\t\t\"account_name\": \"John Checking\",\n\t\t\"provider\": \"PNC BANK\",\n\t\t\"is_verified\": true\n }\n}"}],"_postman_id":"dd92b4aa-0549-4184-8879-8eef726b0c1d"},{"name":"Create verification deposits","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"7fc3fd29-1d18-4c0c-bd72-e1fc19ed8f90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"body":{"mode":"raw","raw":""},"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/account/verify","description":"

Initiate two small (< $1.00) transfers to the account to verify user has access to that account.

\n","urlObject":{"path":["api","v2","user","USER_GUID","goals","GOAL_GUID","account","verify"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"5b69b861-5e43-4ac9-b65d-6da292fe8e5f","name":"Create verification deposits","originalRequest":{"method":"POST","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"body":{"mode":"raw","raw":""},"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/account/verify"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"is_created\": true\n },\n \"data\": {\n \t\"available_balance\": 0,\n \t\"pending_balance\": 0,\n\t\t\"account_number\": 123456789,\n\t\t\"routing_number\": 123456789,\n\t\t\"account_type\": \"CHECKING\",\n\t\t\"account_name\": \"John Checking\",\n\t\t\"provider\": \"PNC BANK\",\n\t\t\"is_verified\": false\n }\n}"}],"_postman_id":"7fc3fd29-1d18-4c0c-bd72-e1fc19ed8f90"},{"name":"Verify verification deposits","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"f9c8e792-1482-4f74-9c18-44aa710d53d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"User-Token","value":"__TOKEN__","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"amount_1\": 0.25,\n\t\"amount_2\": 0.06\n}"},"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/account/verify","description":"

Verify the two microdepoist amounts. It does not matter which amount is submitted as first or second.

\n","urlObject":{"path":["api","v2","user","USER_GUID","goals","GOAL_GUID","account","verify"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"166d0fc9-812c-48bb-bd5d-1ebf81f73dd1","name":"Send the deposit values to the API to verify the account","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"User-Token","value":"__TOKEN__","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"amount_1\": 0.25,\n\t\"amount_2\": 0.06\n}"},"url":"io.plinqit.com/api/v2/user/USER_GUID/goals/GOAL_GUID/account/verify"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"is_verified\": true\n },\n \"data\": {\n \t\"available_balance\": 0,\n \t\"pending_balance\": 0,\n\t\t\"account_number\": 123456789,\n\t\t\"routing_number\": 123456789,\n\t\t\"account_type\": \"CHECKING\",\n\t\t\"account_name\": \"John Checking\",\n\t\t\"provider\": \"PNC BANK\",\n\t\t\"is_verified\": true\n }\n}"}],"_postman_id":"f9c8e792-1482-4f74-9c18-44aa710d53d0"}],"id":"67981c4e-6d70-47fb-bc92-9463784c11cf","description":"

Each goal has an associated goal account. The goal account defines the funding OFDI account used for the goal's transactions, and represents the pending and available balances for the goal. Account balance data for the funding account itself is not included in the goal account object.

While there is a one-to-one relationship between each goal and it's funding account, multiple goals can each be attached to the same or different accounts. Integration settings define whether or not users are able to attach a funding account external to your institution.

The funding account for each goal can be changed by calling the update account route.

Microdeposit account verification is available if a goal is being linked to an account external to your institution.

\n","event":[{"listen":"prerequest","script":{"id":"e2cb2997-6819-425b-bc0f-f1188fe2c665","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7a6e3589-38ff-48cf-8652-d41f7a950338","type":"text/javascript","exec":[""]}}],"_postman_id":"67981c4e-6d70-47fb-bc92-9463784c11cf"},{"name":"Statement","item":[{"name":"Get statement","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"3c21f7da-2d63-4ef6-91dd-d5ed81c0f087","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"User-Token","value":"__TOKEN__","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"date_start\": \"2018-01-01\",\n\t\"date_end\": \"2018-01-31\"\n}"},"url":"io.plinqit.com/api/v2/user/USER_GUID/statement","description":"

Query the API for a transaction statment using the provided start and end dates.

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
date_start	Date YYYY-MM-DD	[optional] Date contraint, earliest
date_end	Date YYYY-MM-DD	[optional] Date contraint, latest

","urlObject":{"path":["api","v2","user","USER_GUID","statement"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"33e9fa0b-5aa4-4663-8a72-b3ae42ba1a6b","name":"Get the statement for the provided date range","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"User-Token","value":"__TOKEN__","type":"text"}],"url":"io.plinqit.com/api/v2/user/USER_GUID/statement"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": \"\",\n \"data\": {\n \t\"date_start\": \"2019-01-01\",\n \t\"date_end\": \"2019-01-31\",\n \t\"total_saved\": 1500,\n \t\"total_withdrawn\": 0,\n \t\"total_interest\": 0.22,\n \t\"total_rewards\": 0,\n \t\"total_penalties\": 0,\n \t\"goals\": [\n \t\t{\n \t\t\t\"id\": \"686ac2f9-24de-4b44-8fbe-606ae5474638\",\n \t\t\t\"saved\": 800.00,\n \t\t\t\"withdrawals\": 0,\n \t\t\t\"interest\": 0.19,\n \t\t\t\"rewards\": 0,\n \t\t\t\"penalties\": 0\n \t\t},\n \t\t{\n \t\t\t\"id\": \"fcff8575-2d53-4073-a38d-9bc0114609d8\",\n \t\t\t\"saved\": 700.00,\n \t\t\t\"withdrawals\": 0,\n \t\t\t\"interest\": 0.03,\n \t\t\t\"rewards\": 0,\n \t\t\t\"penalties\": 0\n \t\t}\t\n \t]\n }\n}"}],"_postman_id":"3c21f7da-2d63-4ef6-91dd-d5ed81c0f087"},{"name":"Get earnings","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"5dc7265b-e69f-440d-a470-f45ca8fcb1b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"User-Token","type":"text","value":"__TOKEN__"}],"body":{"mode":"raw","raw":""},"url":"io.plinqit.com/api/v2/user/USER_GUID/statement/earnings","description":"

Get a list of all earnings for the user. Returns all paid earnings as well as earnings earmarked to be issued once the final transaction of the goal has settled.

Earnings objects

\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

Property	Type	Description
id	GUID	Identifier of the earnings record
goal_id	GUID	Identifier of associated goal account
type	Enum	See type lookup table
status	Enum	See status lookup table
amount	Decimal(2)	Amount of transaction
activity_date	Date	Date of earned activity
eligibility_date	Date [optional]	Date issued (if issued)
transaction_id	GUID [optional]	Identifer of ACH transaction (if issued)
aux_id	GUID [optional]	Identifier of activity

Status lookup table

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Description
issued	The funds have been transferred to the goal account
pending	Funds will be issued when the goal has completed

Type lookup table

\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

Type	Description
reward	Goal completion reward
referral	Completed referral reward
buildskills	Earnings from completing Build Skills item
promo	Promotional reward or bonus
interest	Interest earned on the goal account

","urlObject":{"path":["api","v2","user","USER_GUID","statement","earnings"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"996c34da-52a3-45b6-a6ad-5f6cc048ba23","name":"Get earnings details","originalRequest":{"method":"GET","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"},{"key":"Content-Type","value":"application/json"}],"url":"io.plinqit.com/api/v2/user/USER_GUID/statement/earnings"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"records\": 3\n },\n \"data\": [\n \t{\n \t\t\"id\": \"6f49da4b-9ae5-409a-aef4-1c56b1da42f4\",\n \t\t\"goal_id\": \"fa442694-56d8-48f8-ae45-faf9696c6803\",\n \t\t\"type\": \"referral\",\n \t\t\"status\": \"issued\",\n \t\t\"amount\": \"5.00\",\n \t\t\"activity_date\": \"2019-02-11 14:22:01\",\n \t\t\"eligibility_date\": \"2019-02-29 01:05:38\",\n \t\t\"transaction_id\": \"418b7bdb-a2e8-4800-ad9d-e5b9537ac3f1\",\n \t\t\"aux_id\": \"f0a450da-c3d1-4864-b188-73c89bad42f3\"\n \t},\n \t{\n \t\t\"id\": \"7689aac1-48f4-451d-b89a-776aa82c395a\",\n \t\t\"goal_id\": \"de527fb5-e8c0-47b5-89c6-13dba65811b4\",\n \t\t\"type\": \"buildskills\",\n \t\t\"status\": \"pending\",\n \t\t\"amount\": \"0.13\",\n \t\t\"activity_date\": \"2019-04-11 16:12:11\",\n \t\t\"eligibility_date\": \"\",\n \t\t\"transaction_id\": \"\",\n \t\t\"aux_id\": \"a4b3559b-fcc2-4231-ace1-2f1ca27bd69a\"\n \t},\n \t{\n \t\t\"id\": \"cf081dd6-6475-42aa-8309-e06033c5a7e3\",\n \t\t\"goal_id\": \"de527fb5-e8c0-47b5-89c6-13dba65811b4\",\n \t\t\"type\": \"buildskills\",\n \t\t\"status\": \"pending\",\n \t\t\"amount\": \"0.08\",\n \t\t\"activity_date\": \"2019-04-12 09:50:21\",\n \t\t\"eligibility_date\": \"\",\n \t\t\"transaction_id\": \"\",\n \t\t\"aux_id\": \"f47e9a5c-33aa-41b2-80e9-3028f9f11119\"\n \t}\n ]\n}"}],"_postman_id":"5dc7265b-e69f-440d-a470-f45ca8fcb1b9"}],"id":"4c20b097-d107-4419-9387-8a9df555dbf1","description":"

The statement route provides reporting insight for each of the user's goals. If a start and/or end date is provided the report will be constrained to that date range.

\n","event":[{"listen":"prerequest","script":{"id":"84c772ac-54ad-4c64-9fe2-e3112dfca56c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9de70d36-6497-44fe-8d5c-da2bd1de389e","type":"text/javascript","exec":[""]}}],"_postman_id":"4c20b097-d107-4419-9387-8a9df555dbf1"},{"name":"Build Skills","item":[{"name":"Get item","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"e90390b1-989f-416f-9dfa-348921c66e97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"User-Token","type":"text","value":"__TOKEN__"}],"url":"io.plinqit.com/api/v2/buildskills/{{buildSkillsItemId}}","description":"

Get the Build Skills object defined by the given GUID.

\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

Property	Type	Description
id	GUID	GUID identifier of the item
category_id	GUID	Category identifier
type	Enum	See type lookup table
status	Enum	See status lookup table
label	String	Title of the Build Skill item
description	String [optional]	Long description
value	Decimal(2)	Reward value for completing item
rating	Integer	Average thumbs up rating
duration	String [optional]	Duration of video
image_key	String [optional]	GUID of image file for CDN
article_content	String [optional]	GUID of article content for CDN
mp4_key	String [optional]	GUID of video file for CDN
webm_key	String [optional]	GUID of video file for CDN
ogv_key	String [optional]	GUID of video file for CDN

Type lookup table

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Type	Description
video	Reading skill
article	Video skill

Status lookup table

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Description
eligible	User can engage with the item
completed	User has already completed the item
locked	Quiz not available again until next day

","urlObject":{"path":["api","v2","buildskills","{{buildSkillsItemId}}"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"bbc87865-d053-41db-857a-1d76d3035751","name":"Get Build Skills object","originalRequest":{"method":"GET","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"url":"io.plinqit.com/api/v2/buildskills/{{buildSkillsItemId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"records\": 1\n },\n \"data\": {\n\t\t\"id\": \"f8d54ad5-6471-4098-b48c-6e15fb30e9de\",\n\t\t\"category_id\": \"c8bf1c8c-21c3-4df2-89a5-f36989b0e6b0\",\n\t\t\"type\": \"video\",\n\t\t\"status\": \"eligible\",\n\t\t\"label\": \"Your First Home Mortgage\",\n\t\t\"description\": \"In lorem ipsum...\",\n\t\t\"value\": \"0.15\",\n\t\t\"rating\": \"92\",\n\t\t\"duration\": \"01:20\",\n\t\t\"image_key\": \"9cfbcedc-defc-4a33-b69e-711684ac1f31\",\n\t\t\"article_content\": \"07fe7f5b-e12c-42bb-95a8-95f191186af4\",\n\t\t\"mp4_key\": \"90c42761-c079-4360-9e88-589b92a3d5f4\",\n\t\t\"webm_key\": \"242927a9-5ed4-4d22-acb7-d54c25346599\",\n\t\t\"ogv_key\": \"d191a800-21de-49bc-ac7f-3ae217fca679\"\n }\n}"}],"_postman_id":"e90390b1-989f-416f-9dfa-348921c66e97"},{"name":"Create item","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"636c094e-341d-4d2d-af87-880b24de9b63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"User-Token","type":"text","value":"__TOKEN__"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"category_id","value":"c8bf1c8c-21c3-4df2-89a5-f36989b0e6b0","type":"text"},{"key":"type","value":"video","type":"text"},{"key":"label","value":"Your First Home Mortgage","type":"text"},{"key":"description","value":"In lorem ipsum...","type":"text"},{"key":"value","value":"0.25","type":"text"},{"key":"duration","value":"01:20","type":"text"},{"key":"article_content","value":"","type":"text"},{"key":"video_file","value":"Binary","type":"text"}]},"url":"io.plinqit.com/api/v2/buildskills","description":"

Publish a new Build Skills item.

\n","urlObject":{"path":["api","v2","buildskills"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"2d1796bd-0c5c-465a-9c6f-1823db2df741","name":"Create new Build Skills item","originalRequest":{"method":"POST","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"category_id","value":"c8bf1c8c-21c3-4df2-89a5-f36989b0e6b0","type":"text"},{"key":"type","value":"video","type":"text"},{"key":"label","value":"Your First Home Mortgage","type":"text"},{"key":"description","value":"In lorem ipsum...","type":"text"},{"key":"value","value":"0.25","type":"text"},{"key":"duration","value":"01:20","type":"text"},{"key":"article_content","value":"In lorem ipsum...","type":"text"},{"key":"video_file","value":"Binary","type":"text"}]},"url":"io.plinqit.com/api/v2/buildskills"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"is_created\": true\n },\n \"data\": {\n\t\t\"id\": \"f8d54ad5-6471-4098-b48c-6e15fb30e9de\",\n\t\t\"category_id\": \"c8bf1c8c-21c3-4df2-89a5-f36989b0e6b0\",\n\t\t\"type\": \"video\",\n\t\t\"status\": \"eligible\",\n\t\t\"label\": \"Your First Home Mortgage\",\n\t\t\"description\": \"In lorem ipsum...\",\n\t\t\"value\": \"0.15\",\n\t\t\"rating\": \"92\",\n\t\t\"duration\": \"01:20\",\n\t\t\"image_key\": \"\",\n\t\t\"article_content\": \"\",\n\t\t\"mp4_key\": \"90c42761-c079-4360-9e88-589b92a3d5f4\",\n\t\t\"webm_key\": \"242927a9-5ed4-4d22-acb7-d54c25346599\",\n\t\t\"ogv_key\": \"d191a800-21de-49bc-ac7f-3ae217fca679\"\n }\n}"}],"_postman_id":"636c094e-341d-4d2d-af87-880b24de9b63"},{"name":"Update item","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"4662f1c3-78db-4c74-9770-3e7a994839af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"User-Token","type":"text","value":"__TOKEN__"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"category_id","value":"c8bf1c8c-21c3-4df2-89a5-f36989b0e6b0","type":"text"},{"key":"type","value":"video","type":"text"},{"key":"label","value":"Your First Home Mortgage","type":"text"},{"key":"description","value":"In lorem ipsum...","type":"text"},{"key":"value","value":"0.25","type":"text"},{"key":"duration","value":"01:20","type":"text"},{"key":"article_content","value":"","type":"text"},{"key":"video_file","value":"Binary","type":"text"}]},"url":"io.plinqit.com/api/v2/buildskills/{{buildSkillsItemId}}","description":"

Update the item.

\n","urlObject":{"path":["api","v2","buildskills","{{buildSkillsItemId}}"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"59a02507-c7d4-4f65-8d9e-c1eead4ba940","name":"Update Build Skills object","originalRequest":{"method":"PUT","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"type","value":"video","type":"text"},{"key":"label","value":"Your First Home Mortgage","type":"text"},{"key":"description","value":"In lorem ipsum...","type":"text"},{"key":"value","value":"0.25","type":"text"},{"key":"duration","value":"01:20","type":"text"},{"key":"article_content","value":"In lorem ipsum...","type":"text"},{"key":"video_file","value":"Binary","type":"text"}]},"url":"io.plinqit.com/api/v2/buildskills/{{buildSkillsItemId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"is_updated\": true\n },\n \"data\": {\n\t\t\"id\": \"f8d54ad5-6471-4098-b48c-6e15fb30e9de\",\n\t\t\"category_id\": \"c8bf1c8c-21c3-4df2-89a5-f36989b0e6b0\",\n\t\t\"type\": \"video\",\n\t\t\"status\": \"eligible\",\n\t\t\"label\": \"Your First Home Mortgage\",\n\t\t\"description\": \"In lorem ipsum...\",\n\t\t\"value\": \"0.15\",\n\t\t\"rating\": \"92\",\n\t\t\"duration\": \"01:20\",\n\t\t\"image_key\": \"\",\n\t\t\"article_content\": \"\",\n\t\t\"mp4_key\": \"90c42761-c079-4360-9e88-589b92a3d5f4\",\n\t\t\"webm_key\": \"242927a9-5ed4-4d22-acb7-d54c25346599\",\n\t\t\"ogv_key\": \"d191a800-21de-49bc-ac7f-3ae217fca679\"\n }\n}"}],"_postman_id":"4662f1c3-78db-4c74-9770-3e7a994839af"},{"name":"Delete item","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"f229d726-5edf-4601-8cd8-e4f6eec46ba6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"User-Token","type":"text","value":"__TOKEN__"}],"url":"io.plinqit.com/api/v2/buildskills/{{buildSkillsItemId}}","description":"

Delete the media attached to the item and unpublish it.

\n","urlObject":{"path":["api","v2","buildskills","{{buildSkillsItemId}}"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"8c3e40f1-e5af-4a40-b1f7-80b16285f748","name":"Delete Build Skills item","originalRequest":{"method":"DELETE","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"url":"io.plinqit.com/api/v2/buildskills/{{buildSkillsItemId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"is_deleted\": true\n },\n \"data\": {\n\t\t\"id\": \"f8d54ad5-6471-4098-b48c-6e15fb30e9de\",\n\t\t\"status\": \"archived\"\n }\n}"}],"_postman_id":"f229d726-5edf-4601-8cd8-e4f6eec46ba6"},{"name":"Get Build Skills Categories","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"963097d7-314a-4868-8e2c-d378b381d30f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"User-Token","type":"text","value":"__TOKEN__"}],"url":"io.plinqit.com/api/v2/buildskills/categories","urlObject":{"path":["api","v2","buildskills","categories"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"d5ec382f-1cb4-4bb2-983b-5f64af744c9f","name":"Get Build Skills categories","originalRequest":{"method":"GET","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"url":"io.plinqit.com/api/v2/buildskills/categories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"records\": 6\n },\n \"data\": [\n \t{\n \t\t\"id\": \"46e90084-851a-4085-9256-854741d25a41\",\n \t\t\"label\": \"Saving\"\n \t},\n \t{\n \t\t\"id\": \"09554e2b-dcfe-4493-bfd1-2df4fc52f519\",\n \t\t\"label\": \"Credit\"\n \t},\n \t{\n \t\t\"id\": \"313a3a82-f7ec-4739-8d42-71fbcac596d5\",\n \t\t\"label\": \"Budgeting\"\n \t},\n \t{\n \t\t\"id\": \"91832194-30d8-4b92-bfd6-9185db839ed7\",\n \t\t\"label\": \"Adulting\"\n \t},\n \t{\n \t\t\"id\": \"27abfafa-c8a4-4459-985f-f38912ece3f0\",\n \t\t\"label\": \"Debt\"\n \t},\n \t{\n \t\t\"id\": \"aec27cc2-c57c-4e2b-8c12-2e46550025f4\",\n \t\t\"label\": \"Home\"\n \t}\n ]\n}"}],"_postman_id":"963097d7-314a-4868-8e2c-d378b381d30f"},{"name":"Get earning potential","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"07411a6d-c7de-407d-821e-9ab6ef97fbcb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"User-Token","type":"text","value":"__TOKEN__"}],"url":"io.plinqit.com/api/v2/buildskills/potential","description":"

Route to retrieve data detailing how much money user can earn with all available Build Skills items, as well as how much they have earned to date.

\n","urlObject":{"path":["api","v2","buildskills","potential"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"eb2dcb0e-2381-42c2-8687-70386ef3878d","name":"Get possible earnings","originalRequest":{"method":"GET","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"url":"io.plinqit.com/api/v2/buildskills/potential"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {},\n \"data\": {\n \t\"earnings_possible\": \"24.20\",\n \t\"earnings_complete\": \"0.60\"\n }\n}"}],"_postman_id":"07411a6d-c7de-407d-821e-9ab6ef97fbcb"},{"name":"Get all items","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"8fbf6e83-ffa7-4533-b64d-d44c5f718714","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"User-Token","type":"text","value":"__TOKEN__"}],"url":"io.plinqit.com/api/v2/buildskills?category_id={{buildSkillsCategoryId}}","urlObject":{"path":["api","v2","buildskills"],"host":["io.plinqit.com"],"query":[{"key":"category_id","value":"{{buildSkillsCategoryId}}"}],"variable":[]}},"response":[{"id":"ef87f849-6b46-419b-a499-ce2269ba33a6","name":"Get a list of all Build Skills items","originalRequest":{"method":"GET","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"url":{"raw":"io.plinqit.com/api/v2/buildskills?category_id={{buildSkillsCategoryId}}","host":["io.plinqit.com"],"path":["api","v2","buildskills"],"query":[{"key":"category_id","value":"{{buildSkillsCategoryId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"records\": 1\n },\n \"data\": [\n \t{\n\t\t\t\"id\": \"f8d54ad5-6471-4098-b48c-6e15fb30e9de\",\n\t\t\t\"category_id\": \"c8bf1c8c-21c3-4df2-89a5-f36989b0e6b0\",\n\t\t\t\"type\": \"video\",\n\t\t\t\"status\": \"locked\",\n\t\t\t\"label\": \"Your First Home Mortgage\",\n\t\t\t\"description\": \"In lorem ipsum...\",\n\t\t\t\"value\": \"0.15\",\n\t\t\t\"rating\": \"92\",\n\t\t\t\"duration\": \"01:20\",\n\t\t\t\"image_key\": \"9cfbcedc-defc-4a33-b69e-711684ac1f31\",\n\t\t\t\"article_content\": \"07fe7f5b-e12c-42bb-95a8-95f191186af4\",\n\t\t\t\"mp4_key\": \"90c42761-c079-4360-9e88-589b92a3d5f4\",\n\t\t\t\"webm_key\": \"242927a9-5ed4-4d22-acb7-d54c25346599\",\n\t\t\t\"ogv_key\": \"d191a800-21de-49bc-ac7f-3ae217fca679\"\n\t }\n\t]\n}"}],"_postman_id":"8fbf6e83-ffa7-4533-b64d-d44c5f718714"},{"name":"Get item questions","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"a5782d4b-28dc-458f-814a-6d3da086e887","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"User-Token","type":"text","value":"__TOKEN__"}],"url":"io.plinqit.com/api/v2/buildskills/{{buildSkillsItemId}}/questions","description":"

Get a list of questions relating to the Build Skills item to render a quiz about the content.

\n","urlObject":{"path":["api","v2","buildskills","{{buildSkillsItemId}}","questions"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"e49fddf5-f5f7-4511-98aa-6ab8a0f03b59","name":"Get account data for the associated goal","originalRequest":{"method":"GET","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"url":"io.plinqit.com/api/v2/buildskills/{{buildSkillsItemId}}/questions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"records\": 2\n },\n \"data\": [\n \t{\n \t\t\"id\": \"8fda67ed-555c-43ff-a2e5-1eb40d820b5e\",\n \t\t\"question_label\": \"54% of families in the U.S. have credit card debt.\",\n \t\t\"answers\": [\n \t\t\t[\n \t\t\t\t{\n \t\t\t\t\t\"id\": \"ac197dbe-6f88-406c-980e-579515100027\",\n \t\t\t\t\t\"answer_label\": \"True\"\n \t\t\t\t},\n \t\t\t\t{\n \t\t\t\t\t\"id\": \"fc54f8ca-ab57-46c2-ae76-226051153822\",\n \t\t\t\t\t\"answer_label\": \"False\"\n \t\t\t\t}\n \t\t\t]\n \t\t]\n \t},\n \t{\n \t\t\"id\": \"17f06cd4-0e06-40a5-95cd-85023e17d37a\",\n \t\t\"question_label\": \"What is a common mistake that many people make, that lands them right back in debt-after using a consolidation loan?\",\n \t\t\"answers\": [\n \t\t\t[\n \t\t\t\t{\n \t\t\t\t\t\"id\": \"011536af-d7c3-4a85-bafe-822e1585ae9b\",\n \t\t\t\t\t\"answer_label\": \"They choose a high interest rate.\"\n \t\t\t\t},\n \t\t\t\t{\n \t\t\t\t\t\"id\": \"d0ad13bf-d84f-462d-b6ca-a2cfc79a8e5e\",\n \t\t\t\t\t\"answer_label\": \"Their consolidation loan defaults.\"\n \t\t\t\t},\n \t\t\t\t{\n \t\t\t\t\t\"id\": \"1b158228-8df2-47cd-9953-e52a51cee9c0\",\n \t\t\t\t\t\"answer_label\": \"Balances get charged in full on their credit cards.\"\n \t\t\t\t},\n \t\t\t\t{\n \t\t\t\t\t\"id\": \"53d69b66-1e47-4fbd-ab9f-d244cf6e0b43\",\n \t\t\t\t\t\"answer_label\": \"They immediately buy a new sports car.\"\n \t\t\t\t}\n \t\t\t]\n \t\t]\n \t}\t\n ]\n}"}],"_postman_id":"a5782d4b-28dc-458f-814a-6d3da086e887"},{"name":"Submit item answers","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"e3571fd3-b3ce-4e5e-84d7-52284fb7d08f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"User-Token","type":"text","value":"__TOKEN__"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"answers\": [\n\t\t{\n\t\t\t\"question_id\": \"5f4f1b33-331d-47c8-8a5c-5c97ef50b2fd\",\n\t\t\t\"answer_id\": \"8b8d5fc6-06ea-405f-8921-462ad94a3afd\"\n\t\t},\n\t\t{\n\t\t\t\"question_id\": \"78f3d9c2-08e3-44f3-8c21-98f841000f9a\",\n\t\t\t\"answer_id\": \"bd1d4539-af66-4351-ba41-160d7440fba7\"\n\t\t},\n\t\t{\n\t\t\t\"question_id\": \"b5147c6e-5264-4504-8412-ef1220a33141\",\n\t\t\t\"answer_id\": \"ac5e8d02-ec40-4b74-8fbf-136a3c2bc4d9\"\n\t\t}\t\n\t]\n}"},"url":"io.plinqit.com/api/v2/buildskills/{{buildSkillsItemId}}/questions","description":"

Submit users' answers to the Build Skills quiz.

\n","urlObject":{"path":["api","v2","buildskills","{{buildSkillsItemId}}","questions"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"31e50269-0c8a-4a0d-be28-b37978202810","name":"Submit answers","originalRequest":{"method":"POST","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"answers\": [\n {\n \"question_id\": \"5f4f1b33-331d-47c8-8a5c-5c97ef50b2fd\",\n \"answer_id\": \"8b8d5fc6-06ea-405f-8921-462ad94a3afd\"\n },\n {\n \"question_id\": \"78f3d9c2-08e3-44f3-8c21-98f841000f9a\",\n \"answer_id\": \"bd1d4539-af66-4351-ba41-160d7440fba7\"\n },\n {\n \"question_id\": \"b5147c6e-5264-4504-8412-ef1220a33141\",\n \"answer_id\": \"ac5e8d02-ec40-4b74-8fbf-136a3c2bc4d9\"\n }\n ]\n}"},"url":"io.plinqit.com/api/v2/buildskills/{{buildSkillsItemId}}/questions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"is_passed\": true\n },\n \"data\": {\n \t\"correct\": 2,\n \t\"incorrect\": 0\n }\n}"}],"_postman_id":"e3571fd3-b3ce-4e5e-84d7-52284fb7d08f"},{"name":"Rate item","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"c060de69-f02d-4a93-8a2e-558f45d7ee53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"User-Token","type":"text","value":"__TOKEN__"}],"url":"io.plinqit.com/api/v2/buildskills/{{buildSkillsItemId}}/rate","description":"

Rate the Build Skills item with either a thumbs up or a thumbs down.

\n","urlObject":{"path":["api","v2","buildskills","{{buildSkillsItemId}}","rate"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"271d66b6-a177-4f26-ac2a-5da4ba162dd6","name":"Rate the item","originalRequest":{"method":"POST","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"rating\": \"up\"\n}"},"url":"io.plinqit.com/api/v2/buildskills/{{buildSkillsItemId}}/rate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"is_rated\": true\n },\n \"data\": {}\n}"}],"_postman_id":"c060de69-f02d-4a93-8a2e-558f45d7ee53"}],"id":"71d746a9-858c-4d5f-8c59-9ede9c260b3b","description":"

Our patent pending Build Skills platform increases user engagement with a turn-key library of financial literacy content. The Plinqit Services API also allows your institution to offer its own content within the Plinqit platform.

\n","event":[{"listen":"prerequest","script":{"id":"ca040777-c37a-4ea8-8175-9afafc847323","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fd421933-234e-4b26-90ce-3c7378dc7871","type":"text/javascript","exec":[""]}}],"_postman_id":"71d746a9-858c-4d5f-8c59-9ede9c260b3b"},{"name":"Invites","item":[{"name":"Get invites","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"4ec75313-06c7-4da7-bb36-2387502ee5df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"User-Token","type":"text","value":"__TOKEN__"}],"url":"io.plinqit.com/api/v2/invites","description":"

Get a list of all referrals sent to date by the user.

\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

Property	Type	Description
id	GUID	Unique identifier of the referral
name	String	Concatenated first and last name of invitee
email	String	Email address of invitee
regdate	Date YYYY-MM-DD HH:mm:ss	Date the invitation was created
status	Decimal(2)	See lookup table

Status lookup table

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Description
pending	Invite sent and user has not signed up
registered	Invite sent and user registered
nudged	Invite sent, nudged, but user has not signed up yet

","urlObject":{"path":["api","v2","invites"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"ffacffd5-a791-4eb1-80fe-be80263f0b5e","name":"Get all invites","originalRequest":{"method":"GET","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"}],"url":"io.plinqit.com/api/v2/invites"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"records\": 2\n },\n \"data\": [\n \t{\n \t\t\"id\": \"c94d59ef-b437-49bc-9ed9-433b2a730cb3\",\n \t\t\"name\": \"Jane Smith\",\n \t\t\"email\": \"jane@domain.com\",\n \t\t\"regdate\": \"2019-03-10 11:47:12\",\n \t\t\"status\": \"pending\"\n \t},\n \t{\n \t\t\"id\": \"878b929b-cd2a-4fb3-9850-1185598ef5f4\",\n \t\t\"name\": \"John Brown\",\n \t\t\"email\": \"john@domain.com\",\n \t\t\"regdate\": \"2019-03-02 12:02:55\",\n \t\t\"status\": \"registered\"\n \t}\n ]\n}"}],"_postman_id":"4ec75313-06c7-4da7-bb36-2387502ee5df"},{"name":"Create invite","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"1ad707c2-87b3-4e8e-a884-8359ee152513","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"User-Token","type":"text","value":"__TOKEN__"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"invite\": {\n\t\t\"firstname\": \"Jane\",\n\t\t\"lastname\": \"Smith\",\n\t\t\"email\": \"jane@domain.com\",\n\t\t\"personal_message\": \"In lorem ipsum...\"\n\t}\n}"},"url":"io.plinqit.com/api/v2/invites","description":"

User sends a new invitation.

\n","urlObject":{"path":["api","v2","invites"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"b385d9ab-b99e-46d5-91ef-170f37d14d7d","name":"Create invite","originalRequest":{"method":"POST","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"invite\": {\n\t\t\"firstname\": \"Jane\",\n\t\t\"lastname\": \"Smith\",\n\t\t\"email\": \"jane@domain.com\",\n\t\t\"personal_message\": \"In lorem ipsum...\"\n\t}\n}"},"url":"io.plinqit.com/api/v2/invites"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"is_invited\": true\n },\n \"data\": \t{\n\t\t\"id\": \"c94d59ef-b437-49bc-9ed9-433b2a730cb3\",\n\t\t\"name\": \"Jane Smith\",\n\t\t\"email\": \"jane@domain.com\",\n\t\t\"regdate\": \"2019-03-10 11:47:12\",\n\t\t\"status\": \"pending\"\n\t}\n}"}],"_postman_id":"1ad707c2-87b3-4e8e-a884-8359ee152513"},{"name":"Nudge invite","event":[{"listen":"test","script":{"id":"20f22c70-acd1-41a4-b1bc-0f72f48700ae","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"590cbb26-da16-422f-b051-7c33a02714a2","exec":[""],"type":"text/javascript"}}],"id":"80bd7de7-0832-4aa2-ba79-acd9739d24d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"User-Token","type":"text","value":"__TOKEN__"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"custom_message\": \"In lorem ipsum...\"\n}"},"url":"io.plinqit.com/api/v2/invites/{{invitationId}}/nudge","description":"

Send a pending referral a friendly reminder via email.

Each referral can be nudged no more that one time. The nudge action can include a custom message and is not available until 3 days after the referral has been sent.

\n","urlObject":{"path":["api","v2","invites","{{invitationId}}","nudge"],"host":["io.plinqit.com"],"query":[],"variable":[]}},"response":[{"id":"6fe54d2a-0372-4a6e-9bb5-0f6441c99d4c","name":"Nudge the referral","originalRequest":{"method":"POST","header":[{"key":"User-Token","value":"__TOKEN__","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"custom_message\": \"In lorem ipsum...\"\n}"},"url":"io.plinqit.com/api/v2/invites/{{invitationId}}/nudge"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Dec 2018 20:34:49 GMT"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,X-CustomHeader,Keep-Alive,User-Agent,Admin-Token,User-Token,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, Accept"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"442"},{"key":"Content-Type","value":"application/json"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"response\": {\n \t\"is_nudged\": true\n },\n \"data\": \t{\n\t\t\"id\": \"c94d59ef-b437-49bc-9ed9-433b2a730cb3\",\n\t\t\"name\": \"Jane Smith\",\n\t\t\"email\": \"jane@domain.com\",\n\t\t\"regdate\": \"2019-03-10 11:47:12\",\n\t\t\"status\": \"pending\"\n\t}\n}"}],"_postman_id":"80bd7de7-0832-4aa2-ba79-acd9739d24d9"}],"id":"67d6dcae-8130-498d-aac5-d713db327e3b","description":"

The Plinqit referrals module allows existing users to invite their friends and family to create an account and join in on the savings fun. Integration options include offering rewards for successful referral signups.

Once am invite has been sent, a reminder email can be initiated if the user has not yet signed up.

If multiple users create an invitation to the same email address, the first user to send an invitation to that address will be credited with the referral. For a referral credit to be initiated, the user must sign up using the email address associated with the invitation (referral rewards are not based on the first/last name of the new user).

\n","event":[{"listen":"prerequest","script":{"id":"8cdf0516-d37c-4fd3-b157-fbec5aa10822","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9eef0457-600d-4f71-8d1d-bb4696d27617","type":"text/javascript","exec":[""]}}],"_postman_id":"67d6dcae-8130-498d-aac5-d713db327e3b"}],"event":[{"listen":"prerequest","script":{"id":"aa249a3f-d604-4543-9098-8c01b5092b6b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4e290f26-fd4d-4ee0-9129-43193bcb41e1","type":"text/javascript","exec":[""]}}],"variable":[{"key":"plinqitServicesUrl","value":"io.plinqit.com"},{"key":"plinqitServicesApiUrl","value":"io.plinqit.com"},{"key":"PlinqitServicesToken","value":"__TOKEN__"},{"key":"userId","value":"USER_GUID"},{"key":"goalId","value":"GOAL_GUID"}]}